sbia::basis::PositiveValueConstraint< T > Class Template Reference

Constrain argument values to positive values. More...

#include <CmdArgs.h>

Inheritance diagram for sbia::basis::PositiveValueConstraint< T >:

Collaboration diagram for sbia::basis::PositiveValueConstraint< T >:

List of all members.

Public Member Functions
virtual bool	check (const T &value) const
virtual std::string	description () const
	PositiveValueConstraint (const std::string &typeDesc)
virtual std::string	shortID () const
Protected Attributes
std::string	_typeDesc

---

Detailed Description

template<typename T>
class sbia::basis::PositiveValueConstraint< T >

Constrain argument values to positive values.

Definition at line 204 of file CmdArgs.h.

---

Member Function Documentation

template<typename T >

virtual bool sbia::basis::PositiveValueConstraint< T >::check

(

const T &

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< T >.

Definition at line 211 of file CmdArgs.h.

template<typename T >

virtual std::string sbia::basis::PositiveValueConstraint< T >::description

(

)

const [inline, virtual]

Returns a description of the Constraint.

Implements TCLAP::Constraint< T >.

Definition at line 209 of file CmdArgs.h.

template<typename T >

virtual std::string sbia::basis::PositiveValueConstraint< T >::shortID

(

)

const [inline, virtual]

Returns the short ID for the Constraint.

Implements TCLAP::Constraint< T >.

Definition at line 210 of file CmdArgs.h.

---

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

• CmdArgs.h