Optika::FileNameValidator Class Reference

#include <Optika_SpecificParameterEntryValidators.hpp>

Inheritance diagram for Optika::FileNameValidator:

Collaboration diagram for Optika::FileNameValidator:

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

---

Detailed Description

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

---

Constructor & Destructor Documentation

Optika::FileNameValidator::FileNameValidator

(

bool

mustAlreadyExist = false

)

Constructs a FileNameValidator.

Parameters:

mustAlreadyExist

True if the file the user specifies should already exists, false otherwise.

---

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

bool Optika::FileNameValidator::setFileMustExist

(

bool

shouldFileExist

)

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

Parameters:

shouldFileExist

True if the file should already exist, false otherwise.

Returns:

The new value of the shouldFileExist variable.

---

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

• Optika_SpecificParameterEntryValidators.hpp
• Optika_SpecificParameterEntryValidators.cpp