KSLCore/ksl.modeling.supplychain.spec/ShipmentFormationSpec

ShipmentFormationSpec

@Serializable

data class ShipmentFormationSpec(val option: FormingOption, val countLimit: Int? = null, val weightLimits: LimitsSpec? = null, val cubeLimits: LimitsSpec? = null)(source)

Serializable description of a per-edge shipment-formation policy, mirroring the framework's ShipmentFormation. Attached to a NodeSpec (NodeSpec.shipmentFormationFromParent) or a DemandGeneratorSpec (DemandGeneratorSpec.shipmentFormation).

Validation (see validate):

FormingOption.COUNT requires countLimit > 0.
FormingOption.WEIGHT requires weightLimits.
FormingOption.CUBE requires cubeLimits.
Formation is only permitted under TransportStrategySpec.PerIHPTimeBased.

Parameters

option

the forming trigger

countLimit

demands per load under FormingOption.COUNT

weightLimits

min/max queued weight under FormingOption.WEIGHT

cubeLimits

min/max queued cube under FormingOption.CUBE

Constructors

ShipmentFormationSpec

constructor(option: FormingOption, countLimit: Int? = null, weightLimits: LimitsSpec? = null, cubeLimits: LimitsSpec? = null)

Properties

val countLimit: Int?

val cubeLimits: LimitsSpec?

val option: FormingOption

val weightLimits: LimitsSpec?