CYCAMORE
Loading...
Searching...
No Matches
cycamore::Storage Class Reference

This Facility is intended to hold materials for a user specified amount of time in order to model a storage facility with a certain residence time or holdup time. More...

#include <storage.h>

Inheritance diagram for cycamore::Storage:

Public Member Functions

virtual Json::Value annotations ()
 
virtual cyclus::Agent * Clone ()
 
virtual void EnterNotify ()
 Sets up the Storage Facility's trade requests.
 
virtual void EnterNotify ()
 Sets up the Storage Facility's trade requests.
 
virtual void InfileToDb (cyclus::InfileTree *tree, cyclus::DbInit di)
 
virtual void InitFrom (cycamore::Storage *m)
 
virtual void InitFrom (cyclus::QueryableBackend *b)
 
virtual void InitInv (cyclus::Inventories &inv)
 
virtual std::string schema ()
 
virtual void Snapshot (cyclus::DbInit di)
 
virtual cyclus::Inventories SnapshotInv ()
 
 Storage (cyclus::Context *ctx)
 
 Storage (cyclus::Context *ctx)
 
virtual std::string str ()
 A verbose printer for the Storage Facility.
 
virtual std::string str ()
 A verbose printer for the Storage Facility.
 
virtual void Tick ()
 The handleTick function specific to the Storage.
 
virtual void Tick ()
 The handleTick function specific to the Storage.
 
virtual void Tock ()
 The handleTick function specific to the Storage.
 
virtual void Tock ()
 The handleTick function specific to the Storage.
 
virtual std::string version ()
 
virtual std::string version ()
 

Protected Member Functions

void AddMat_ (cyclus::Material::Ptr mat)
 adds a material into the incoming commodity inventory
 
void AddMat_ (cyclus::Material::Ptr mat)
 adds a material into the incoming commodity inventory
 
void BeginProcessing_ ()
 Move all unprocessed inventory to processing.
 
void BeginProcessing_ ()
 Move all unprocessed inventory to processing.
 
double capacity ()
 returns total capacity
 
double capacity ()
 returns total capacity
 
double current_capacity ()
 current maximum amount that can be added to processing
 
double current_capacity ()
 current maximum amount that can be added to processing
 
void InitBuyPolicyParameters ()
 sets up the distributions for the buy policy
 
void InitBuyPolicyParameters ()
 sets up the distributions for the buy policy
 
void ProcessMat_ (double cap)
 Move as many ready resources as allowable into stocks.
 
void ProcessMat_ (double cap)
 Move as many ready resources as allowable into stocks.
 
int ready_time ()
 returns the time key for ready materials
 
int ready_time ()
 returns the time key for ready materials
 
void ReadyMatl_ (int time)
 move ready resources from processing to ready at a certain time
 
void ReadyMatl_ (int time)
 move ready resources from processing to ready at a certain time
 
void RecordPosition ()
 
void RecordPosition ()
 

Protected Attributes

std::string active_buying_frequency_type
 
int active_buying_max
 
double active_buying_mean
 
int active_buying_min
 
double active_buying_stddev
 
int active_buying_val
 
cyclus::IntDistribution::Ptr active_dist_ = NULL
 
cyclus::toolkit::MatlBuyPolicy buy_policy
 
double buying_size_max
 
double buying_size_mean
 
double buying_size_min
 
double buying_size_stddev
 
std::string buying_size_type
 
double buying_size_val
 
cyclus::toolkit::Position coordinates
 
double cumulative_cap
 
std::vector< intcycpp_shape_active_buying_frequency_type
 
std::vector< intcycpp_shape_active_buying_max
 
std::vector< intcycpp_shape_active_buying_mean
 
std::vector< intcycpp_shape_active_buying_min
 
std::vector< intcycpp_shape_active_buying_stddev
 
std::vector< intcycpp_shape_active_buying_val
 
std::vector< intcycpp_shape_buying_size_max
 
std::vector< intcycpp_shape_buying_size_mean
 
std::vector< intcycpp_shape_buying_size_min
 
std::vector< intcycpp_shape_buying_size_stddev
 
std::vector< intcycpp_shape_buying_size_type
 
std::vector< intcycpp_shape_buying_size_val
 
std::vector< intcycpp_shape_cumulative_cap
 
std::vector< intcycpp_shape_discrete_handling
 
std::vector< intcycpp_shape_dormant_buying_frequency_type
 
std::vector< intcycpp_shape_dormant_buying_max
 
std::vector< intcycpp_shape_dormant_buying_mean
 
std::vector< intcycpp_shape_dormant_buying_min
 
std::vector< intcycpp_shape_dormant_buying_stddev
 
std::vector< intcycpp_shape_dormant_buying_val
 
std::vector< intcycpp_shape_in_commod_prefs
 
std::vector< intcycpp_shape_in_commods
 
std::vector< intcycpp_shape_in_recipe
 
std::vector< intcycpp_shape_inventory
 
std::vector< intcycpp_shape_inventory_tracker
 
std::vector< intcycpp_shape_latitude
 
std::vector< intcycpp_shape_longitude
 
std::vector< intcycpp_shape_max_inv_size
 
std::vector< intcycpp_shape_out_commods
 
std::vector< intcycpp_shape_package
 
std::vector< intcycpp_shape_processing
 
std::vector< intcycpp_shape_ready
 
std::vector< intcycpp_shape_reorder_point
 
std::vector< intcycpp_shape_reorder_quantity
 
std::vector< intcycpp_shape_residence_time
 
