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

An xml converter for ParameterConditions. More...

#include <Teuchos_StandardConditionXMLConverters.hpp>

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

Special Converter Functions

virtual RCP< ParameterConditiongetSpecificParameterCondition (const XMLObject &xmlObj, RCP< ParameterEntry > parameterEntry) const =0
 Gets the specific ParameterCondition to be returned by this conveter when converting from XML. More...
 
virtual void addSpecificXMLTraits (RCP< const ParameterCondition > condition, XMLObject &xmlObj) const =0
 Adds specific xml traits to the xmlObj for a particular ParmaterCondtion. More...
 

Overridden from ConditionXMLConverter

virtual RCP< ConditionconvertXML (const XMLObject &xmlObj, const XMLParameterListReader::EntryIDsMap &entryIDsMap) const
 
void convertCondition (const RCP< const Condition > condition, XMLObject &xmlObj, const XMLParameterListWriter::EntryIDsMap &entryIDsMap) const
 

Private Members

static const std::string & getParameterEntryIdAttributeName ()
 gets the ParameterEntryID attribute name. More...
 

Additional Inherited Members

- Public Member Functions inherited from Teuchos::ConditionXMLConverter
RCP< ConditionfromXMLtoCondition (const XMLObject &xmlObj, const XMLParameterListReader::EntryIDsMap &entryIDsMap) const
 Converts a given XMLObject to a Condition. More...
 
XMLObject fromConditiontoXML (const RCP< const Condition > condition, const XMLParameterListWriter::EntryIDsMap &entryIDsMap) const
 Converters a given ParameterEntryValidator to XML. More...
 
- 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 Member Functions inherited from Teuchos::ConditionXMLConverter
static const std::string & getTypeAttributeName ()
 Returns the string to be used for the type attribute. 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 xml converter for ParameterConditions.

Definition at line 170 of file Teuchos_StandardConditionXMLConverters.hpp.

Member Function Documentation

virtual RCP<ParameterCondition> Teuchos::ParameterConditionConverter::getSpecificParameterCondition ( const XMLObject xmlObj,
RCP< ParameterEntry parameterEntry 
) const
pure virtual

Gets the specific ParameterCondition to be returned by this conveter when converting from XML.

Parameters
xmlObjThe xml object from which the ParameterCondition is being derived.
parameterEntryThe ParameterEntry the ParameterCondition evaluates.

Implemented in Teuchos::NumberConditionConverter< T >, Teuchos::BoolConditionConverter, and Teuchos::StringConditionConverter.

virtual void Teuchos::ParameterConditionConverter::addSpecificXMLTraits ( RCP< const ParameterCondition condition,
XMLObject xmlObj 
) const
pure virtual

Adds specific xml traits to the xmlObj for a particular ParmaterCondtion.

Parameters
conditionThe ParameterCondition to be converted.
xmlObjThe XMLObject to which the specific traits should be added.

Implemented in Teuchos::NumberConditionConverter< T >, Teuchos::BoolConditionConverter, and Teuchos::StringConditionConverter.

RCP< Condition > Teuchos::ParameterConditionConverter::convertXML ( const XMLObject xmlObj,
const XMLParameterListReader::EntryIDsMap entryIDsMap 
) const
virtual
void Teuchos::ParameterConditionConverter::convertCondition ( const RCP< const Condition condition,
XMLObject xmlObj,
const XMLParameterListWriter::EntryIDsMap entryIDsMap 
) const
virtual
static const std::string& Teuchos::ParameterConditionConverter::getParameterEntryIdAttributeName ( )
inlinestaticprivate

gets the ParameterEntryID attribute name.

Definition at line 223 of file Teuchos_StandardConditionXMLConverters.hpp.


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