utility::Bound< T > Class Template Reference

Bound value class. More...

#include <Bound.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 T>
class utility::Bound< T >

Bound value class.

Member Typedef Documentation

Value

template<typename T >

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

value_type

template<typename T >

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

Constructor & Destructor Documentation

Bound() [1/2]

template<typename T >

utility::Bound< T >::Bound ( )

inline

Default constructor.

Referenced by utility::Bound< T >::Strict().

Bound() [2/2]

template<typename T >

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

inlineexplicit

~Bound()

template<typename T >

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

inline

Destructor.

Member Function Documentation

activate()

template<typename T >

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

inline

Activate.

References utility::Bound< T >::active_.

active()

template<typename T >

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

inline

Active bound?

References utility::Bound< T >::active_.

clear()

template<typename T >

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

inline

Clear.

References utility::Bound< T >::active_, utility::Bound< T >::strict_, and utility::Bound< T >::value_.

Referenced by pyrosetta.bindings.pose.ResidueLabelAccessor::discard().

deactivate()

template<typename T >

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

inline

Deactivate.

References utility::Bound< T >::active_.

inactive()

template<typename T >

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

inline

Inactive bound?

References utility::Bound< T >::active_.

operator()() [1/2]

template<typename T >

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

inline

Bound value.

References utility::Bound< T >::active_, debug_assert, and utility::Bound< T >::value_.

operator()() [2/2]

template<typename T >

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

inline

Value assignment.

References utility::Bound< T >::active_, utility::Bound< T >::strict_, and utility::Bound< T >::value_.

strict()

template<typename T >

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

inline

Strict inequality (< or >) bound?

References utility::Bound< T >::strict_.

Strict()

template<typename T >

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

inlinestatic

References utility::Bound< T >::Bound().

value() [1/2]

template<typename T >

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

inline

Bound value.

References utility::Bound< T >::active_, debug_assert, and utility::Bound< T >::value_.

value() [2/2]

template<typename T >

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

inline

Value assignment.

References utility::Bound< T >::active_, utility::Bound< T >::strict_, and utility::Bound< T >::value_.

Member Data Documentation

active_

template<typename T >

bool utility::Bound< T >::active_

private

Active bound?

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

strict_

template<typename T >

bool utility::Bound< T >::strict_

private

Strict inequality (< or >) bound?

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

value_

template<typename T >

Value utility::Bound< T >::value_

private

Bound value.

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

---

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

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