Teuchos - Trilinos Tools Package Version of the Day
Teuchos::FileNameValidator Class Reference

Validate a file name entry. More...

#include <Teuchos_StandardParameterEntryValidators.hpp>

Inheritance diagram for Teuchos::FileNameValidator:
Teuchos::ParameterEntryValidator Teuchos::Describable Teuchos::LabeledObject

List of all members.

Public Member Functions

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.
bool fileEmptyNameOK () const
 Gets the variable describing whether or not this validator is OK with file name being empty (even if fileMustExist() returns true).
Setter Functions
bool setFileMustExist (bool shouldFileExist)
 Sets whether or not the validator requires the file to already exist.
bool setFileEmptyNameOK (bool isEmptyNameOK)
 Sets whether or not the validator is OK with empty file name (even if fileMustExist() returns true)
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
 

Static Public Member Functions

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

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 1440 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 1449 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 380 of file Teuchos_StandardParameterEntryValidators.cpp.

bool Teuchos::FileNameValidator::fileEmptyNameOK ( ) const

Gets the variable describing whether or not this validator is OK with file name being empty (even if fileMustExist() returns true).

Note: This property of the validator is not persistent. It is not saved or retrieved. Its purpose is to work around the fact that an input file name, for which user has not given the name by selecting in a GUI, is empty.

Returns:
Whether or not the validator is OK with file name being empty.

Definition at line 385 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 390 of file Teuchos_StandardParameterEntryValidators.cpp.

bool Teuchos::FileNameValidator::setFileEmptyNameOK ( bool  isEmptyNameOK)

Sets whether or not the validator is OK with empty file name (even if fileMustExist() returns true)

Parameters:
isEmptyNameOKTrue if empty name is all right, false otherwise.
Returns:
The new value of the isEmptyNameOK variable.

Definition at line 396 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]

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