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

Provides ability to lookup DependencyXMLConverterDB. More...

#include <Teuchos_DependencyXMLConverterDB.hpp>

List of all members.

Modifier Functions

static void addConverter (RCP< const Dependency > dependency, RCP< DependencyXMLConverter > converterToAdd)
 Add a converter to the database.

Converter Functions

static RCP< const
DependencyXMLConverter
getConverter (const Dependency &dependency)
 Get an appropriate DependencyXMLConverter given a ParameterEntry.
static RCP< const
DependencyXMLConverter
getConverter (const XMLObject &xmlObject)
 Get an appropriate DependencyXMLConverter given a XMLObject.
static XMLObject convertDependency (RCP< const Dependency > dependency, const XMLParameterListWriter::EntryIDsMap &entryIDsMap, ValidatortoIDMap &validatorIDsMap)
 Given a dependency converts the dependency to XML.
static RCP< DependencyconvertXML (const XMLObject &xmlObject, const XMLParameterListReader::EntryIDsMap &entryIDsMap, const IDtoValidatorMap &validatorIDsMap)
 Given an XMLObject converts the XMLObject to a Dependency.

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< DependencyXMLConverter > > 
ConverterMap
 convience class.
typedef std::pair< std::string,
RCP< DependencyXMLConverter > > 
ConverterPair
 convience typedef.
static ConverterMapgetConverterMap ()
 Gets the default converter to be used to convert Dependencies.

Detailed Description

Provides ability to lookup DependencyXMLConverterDB.

Definition at line 64 of file Teuchos_DependencyXMLConverterDB.hpp.


Member Typedef Documentation

convience class.

Definition at line 163 of file Teuchos_DependencyXMLConverterDB.hpp.

convience typedef.

Definition at line 167 of file Teuchos_DependencyXMLConverterDB.hpp.


Member Function Documentation

void Teuchos::DependencyXMLConverterDB::addConverter ( RCP< const Dependency dependency,
RCP< DependencyXMLConverter converterToAdd 
) [static]

Add a converter to the database.

Parameters:
Adummy dependency representing the type of dependency the converter will convert.
convertToAddThe converter to add to the database.

Definition at line 51 of file Teuchos_DependencyXMLConverterDB.cpp.

RCP< const DependencyXMLConverter > Teuchos::DependencyXMLConverterDB::getConverter ( const Dependency dependency) [static]

Get an appropriate DependencyXMLConverter given a ParameterEntry.

Parameters:
dependencyThe ParameterEntryDependency for which a converter is desired.

Definition at line 61 of file Teuchos_DependencyXMLConverterDB.cpp.

RCP< const DependencyXMLConverter > Teuchos::DependencyXMLConverterDB::getConverter ( const XMLObject xmlObject) [static]

Get an appropriate DependencyXMLConverter given a XMLObject.

Parameters:
xmlObjectThe XMLObject for which a converter is desired.

Definition at line 77 of file Teuchos_DependencyXMLConverterDB.cpp.

XMLObject Teuchos::DependencyXMLConverterDB::convertDependency ( RCP< const Dependency dependency,
const XMLParameterListWriter::EntryIDsMap entryIDsMap,
ValidatortoIDMap validatorIDsMap 
) [static]

Given a dependency converts the dependency to XML.

Parameters:
dependencyDependency to Convert.
entryIDsMapA map containing ParameterEntrys and their associated IDs.
validatorIDsMapA map containing ParameterEntryValidators and their associated IDs.
Returns:
XML representation of the dependency.

Definition at line 103 of file Teuchos_DependencyXMLConverterDB.cpp.

RCP< Dependency > Teuchos::DependencyXMLConverterDB::convertXML ( const XMLObject xmlObject,
const XMLParameterListReader::EntryIDsMap entryIDsMap,
const IDtoValidatorMap validatorIDsMap 
) [static]

Given an XMLObject converts the XMLObject to a Dependency.

Parameters:
xmlObjectThe XMLObject to convert into a depdendency.
entryIDsMapA map containing ParameterEntrys and their associated IDs.
validatorIDsMapA map containing ParameterEntryValidators and their associated IDs.
Returns:
A Dependency that was represented by the XML.

Definition at line 112 of file Teuchos_DependencyXMLConverterDB.cpp.

static void Teuchos::DependencyXMLConverterDB::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 144 of file Teuchos_DependencyXMLConverterDB.hpp.

DependencyXMLConverterDB::ConverterMap & Teuchos::DependencyXMLConverterDB::getConverterMap ( ) [static, private]

Gets the default converter to be used to convert Dependencies.

Definition at line 122 of file Teuchos_DependencyXMLConverterDB.cpp.


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines