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::DependencyXMLConverter Class Referenceabstract

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

#include <Teuchos_DependencyXMLConverter.hpp>

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

Converter Functions

RCP< DependencyfromXMLtoDependency (const XMLObject &xmlObj, const XMLParameterListReader::EntryIDsMap &entryIDsMap, const IDtoValidatorMap &validatorIDsMap) const
 Converts a given XMLObject to a Dependency. More...
 
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. More...
 
XMLObject fromDependencytoXML (const RCP< const Dependency > dependency, const XMLParameterListWriter::EntryIDsMap &entryIDsMap, ValidatortoIDMap &validatorIDsMap) const
 Converters a given ParameterEntryValidator to XML. More...
 
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. More...
 

Attribute/Query Functions

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

Additional Inherited Members

- Public Member Functions inherited from Teuchos::Describable
virtual std::string description () const
 Return a simple one-line description of this object. More...
 
virtual void describe (FancyOStream &out, const EVerbosityLevel verbLevel=verbLevel_default) const
 Print the object with some verbosity level to a FancyOStream. More...
 
void describe (std::ostream &out, const EVerbosityLevel verbLevel=verbLevel_default) const
 Version of describe() that takes an std::ostream instead of a FancyOStream. More...
 
virtual ~Describable ()
 Destructor (marked virtual for memory safety of derived classes). More...
 
- Public Member Functions inherited from Teuchos::LabeledObject
 LabeledObject ()
 Construct with an empty label. More...
 
virtual ~LabeledObject ()
 
virtual void setObjectLabel (const std::string &objectLabel)
 Set the object label (see LabeledObject). More...
 
virtual std::string getObjectLabel () const
 Get the object label (see LabeledObject). More...
 
- Static Public Attributes inherited from Teuchos::Describable
static const EVerbosityLevel verbLevel_default = VERB_DEFAULT
 Default value for the verbLevel argument of describe(). More...
 

Detailed Description

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

Definition at line 31 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 18 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::ArrayModifierDependencyXMLConverter< DependeeType, DependentType >, Teuchos::ValidatorDependencyXMLConverter, and Teuchos::VisualDependencyXMLConverter.

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 67 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::ArrayModifierDependencyXMLConverter< DependeeType, DependentType >, Teuchos::ValidatorDependencyXMLConverter, and Teuchos::VisualDependencyXMLConverter.

static const std::string& Teuchos::DependencyXMLConverter::getDependeeTagName ( )
inlinestatic

Returns the string to be used for the dependee tag.

Definition at line 112 of file Teuchos_DependencyXMLConverter.hpp.

static const std::string& Teuchos::DependencyXMLConverter::getDependentTagName ( )
inlinestatic

Returns the string to be used for the dependent tag.

Definition at line 120 of file Teuchos_DependencyXMLConverter.hpp.

static const std::string& Teuchos::DependencyXMLConverter::getParameterIdAttributeName ( )
inlinestatic

Returns the string to be used for the ParameterID attribute.

Definition at line 128 of file Teuchos_DependencyXMLConverter.hpp.

static const std::string& Teuchos::DependencyXMLConverter::getTypeAttributeName ( )
inlinestatic

Returns the string to be used for the type attribute.

Definition at line 136 of file Teuchos_DependencyXMLConverter.hpp.


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