PlannedStep
in package
FinalYes
One planned timeless movement.
Table of Contents
Properties
- $edge : MovementEdge
- $id : string
- $policies : array<string|int, mixed>
- $quantity : int|float
Methods
- __construct() : mixed
- Create one timeless planned movement step.
- deltas() : array<int, QuantityStateDelta>
- Convert this planned step into quantity-state deltas.
- plannerRules() : array<int, PlannerRuleInterface>
- Return the planner rules applicable to the planned step.
- policies() : array<int, PolicyInterface>
- Return all applicable policies for the planned step, merging step first and edge second.
- shipmentCalendarRules() : array<int, ShipmentCalendarRuleInterface>
- Return shipment calendar rules applicable to the planned step.
- withQuantity() : self
- Return a copy of this step with a different planned quantity.
Properties
$edge read-only
public
MovementEdge
$edge
$id read-only
public
string
$id
$policies read-only
public
array<string|int, mixed>
$policies
= []
$quantity read-only
public
int|float
$quantity
Methods
__construct()
Create one timeless planned movement step.
public
__construct(string $id, MovementEdge $edge, int|float $quantity[, array<int, PolicyInterface> $policies = [] ]) : mixed
Parameters
- $id : string
- $edge : MovementEdge
- $quantity : int|float
- $policies : array<int, PolicyInterface> = []
deltas()
Convert this planned step into quantity-state deltas.
public
deltas() : array<int, QuantityStateDelta>
Return values
array<int, QuantityStateDelta>plannerRules()
Return the planner rules applicable to the planned step.
public
plannerRules() : array<int, PlannerRuleInterface>
Return values
array<int, PlannerRuleInterface>policies()
Return all applicable policies for the planned step, merging step first and edge second.
public
policies() : array<int, PolicyInterface>
Return values
array<int, PolicyInterface>shipmentCalendarRules()
Return shipment calendar rules applicable to the planned step.
public
shipmentCalendarRules() : array<int, ShipmentCalendarRuleInterface>
Return values
array<int, ShipmentCalendarRuleInterface>withQuantity()
Return a copy of this step with a different planned quantity.
public
withQuantity(int|float $quantity) : self
Parameters
- $quantity : int|float