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

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

#include <Teuchos_ConditionXMLConverter.hpp>

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

List of all members.

Converter Functions

RCP< ConditionfromXMLtoCondition (const XMLObject &xmlObj, const XMLParameterListReader::EntryIDsMap &entryIDsMap) const
 Converts a given XMLObject to a Condition.
virtual RCP< ConditionconvertXML (const XMLObject &xmlObj, const XMLParameterListReader::EntryIDsMap &entryIDsMap) const =0
 Preforms any and all special xml conversion that is specific to a particular Condition.
XMLObject fromConditiontoXML (const RCP< const Condition > condition, const XMLParameterListWriter::EntryIDsMap &entryIDsMap) const
 Converters a given ParameterEntryValidator to XML.
virtual void convertCondition (const RCP< const Condition > condition, XMLObject &xmlObj, const XMLParameterListWriter::EntryIDsMap &entryIDsMap) const =0
 Preforms any and all special condition conversion that is specific to a particlar Condition.

Attribute/Query Functions

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_ConditionXMLConverter.hpp.


Member Function Documentation

RCP< Condition > Teuchos::ConditionXMLConverter::fromXMLtoCondition ( const XMLObject xmlObj,
const XMLParameterListReader::EntryIDsMap entryIDsMap 
) const

Converts a given XMLObject to a Condition.

Parameters:
xmlObjThe XMLObject to convert to a Condition.
entryIDsMapA map containing ParameterEntrys and their assocaited
Returns:
The converted Condition.

Definition at line 49 of file Teuchos_ConditionXMLConverter.cpp.

virtual RCP<Condition> Teuchos::ConditionXMLConverter::convertXML ( const XMLObject xmlObj,
const XMLParameterListReader::EntryIDsMap entryIDsMap 
) const [pure virtual]

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

Parameters:
xmlObjThe xml to be converted. in which this resulting condition will be inserted.
entryIDsMapA map containing ParameterEntrys and their assocaited
Returns:
The converted Condition.

Implemented in Teuchos::BoolLogicConditionConverter, Teuchos::NotConditionConverter, and Teuchos::ParameterConditionConverter.

XMLObject Teuchos::ConditionXMLConverter::fromConditiontoXML ( const RCP< const Condition condition,
const XMLParameterListWriter::EntryIDsMap entryIDsMap 
) const

Converters a given ParameterEntryValidator to XML.

Parameters:
conditionThe Condition to be converted to XML.
entryIDsMapA map containing ParameterEntrys and their assocaited
Returns:
An XML representation of the given Condition.

Definition at line 56 of file Teuchos_ConditionXMLConverter.cpp.

virtual void Teuchos::ConditionXMLConverter::convertCondition ( const RCP< const Condition condition,
XMLObject xmlObj,
const XMLParameterListWriter::EntryIDsMap entryIDsMap 
) const [pure virtual]

Preforms any and all special condition conversion that is specific to a particlar Condition.

Parameters:
conditionThe Condition to be converted.
xmlObjThe xml representation of the condition on to which all children should be attached and attributes added.
entryIDsMapA map containing ParameterEntrys and their assocaited
Returns:
An XML representation of the given Condition.

Implemented in Teuchos::BoolLogicConditionConverter, Teuchos::NotConditionConverter, and Teuchos::ParameterConditionConverter.

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

Returns the string to be used for the type attribute.

Definition at line 127 of file Teuchos_ConditionXMLConverter.hpp.


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