|
Teuchos - Trilinos Tools Package
Version of the Day
|
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
|
Teuchos - Trilinos Tools Package
Version of the Day
|
An abstract base class for converting ParameterEntryValidators to and from XML. More...
#include <Teuchos_ValidatorXMLConverter.hpp>
Public Member Functions | |
Converter Functions | |
| RCP< ParameterEntryValidator > | fromXMLtoValidator (const XMLObject &xmlObj, const IDtoValidatorMap &validatorIDsMap) const |
| Converts a given XMLObject to a ParameterEntryValidator. More... | |
| virtual RCP < ParameterEntryValidator > | convertXML (const XMLObject &xmlObj, const IDtoValidatorMap &validatorIDsMap) const =0 |
| Preforms any and all special xml conversion that is specific to a particular ParameterEntryValidator. More... | |
| XMLObject | fromValidatortoXML (const RCP< const ParameterEntryValidator > validator, const ValidatortoIDMap &validatorIDsMap, bool assignedID=true) const |
| Converters a given ParameterEntryValidator to XML. More... | |
| virtual void | convertValidator (const RCP< const ParameterEntryValidator > validator, XMLObject &xmlObj, const ValidatortoIDMap &validatorIDsMap) const =0 |
| Preforms any and all special validator conversion that is specific to a particlar ParameterEntryValidator. 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 | |
Attribute/Query Functions | |
| static const std::string & | getIdAttributeName () |
| static const std::string & | getPrototypeIdAttributeName () |
| static const std::string & | getTypeAttributeName () |
| static const std::string & | getValidatorTagName () |
Additional Inherited Members | |
| 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... | |
An abstract base class for converting ParameterEntryValidators to and from XML.
Definition at line 32 of file Teuchos_ValidatorXMLConverter.hpp.
| RCP< ParameterEntryValidator > Teuchos::ValidatorXMLConverter::fromXMLtoValidator | ( | const XMLObject & | xmlObj, |
| const IDtoValidatorMap & | validatorIDsMap | ||
| ) | const |
Converts a given XMLObject to a ParameterEntryValidator.
| xmlObj | The XMLObject to convert to a ParameterEntryValidator. |
| validatorIDsMap | A map containing ParameterEntryValidators and their associated IDs. |
Definition at line 15 of file Teuchos_ValidatorXMLConverter.cpp.
|
pure virtual |
Preforms any and all special xml conversion that is specific to a particular ParameterEntryValidator.
| xmlObj | The xml to be converted. |
| validatorIDsMap | A map containing ParameterEntryValidators and their associated IDs. |
Implemented in Teuchos::StringValidatorXMLConverter, Teuchos::FileNameValidatorXMLConverter, Teuchos::EnhancedNumberValidatorXMLConverter< T >, Teuchos::AnyNumberValidatorXMLConverter, Teuchos::BoolValidatorXMLConverter, and Teuchos::StringToIntegralValidatorXMLConverter< IntegralType >.
| XMLObject Teuchos::ValidatorXMLConverter::fromValidatortoXML | ( | const RCP< const ParameterEntryValidator > | validator, |
| const ValidatortoIDMap & | validatorIDsMap, | ||
| bool | assignedID = true |
||
| ) | const |
Converters a given ParameterEntryValidator to XML.
| validator | The ParameterEntryValidator to be converted to XML. |
| validatorIDsMap | A map containing ParameterEntryValidators and their associated IDs. |
| assignedID | Whether or not the validator to be converted has been assigned an ID and is therefore in the validatorIDsMap and should have a ID attribute. |
Definition at line 36 of file Teuchos_ValidatorXMLConverter.cpp.
|
pure virtual |
Preforms any and all special validator conversion that is specific to a particlar ParameterEntryValidator.
| validator | The validator to be converted. |
| xmlObj | The XMLObject to store all serialization in. |
| validatorIDsMap | A map containing ParameterEntryValidators and their associated IDs. being converted. |
Implemented in Teuchos::StringValidatorXMLConverter, Teuchos::FileNameValidatorXMLConverter, Teuchos::EnhancedNumberValidatorXMLConverter< T >, Teuchos::AnyNumberValidatorXMLConverter, Teuchos::BoolValidatorXMLConverter, and Teuchos::StringToIntegralValidatorXMLConverter< IntegralType >.
|
inlinestatic |
Definition at line 115 of file Teuchos_ValidatorXMLConverter.hpp.
|
inlinestatic |
Definition at line 121 of file Teuchos_ValidatorXMLConverter.hpp.
|
inlinestatic |
Definition at line 127 of file Teuchos_ValidatorXMLConverter.hpp.
|
inlinestatic |
Definition at line 133 of file Teuchos_ValidatorXMLConverter.hpp.
1.8.5