MovementSchedule
in package
FinalYes
Immutable summary of one planned movement schedule over time.
Table of Contents
Properties
- $milestones : array<string|int, mixed>
- $remaining : int|float
- $steps : array<string|int, mixed>
Methods
- __construct() : mixed
- Create one timed movement schedule result.
- deltas() : array<int, TimedQuantityStateDelta>
- Aggregate timed quantity-state deltas for this schedule.
- firstMilestone() : ScheduleMilestone|null
- Return the first milestone reached by this schedule, if any.
- isComplete() : bool
- Return true when the requested quantity is fully scheduled.
- lastMilestone() : ScheduleMilestone|null
- Return the final milestone reached by this schedule, if any.
- step() : ScheduledStep|null
- Find one scheduled step by id.
Properties
$milestones read-only
public
array<string|int, mixed>
$milestones
= []
$remaining read-only
public
int|float
$remaining
$steps read-only
public
array<string|int, mixed>
$steps
Methods
__construct()
Create one timed movement schedule result.
public
__construct(array<int, ScheduledStep> $steps, int|float $remaining[, array<int, ScheduleMilestone> $milestones = [] ]) : mixed
Parameters
- $steps : array<int, ScheduledStep>
- $remaining : int|float
- $milestones : array<int, ScheduleMilestone> = []
deltas()
Aggregate timed quantity-state deltas for this schedule.
public
deltas() : array<int, TimedQuantityStateDelta>
Return values
array<int, TimedQuantityStateDelta>firstMilestone()
Return the first milestone reached by this schedule, if any.
public
firstMilestone() : ScheduleMilestone|null
Return values
ScheduleMilestone|nullisComplete()
Return true when the requested quantity is fully scheduled.
public
isComplete() : bool
Return values
boollastMilestone()
Return the final milestone reached by this schedule, if any.
public
lastMilestone() : ScheduleMilestone|null
Return values
ScheduleMilestone|nullstep()
Find one scheduled step by id.
public
step(string $id) : ScheduledStep|null
Parameters
- $id : string