CYCLUS
Loading...
Searching...
No Matches
Public Member Functions | List of all members
cyclus::toolkit::CommodityProducerManager Class Reference

Detailed Description

A mixin to provide information about commodity producers.

Definition at line 14 of file commodity_producer_manager.h.

#include <commodity_producer_manager.h>

Inheritance diagram for cyclus::toolkit::CommodityProducerManager:
cyclus::toolkit::AgentManaged

Public Member Functions

 CommodityProducerManager (Agent *agent=NULL)
 
const std::set< CommodityProducer * > & producers () const
 
void Register (CommodityProducer *producer)
 
double TotalCapacity (Commodity &commodity)
 
void Unregister (CommodityProducer *producer)
 
virtual ~CommodityProducerManager ()
 
- Public Member Functions inherited from cyclus::toolkit::AgentManaged
Agent * agent () const
 
 AgentManaged (Agent *agent=NULL)
 

Constructor & Destructor Documentation

◆ CommodityProducerManager()

cyclus::toolkit::CommodityProducerManager::CommodityProducerManager ( Agent * agent = NULL)
inline

Definition at line 16 of file commodity_producer_manager.h.

◆ ~CommodityProducerManager()

virtual cyclus::toolkit::CommodityProducerManager::~CommodityProducerManager ( )
inlinevirtual

Definition at line 17 of file commodity_producer_manager.h.

Member Function Documentation

◆ producers()

const std::set< CommodityProducer * > & cyclus::toolkit::CommodityProducerManager::producers ( ) const
inline

Definition at line 35 of file commodity_producer_manager.h.

◆ Register()

void cyclus::toolkit::CommodityProducerManager::Register ( CommodityProducer * producer)
inline

Register a commodity producer with the manager.

Parameters
producerthe producer

Definition at line 25 of file commodity_producer_manager.h.

◆ TotalCapacity()

double cyclus::toolkit::CommodityProducerManager::TotalCapacity ( Commodity & commodity)
Returns
the total production capacity for a commodity amongst producers
Parameters
commoditythe commodity in question

Definition at line 7 of file commodity_producer_manager.cc.

◆ Unregister()

void cyclus::toolkit::CommodityProducerManager::Unregister ( CommodityProducer * producer)
inline

Unregister a commodity producer with the manager.

Parameters
producerthe producer

Definition at line 31 of file commodity_producer_manager.h.

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