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:

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, CommodityCompare >	ProducedCommodities ()

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
Agent *	agent () const

	AgentManaged (Agent *agent=NULL)

Constructor & Destructor Documentation

◆ CommodityProducer()

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

Definition at line 10 of file commodity_producer.cc.

◆ ~CommodityProducer()

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

virtual

Definition at line 17 of file commodity_producer.cc.

Member Function Documentation

◆ Add() [1/2]

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

inline

Register a commodity as being produced by this object.

Parameters

commodity the commodity being produced

Definition at line 64 of file commodity_producer.h.

◆ Add() [2/2]

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

commodity	the commodity being produced
info	the information describing the commodity

Definition at line 72 of file commodity_producer.h.

◆ Capacity()

double cyclus::toolkit::CommodityProducer::Capacity ( const Commodity & commodity )

inline

Parameters

commodity the commodity in question

Returns: the production capacity for a commodity

Definition at line 38 of file commodity_producer.h.

◆ Copy()

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

Add all commodities produced by a source.

Parameters

source the original commodity producer

Definition at line 28 of file commodity_producer.cc.

◆ Cost()

double cyclus::toolkit::CommodityProducer::Cost ( const Commodity & commodity )

inline

Returns: the cost to produce a commodity at a given capacity

Parameters

commodity the commodity in question

Definition at line 44 of file commodity_producer.h.

◆ ProducedCommodities()

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.

◆ Produces()

bool cyclus::toolkit::CommodityProducer::Produces ( const Commodity & commodity ) const

inline

Parameters

commodity the commodity in question

Returns: true if the commodity is produced by this entity

Definition at line 32 of file commodity_producer.h.

◆ Rm()

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

inline

Unregister a commodity as being produced by this object.

Parameters

commodity the commodity being produced

Definition at line 78 of file commodity_producer.h.

◆ SetCapacity()

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

inline

Set the production capacity for a given commodity.

Parameters

commodity	the commodity being produced
capacity	the production capacity

Definition at line 51 of file commodity_producer.h.

◆ SetCost()

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

inline

Set the production cost for a given commodity.

Parameters

commodity	the commodity being produced
cost	the production cost

Definition at line 58 of file commodity_producer.h.

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

Detailed Description

Public Member Functions

Constructor & Destructor Documentation

◆ CommodityProducer()

◆ ~CommodityProducer()

Member Function Documentation

◆ Add() [1/2]

◆ Add() [2/2]

◆ Capacity()

◆ Copy()

◆ Cost()

◆ ProducedCommodities()

◆ Produces()

◆ Rm()

◆ SetCapacity()

◆ SetCost()