Public Types | Public Member Functions | List of all members
cyclus::Converter< T > Class Template Referenceabstract

Detailed Description

template<class T>
class cyclus::Converter< T >

a simple interface for converting resource objects to unit capacities

Definition at line 16 of file capacity_constraint.h.

#include <capacity_constraint.h>

Inheritance diagram for cyclus::Converter< T >:
Inheritance graph

Public Types

typedef boost::shared_ptr< Converter< T > > Ptr

Public Member Functions

virtual double convert (boost::shared_ptr< T > offer, Arc const *a=NULL, ExchangeTranslationContext< T > const *ctx=NULL) const =0
bool operator!= (Converter &other) const
virtual bool operator== (Converter &other) const

Member Typedef Documentation

◆ Ptr

template<class T>
typedef boost::shared_ptr< Converter<T> > cyclus::Converter< T >::Ptr

Definition at line 17 of file capacity_constraint.h.

Member Function Documentation

◆ convert()

template<class T>
virtual double cyclus::Converter< T >::convert ( boost::shared_ptr< T >  offer,
Arc const *  a = NULL,
ExchangeTranslationContext< T > const *  ctx = NULL 
) const
pure virtual

convert a capacitated quantity for an offer in its exchange context

offerthe resource being offered
athe associated arc for the potential offer
ctxthe exchange context in which the offer is being made
it is up to the user to inherit default parameters

Implemented in cyclus::TrivialConverter< T >, and cyclus::QtyCoeffConverter< T >.

◆ operator!=()

template<class T>
bool cyclus::Converter< T >::operator!= ( Converter< T > &  other) const

Definition at line 35 of file capacity_constraint.h.

◆ operator==()

template<class T>
virtual bool cyclus::Converter< T >::operator== ( Converter< T > &  other) const

operator== is available for subclassing, see cyclus::TrivialConverter for an example

Reimplemented in cyclus::TrivialConverter< T >, and cyclus::QtyCoeffConverter< T >.

Definition at line 32 of file capacity_constraint.h.

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