Teuchos Package Browser (Single Doxygen Collection) Version of the Day
custom_validator_xml.cpp
Go to the documentation of this file.
00001 /*
00002 // @HEADER
00003 // ***********************************************************************
00004 //
00005 //                    Teuchos: Common Tools Package
00006 //                 Copyright (2004) Sandia Corporation
00007 //
00008 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
00009 // license for use of this work by or on behalf of the U.S. Government.
00010 //
00011 // Redistribution and use in source and binary forms, with or without
00012 // modification, are permitted provided that the following conditions are
00013 // met:
00014 //
00015 // 1. Redistributions of source code must retain the above copyright
00016 // notice, this list of conditions and the following disclaimer.
00017 //
00018 // 2. Redistributions in binary form must reproduce the above copyright
00019 // notice, this list of conditions and the following disclaimer in the
00020 // documentation and/or other materials provided with the distribution.
00021 //
00022 // 3. Neither the name of the Corporation nor the names of the
00023 // contributors may be used to endorse or promote products derived from
00024 // this software without specific prior written permission.
00025 //
00026 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
00027 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00028 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
00029 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
00030 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
00031 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
00032 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00033 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00034 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00035 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00036 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00037 //
00038 // Questions? Contact Michael A. Heroux (maherou@sandia.gov)
00039 //
00040 // ***********************************************************************
00041 // @HEADER
00042 */
00043 
00044 #include "Teuchos_ParameterList.hpp"
00045 #include "Teuchos_Array.hpp"  
00046 #include "Teuchos_Version.hpp"
00047 #include "Teuchos_ParameterEntryXMLConverterDB.hpp"
00048 #include "Teuchos_XMLParameterListCoreHelpers.hpp"
00049 #include "Teuchos_StandardParameterEntryValidators.hpp"
00050 #include "Teuchos_ValidatorXMLConverterDB.hpp"
00051 #include "Teuchos_StandardValidatorXMLConverters.hpp"
00052 #include <iostream>
00053 
00054 
00055 
00062 int main(int argc, char* argv[])
00063 {
00064   std::cout << Teuchos::Teuchos_Version() << std::endl << std::endl;
00065 
00066   Teuchos::ParameterList My_List;
00067 
00068   //Basic data types
00069   Teuchos::RCP<Teuchos::StringToIntegralParameterEntryValidator<short> >
00070     solverValidator = Teuchos::rcp(
00071       new Teuchos::StringToIntegralParameterEntryValidator<short>(
00072         Teuchos::tuple<std::string>( "GMRES", "CG", "TFQMR" )
00073         ,"Solver"
00074         )
00075       );
00076   My_List.set(
00077     "Solver"
00078     ,"GMRES" 
00079     ,"The type of solver to use."
00080     ,solverValidator
00081     );
00082 
00083   //By default, there is no validator converter for a StringToIntegralParameterEntryValidator
00084   //templated on type short. So lets add one with the following convience macro found
00085   //in ValidatorXMLConverterDB.hpp
00086   TEUCHOS_ADD_STRINGTOINTEGRALVALIDATOR_CONVERTER(short)
00087 
00088   //Of course if you have a completly custom validator you'll need to do a little more
00089   //You'll have to make you're own converter for it by subclassing the ValidatorXMLConverter
00090   //class and then use the TEUCHOS_ADD_VALIDATOR_CONVERTER convience macro.
00091 
00092   
00093    //Now we'll write it out to xml.
00094   Teuchos::writeParameterListToXmlFile(My_List, "custom_validator_test_list.xml");
00095   //Then read it in to a new list.
00096  
00097   Teuchos::writeParameterListToXmlOStream(My_List, std::cout);
00098   Teuchos::RCP<Teuchos::ParameterList> readIn = Teuchos::getParametersFromXmlFile("custom_validator_test_list.xml");
00099 
00100   std::cout << *readIn;
00101 
00108   return 0;
00109 }
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines