CYCLUS
Public Member Functions | List of all members
cyclus::toolkit::CommodityProducer Class Reference

Detailed Description

A mixin to provide information about produced commodities.

Definition at line 23 of file commodity_producer.h.

#include <commodity_producer.h>

Inheritance diagram for cyclus::toolkit::CommodityProducer:
cyclus::toolkit::AgentManaged

Public Member Functions

void Add (const Commodity &commodity)
 
void Add (const Commodity &commodity, const CommodInfo &info)
 
double Capacity (const Commodity &commodity)
 
 CommodityProducer (double default_capacity=0, double default_cost=kModifierLimit, Agent *agent=NULL)
 
void Copy (CommodityProducer *source)
 
double Cost (const Commodity &commodity)
 
std::set< Commodity, CommodityCompareProducedCommodities ()
 
bool Produces (const Commodity &commodity) const
 
void Rm (const Commodity &commodity)
 
void SetCapacity (const Commodity &commodity, double capacity)
 
void SetCost (const Commodity &commodity, double cost)
 
virtual ~CommodityProducer ()
 
- Public Member Functions inherited from cyclus::toolkit::AgentManaged
Agentagent () const
 
 AgentManaged (Agent *agent=NULL)
 

Constructor & Destructor Documentation

cyclus::toolkit::CommodityProducer::CommodityProducer ( double  default_capacity = 0,
double  default_cost = kModifierLimit,
Agent agent = NULL 
)

Definition at line 10 of file commodity_producer.cc.

cyclus::toolkit::CommodityProducer::~CommodityProducer ( )
virtual

Definition at line 17 of file commodity_producer.cc.

Member Function Documentation

void cyclus::toolkit::CommodityProducer::Add ( const Commodity commodity)
inline

Register a commodity as being produced by this object.

Parameters
commoditythe commodity being produced

Definition at line 64 of file commodity_producer.h.

void cyclus::toolkit::CommodityProducer::Add ( const Commodity commodity,
const CommodInfo info 
)
inline

Register a commodity as being produced by this object and set its relevant info.

Parameters
commoditythe commodity being produced
infothe information describing the commodity

Definition at line 72 of file commodity_producer.h.

double cyclus::toolkit::CommodityProducer::Capacity ( const Commodity commodity)
inline
Parameters
commoditythe commodity in question
Returns
the production capacity for a commodity

Definition at line 38 of file commodity_producer.h.

void cyclus::toolkit::CommodityProducer::Copy ( CommodityProducer source)

Add all commodities produced by a source.

Parameters
sourcethe original commodity producer

Definition at line 28 of file commodity_producer.cc.

double cyclus::toolkit::CommodityProducer::Cost ( const Commodity commodity)
inline
Returns
the cost to produce a commodity at a given capacity
Parameters
commoditythe commodity in question

Definition at line 44 of file commodity_producer.h.

std::set< Commodity, CommodityCompare > cyclus::toolkit::CommodityProducer::ProducedCommodities ( )
Returns
the set of commodities produced by this producers

Definition at line 19 of file commodity_producer.cc.

bool cyclus::toolkit::CommodityProducer::Produces ( const Commodity commodity) const
inline
Parameters
commoditythe commodity in question
Returns
true if the commodity is produced by this entity

Definition at line 32 of file commodity_producer.h.

void cyclus::toolkit::CommodityProducer::Rm ( const Commodity commodity)
inline

Unregister a commodity as being produced by this object.

Parameters
commoditythe commodity being produced

Definition at line 78 of file commodity_producer.h.

void cyclus::toolkit::CommodityProducer::SetCapacity ( const Commodity commodity,
double  capacity 
)
inline

Set the production capacity for a given commodity.

Parameters
commoditythe commodity being produced
capacitythe production capacity

Definition at line 51 of file commodity_producer.h.

void cyclus::toolkit::CommodityProducer::SetCost ( const Commodity commodity,
double  cost 
)
inline

Set the production cost for a given commodity.

Parameters
commoditythe commodity being produced
costthe production cost

Definition at line 58 of file commodity_producer.h.


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