DemandLineSchedule
in package
One demand line plus its computed movement schedule and arrival timeline.
Table of Contents
Properties
- $arrivals : array<string|int, mixed>
- Quantity arrivals at the target over time.
- $line : DemandLine
- Original requested demand line.
- $schedule : MovementSchedule
- Underlying movement schedule for this line.
- $subjectKey : string
- Normalized subject key used to match state and shipment lines.
- $target : Slot
- Final target slot this line is being scheduled toward.
Methods
- __construct() : mixed
- Create one scheduled demand line result.
- completeTime() : int|null
- Return the final time at which this line becomes fully available, if any.
- firstReadyTime() : int|null
- Return the first time any quantity becomes available for this line, if any.
- fulfilledQuantity() : int|float
- Return the quantity currently scheduled to reach the target.
- isComplete() : bool
- Return true when the line quantity is fully scheduled.
- readyArrivalSteps() : array<int, ScheduledStep>
- Return terminal scheduled steps that have arrived at the target by the given time.
- releasedArrivalSteps() : array<int, ScheduledStep>
- Return the terminal arrival steps that contribute the next released quantity slice.
- remainingQuantity() : int|float
- Return the quantity not yet scheduled for the line.
- requestedQuantity() : int|float
- Return the quantity originally requested for this line.
Properties
$arrivals read-only
Quantity arrivals at the target over time.
public
array<string|int, mixed>
$arrivals
$line read-only
Original requested demand line.
public
DemandLine
$line
$schedule read-only
Underlying movement schedule for this line.
public
MovementSchedule
$schedule
$subjectKey read-only
Normalized subject key used to match state and shipment lines.
public
string
$subjectKey
$target read-only
Final target slot this line is being scheduled toward.
public
Slot
$target
Methods
__construct()
Create one scheduled demand line result.
public
__construct(DemandLine $line, string $subjectKey, MovementSchedule $schedule, Slot $target, array<int, DemandLineArrival> $arrivals) : mixed
Parameters
- $line : DemandLine
- $subjectKey : string
- $schedule : MovementSchedule
- $target : Slot
- $arrivals : array<int, DemandLineArrival>
completeTime()
Return the final time at which this line becomes fully available, if any.
public
completeTime() : int|null
Return values
int|nullfirstReadyTime()
Return the first time any quantity becomes available for this line, if any.
public
firstReadyTime() : int|null
Return values
int|nullfulfilledQuantity()
Return the quantity currently scheduled to reach the target.
public
fulfilledQuantity() : int|float
Return values
int|floatisComplete()
Return true when the line quantity is fully scheduled.
public
isComplete() : bool
Return values
boolreadyArrivalSteps()
Return terminal scheduled steps that have arrived at the target by the given time.
public
readyArrivalSteps(int $time) : array<int, ScheduledStep>
Parameters
- $time : int
Return values
array<int, ScheduledStep>releasedArrivalSteps()
Return the terminal arrival steps that contribute the next released quantity slice.
public
releasedArrivalSteps(int $time, int|float $alreadyShipped, int|float $releaseQuantity) : array<int, ScheduledStep>
Parameters
- $time : int
- $alreadyShipped : int|float
- $releaseQuantity : int|float
Return values
array<int, ScheduledStep>remainingQuantity()
Return the quantity not yet scheduled for the line.
public
remainingQuantity() : int|float
Return values
int|floatrequestedQuantity()
Return the quantity originally requested for this line.
public
requestedQuantity() : int|float