Teuchos Package Browser (Single Doxygen Collection) Version of the Day
Teuchos::ConditionXMLConverterDB Class Reference

Provides ability to lookup ConditionXMLConverters. More...

#include <Teuchos_ConditionXMLConverterDB.hpp>

List of all members.

Modifier Functions

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

Converter Functions

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

I/O Functions

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

Private Members

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

Detailed Description

Provides ability to lookup ConditionXMLConverters.

Definition at line 61 of file Teuchos_ConditionXMLConverterDB.hpp.


Member Typedef Documentation

typedef std::map<std::string, RCP<ConditionXMLConverter> > Teuchos::ConditionXMLConverterDB::ConverterMap [private]

convience class.

Definition at line 159 of file Teuchos_ConditionXMLConverterDB.hpp.

typedef std::pair<std::string, RCP<ConditionXMLConverter> > Teuchos::ConditionXMLConverterDB::ConverterPair [private]

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) [inline, static]

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 ( ) [static, private]

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:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines