sbia::basis::ExistingFileConstraint Class Reference

Constrain argument values to paths of existing files. More...

#include <CmdArgs.h>

Inheritance diagram for sbia::basis::ExistingFileConstraint:

Collaboration diagram for sbia::basis::ExistingFileConstraint:

List of all members.

Public Member Functions
virtual bool	check (const std::string &value) const
virtual std::string	description () const
	ExistingFileConstraint (const std::string &typeDesc="<file>")
virtual std::string	shortID () const
Protected Attributes
std::string	_typeDesc

---

Detailed Description

Constrain argument values to paths of existing files.

Definition at line 239 of file CmdArgs.h.

---

Member Function Documentation

virtual bool sbia::basis::ExistingFileConstraint::check

(

const std::string &

value

)

const [inline, virtual]

The method used to verify that the value parsed from the command line meets the constraint.

Parameters:

value

- The value that will be checked.

Implements TCLAP::Constraint< std::string >.

Definition at line 246 of file CmdArgs.h.

virtual std::string sbia::basis::ExistingFileConstraint::description

(

)

const [inline, virtual]

Returns a description of the Constraint.

Implements TCLAP::Constraint< std::string >.

Definition at line 244 of file CmdArgs.h.

virtual std::string sbia::basis::ExistingFileConstraint::shortID

(

)

const [inline, virtual]

Returns the short ID for the Constraint.

Implements TCLAP::Constraint< std::string >.

Definition at line 245 of file CmdArgs.h.

---

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

• CmdArgs.h