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

Provides ability to lookup ConditionXMLConverters. More...

#include <Teuchos_ConditionXMLConverterDB.hpp>

Modifier Functions

static void addConverter (RCP< const Condition > condition, RCP< ConditionXMLConverter > converterToAdd)
 Add a converter to the database. More...
 

Converter Functions

static RCP< const
ConditionXMLConverter
getConverter (const Condition &condition)
 Get an appropriate ConditionXMLConverter given a Condition. More...
 
static RCP< const
ConditionXMLConverter
getConverter (const XMLObject &xmlObject)
 Get an appropriate ConditionXMLConverter given a XMLObject. More...
 
static XMLObject convertCondition (RCP< const Condition > condition, const XMLParameterListWriter::EntryIDsMap &entryIDsMap)
 Given a condition and ConditiontoIDMap, converts the condition to XML. More...
 
static RCP< ConditionconvertXML (const XMLObject &xmlObject, const XMLParameterListReader::EntryIDsMap &entryIDsMap)
 Given an XMLObject and IDtoConditionMap, converts the XMLObject to a Condition. More...
 

I/O Functions

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

Private Members

typedef std::map< std::string,
RCP< ConditionXMLConverter > > 
ConverterMap
 convience class. More...
 
typedef std::pair< std::string,
RCP< ConditionXMLConverter > > 
ConverterPair
 convience typedef. More...
 
static ConverterMapgetConverterMap ()
 Gets the default converter to be used to convert Conditions. More...
 

Detailed Description

Provides ability to lookup ConditionXMLConverters.

Definition at line 61 of file Teuchos_ConditionXMLConverterDB.hpp.

Member Typedef Documentation

convience class.

Definition at line 159 of file Teuchos_ConditionXMLConverterDB.hpp.

convience typedef.

Definition at line 162 of file Teuchos_ConditionXMLConverterDB.hpp.

Member Function Documentation

void Teuchos::ConditionXMLConverterDB::addConverter ( RCP< const Condition condition,
RCP< ConditionXMLConverter converterToAdd 
)
static

Add a converter to the database.

Parameters
conditionA dummy condition representing the type of contidion this converter will convert.
convertToAddThe converter to add to the database.

Definition at line 51 of file Teuchos_ConditionXMLConverterDB.cpp.

RCP< const ConditionXMLConverter > Teuchos::ConditionXMLConverterDB::getConverter ( const Condition condition)
static

Get an appropriate ConditionXMLConverter given a Condition.

Parameters
conditionThe Condition for which a converter is desired.
Returns
A converter for the condition.

Definition at line 60 of file Teuchos_ConditionXMLConverterDB.cpp.

RCP< const ConditionXMLConverter > Teuchos::ConditionXMLConverterDB::getConverter ( const XMLObject xmlObject)
static

Get an appropriate ConditionXMLConverter given a XMLObject.

Parameters
xmlObjectThe XMLObject for which a converter is desired.
Returns
A converter for the XMLObject.

Definition at line 74 of file Teuchos_ConditionXMLConverterDB.cpp.

XMLObject Teuchos::ConditionXMLConverterDB::convertCondition ( RCP< const Condition condition,
const XMLParameterListWriter::EntryIDsMap entryIDsMap 
)
static

Given a condition and ConditiontoIDMap, converts the condition to XML.

Parameters
Thecondition to convert.
entryIDsMapA map containing ParameterEntrys and their associated IDs.
Returns
XML representation of the condition.

Definition at line 88 of file Teuchos_ConditionXMLConverterDB.cpp.

RCP< Condition > Teuchos::ConditionXMLConverterDB::convertXML ( const XMLObject xmlObject,
const XMLParameterListReader::EntryIDsMap entryIDsMap 
)
static

Given an XMLObject and IDtoConditionMap, converts the XMLObject to a Condition.

Parameters
xmlObjectThe XMLObject to be converted.
entryIDsMapA map containing ParameterEntrys and their associated IDs.
Returns
A Condition that was represented by the XML.

Definition at line 95 of file Teuchos_ConditionXMLConverterDB.cpp.

static void Teuchos::ConditionXMLConverterDB::printKnownConverters ( std::ostream &  out)
inlinestatic

prints the xml tags associated with all known converters

Parameters
outStream to which tags should be printed.

Definition at line 140 of file Teuchos_ConditionXMLConverterDB.hpp.

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

Gets the default converter to be used to convert Conditions.

Definition at line 104 of file Teuchos_ConditionXMLConverterDB.cpp.


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