Struct ScriptWriter 

pub struct ScriptWriter { /* private fields */ }

Generate a scenario to be executed by the Company simulator.

Implementations

impl ScriptWriter

pub fn quiet(&self) -> bool

Supress all output.

pub fn current_day(&self) -> i32

pub fn set_current_day(&self, value: i32) -> i32

pub fn initial_customers(&self) -> u32

How many customers we have the day 1

pub fn market_capacity(&self) -> u32

The maximum number of customer the company can have by the end of the simulation period.

pub fn inflection_point(&self) -> u32

Where customer base growth reaches its peak.

pub fn growth_rate(&self) -> f64

Company’s “success” rate – how fast the customer base grows

pub fn min_customer_orders(&self) -> f64

pub fn max_customer_orders(&self) -> f64

pub fn product_count(&self) -> i32

pub fn return_window(&self) -> i32

pub fn products(&self) -> RwLockReadGuard<'_, Vec<Product>>

Index in the vector is the products ID.

pub fn products_mut(&self) -> RwLockWriteGuard<'_, Vec<Product>>

pub fn return_probs<'fx_reader_lifetime>( &'fx_reader_lifetime self, ) -> MappedRwLockReadGuard<'fx_reader_lifetime, BTreeMap<i32, f64>>

Product return probability per day, by ID.

pub fn steps(&self) -> RwLockReadGuard<'_, Vec<Step>>

pub fn steps_mut(&self) -> RwLockWriteGuard<'_, Vec<Step>>

pub fn set_steps(&self, value: Vec<Step>) -> Vec<Step>

pub fn returns(&self) -> RwLockReadGuard<'_, HashMap<i32, Vec<Order>>>

“Planned” returns, per day

pub fn returns_mut(&self) -> RwLockWriteGuard<'_, HashMap<i32, Vec<Order>>>

pub fn backorders(&self) -> RwLockReadGuard<'_, Vec<VecDeque<usize>>>

Backorders by their indices in the steps array, per product ID. When inventory is replenished, these orders will be processed first.

Since product ID is its vector index, we use a Vec here too.

pub fn backorders_mut(&self) -> RwLockWriteGuard<'_, Vec<VecDeque<usize>>>

pub fn total_backordered(&self) -> usize

pub fn clear_total_backordered(&self) -> Option<usize>

pub fn pending_orders(&self) -> RwLockReadGuard<'_, HashMap<i32, Vec<usize>>>

Pending orders by their indices in the steps array, keyed by shipping day. This is a map from the day to a queue of orders.

pub fn pending_orders_mut( &self, ) -> RwLockWriteGuard<'_, HashMap<i32, Vec<usize>>>

pub fn inventory(&self) -> RwLockReadGuard<'_, Vec<InventoryRecord>>

Inventory record per product ID. Since product ID is its vector index in self.products, we use a Vec here too.

pub fn inventory_mut(&self) -> RwLockWriteGuard<'_, Vec<InventoryRecord>>

pub fn shipments(&self) -> RwLockReadGuard<'_, BTreeMap<i32, Vec<Shipment>>>

Map shipment day into shipments.

pub fn shipments_mut( &self, ) -> RwLockWriteGuard<'_, BTreeMap<i32, Vec<Shipment>>>

pub fn product_shipping(&self) -> RwLockReadGuard<'_, BTreeMap<i32, i32>>

Map product ID into the number of items currently shipping.

pub fn product_shipping_mut(&self) -> RwLockWriteGuard<'_, BTreeMap<i32, i32>>

pub fn customers(&self) -> RwLockReadGuard<'_, HashMap<String, Arc<Customer>>>

Map unique email into customer.

pub fn customers_mut( &self, ) -> RwLockWriteGuard<'_, HashMap<String, Arc<Customer>>>

pub fn customer_counts(&self) -> RwLockReadGuard<'_, VecDeque<u32>>

Customer counts over the last few days.

pub fn customer_counts_mut(&self) -> RwLockWriteGuard<'_, VecDeque<u32>>

pub fn customer_history_length(&self) -> usize

Customer history length

pub fn next_day_customers(&self) -> usize

Keep track of the number of customers that are expected to be registered the next day.

pub fn set_next_day_customers(&self, value: usize) -> usize

pub fn random_pool(&self) -> Arc<RndPool>

pub fn product_price_model<'fx_reader_lifetime>( &'fx_reader_lifetime self, ) -> MappedRwLockReadGuard<'fx_reader_lifetime, Arc<ProductModel>>

pub fn track_product(&self) -> Option<usize>

pub fn set_track_product(&self, value: usize) -> Option<usize>

pub fn clear_track_product(&self) -> Option<usize>

pub fn customer_sessions<'fx_reader_lifetime>( &'fx_reader_lifetime self, ) -> MappedRwLockReadGuard<'fx_reader_lifetime, Vec<Option<DbSession>>>

pub fn customer_sessions_mut<'fx_get_mut>( &'fx_get_mut self, ) -> MappedRwLockWriteGuard<'fx_get_mut, Vec<Option<DbSession>>>

pub fn new() -> Arc<Self>

pub fn builder() -> ScriptWriterBuilder

Creates a new builder for this struct.

impl ScriptWriter

pub fn create(&self) -> Result<Vec<Step>>

pub fn direct(&self) -> Result<()>

pub fn customer_model(&self) -> &CustomerModel

Trait Implementations

impl Default for ScriptWriter

fn default() -> Self

Returns the “default value” for a type.

impl Parent for ScriptWriter

type WeakSelf = Weak<ScriptWriter>

Weak ref-count type for the parent to hold a reference to itself.

fn __fxplus_myself_downgrade(&self) -> Weak<Self>

impl FXStruct for ScriptWriter