Teuchos Package Browser (Single Doxygen Collection)  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Static Private Member Functions | List of all members
Teuchos::ParameterEntryXMLConverterDB Class Reference

Provides ability to lookup ParameterEntryXMLConverters. More...

#include <Teuchos_ParameterEntryXMLConverterDB.hpp>

Static Private Member Functions

static ConverterMapgetConverterMap ()
 Gets the map containing all the ParameterEntry converters. More...
 

Modifier Functions

static void addConverter (RCP< ParameterEntryXMLConverter > converterToAdd)
 Add a converter to the database. More...
 

Getter Functions

static RCP< const
ParameterEntryXMLConverter
getConverter (RCP< const ParameterEntry > entry)
 Get an appropriate ParameterEntryXMLConverter given a ParameterEntry. More...
 
static RCP< const
ParameterEntryXMLConverter
getConverter (const XMLObject &xmlObject)
 Get an appropriate ParameterEntryXMLConverter given a XMLObject. More...
 
static RCP< const
ParameterEntryXMLConverter
getDefaultConverter ()
 Gets the default converter to be used on Parameter Entries. More...
 

Converter Functions

static XMLObject convertEntry (RCP< const ParameterEntry > entry, const std::string &name, const ParameterEntry::ParameterEntryID &id, const ValidatortoIDMap &validatorIDsMap)
 Converts the given ParameterEntry to XML. More...
 
static ParameterEntry convertXML (const XMLObject &xmlObj)
 Converts XML to a ParameterEntry. More...
 

I/O Functions

static void printKnownConverters (std::ostream &out)
 prints the xml tags associated with all known converters More...
 

Private types.

typedef std::map< std::string,
RCP
< ParameterEntryXMLConverter > > 
ConverterMap
 convience typedef More...
 
typedef std::pair< std::string,
RCP
< ParameterEntryXMLConverter > > 
ConverterPair
 convience typedef More...
 

Detailed Description

Provides ability to lookup ParameterEntryXMLConverters.

Definition at line 27 of file Teuchos_ParameterEntryXMLConverterDB.hpp.

Member Typedef Documentation

convience typedef

Definition at line 115 of file Teuchos_ParameterEntryXMLConverterDB.hpp.

convience typedef

Definition at line 118 of file Teuchos_ParameterEntryXMLConverterDB.hpp.

Member Function Documentation

static void Teuchos::ParameterEntryXMLConverterDB::addConverter ( RCP< ParameterEntryXMLConverter converterToAdd)
inlinestatic

Add a converter to the database.

Parameters
convertToAddThe converter to add to the database.

Definition at line 37 of file Teuchos_ParameterEntryXMLConverterDB.hpp.

RCP< const ParameterEntryXMLConverter > Teuchos::ParameterEntryXMLConverterDB::getConverter ( RCP< const ParameterEntry entry)
static

Get an appropriate ParameterEntryXMLConverter given a ParameterEntry.

Parameters
entryThe ParameterEntry for which a converter is desired.

Definition at line 20 of file Teuchos_ParameterEntryXMLConverterDB.cpp.

RCP< const ParameterEntryXMLConverter > Teuchos::ParameterEntryXMLConverterDB::getConverter ( const XMLObject xmlObject)
static

Get an appropriate ParameterEntryXMLConverter given a XMLObject.

Parameters
xmlObjectThe XMLObject for which a converter is desired.

Definition at line 33 of file Teuchos_ParameterEntryXMLConverterDB.cpp.

RCP< const ParameterEntryXMLConverter > Teuchos::ParameterEntryXMLConverterDB::getDefaultConverter ( )
static

Gets the default converter to be used on Parameter Entries.

Definition at line 70 of file Teuchos_ParameterEntryXMLConverterDB.cpp.

static XMLObject Teuchos::ParameterEntryXMLConverterDB::convertEntry ( RCP< const ParameterEntry entry,
const std::string &  name,
const ParameterEntry::ParameterEntryID id,
const ValidatortoIDMap validatorIDsMap 
)
inlinestatic

Converts the given ParameterEntry to XML.

Definition at line 78 of file Teuchos_ParameterEntryXMLConverterDB.hpp.

static ParameterEntry Teuchos::ParameterEntryXMLConverterDB::convertXML ( const XMLObject xmlObj)
inlinestatic

Converts XML to a ParameterEntry.

Definition at line 91 of file Teuchos_ParameterEntryXMLConverterDB.hpp.

void Teuchos::ParameterEntryXMLConverterDB::printKnownConverters ( std::ostream &  out)
static

prints the xml tags associated with all known converters

Parameters
outStream to which tags should be printed.

Definition at line 58 of file Teuchos_ParameterEntryXMLConverterDB.cpp.

ParameterEntryXMLConverterDB::ConverterMap & Teuchos::ParameterEntryXMLConverterDB::getConverterMap ( )
staticprivate

Gets the map containing all the ParameterEntry converters.

Definition at line 80 of file Teuchos_ParameterEntryXMLConverterDB.cpp.


The documentation for this class was generated from the following files: