Teuchos Package Browser (Single Doxygen Collection)
Version of the Day
|
A class used to convert parameter entries to xml and vice versa. More...
#include <Teuchos_ParameterEntryXMLConverter.hpp>
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... | |
Related Functions inherited from Teuchos::Describable | |
DescribableStreamManipulatorState | describe (const Describable &describable, const EVerbosityLevel verbLevel=Describable::verbLevel_default) |
Describable output stream manipulator. More... | |
std::ostream & | operator<< (std::ostream &os, const DescribableStreamManipulatorState &d) |
Output stream operator for Describable manipulator. More... | |
A class used to convert parameter entries to xml and vice versa.
Definition at line 61 of file Teuchos_ParameterEntryXMLConverter.hpp.
ParameterEntry Teuchos::ParameterEntryXMLConverter::fromXMLtoParameterEntry | ( | const XMLObject & | xmlObj | ) | const |
Converts the given xml into a parameter entry.
xmlObj | The xml to be converted to a parameter entry. |
Definition at line 52 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.
entry | The parameter entry to convert to xml. |
name | The name associated with the parameter entry. |
Definition at line 108 of file Teuchos_ParameterEntryXMLConverter.cpp.
|
pure virtual |
Implemented in Teuchos::StandardTemplatedParameterConverter< T >, and Teuchos::AnyParameterEntryConverter.
|
pure virtual |
Gets a string representing the value that should be assigned to the "type" attribute when converting a parameter entry to xml.
Implemented in Teuchos::StandardTemplatedParameterConverter< T >, and Teuchos::AnyParameterEntryConverter.
|
pure virtual |
Gets the value to be assigned to the "value" attribute when converting the paramter entry to xml.
entry | The entry being converted. |
Implemented in Teuchos::StandardTemplatedParameterConverter< T >, and Teuchos::AnyParameterEntryConverter.
|
inlinestatic |
Definition at line 114 of file Teuchos_ParameterEntryXMLConverter.hpp.
|
inlinestatic |
Definition at line 120 of file Teuchos_ParameterEntryXMLConverter.hpp.
|
inlinestatic |
Definition at line 126 of file Teuchos_ParameterEntryXMLConverter.hpp.
|
inlinestaticprivate |
Definition at line 139 of file Teuchos_ParameterEntryXMLConverter.hpp.
|
inlinestaticprivate |
Definition at line 145 of file Teuchos_ParameterEntryXMLConverter.hpp.
|
inlinestaticprivate |
Definition at line 151 of file Teuchos_ParameterEntryXMLConverter.hpp.