Optika GUI Toolik Version of the Day
Public Member Functions | Private Attributes
Optika::FileNameValidator Class Reference

#include <Optika_SpecificParameterEntryValidators.hpp>

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

List of all members.

Public Member Functions

 FileNameValidator (bool mustAlreadyExist=false)
bool fileMustExist () const
bool setFileMustExist (bool shouldFileExist)
Teuchos::RCP< const
Teuchos::Array< std::string > > 
validStringValues () const
void validate (Teuchos::ParameterEntry const &entry, std::string const &paramName, std::string const &sublistName) const
void printDoc (std::string const &docString, std::ostream &out) const

Private Attributes

bool mustAlreadyExist

Detailed Description

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

Definition at line 574 of file Optika_SpecificParameterEntryValidators.hpp.


Constructor & Destructor Documentation

Optika::FileNameValidator::FileNameValidator ( bool  mustAlreadyExist = false)

Constructs a FileNameValidator.

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

Definition at line 32 of file Optika_SpecificParameterEntryValidators.cpp.


Member Function Documentation

bool Optika::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 34 of file Optika_SpecificParameterEntryValidators.cpp.

bool Optika::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 38 of file Optika_SpecificParameterEntryValidators.cpp.

Teuchos::RCP< const Teuchos::Array< std::string > > Optika::FileNameValidator::validStringValues ( ) const [virtual]
void Optika::FileNameValidator::validate ( Teuchos::ParameterEntry const &  entry,
std::string const &  paramName,
std::string const &  sublistName 
) const [virtual]
void Optika::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 608 of file Optika_SpecificParameterEntryValidators.hpp.


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