Teuchos - Trilinos Tools Package Version of the Day
Loading...
Searching...
No Matches
List of all members
Teuchos::FileNameValidatorXMLConverter Class Reference

Converts FileNameValidators to and from XML. More...

#include <Teuchos_StandardValidatorXMLConverters.hpp>

Inheritance diagram for Teuchos::FileNameValidatorXMLConverter:
Teuchos::ValidatorXMLConverter Teuchos::Describable Teuchos::LabeledObject

Public Member Functions

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
 
- Public Member Functions inherited from Teuchos::ValidatorXMLConverter
RCP< ParameterEntryValidatorfromXMLtoValidator (const XMLObject &xmlObj, const IDtoValidatorMap &validatorIDsMap) const
 Converts a given XMLObject to a ParameterEntryValidator.
 
XMLObject fromValidatortoXML (const RCP< const ParameterEntryValidator > validator, const ValidatortoIDMap &validatorIDsMap, bool assignedID=true) const
 Converters a given ParameterEntryValidator to XML.
 
- Public Member Functions inherited from Teuchos::Describable
virtual std::string description () const
 Return a simple one-line description of this object.
 
virtual void describe (FancyOStream &out, const EVerbosityLevel verbLevel=verbLevel_default) const
 Print the object with some verbosity level to a FancyOStream.
 
void describe (std::ostream &out, const EVerbosityLevel verbLevel=verbLevel_default) const
 Version of describe() that takes an std::ostream instead of a FancyOStream.
 
virtual ~Describable ()
 Destructor (marked virtual for memory safety of derived classes).
 
- Public Member Functions inherited from Teuchos::LabeledObject
 LabeledObject ()
 Construct with an empty label.
 
virtual ~LabeledObject ()
 
virtual void setObjectLabel (const std::string &objectLabel)
 Set the object label (see LabeledObject).
 
virtual std::string getObjectLabel () const
 Get the object label (see LabeledObject).
 

Additional Inherited Members

- 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().
 

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"
/>
Smart reference counting pointer class for automatic garbage collection.

The "fileMustExist" XML attribute is optional.

Definition at line 526 of file Teuchos_StandardValidatorXMLConverters.hpp.

Member Function Documentation

◆ convertXML()

RCP< ParameterEntryValidator > Teuchos::FileNameValidatorXMLConverter::convertXML ( const XMLObject & xmlObj,
const IDtoValidatorMap & validatorIDsMap ) const
virtual

◆ convertValidator()

void Teuchos::FileNameValidatorXMLConverter::convertValidator ( const RCP< const ParameterEntryValidator > validator,
XMLObject & xmlObj,
const ValidatortoIDMap & validatorIDsMap ) const
virtual

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