utility::Bound< typename > Class Template Reference

Bound value class. More...

#include <Bound.fwd.hh>

Public Types
typedef T	Value
typedef T	value_type

Public Member Functions
	Bound ()
	Default constructor. More...
	Bound (Value const &value_a, bool const strict_a=false)
	~Bound ()
	Destructor. More...
Bound &	value (Value const &value_a, bool const strict_a=false)
	Value assignment. More...
Bound &	operator() (Value const &value_a, bool const strict_a=false)
	Value assignment. More...
Bound &	activate ()
	Activate. More...
Bound &	deactivate ()
	Deactivate. More...
Bound &	clear ()
	Clear. More...
bool	active () const
	Active bound? More...
bool	inactive () const
	Inactive bound? More...
Value const &	operator() () const
	Bound value. More...
Value const &	value () const
	Bound value. More...
bool	strict () const
	Strict inequality (< or >) bound? More...

Static Public Member Functions
static Bound	Strict (Value const &value_a)

Private Attributes
bool	active_
	Active bound? More...
Value	value_
	Bound value. More...
bool	strict_
	Strict inequality (< or >) bound? More...

Detailed Description

template<typename>
class utility::Bound< typename >

Bound value class.

Definition at line 23 of file Bound.fwd.hh.

Member Typedef Documentation

template<typename >

typedef T utility::Bound< typename >::Value

Definition at line 39 of file Bound.hh.

template<typename >

typedef T utility::Bound< typename >::value_type

Definition at line 42 of file Bound.hh.

Constructor & Destructor Documentation

template<typename >

utility::Bound< typename >::Bound ( )

inline

Default constructor.

Definition at line 50 of file Bound.hh.

Referenced by utility::Bound< file::FileName >::Strict().

template<typename >

utility::Bound< typename >::Bound ( Value const &  value_a, bool const  strict_a = false  )

inlineexplicit

Definition at line 60 of file Bound.hh.

template<typename >

utility::Bound< typename >::~Bound ( )

inline

Destructor.

Definition at line 82 of file Bound.hh.

Member Function Documentation

template<typename >

Bound& utility::Bound< typename >::activate ( )

inline

Activate.

Definition at line 122 of file Bound.hh.

template<typename >

bool utility::Bound< typename >::active ( ) const

inline

Active bound?

Definition at line 157 of file Bound.hh.

Referenced by utility::options::ScalarOption_T_< PathOptionKey, file::PathName >::legal_limits_report(), utility::options::VectorOption_T_< BooleanVectorOptionKey, bool >::legal_limits_report(), utility::options::ScalarOption_T_< PathOptionKey, file::PathName >::legal_string(), and utility::options::VectorOption_T_< BooleanVectorOptionKey, bool >::legal_string().

template<typename >

Bound& utility::Bound< typename >::clear ( )

inline

Clear.

Definition at line 142 of file Bound.hh.

template<typename >

Bound& utility::Bound< typename >::deactivate ( )

inline

Deactivate.

Definition at line 132 of file Bound.hh.

template<typename >

bool utility::Bound< typename >::inactive ( ) const

inline

Inactive bound?

Definition at line 166 of file Bound.hh.

Referenced by utility::options::ScalarOption_T_< PathOptionKey, file::PathName >::legal_string(), and utility::options::VectorOption_T_< BooleanVectorOptionKey, bool >::legal_string().

template<typename >

Bound& utility::Bound< typename >::operator() ( Value const &  value_a, bool const  strict_a = false  )

inline

Value assignment.

Definition at line 107 of file Bound.hh.

template<typename >

Value const& utility::Bound< typename >::operator() ( ) const

inline

Bound value.

Definition at line 175 of file Bound.hh.

template<typename >

static Bound utility::Bound< typename >::Strict ( Value const &  value_a )

inlinestatic

Definition at line 74 of file Bound.hh.

template<typename >

bool utility::Bound< typename >::strict ( ) const

inline

Strict inequality (< or >) bound?

Definition at line 195 of file Bound.hh.

Referenced by utility::options::ScalarOption_T_< PathOptionKey, file::PathName >::legal_limits_report(), utility::options::VectorOption_T_< BooleanVectorOptionKey, bool >::legal_limits_report(), utility::options::ScalarOption_T_< PathOptionKey, file::PathName >::legal_string(), and utility::options::VectorOption_T_< BooleanVectorOptionKey, bool >::legal_string().

template<typename >

Bound& utility::Bound< typename >::value ( Value const &  value_a, bool const  strict_a = false  )

inline

Value assignment.

Definition at line 92 of file Bound.hh.

template<typename >

Value const& utility::Bound< typename >::value ( ) const

inline

Bound value.

Definition at line 185 of file Bound.hh.

Member Data Documentation

template<typename >

bool utility::Bound< typename >::active_

private

Active bound?

Definition at line 205 of file Bound.hh.

Referenced by utility::Bound< file::FileName >::activate(), utility::Bound< file::FileName >::active(), utility::Bound< file::FileName >::clear(), utility::Bound< file::FileName >::deactivate(), utility::Bound< file::FileName >::inactive(), utility::Bound< file::FileName >::operator()(), and utility::Bound< file::FileName >::value().

template<typename >

bool utility::Bound< typename >::strict_

private

Strict inequality (< or >) bound?

Definition at line 211 of file Bound.hh.

Referenced by utility::Bound< file::FileName >::clear(), utility::Bound< file::FileName >::operator()(), utility::Bound< file::FileName >::strict(), and utility::Bound< file::FileName >::value().

template<typename >

Value utility::Bound< typename >::value_

private

Bound value.

Definition at line 208 of file Bound.hh.

Referenced by utility::Bound< file::FileName >::clear(), utility::Bound< file::FileName >::operator()(), and utility::Bound< file::FileName >::value().

---

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

• src/utility/Bound.fwd.hh
• src/utility/Bound.hh