Teuchos Package Browser (Single Doxygen Collection) Version of the Day
Teuchos::FileNameValidator Class Reference

Validate a file name entry. More...

#include <Teuchos_StandardParameterEntryValidators.hpp>

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

List of all members.

Public types

static bool mustAlreadyExistDefault ()
 The default value of the mustAlreadyExist parameter in the constructor.

Constructors/Destructor

 FileNameValidator (bool mustAlreadyExist=mustAlreadyExistDefault())
 Constructs a FileNameValidator.

Attribute/Query Functions

bool fileMustExist () const
 Gets the variable describing whether or not this validator wants the file that is specified to already exist.

Setter Functions

bool setFileMustExist (bool shouldFileExist)
 Sets whether or not the validator requires the file to already exist.

Overridden from ParameterEntryValidator

ValidStringsList validStringValues () const
 
void validate (ParameterEntry const &entry, std::string const &paramName, std::string const &sublistName) const
 
const std::string getXMLTypeName () const
 
void printDoc (std::string const &docString, std::ostream &out) const
 

Private Members

bool mustAlreadyExist_
 Whether or not the file specified in the parameter should already exist.

Detailed Description

Validate a file name entry.

Simply indicates that the parameter entry with this validator should contain a filename.

Please see FileNameValidatorXMLConverter for documenation regarding the XML representation of this validator.

Definition at line 1345 of file Teuchos_StandardParameterEntryValidators.hpp.


Constructor & Destructor Documentation

Teuchos::FileNameValidator::FileNameValidator ( bool  mustAlreadyExist = mustAlreadyExistDefault())

Constructs a FileNameValidator.

Parameters:
mustAlreadyExistTrue if the file the user specifies should already exists, false otherwise.

Definition at line 374 of file Teuchos_StandardParameterEntryValidators.cpp.


Member Function Documentation

static bool Teuchos::FileNameValidator::mustAlreadyExistDefault ( ) [inline, static]

The default value of the mustAlreadyExist parameter in the constructor.

Definition at line 1354 of file Teuchos_StandardParameterEntryValidators.hpp.

bool Teuchos::FileNameValidator::fileMustExist ( ) const

Gets the variable describing whether or not this validator wants the file that is specified to already exist.

Returns:
Whether or not the validator requires the file to already exist

Definition at line 379 of file Teuchos_StandardParameterEntryValidators.cpp.

bool Teuchos::FileNameValidator::setFileMustExist ( bool  shouldFileExist)

Sets whether or not the validator requires the file to already exist.

Parameters:
shouldFileExistTrue if the file should already exist, false otherwise.
Returns:
The new value of the shouldFileExist variable.

Definition at line 385 of file Teuchos_StandardParameterEntryValidators.cpp.

ParameterEntryValidator::ValidStringsList Teuchos::FileNameValidator::validStringValues ( ) const [virtual]
void Teuchos::FileNameValidator::validate ( ParameterEntry const &  entry,
std::string const &  paramName,
std::string const &  sublistName 
) const [virtual]
const std::string Teuchos::FileNameValidator::getXMLTypeName ( ) const [virtual]
void Teuchos::FileNameValidator::printDoc ( std::string const &  docString,
std::ostream &  out 
) const [virtual]

Member Data Documentation

Whether or not the file specified in the parameter should already exist.

Definition at line 1425 of file Teuchos_StandardParameterEntryValidators.hpp.


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines