CYCLUS
Public Member Functions | Public Attributes | List of all members
cyclus::QtyCoeffConverter< T > Struct Template Reference

Detailed Description

template<class T>
struct cyclus::QtyCoeffConverter< T >

provide coefficients for default mass constraints

Coefficients are determiend by the request portfolio and are provided to the converter. The arc and exchange context are used in order to reference the original request so that the request's coefficient can be applied.

Definition at line 32 of file request_portfolio.h.

#include <request_portfolio.h>

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

Public Member Functions

virtual double convert (boost::shared_ptr< T > offer, Arc const *a, ExchangeTranslationContext< T > const *ctx) const
 
virtual bool operator== (Converter< T > &other) const
 
 QtyCoeffConverter (const std::map< Request< T > *, double > &coeffs)
 
- Public Member Functions inherited from cyclus::Converter< T >
bool operator!= (Converter &other) const
 

Public Attributes

std::map< Request< T > *, double > coeffs
 

Additional Inherited Members

- Public Types inherited from cyclus::Converter< T >
typedef boost::shared_ptr< Converter< T > > Ptr
 

Constructor & Destructor Documentation

template<class T>
cyclus::QtyCoeffConverter< T >::QtyCoeffConverter ( const std::map< Request< T > *, double > &  coeffs)
inline

Definition at line 33 of file request_portfolio.h.

Member Function Documentation

template<class T>
virtual double cyclus::QtyCoeffConverter< T >::convert ( boost::shared_ptr< T >  offer,
Arc const *  a,
ExchangeTranslationContext< T > const *  ctx 
) const
inlinevirtual

convert a capacitated quantity for an offer in its exchange context

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

Implements cyclus::Converter< T >.

Definition at line 36 of file request_portfolio.h.

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

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

Reimplemented from cyclus::Converter< T >.

Definition at line 43 of file request_portfolio.h.

Member Data Documentation

template<class T>
std::map<Request<T>*, double> cyclus::QtyCoeffConverter< T >::coeffs

Definition at line 48 of file request_portfolio.h.


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