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

An abstract base class for converting Dependencies to and from XML. More...

#include <Teuchos_DependencyXMLConverter.hpp>

Inheritance diagram for Teuchos::DependencyXMLConverter:
Inheritance graph
[legend]

List of all members.

Converter Functions

RCP< DependencyfromXMLtoDependency (const XMLObject &xmlObj, const XMLParameterListReader::EntryIDsMap &entryIDsMap, const IDtoValidatorMap &validatorIDsMap) const
 Converts a given XMLObject to a Dependency.
virtual RCP< DependencyconvertXML (const XMLObject &xmlObj, const Dependency::ConstParameterEntryList dependees, const Dependency::ParameterEntryList dependets, const XMLParameterListReader::EntryIDsMap &entryIDsMap, const IDtoValidatorMap &validatorIDsMap) const =0
 Preforms any and all special xml conversion that is specific to a particular Dependency.
XMLObject fromDependencytoXML (const RCP< const Dependency > dependency, const XMLParameterListWriter::EntryIDsMap &entryIDsMap, ValidatortoIDMap &validatorIDsMap) const
 Converters a given ParameterEntryValidator to XML.
virtual void convertDependency (const RCP< const Dependency > dependency, XMLObject &xmlObj, const XMLParameterListWriter::EntryIDsMap &entryIDsMap, ValidatortoIDMap &validatorIDsMap) const =0
 Preforms any and all special dependency conversion that is specific to a particlar Dependency.

Attribute/Query Functions

static const std::string & getDependeeTagName ()
 Returns the string to be used for the dependee tag.
static const std::string & getDependentTagName ()
 Returns the string to be used for the dependent tag.
static const std::string & getParameterIdAttributeName ()
 Returns the string to be used for the ParameterID attribute.
static const std::string & getTypeAttributeName ()
 Returns the string to be used for the type attribute.

Detailed Description

An abstract base class for converting Dependencies to and from XML.

Definition at line 63 of file Teuchos_DependencyXMLConverter.hpp.


Member Function Documentation

RCP< Dependency > Teuchos::DependencyXMLConverter::fromXMLtoDependency ( const XMLObject xmlObj,
const XMLParameterListReader::EntryIDsMap entryIDsMap,
const IDtoValidatorMap validatorIDsMap 
) const

Converts a given XMLObject to a Dependency.

Parameters:
xmlObjThe XMLObject to convert to a Dependency.
entryIDsMapA map containing ParameterEntrys and their associated IDs.
validtorIDsMapA map containing ParameterEntryValidators and their associated IDs.
Returns:
The converted Dependency.

Definition at line 50 of file Teuchos_DependencyXMLConverter.cpp.

virtual RCP<Dependency> Teuchos::DependencyXMLConverter::convertXML ( const XMLObject xmlObj,
const Dependency::ConstParameterEntryList  dependees,
const Dependency::ParameterEntryList  dependets,
const XMLParameterListReader::EntryIDsMap entryIDsMap,
const IDtoValidatorMap validatorIDsMap 
) const [pure virtual]

Preforms any and all special xml conversion that is specific to a particular Dependency.

Parameters:
xmlObjThe xml to be converted. in which this resulting dependency will be inserted.
dependeesThe dependees of the dependency.
dependentsThe dependents of the dependency.
entryIDsMapA map containing ParameterEntrys and their associated IDs.
validtorIDsMapA map containing ParameterEntryValidators and their associated IDs.
Returns:
The converted Dependency.

Implemented in Teuchos::VisualDependencyXMLConverter, Teuchos::ValidatorDependencyXMLConverter, and Teuchos::ArrayModifierDependencyXMLConverter< DependeeType, DependentType >.

XMLObject Teuchos::DependencyXMLConverter::fromDependencytoXML ( const RCP< const Dependency dependency,
const XMLParameterListWriter::EntryIDsMap entryIDsMap,
ValidatortoIDMap validatorIDsMap 
) const

Converters a given ParameterEntryValidator to XML.

Parameters:
dependencyThe Dependency to be converted to XML.
entryIDsMapA map containing ParameterEntrys and their associated IDs.
validtorIDsMapA map containing ParameterEntryValidators and their associated IDs.
Returns:
An XML representation of the given Dependency.

Definition at line 99 of file Teuchos_DependencyXMLConverter.cpp.

virtual void Teuchos::DependencyXMLConverter::convertDependency ( const RCP< const Dependency dependency,
XMLObject xmlObj,
const XMLParameterListWriter::EntryIDsMap entryIDsMap,
ValidatortoIDMap validatorIDsMap 
) const [pure virtual]

Preforms any and all special dependency conversion that is specific to a particlar Dependency.

Parameters:
dependencyThe validator to be converted.
xmlObjThe XMLObject on which all child tags should be appended and attributes added.
entryIDsMapA map containing ParameterEntrys and their associated IDs.
validtorIDsMapA map containing ParameterEntryValidators and their associated IDs.
Returns:
An XML representation of the given Dependency.

Implemented in Teuchos::VisualDependencyXMLConverter, Teuchos::ValidatorDependencyXMLConverter, and Teuchos::ArrayModifierDependencyXMLConverter< DependeeType, DependentType >.

static const std::string& Teuchos::DependencyXMLConverter::getDependeeTagName ( ) [inline, static]

Returns the string to be used for the dependee tag.

Definition at line 144 of file Teuchos_DependencyXMLConverter.hpp.

static const std::string& Teuchos::DependencyXMLConverter::getDependentTagName ( ) [inline, static]

Returns the string to be used for the dependent tag.

Definition at line 152 of file Teuchos_DependencyXMLConverter.hpp.

static const std::string& Teuchos::DependencyXMLConverter::getParameterIdAttributeName ( ) [inline, static]

Returns the string to be used for the ParameterID attribute.

Definition at line 160 of file Teuchos_DependencyXMLConverter.hpp.

static const std::string& Teuchos::DependencyXMLConverter::getTypeAttributeName ( ) [inline, static]

Returns the string to be used for the type attribute.

Definition at line 168 of file Teuchos_DependencyXMLConverter.hpp.


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