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

A class used to convert parameter entries to xml and vice versa. More...

#include <Teuchos_ParameterEntryXMLConverter.hpp>

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

Converter Functions

ParameterEntry fromXMLtoParameterEntry (const XMLObject &xmlObj) const
 Converts the given xml into a parameter entry. More...
 
XMLObject fromParameterEntrytoXML (RCP< const ParameterEntry > entry, const std::string &name, const ParameterEntry::ParameterEntryID &id, const ValidatortoIDMap &validatorIDsMap) const
 Converts the given parameter entry to xml. More...
 
virtual any getAny (const XMLObject &xmlObj) const =0
 

Attribute/Query Methods

virtual const std::string getTypeAttributeValue () const =0
 Gets a string representing the value that should be assigned to the "type" attribute when converting a parameter entry to xml. More...
 
virtual const std::string getValueAttributeValue (RCP< const ParameterEntry > entry) const =0
 Gets the value to be assigned to the "value" attribute when converting the paramter entry to xml. More...
 
static const std::string & getTypeAttributeName ()
 
static const std::string & getIdAttributeName ()
 
static const std::string & getValueAttributeName ()
 

Private Members

static const std::string & getDefaultAttributeName ()
 
static const std::string & getUsedAttributeName ()
 
static const std::string & getDocStringAttributeName ()
 

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

A class used to convert parameter entries to xml and vice versa.

Definition at line 29 of file Teuchos_ParameterEntryXMLConverter.hpp.

Member Function Documentation

ParameterEntry Teuchos::ParameterEntryXMLConverter::fromXMLtoParameterEntry ( const XMLObject xmlObj) const

Converts the given xml into a parameter entry.

Parameters
xmlObjThe xml to be converted to a parameter entry.
Returns
A ParameterEntry with the aspects specified by the xml.

Definition at line 20 of file Teuchos_ParameterEntryXMLConverter.cpp.

XMLObject Teuchos::ParameterEntryXMLConverter::fromParameterEntrytoXML ( RCP< const ParameterEntry entry,
const std::string &  name,
const ParameterEntry::ParameterEntryID id,
const ValidatortoIDMap validatorIDsMap 
) const

Converts the given parameter entry to xml.

Parameters
entryThe parameter entry to convert to xml.
nameThe name associated with the parameter entry.
Returns
An XMLObject representing the parameter entry.

Definition at line 76 of file Teuchos_ParameterEntryXMLConverter.cpp.

virtual any Teuchos::ParameterEntryXMLConverter::getAny ( const XMLObject xmlObj) const
pure virtual
virtual const std::string Teuchos::ParameterEntryXMLConverter::getTypeAttributeValue ( ) const
pure virtual

Gets a string representing the value that should be assigned to the "type" attribute when converting a parameter entry to xml.

Returns
The value to be assigned to the "type" attribute when converting a parameter entry to xml.

Implemented in Teuchos::StandardTemplatedParameterConverter< T >, and Teuchos::AnyParameterEntryConverter.

virtual const std::string Teuchos::ParameterEntryXMLConverter::getValueAttributeValue ( RCP< const ParameterEntry entry) const
pure virtual

Gets the value to be assigned to the "value" attribute when converting the paramter entry to xml.

Parameters
entryThe entry being converted.
Returns
The value to be assigned to the "value" attribute when converting the parameter entry to xml.

Implemented in Teuchos::StandardTemplatedParameterConverter< T >, and Teuchos::AnyParameterEntryConverter.

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

Definition at line 82 of file Teuchos_ParameterEntryXMLConverter.hpp.

static const std::string& Teuchos::ParameterEntryXMLConverter::getIdAttributeName ( )
inlinestatic

Definition at line 88 of file Teuchos_ParameterEntryXMLConverter.hpp.

static const std::string& Teuchos::ParameterEntryXMLConverter::getValueAttributeName ( )
inlinestatic

Definition at line 94 of file Teuchos_ParameterEntryXMLConverter.hpp.

static const std::string& Teuchos::ParameterEntryXMLConverter::getDefaultAttributeName ( )
inlinestaticprivate

Definition at line 107 of file Teuchos_ParameterEntryXMLConverter.hpp.

static const std::string& Teuchos::ParameterEntryXMLConverter::getUsedAttributeName ( )
inlinestaticprivate

Definition at line 113 of file Teuchos_ParameterEntryXMLConverter.hpp.

static const std::string& Teuchos::ParameterEntryXMLConverter::getDocStringAttributeName ( )
inlinestaticprivate

Definition at line 119 of file Teuchos_ParameterEntryXMLConverter.hpp.


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