std::vector< intcycpp_shape_sell_quantity
 
std::vector< intcycpp_shape_stocks
 
std::vector< intcycpp_shape_throughput
 
std::vector< intcycpp_shape_transport_unit
 
bool discrete_handling
 
std::string dormant_buying_frequency_type
 
int dormant_buying_max
 
double dormant_buying_mean
 
int dormant_buying_min
 
double dormant_buying_stddev
 
int dormant_buying_val
 
cyclus::IntDistribution::Ptr dormant_dist_ = NULL
 
std::list< intentry_times
 
std::vector< double > in_commod_prefs
 
std::vector< std::string > in_commods
 
std::string in_recipe
 
cyclus::toolkit::ResBuf< cyclus::Material > inventory
 
cyclus::toolkit::TotalInvTracker inventory_tracker
 
double latitude
 
double longitude
 
double max_inv_size
 
std::vector< std::string > out_commods
 
std::string package
 
cyclus::toolkit::ResBuf< cyclus::Material > processing
 
cyclus::toolkit::ResBuf< cyclus::Material > ready
 
double reorder_point
 
double reorder_quantity
 
int residence_time
 
cyclus::toolkit::MatlSellPolicy sell_policy
 
double sell_quantity
 
cyclus::DoubleDistribution::Ptr size_dist_ = NULL
 
cyclus::toolkit::ResBuf< cyclus::Material > stocks
 
double throughput
 
std::string transport_unit
 

Friends

class StorageTest
 

Detailed Description

This Facility is intended to hold materials for a user specified amount of time in order to model a storage facility with a certain residence time or holdup time.

The Storage class inherits from the Facility class and is dynamically loaded by the Agent class when requested.

Introduction

This Agent was initially developed to support the fco code-to-code comparison. It's very similar to the "NullFacility" of years past. Its purpose is to hold materials and release them only after some period of delay time.

Agent Parameters

in_commods is a vector of strings naming the commodities that this facility receives out_commods is a string naming the commodity that in_commod is stocks into residence_time is the minimum number of timesteps between receiving and offering in_recipe (optional) describes the incoming resource by recipe

Optional Parameters

sell_quantity restricts selling to only integer multiples of this value max_inv_size is the maximum capacity of the inventory storage throughput is the maximum processing capacity per timestep active_buying_frequency_type is the type of distribution used to determine the length of the active buying period active_buying_val is the length of the active buying period if active_buying_frequency_type is Fixed active_buying_min is the minimum length of the active buying period if active_buying_frequency_type is Uniform (required) or Normal (optional) active_buying_max is the maximum length of the active buying period if active_buying_frequency_type is Uniform (required) or Normal (optional) active_buying_mean is the mean length of the active buying period if active_buying_frequency_type is Normal active_buying_std is the standard deviation of the active buying period if active_buying_frequency_type is Normal dormant_buying_frequency_type is the type of distribution used to determine the length of the dormant buying period dormant_buying_val is the length of the dormant buying period if dormant_buying_frequency_type is Fixed dormant_buying_min is the minimum length of the dormant buying period if dormant_buying_frequency_type is Uniform (required) or Normal (optional) dormant_buying_max is the maximum length of the dormant buying period if dormant_buying_frequency_type is Uniform (required) or Normal (optional) dormant_buying_mean is the mean length of the dormant buying period if dormant_buying_frequency_type is Normal dormant_buying_std is the standard deviation of the dormant buying period if dormant_buying_frequency_type is Normal buying_size_type is the type of distribution used to determine the size of buy requests, as a fraction of the current capacity buying_size_val is the size of the buy request for Fixed buying_size_type buying_size_min is the minimum size of the buy request if buying_size_type is Uniform (required) or Normal (optional) buying_size_max is the maximum size of the buy request if buying_size_type is Uniform (required) or Normal (optional) buying_size_mean is the mean size of the buy request if buying_size_type is Normal buying_size_stddev is the standard deviation of the buy request if buying_size_type is Normal package is the name of the package type to ship

Detailed Behavior

Tick: Nothing really happens on the tick.

Tock: On the tock, any material that has been waiting for long enough (delay time) is placed in the stocks buffer.

Any brand new inventory that was received in this timestep is placed into the processing queue to begin waiting.

Making Requests: This facility requests all of the in_commod that it can.

Receiving Resources: Anything of the in_commod that is received by this facility goes into the inventory.

Making Offers: Any stocks material in the stocks buffer is offered to the market.

Sending Resources: Matched resources are sent immediately.

Definition at line 91 of file build/cycamore/storage.h.

Constructor & Destructor Documentation

◆ Storage() [1/2]

cycamore::Storage::Storage ( cyclus::Context * ctx)
Parameters
ctxthe cyclus context for access to simulation-wide parameters

Definition at line 9 of file build/cycamore/storage.cc.

References inventory, inventory_tracker, processing, ready, and stocks.

Referenced by cycamore::ConstructStorage().

◆ Storage() [2/2]

cycamore::Storage::Storage ( cyclus::Context * ctx)
Parameters
ctxthe cyclus context for access to simulation-wide parameters

Member Function Documentation

◆ AddMat_() [1/2]

void cycamore::Storage::AddMat_ ( cyclus::Material::Ptr mat)
protected

adds a material into the incoming commodity inventory

Parameters
matthe material to add to the incoming inventory.
Exceptions
ifthere is trouble with pushing to the inventory buffer.

Definition at line 1564 of file build/cycamore/storage.cc.

