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::FileNameValidatorXMLConverter Class Reference

Converts FileNameValidators to and from XML. More...

#include <Teuchos_StandardValidatorXMLConverters.hpp>

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

Overridden from ValidatorXMLConverter

RCP< ParameterEntryValidatorconvertXML (const XMLObject &xmlObj, const IDtoValidatorMap &validatorIDsMap) const
 
void convertValidator (const RCP< const ParameterEntryValidator > validator, XMLObject &xmlObj, const ValidatortoIDMap &validatorIDsMap) const
 

Private Members

static const std::string & getFileMustExistAttributeName ()
 

Additional Inherited Members

- Public Member Functions inherited from Teuchos::ValidatorXMLConverter
RCP< ParameterEntryValidatorfromXMLtoValidator (const XMLObject &xmlObj, const IDtoValidatorMap &validatorIDsMap) const
 Converts a given XMLObject to a ParameterEntryValidator. More...
 
XMLObject fromValidatortoXML (const RCP< const ParameterEntryValidator > validator, const ValidatortoIDMap &validatorIDsMap, bool assignedID=true) 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::ValidatorXMLConverter
static const std::string & getIdAttributeName ()
 
static const std::string & getPrototypeIdAttributeName ()
 
static const std::string & getTypeAttributeName ()
 
static const std::string & getValidatorTagName ()
 
- 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

Converts FileNameValidators to and from XML.

The valid XML representation of a FileNameValidator is:

<Validator type="FilenameValidator"
fileMustExist="Bool Value"
validatorId="Validator Id"
/>

The "fileMustExist" XML attribute is optional.

Definition at line 493 of file Teuchos_StandardValidatorXMLConverters.hpp.

Member Function Documentation

RCP< ParameterEntryValidator > Teuchos::FileNameValidatorXMLConverter::convertXML ( const XMLObject xmlObj,
const IDtoValidatorMap validatorIDsMap 
) const
virtual
void Teuchos::FileNameValidatorXMLConverter::convertValidator ( const RCP< const ParameterEntryValidator validator,
XMLObject xmlObj,
const ValidatortoIDMap validatorIDsMap 
) const
virtual
static const std::string& Teuchos::FileNameValidatorXMLConverter::getFileMustExistAttributeName ( )
inlinestaticprivate

Definition at line 525 of file Teuchos_StandardValidatorXMLConverters.hpp.


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