cyclus::CapacityConstraint< T > Class Template Reference

Detailed Description

template<class T>
class cyclus::CapacityConstraint< T >

A CapacityConstraint provides an ability to determine an agent's constraints on resource allocation given a capacity.

Definition at line 57 of file capacity_constraint.h.

#include <capacity_constraint.h>

Public Member Functions
double	capacity () const
	CapacityConstraint (const CapacityConstraint &other)
	CapacityConstraint (double capacity)
	CapacityConstraint (double capacity, typename Converter< T >::Ptr converter)
double	convert (boost::shared_ptr< T > offer, Arc const *a=NULL, ExchangeTranslationContext< T > const *ctx=NULL) const
Converter< T >::Ptr	converter () const
int	id () const

Constructor & Destructor Documentation

CapacityConstraint() [1/3]

template<class T>

cyclus::CapacityConstraint< T >::CapacityConstraint ( double capacity, typename Converter< T >::Ptr converter )

inline

constructor for a constraint with a non-trivial converter

Definition at line 60 of file capacity_constraint.h.

CapacityConstraint() [2/3]

template<class T>

cyclus::CapacityConstraint< T >::CapacityConstraint ( double capacity )

inlineexplicit

constructor for a constraint with a trivial converter (i.e., one that simply returns 1)

Definition at line 68 of file capacity_constraint.h.

CapacityConstraint() [3/3]

template<class T>

cyclus::CapacityConstraint< T >::CapacityConstraint ( const CapacityConstraint< T > & other )

inline

constructor for a constraint with a non-trivial converter

Definition at line 76 of file capacity_constraint.h.

Member Function Documentation

capacity()

template<class T>

double cyclus::CapacityConstraint< T >::capacity ( ) const

inline

Returns

the constraints capacity

Definition at line 82 of file capacity_constraint.h.

convert()

template<class T>

double cyclus::CapacityConstraint< T >::convert ( boost::shared_ptr< T > offer, Arc const * a = NULL, ExchangeTranslationContext< T > const * ctx = NULL ) const

inline

Definition at line 87 of file capacity_constraint.h.

converter()

template<class T>

Converter< T >::Ptr cyclus::CapacityConstraint< T >::converter ( ) const

inline

Returns

the converter

Definition at line 85 of file capacity_constraint.h.

id()

template<class T>

int cyclus::CapacityConstraint< T >::id ( ) const

inline

Returns

a unique id for the constraint

Definition at line 94 of file capacity_constraint.h.

---

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

• capacity_constraint.h