References inventory.

◆ AddMat_() [2/2]

void cycamore::Storage::AddMat_ ( cyclus::Material::Ptr mat)
protected

adds a material into the incoming commodity inventory

Parameters
matthe material to add to the incoming inventory.
Exceptions
ifthere is trouble with pushing to the inventory buffer.

◆ annotations()

Json::Value cycamore::Storage::annotations ( )
virtual

Definition at line 206 of file build/cycamore/storage.cc.

◆ BeginProcessing_() [1/2]

void cycamore::Storage::BeginProcessing_ ( )
protected

Move all unprocessed inventory to processing.

Definition at line 1582 of file build/cycamore/storage.cc.

References entry_times, inventory, and processing.

Referenced by Tock().

◆ BeginProcessing_() [2/2]

void cycamore::Storage::BeginProcessing_ ( )
protected

Move all unprocessed inventory to processing.

◆ capacity() [1/2]

double cycamore::Storage::capacity ( )
inlineprotected

returns total capacity

Definition at line 163 of file build/cycamore/storage.h.

References inventory_tracker.

◆ capacity() [2/2]

double cycamore::Storage::capacity ( )
inlineprotected

returns total capacity

Definition at line 153 of file src/storage.h.

References inventory_tracker.

◆ Clone()

cyclus::Agent * cycamore::Storage::Clone ( )
virtual

Definition at line 1073 of file build/cycamore/storage.cc.

Referenced by cycamore::TEST_F().

◆ current_capacity() [1/2]

double cycamore::Storage::current_capacity ( )
inlineprotected

current maximum amount that can be added to processing

Definition at line 159 of file build/cycamore/storage.h.

References inventory_tracker.

Referenced by Tick(), and Tock().

◆ current_capacity() [2/2]

double cycamore::Storage::current_capacity ( )
inlineprotected

current maximum amount that can be added to processing

Definition at line 149 of file src/storage.h.

References inventory_tracker.

◆ EnterNotify() [1/2]

◆ EnterNotify() [2/2]

virtual void cycamore::Storage::EnterNotify ( )
virtual

Sets up the Storage Facility's trade requests.

◆ InfileToDb()

void cycamore::Storage::InfileToDb ( cyclus::InfileTree * tree,
cyclus::DbInit di )
virtual

Definition at line 576 of file build/cycamore/storage.cc.

References active_buying_frequency_type, active_buying_max, active_buying_mean, active_buying_min, active_buying_stddev, active_buying_val, buying_size_max, buying_size_mean, buying_size_min, buying_size_stddev, buying_size_type, buying_size_val, cumulative_cap, cycpp_shape_active_buying_frequency_type, cycpp_shape_active_buying_max, cycpp_shape_active_buying_mean, cycpp_shape_active_buying_min, cycpp_shape_active_buying_stddev, cycpp_shape_active_buying_val, cycpp_shape_buying_size_max, cycpp_shape_buying_size_mean, cycpp_shape_buying_size_min, cycpp_shape_buying_size_stddev, cycpp_shape_buying_size_type, cycpp_shape_buying_size_val, cycpp_shape_cumulative_cap, cycpp_shape_discrete_handling, cycpp_shape_dormant_buying_frequency_type, cycpp_shape_dormant_buying_max, cycpp_shape_dormant_buying_mean, cycpp_shape_dormant_buying_min, cycpp_shape_dormant_buying_stddev, cycpp_shape_dormant_buying_val, cycpp_shape_in_commod_prefs, cycpp_shape_in_commods, cycpp_shape_in_recipe, cycpp_shape_inventory, cycpp_shape_inventory_tracker, cycpp_shape_latitude, cycpp_shape_longitude, cycpp_shape_max_inv_size, cycpp_shape_out_commods, cycpp_shape_package, cycpp_shape_processing, cycpp_shape_ready, cycpp_shape_reorder_point, cycpp_shape_reorder_quantity, cycpp_shape_residence_time, cycpp_shape_sell_quantity, cycpp_shape_stocks, cycpp_shape_throughput, cycpp_shape_transport_unit, discrete_handling, dormant_buying_frequency_type, dormant_buying_max, dormant_buying_mean, dormant_buying_min, dormant_buying_stddev, dormant_buying_val, in_commod_prefs, in_commods, in_recipe, latitude, longitude, max_inv_size, out_commods, package, reorder_point, reorder_quantity, residence_time, sell_quantity, throughput, and transport_unit.

◆ InitBuyPolicyParameters() [1/2]

void cycamore::Storage::InitBuyPolicyParameters ( )
protected

sets up the distributions for the buy policy

set up active buying distribution

set up dormant buying distribution

set up buying size distribution

set up active buying distribution

set up dormant buying distribution

set up buying size distribution

Definition at line 1330 of file build/cycamore/storage.cc.

References active_buying_frequency_type, active_buying_max, active_buying_mean, active_buying_min, active_buying_stddev, active_buying_val, active_dist_, buying_size_max, buying_size_mean, buying_size_min, buying_size_stddev, buying_size_type, buying_size_val, dormant_buying_frequency_type, dormant_buying_max, dormant_buying_mean, dormant_buying_min, dormant_buying_stddev, dormant_buying_val, dormant_dist_, and size_dist_.

Referenced by EnterNotify().

◆ InitBuyPolicyParameters() [2/2]

void cycamore::Storage::InitBuyPolicyParameters ( )
protected

sets up the distributions for the buy policy

◆ InitFrom() [1/2]

