ScheduledStep
in package
FinalYes
One scheduled timed movement.
Table of Contents
Properties
- $edge : TimedMovementEdge
- $id : string
- $policies : array<int, PolicyInterface>
- $quantity : int|float
Methods
- __construct() : mixed
- Create one scheduled movement step.
- arrivalTime() : int
- Return the scheduled arrival time index.
- deltas() : array<int, TimedQuantityStateDelta>
- Convert this scheduled step into timed quantity-state deltas.
- departureTime() : int
- Return the scheduled departure time index.
- duration() : int
- Return the scheduled duration in canonical bucket count.
- milestone() : ScheduleMilestone
- Return the arrival milestone implied by this scheduled step.
- plannerRules() : array<int, PlannerRuleInterface>
- Return the planner rules applicable to the scheduled step.
- policies() : array<int, PolicyInterface>
- Return all applicable policies for the scheduled step, merging step first and edge second.
- shipmentCalendarRules() : array<int, ShipmentCalendarRuleInterface>
- Return shipment calendar rules applicable to the scheduled step.
- withQuantity() : self
- Return a copy of this step with a different scheduled quantity.
Properties
$edge read-only
public
TimedMovementEdge
$edge
$id read-only
public
string
$id
$policies read-only
public
array<int, PolicyInterface>
$policies
= []
$quantity read-only
public
int|float
$quantity
Methods
__construct()
Create one scheduled movement step.
public
__construct(string $id, TimedMovementEdge $edge, int|float $quantity[, array<string|int, mixed> $policies = [] ]) : mixed
Parameters
- $id : string
- $edge : TimedMovementEdge
- $quantity : int|float
- $policies : array<string|int, mixed> = []
arrivalTime()
Return the scheduled arrival time index.
public
arrivalTime() : int
Return values
intdeltas()
Convert this scheduled step into timed quantity-state deltas.
public
deltas() : array<int, TimedQuantityStateDelta>
Return values
array<int, TimedQuantityStateDelta>departureTime()
Return the scheduled departure time index.
public
departureTime() : int
Return values
intduration()
Return the scheduled duration in canonical bucket count.
public
duration() : int
Return values
intmilestone()
Return the arrival milestone implied by this scheduled step.
public
milestone([string|null $name = null ]) : ScheduleMilestone
Parameters
- $name : string|null = null
Return values
ScheduleMilestoneplannerRules()
Return the planner rules applicable to the scheduled step.
public
plannerRules() : array<int, PlannerRuleInterface>
Return values
array<int, PlannerRuleInterface>policies()
Return all applicable policies for the scheduled 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 scheduled step.
public
shipmentCalendarRules() : array<int, ShipmentCalendarRuleInterface>
Return values
array<int, ShipmentCalendarRuleInterface>withQuantity()
Return a copy of this step with a different scheduled quantity.
public
withQuantity(int|float $quantity) : self
Parameters
- $quantity : int|float