CYCLUS
Public Member Functions | List of all members
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 64 of file capacity_constraint.h.

#include <capacity_constraint.h>

Public Member Functions

double capacity () const
 
 CapacityConstraint (double capacity, typename Converter< T >::Ptr converter)
 
 CapacityConstraint (double capacity)
 
 CapacityConstraint (const CapacityConstraint &other)
 
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

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 67 of file capacity_constraint.h.

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 77 of file capacity_constraint.h.

template<class T>
cyclus::CapacityConstraint< T >::CapacityConstraint ( const CapacityConstraint< T > &  other)
inline

constructor for a constraint with a non-trivial converter

Definition at line 86 of file capacity_constraint.h.

Member Function Documentation

template<class T>
double cyclus::CapacityConstraint< T >::capacity ( ) const
inline
Returns
the constraints capacity

Definition at line 92 of file capacity_constraint.h.

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 101 of file capacity_constraint.h.

template<class T>
Converter<T>::Ptr cyclus::CapacityConstraint< T >::converter ( ) const
inline
Returns
the converter

Definition at line 97 of file capacity_constraint.h.

template<class T>
int cyclus::CapacityConstraint< T >::id ( ) const
inline
Returns
a unique id for the constraint

Definition at line 109 of file capacity_constraint.h.


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