void cycamore::Storage::InitFrom ( cycamore::Storage * m)
virtual

Definition at line 1081 of file build/cycamore/storage.cc.

References active_buying_frequency_type, active_buying_max, active_buying_mean, active_buying_min, active_buying_stddev, active_buying_val, buying_size_max, buying_size_mean, buying_size_min, buying_size_stddev, buying_size_type, buying_size_val, cumulative_cap, cycpp_shape_active_buying_frequency_type, cycpp_shape_active_buying_max, cycpp_shape_active_buying_mean, cycpp_shape_active_buying_min, cycpp_shape_active_buying_stddev, cycpp_shape_active_buying_val, cycpp_shape_buying_size_max, cycpp_shape_buying_size_mean, cycpp_shape_buying_size_min, cycpp_shape_buying_size_stddev, cycpp_shape_buying_size_type, cycpp_shape_buying_size_val, cycpp_shape_cumulative_cap, cycpp_shape_discrete_handling, cycpp_shape_dormant_buying_frequency_type, cycpp_shape_dormant_buying_max, cycpp_shape_dormant_buying_mean, cycpp_shape_dormant_buying_min, cycpp_shape_dormant_buying_stddev, cycpp_shape_dormant_buying_val, cycpp_shape_in_commod_prefs, cycpp_shape_in_commods, cycpp_shape_in_recipe, cycpp_shape_inventory, cycpp_shape_inventory_tracker, cycpp_shape_latitude, cycpp_shape_longitude, cycpp_shape_max_inv_size, cycpp_shape_out_commods, cycpp_shape_package, cycpp_shape_processing, cycpp_shape_ready, cycpp_shape_reorder_point, cycpp_shape_reorder_quantity, cycpp_shape_residence_time, cycpp_shape_sell_quantity, cycpp_shape_stocks, cycpp_shape_throughput, cycpp_shape_transport_unit, discrete_handling, dormant_buying_frequency_type, dormant_buying_max, dormant_buying_mean, dormant_buying_min, dormant_buying_stddev, dormant_buying_val, in_commod_prefs, in_commods, in_recipe, cycamore::Source::inventory, inventory_tracker, cycamore::Source::latitude, cycamore::Source::longitude, max_inv_size, out_commods, processing, ready, reorder_point, reorder_quantity, residence_time, sell_quantity, stocks, throughput, and cycamore::Source::transport_unit.

◆ InitFrom() [2/2]

void cycamore::Storage::InitFrom ( cyclus::QueryableBackend * b)
virtual

Definition at line 1204 of file build/cycamore/storage.cc.

References active_buying_frequency_type, active_buying_max, active_buying_mean, active_buying_min, active_buying_stddev, active_buying_val, buying_size_max, buying_size_mean, buying_size_min, buying_size_stddev, buying_size_type, buying_size_val, cumulative_cap, cycpp_shape_active_buying_frequency_type, cycpp_shape_active_buying_max, cycpp_shape_active_buying_mean, cycpp_shape_active_buying_min, cycpp_shape_active_buying_stddev, cycpp_shape_active_buying_val, cycpp_shape_buying_size_max, cycpp_shape_buying_size_mean, cycpp_shape_buying_size_min, cycpp_shape_buying_size_stddev, cycpp_shape_buying_size_type, cycpp_shape_buying_size_val, cycpp_shape_cumulative_cap, cycpp_shape_discrete_handling, cycpp_shape_dormant_buying_frequency_type, cycpp_shape_dormant_buying_max, cycpp_shape_dormant_buying_mean, cycpp_shape_dormant_buying_min, cycpp_shape_dormant_buying_stddev, cycpp_shape_dormant_buying_val, cycpp_shape_in_commod_prefs, cycpp_shape_in_commods, cycpp_shape_in_recipe, cycpp_shape_inventory, cycpp_shape_inventory_tracker, cycpp_shape_latitude, cycpp_shape_longitude, cycpp_shape_max_inv_size, cycpp_shape_out_commods, cycpp_shape_package, cycpp_shape_processing, cycpp_shape_ready, cycpp_shape_reorder_point, cycpp_shape_reorder_quantity, cycpp_shape_residence_time, cycpp_shape_sell_quantity, cycpp_shape_stocks, cycpp_shape_throughput, cycpp_shape_transport_unit, discrete_handling, dormant_buying_frequency_type, dormant_buying_max, dormant_buying_mean, dormant_buying_min, dormant_buying_stddev, dormant_buying_val, in_commod_prefs, in_commods, in_recipe, cycamore::Source::inventory, inventory_tracker, cycamore::Source::latitude, cycamore::Source::longitude, max_inv_size, out_commods, processing, ready, reorder_point, reorder_quantity, residence_time, sell_quantity, stocks, cycamore::Source::throughput, throughput, and cycamore::Source::transport_unit.

◆ InitInv()

void cycamore::Storage::InitInv ( cyclus::Inventories & inv)
virtual

Definition at line 551 of file build/cycamore/storage.cc.

References inventory, processing, ready, and stocks.

◆ ProcessMat_() [1/2]

void cycamore::Storage::ProcessMat_ ( double cap)
protected

Move as many ready resources as allowable into stocks.

Parameters
capcurrent throughput capacity

Definition at line 1599 of file build/cycamore/storage.cc.

References discrete_handling, ready, and stocks.

Referenced by Tock().

◆ ProcessMat_() [2/2]

void cycamore::Storage::ProcessMat_ ( double cap)
protected

Move as many ready resources as allowable into stocks.

