KSLCore/ksl.modeling.supplychain.inventory/InventoryHolderAbstract

InventoryHolderAbstract

abstract class InventoryHolderAbstract @JvmOverloads constructor(parent: ModelElement, initialAvailability: Boolean = true, name: String? = null) : DemandFillerAbstract, DemandSenderIfc, AggregateInventoryResponseIfc(source)

Abstract base for objects that hold one Inventory per ItemType and route incoming demands to the appropriate inventory. Acts as a DemandFillerIfc (forwards demands by item type) and a DemandSenderIfc (forwards inventory replenishment demands outward).

Aggregate statistics across the held inventories are exposed via AggregateInventoryResponseIfc (delegated to a member AggregateInventoryResponse).

See sc.inventorylayer.InventoryHolderAbstract

Inheritors

InventoryHoldingPoint

Constructors

InventoryHolderAbstract

@JvmOverloads

constructor(parent: ModelElement, initialAvailability: Boolean = true, name: String? = null)

Properties

aggregateAmountBackOrdered

open override val aggregateAmountBackOrdered: AggregateTWResponse

aggregateAmountOnOrder

open override val aggregateAmountOnOrder: AggregateTWResponse

aggregateAvgCustomerWaitTime

open override val aggregateAvgCustomerWaitTime: AggregateResponse

aggregateAvgFirstFillRate

open override val aggregateAvgFirstFillRate: AggregateResponse

aggregateFractionTimeOnHandGTZero

val aggregateFractionTimeOnHandGTZero: TWResponseCIfc

Read-only view of the time-weighted "fraction of time on-hand > 0".

aggregateNumberBackOrdered

open override val aggregateNumberBackOrdered: AggregateTWResponse

aggregateNumberOfReplenishmentDemands

open override val aggregateNumberOfReplenishmentDemands: AggregateCounter

aggregateOnHandInventory

open override val aggregateOnHandInventory: AggregateTWResponse

demandFiller

open override var demandFiller: DemandFillerIfc?

Direct filler override; if set, used instead of demandFillerFinder.

demandFillerFinder

open override var demandFillerFinder: DemandFillerFinderIfc?

Finder used to locate a filler for each generated demand.

itemTypes

open override val itemTypes: Collection<ItemType>

All item types this filler is willing to fill.

myInventory

protected val myInventory: MutableMap<ItemType, Inventory>

Per-item-type inventories. LinkedHashMap per porting plan §4.3.

numberOfItemTypes

val numberOfItemTypes: Int

Number of distinct item types held.

replenishmentRequester

var replenishmentRequester: ReplenishmentRequesterIfc?

Used by held inventories internally; defaults to a requester that calls back into this holder. Subclasses may swap it.

Functions

addInventory

fun addInventory(inventory: Inventory)

Add an Inventory for its declared Inventory.itemType. Subscribes the inventory's responses to this holder's aggregate; sets the inventory's Inventory.replenishmentRequester so its replenishment routes through here.

addReorderPointOrderUpToLevelInventory

@JvmOverloads

fun addReorderPointOrderUpToLevelInventory(type: ItemType, reorderPoint: Int, orderUpToPoint: Int, initialOnHand: Int = 0, name: String? = null): Inventory

addReorderPointReorderQuantityInventory

@JvmOverloads

fun addReorderPointReorderQuantityInventory(type: ItemType, reorderPoint: Int, reorderQty: Int, initialOnHand: Int = 0, name: String? = null): Inventory

canFillItemType

open override fun canFillItemType(type: ItemType): Boolean

True if this filler can fill demands of type.

open override fun canFillItemType(demand: SupplyChainModel.Demand): Boolean

True if this filler can fill demands of demand's item type.

determineRequestStatus

open override fun determineRequestStatus(demand: SupplyChainModel.Demand): DemandStatusCode

The status demand would receive if filled now. Only valid at the current simulation time.

fillDemand

abstract override fun fillDemand(demand: SupplyChainModel.Demand)

Fill a previously received demand. Must be called at the same simulation time as the receipt — no time may elapse between receive and fillDemand.

getInventory

fun getInventory(type: ItemType): Inventory?

getInventoryInfo

fun getInventoryInfo(type: ItemType): InventoryIfc?

mightRequest

open override fun mightRequest(type: ItemType): Boolean

True if this sender may produce demands of type.

negotiate

open override fun negotiate(demand: SupplyChainModel.Demand): DemandMessageIfc?

Returns a DemandMessageIfc describing what would happen if demand were sent now, or null if negotiation is not supported.

receive

abstract override fun receive(demand: SupplyChainModel.Demand)

Subclasses define how demands are received and filled.

removeInventory

@JvmOverloads

fun removeInventory(type: ItemType, fromModel: Boolean = false): Inventory

Remove the inventory for type. The associated Inventory model element may optionally be removed from the model.

requestReplenishment

protected open fun requestReplenishment(inventory: Inventory, demand: SupplyChainModel.Demand)

Invoked by an internal inventory (via the wired-up replenishment requester) to send its replenishment demand outward. Sets the holder as the demand's sender and uses the holder's filler or finder to dispatch.

subscribeTo

open override fun subscribeTo(r: AggregateInventoryResponseIfc)

Wire this aggregate as a downstream observer of r: every observation on r's underlying responses is mirrored onto this aggregate's matching field.

unsubscribeFrom

open override fun unsubscribeFrom(r: AggregateInventoryResponseIfc)

Undo subscribeTo.

willReject

open override fun willReject(demand: SupplyChainModel.Demand): Boolean

True if demand would be rejected if filled now.