Teuchos Package Browser (Single Doxygen Collection) Version of the Day
Loading...
Searching...
No Matches
List of all members
Teuchos::ParameterEntryXMLConverterDB Class Reference

Provides ability to lookup ParameterEntryXMLConverters. More...

#include <Teuchos_ParameterEntryXMLConverterDB.hpp>

Private types.

typedef std::map< std::string, RCP< ParameterEntryXMLConverter > > ConverterMap
 convience typedef
 
typedef std::pair< std::string, RCP< ParameterEntryXMLConverter > > ConverterPair
 convience typedef
 
static ConverterMapgetConverterMap ()
 Gets the map containing all the ParameterEntry converters.
 

Modifier Functions

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

Getter Functions

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

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.
 
static ParameterEntry convertXML (const XMLObject &xmlObj)
 Converts XML to a ParameterEntry.
 

I/O Functions

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

Detailed Description

Provides ability to lookup ParameterEntryXMLConverters.

Definition at line 60 of file Teuchos_ParameterEntryXMLConverterDB.hpp.

Member Typedef Documentation

◆ ConverterMap

convience typedef

Definition at line 148 of file Teuchos_ParameterEntryXMLConverterDB.hpp.

◆ ConverterPair

convience typedef

Definition at line 151 of file Teuchos_ParameterEntryXMLConverterDB.hpp.

Member Function Documentation

◆ addConverter()

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 70 of file Teuchos_ParameterEntryXMLConverterDB.hpp.

◆ getConverter() [1/2]

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 52 of file Teuchos_ParameterEntryXMLConverterDB.cpp.

◆ getConverter() [2/2]

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 65 of file Teuchos_ParameterEntryXMLConverterDB.cpp.

◆ getDefaultConverter()

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

Gets the default converter to be used on Parameter Entries.

Definition at line 102 of file Teuchos_ParameterEntryXMLConverterDB.cpp.

◆ convertEntry()

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 111 of file Teuchos_ParameterEntryXMLConverterDB.hpp.

◆ convertXML()

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

Converts XML to a ParameterEntry.

Definition at line 124 of file Teuchos_ParameterEntryXMLConverterDB.hpp.

◆ printKnownConverters()

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 90 of file Teuchos_ParameterEntryXMLConverterDB.cpp.

◆ getConverterMap()

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

Gets the map containing all the ParameterEntry converters.

Definition at line 112 of file Teuchos_ParameterEntryXMLConverterDB.cpp.


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