Parameters
capcurrent throughput capacity

◆ ready_time() [1/2]

int cycamore::Storage::ready_time ( )
inlineprotected

returns the time key for ready materials

Definition at line 166 of file build/cycamore/storage.h.

References residence_time.

Referenced by Tock().

◆ ready_time() [2/2]

int cycamore::Storage::ready_time ( )
inlineprotected

returns the time key for ready materials

Definition at line 156 of file src/storage.h.

References residence_time.

◆ ReadyMatl_() [1/2]

void cycamore::Storage::ReadyMatl_ ( int time)
protected

move ready resources from processing to ready at a certain time

Parameters
timethe time of interest

Definition at line 1630 of file build/cycamore/storage.cc.

References entry_times, processing, and ready.

Referenced by Tock().

◆ ReadyMatl_() [2/2]

void cycamore::Storage::ReadyMatl_ ( int time)
protected

move ready resources from processing to ready at a certain time

Parameters
timethe time of interest

◆ RecordPosition() [1/2]

void cycamore::Storage::RecordPosition ( )
protected

Definition at line 1643 of file build/cycamore/storage.cc.

References latitude, and longitude.

Referenced by EnterNotify().

◆ RecordPosition() [2/2]

void cycamore::Storage::RecordPosition ( )
protected

◆ schema()

std::string cycamore::Storage::schema ( )
virtual

Definition at line 21 of file build/cycamore/storage.cc.

◆ Snapshot()

void cycamore::Storage::Snapshot ( cyclus::DbInit di)
virtual

Definition at line 1033 of file build/cycamore/storage.cc.

References active_buying_frequency_type, active_buying_max, active_buying_mean, active_buying_min, active_buying_stddev, active_buying_val, buying_size_max, buying_size_mean, buying_size_min, buying_size_stddev, buying_size_type, buying_size_val, cumulative_cap, cycpp_shape_active_buying_frequency_type, cycpp_shape_active_buying_max, cycpp_shape_active_buying_mean, cycpp_shape_active_buying_min, cycpp_shape_active_buying_stddev, cycpp_shape_active_buying_val, cycpp_shape_buying_size_max, cycpp_shape_buying_size_mean, cycpp_shape_buying_size_min, cycpp_shape_buying_size_stddev, cycpp_shape_buying_size_type, cycpp_shape_buying_size_val, cycpp_shape_cumulative_cap, cycpp_shape_discrete_handling, cycpp_shape_dormant_buying_frequency_type, cycpp_shape_dormant_buying_max, cycpp_shape_dormant_buying_mean, cycpp_shape_dormant_buying_min, cycpp_shape_dormant_buying_stddev, cycpp_shape_dormant_buying_val, cycpp_shape_in_commod_prefs, cycpp_shape_in_commods, cycpp_shape_in_recipe, cycpp_shape_latitude, cycpp_shape_longitude, cycpp_shape_max_inv_size, cycpp_shape_out_commods, cycpp_shape_package, cycpp_shape_reorder_point, cycpp_shape_reorder_quantity, cycpp_shape_residence_time, cycpp_shape_sell_quantity, cycpp_shape_throughput, cycpp_shape_transport_unit, discrete_handling, dormant_buying_frequency_type, dormant_buying_max, dormant_buying_mean, dormant_buying_min, dormant_buying_stddev, dormant_buying_val, in_commod_prefs, in_commods, in_recipe, latitude, longitude, max_inv_size, out_commods, package, reorder_point, reorder_quantity, residence_time, sell_quantity, throughput, and transport_unit.

◆ SnapshotInv()

cyclus::Inventories cycamore::Storage::SnapshotInv ( )
virtual

Definition at line 561 of file build/cycamore/storage.cc.

References inventory, processing, ready, and stocks.

◆ str() [1/2]

std::string cycamore::Storage::str ( )
virtual

A verbose printer for the Storage Facility.

Definition at line 1483 of file build/cycamore/storage.cc.

References out_commods, residence_time, and throughput.

Referenced by cycamore::TEST_F().

◆ str() [2/2]

virtual std::string cycamore::Storage::str ( )
virtual

A verbose printer for the Storage Facility.

◆ Tick() [1/2]

void cycamore::Storage::Tick ( )
virtual

The handleTick function specific to the Storage.

Definition at line 1509 of file build/cycamore/storage.cc.

References current_capacity(), max_inv_size, processing, ready, and stocks.

Referenced by cycamore::TEST_F().

◆ Tick() [2/2]

virtual void cycamore::Storage::Tick ( )
virtual

The handleTick function specific to the Storage.

◆ Tock() [1/2]

◆ Tock() [2/2]

virtual void cycamore::Storage::Tock ( )
virtual

The handleTick function specific to the Storage.

◆ version() [1/2]

virtual std::string cycamore::Storage::version ( )
inlinevirtual

Definition at line 136 of file build/cycamore/storage.h.

References CYCAMORE_VERSION.

◆ version() [2/2]

virtual std::string cycamore::Storage::version ( )
inlinevirtual

Definition at line 125 of file src/storage.h.

References CYCAMORE_VERSION.

Friends And Related Symbol Documentation

◆ StorageTest

StorageTest
friend

Definition at line 456 of file build/cycamore/storage.h.

Member Data Documentation

◆ active_buying_frequency_type

std::string cycamore::Storage::active_buying_frequency_type
protected

◆ active_buying_max

int cycamore::Storage::active_buying_max
protected

◆ active_buying_mean

double cycamore::Storage::active_buying_mean
protected

◆ active_buying_min

int cycamore::Storage::active_buying_min
protected

◆ active_buying_stddev

double cycamore::Storage::active_buying_stddev
protected

◆ active_buying_val

int cycamore::Storage::active_buying_val
protected

◆ active_dist_

cyclus::IntDistribution::Ptr cycamore::Storage::active_dist_ = NULL
protected

Definition at line 448 of file build/cycamore/storage.h.

Referenced by EnterNotify(), and InitBuyPolicyParameters().

◆ buy_policy

cyclus::toolkit::MatlBuyPolicy cycamore::Storage::buy_policy
protected

Definition at line 429 of file build/cycamore/storage.h.

Referenced by EnterNotify().

◆ buying_size_max

double cycamore::Storage::buying_size_max
protected

◆ buying_size_mean

double cycamore::Storage::buying_size_mean
protected

◆ buying_size_min

double cycamore::Storage::buying_size_min
protected

◆ buying_size_stddev

double cycamore::Storage::buying_size_stddev
protected

◆ buying_size_type

std::string cycamore::Storage::buying_size_type
protected

◆ buying_size_val

double cycamore::Storage::buying_size_val
protected

◆ coordinates

cyclus::toolkit::Position cycamore::Storage::coordinates
protected

Definition at line 452 of file build/cycamore/storage.h.

◆ cumulative_cap

double cycamore::Storage::cumulative_cap
protected

Definition at line 374 of file build/cycamore/storage.h.

Referenced by EnterNotify(), InfileToDb(), InitFrom(), InitFrom(), and Snapshot().

◆ cycpp_shape_active_buying_frequency_type

std::vector<int> cycamore::Storage::cycpp_shape_active_buying_frequency_type
protected

Definition at line 235 of file build/cycamore/storage.h.

Referenced by InfileToDb(), InitFrom(), InitFrom(), and Snapshot().

◆ cycpp_shape_active_buying_max

std::vector<int> cycamore::Storage::cycpp_shape_active_buying_max
protected

Definition at line 256 of file build/cycamore/storage.h.

Referenced by InfileToDb(), InitFrom(), InitFrom(), and Snapshot().

◆ cycpp_shape_active_buying_mean

std::vector<int> cycamore::Storage::cycpp_shape_active_buying_mean
protected

Definition at line 263 of file build/cycamore/storage.h.

Referenced by InfileToDb(), InitFrom(), InitFrom(), and Snapshot().

◆ cycpp_shape_active_buying_min

std::vector<int> cycamore::Storage::cycpp_shape_active_buying_min
protected

Definition at line 249 of file build/cycamore/storage.h.

Referenced by InfileToDb(), InitFrom(), InitFrom(), and Snapshot().

◆ cycpp_shape_active_buying_stddev

std::vector<int> cycamore::Storage::cycpp_shape_active_buying_stddev
protected

Definition at line 270 of file build/cycamore/storage.h.

Referenced by InfileToDb(), InitFrom(), InitFrom(), and Snapshot().

◆ cycpp_shape_active_buying_val

std::vector<int> cycamore::Storage::cycpp_shape_active_buying_val
protected

Definition at line 242 of file build/cycamore/storage.h.

Referenced by InfileToDb(), InitFrom(), InitFrom(), and Snapshot().

◆ cycpp_shape_buying_size_max

std::vector<int> cycamore::Storage::cycpp_shape_buying_size_max
protected

Definition at line 340 of file build/cycamore/storage.h.

Referenced by InfileToDb(), InitFrom(), InitFrom(), and Snapshot().

◆ cycpp_shape_buying_size_mean

std::vector<int> cycamore::Storage::cycpp_shape_buying_size_mean
protected

Definition at line 347 of file build/cycamore/storage.h.

Referenced by InfileToDb(), InitFrom(), InitFrom(), and Snapshot().

◆ cycpp_shape_buying_size_min

std::vector<int> cycamore::Storage::cycpp_shape_buying_size_min
protected

Definition at line 333 of file build/cycamore/storage.h.

Referenced by InfileToDb(), InitFrom(), InitFrom(), and Snapshot().

◆ cycpp_shape_buying_size_stddev

std::vector<int> cycamore::Storage::cycpp_shape_buying_size_stddev
protected

Definition at line 354 of file build/cycamore/storage.h.

Referenced by InfileToDb(), InitFrom(), InitFrom(), and Snapshot().

◆ cycpp_shape_buying_size_type

std::vector<int> cycamore::Storage::cycpp_shape_buying_size_type
protected

Definition at line 319 of file build/cycamore/storage.h.

Referenced by InfileToDb(), InitFrom(), InitFrom(), and Snapshot().

◆ cycpp_shape_buying_size_val

std::vector<int> cycamore::Storage::cycpp_shape_buying_size_val
protected

Definition at line 326 of file build/cycamore/storage.h.

Referenced by InfileToDb(), InitFrom(), InitFrom(), and Snapshot().

◆ cycpp_shape_cumulative_cap

std::vector<int> cycamore::Storage::cycpp_shape_cumulative_cap
protected

Definition at line 375 of file build/cycamore/storage.h.

Referenced by InfileToDb(), InitFrom(), InitFrom(), and Snapshot().

◆ cycpp_shape_discrete_handling

std::vector<int> cycamore::Storage::cycpp_shape_discrete_handling
protected

Definition at line 228 of file build/cycamore/storage.h.

Referenced by InfileToDb(), InitFrom(), InitFrom(), and Snapshot().

◆ cycpp_shape_dormant_buying_frequency_type

std::vector<int> cycamore::Storage::cycpp_shape_dormant_buying_frequency_type
protected

Definition at line 277 of file build/cycamore/storage.h.

Referenced by InfileToDb(), InitFrom(), InitFrom(), and Snapshot().

◆ cycpp_shape_dormant_buying_max

std::vector<int> cycamore::Storage::cycpp_shape_dormant_buying_max
protected

Definition at line 298 of file build/cycamore/storage.h.

Referenced by InfileToDb(), InitFrom(), InitFrom(), and Snapshot().

◆ cycpp_shape_dormant_buying_mean

std::vector<int> cycamore::Storage::cycpp_shape_dormant_buying_mean
protected

Definition at line 305 of file build/cycamore/storage.h.

Referenced by InfileToDb(), InitFrom(), InitFrom(), and Snapshot().

◆ cycpp_shape_dormant_buying_min

std::vector<int> cycamore::Storage::cycpp_shape_dormant_buying_min
protected

Definition at line 291 of file build/cycamore/storage.h.

Referenced by InfileToDb(), InitFrom(), InitFrom(), and Snapshot().

◆ cycpp_shape_dormant_buying_stddev

std::vector<int> cycamore::Storage::cycpp_shape_dormant_buying_stddev
protected

Definition at line 312 of file build/cycamore/storage.h.

Referenced by InfileToDb(), InitFrom(), InitFrom(), and Snapshot().

◆ cycpp_shape_dormant_buying_val

std::vector<int> cycamore::Storage::cycpp_shape_dormant_buying_val
protected

Definition at line 284 of file build/cycamore/storage.h.

Referenced by InfileToDb(), InitFrom(), InitFrom(), and Snapshot().

◆ cycpp_shape_in_commod_prefs

std::vector<int> cycamore::Storage::cycpp_shape_in_commod_prefs
protected

Definition at line 179 of file build/cycamore/storage.h.

Referenced by InfileToDb(), InitFrom(), InitFrom(), and Snapshot().

◆ cycpp_shape_in_commods

std::vector<int> cycamore::Storage::cycpp_shape_in_commods
protected

Definition at line 171 of file build/cycamore/storage.h.

Referenced by InfileToDb(), InitFrom(), InitFrom(), and Snapshot().

◆ cycpp_shape_in_recipe

std::vector<int> cycamore::Storage::cycpp_shape_in_recipe
protected

Definition at line 193 of file build/cycamore/storage.h.

Referenced by InfileToDb(), InitFrom(), InitFrom(), and Snapshot().

◆ cycpp_shape_inventory

std::vector<int> cycamore::Storage::cycpp_shape_inventory
protected

Definition at line 395 of file build/cycamore/storage.h.

Referenced by InfileToDb(), InitFrom(), and InitFrom().

◆ cycpp_shape_inventory_tracker

std::vector<int> cycamore::Storage::cycpp_shape_inventory_tracker
protected

Definition at line 424 of file build/cycamore/storage.h.

Referenced by InfileToDb(), InitFrom(), and InitFrom().

◆ cycpp_shape_latitude

std::vector<int> cycamore::Storage::cycpp_shape_latitude
protected

Definition at line 437 of file build/cycamore/storage.h.

Referenced by InfileToDb(), InitFrom(), InitFrom(), and Snapshot().

◆ cycpp_shape_longitude

std::vector<int> cycamore::Storage::cycpp_shape_longitude
protected

Definition at line 444 of file build/cycamore/storage.h.

Referenced by InfileToDb(), InitFrom(), InitFrom(), and Snapshot().

◆ cycpp_shape_max_inv_size

std::vector<int> cycamore::Storage::cycpp_shape_max_inv_size
protected

Definition at line 221 of file build/cycamore/storage.h.

Referenced by InfileToDb(), InitFrom(), InitFrom(), and Snapshot().

◆ cycpp_shape_out_commods

std::vector<int> cycamore::Storage::cycpp_shape_out_commods
protected

Definition at line 186 of file build/cycamore/storage.h.

Referenced by InfileToDb(), InitFrom(), InitFrom(), and Snapshot().

◆ cycpp_shape_package

std::vector<int> cycamore::Storage::cycpp_shape_package
protected

Definition at line 382 of file build/cycamore/storage.h.

Referenced by InfileToDb(), InitFrom(), InitFrom(), and Snapshot().

◆ cycpp_shape_processing

std::vector<int> cycamore::Storage::cycpp_shape_processing
protected

Definition at line 418 of file build/cycamore/storage.h.

Referenced by InfileToDb(), InitFrom(), and InitFrom().

◆ cycpp_shape_ready

std::vector<int> cycamore::Storage::cycpp_shape_ready
protected

Definition at line 407 of file build/cycamore/storage.h.

Referenced by InfileToDb(), InitFrom(), and InitFrom().

◆ cycpp_shape_reorder_point

std::vector<int> cycamore::Storage::cycpp_shape_reorder_point
protected

Definition at line 361 of file build/cycamore/storage.h.

Referenced by InfileToDb(), InitFrom(), InitFrom(), and Snapshot().

◆ cycpp_shape_reorder_quantity

std::vector<int> cycamore::Storage::cycpp_shape_reorder_quantity
protected

Definition at line 368 of file build/cycamore/storage.h.

Referenced by InfileToDb(), InitFrom(), InitFrom(), and Snapshot().

◆ cycpp_shape_residence_time

std::vector<int> cycamore::Storage::cycpp_shape_residence_time
protected

Definition at line 200 of file build/cycamore/storage.h.

Referenced by InfileToDb(), InitFrom(), InitFrom(), and Snapshot().

◆ cycpp_shape_sell_quantity

std::vector<int> cycamore::Storage::cycpp_shape_sell_quantity
protected

Definition at line 207 of file build/cycamore/storage.h.

Referenced by InfileToDb(), InitFrom(), InitFrom(), and Snapshot().

◆ cycpp_shape_stocks

std::vector<int> cycamore::Storage::cycpp_shape_stocks
protected

Definition at line 401 of file build/cycamore/storage.h.

Referenced by InfileToDb(), InitFrom(), and InitFrom().

◆ cycpp_shape_throughput

std::vector<int> cycamore::Storage::cycpp_shape_throughput
protected

Definition at line 214 of file build/cycamore/storage.h.

Referenced by InfileToDb(), InitFrom(), InitFrom(), and Snapshot().

◆ cycpp_shape_transport_unit

std::vector<int> cycamore::Storage::cycpp_shape_transport_unit
protected

Definition at line 389 of file build/cycamore/storage.h.

Referenced by InfileToDb(), InitFrom(), InitFrom(), and Snapshot().

◆ discrete_handling

bool cycamore::Storage::discrete_handling
protected

◆ dormant_buying_frequency_type

std::string cycamore::Storage::dormant_buying_frequency_type
protected

◆ dormant_buying_max

int cycamore::Storage::dormant_buying_max
protected

◆ dormant_buying_mean

double cycamore::Storage::dormant_buying_mean
protected

◆ dormant_buying_min

int cycamore::Storage::dormant_buying_min
protected

◆ dormant_buying_stddev

double cycamore::Storage::dormant_buying_stddev
protected

◆ dormant_buying_val

int cycamore::Storage::dormant_buying_val
protected

◆ dormant_dist_

cyclus::IntDistribution::Ptr cycamore::Storage::dormant_dist_ = NULL
protected

Definition at line 449 of file build/cycamore/storage.h.

Referenced by EnterNotify(), and InitBuyPolicyParameters().

◆ entry_times

std::list< int > cycamore::Storage::entry_times
protected

Definition at line 414 of file build/cycamore/storage.h.

Referenced by BeginProcessing_(), and ReadyMatl_().

◆ in_commod_prefs

std::vector< double > cycamore::Storage::in_commod_prefs
protected

Definition at line 178 of file build/cycamore/storage.h.

Referenced by EnterNotify(), InfileToDb(), InitFrom(), InitFrom(), Snapshot(), and Tock().

◆ in_commods

std::vector< std::string > cycamore::Storage::in_commods
protected

◆ in_recipe

std::string cycamore::Storage::in_recipe
protected

◆ inventory

cyclus::toolkit::ResBuf< cyclus::Material > cycamore::Storage::inventory
protected

◆ inventory_tracker

cyclus::toolkit::TotalInvTracker cycamore::Storage::inventory_tracker
protected

◆ latitude

double cycamore::Storage::latitude
protected

Definition at line 436 of file build/cycamore/storage.h.

Referenced by InfileToDb(), RecordPosition(), and Snapshot().

◆ longitude

double cycamore::Storage::longitude
protected

Definition at line 443 of file build/cycamore/storage.h.

Referenced by InfileToDb(), RecordPosition(), and Snapshot().

◆ max_inv_size

double cycamore::Storage::max_inv_size
protected

◆ out_commods

std::vector< std::string > cycamore::Storage::out_commods
protected

◆ package

std::string cycamore::Storage::package
protected

◆ processing

cyclus::toolkit::ResBuf< cyclus::Material > cycamore::Storage::processing
protected

◆ ready

cyclus::toolkit::ResBuf< cyclus::Material > cycamore::Storage::ready
protected

◆ reorder_point

double cycamore::Storage::reorder_point
protected

Definition at line 360 of file build/cycamore/storage.h.

Referenced by EnterNotify(), InfileToDb(), InitFrom(), InitFrom(), and Snapshot().

◆ reorder_quantity

double cycamore::Storage::reorder_quantity
protected

Definition at line 367 of file build/cycamore/storage.h.

Referenced by EnterNotify(), InfileToDb(), InitFrom(), InitFrom(), and Snapshot().

◆ residence_time

int cycamore::Storage::residence_time
protected

◆ sell_policy

cyclus::toolkit::MatlSellPolicy cycamore::Storage::sell_policy
protected

Definition at line 432 of file build/cycamore/storage.h.

Referenced by EnterNotify().

◆ sell_quantity

double cycamore::Storage::sell_quantity
protected

Definition at line 206 of file build/cycamore/storage.h.

Referenced by EnterNotify(), InfileToDb(), InitFrom(), InitFrom(), and Snapshot().

◆ size_dist_

cyclus::DoubleDistribution::Ptr cycamore::Storage::size_dist_ = NULL
protected

Definition at line 450 of file build/cycamore/storage.h.

Referenced by EnterNotify(), and InitBuyPolicyParameters().

◆ stocks

cyclus::toolkit::ResBuf< cyclus::Material > cycamore::Storage::stocks
protected

◆ throughput

double cycamore::Storage::throughput
protected

◆ transport_unit

std::string cycamore::Storage::transport_unit
protected

Definition at line 388 of file build/cycamore/storage.h.

Referenced by EnterNotify(), InfileToDb(), and Snapshot().


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