DemandReleaseContext
in package
Rich order-level context passed to demand release policies and shipment calendars.
Table of Contents
Properties
- $availableBySubject : array<string|int, mixed>
- Quantities ready to ship now, keyed by subject key.
- $finalEvaluation : bool
- True when the planner has reached its final release evaluation after all arrivals.
- $lineSchedules : array<string|int, mixed>
- Per-line schedules available to the current planning step.
- $request : DemandScheduleRequest
- Original demand scheduling request being planned.
- $shipments : array<string|int, mixed>
- Shipments already planned before this context evaluation.
- $shippedBySubject : array<string|int, mixed>
- Quantities already shipped by prior planned shipments, keyed by subject key.
- $time : int
- Candidate release time currently being evaluated.
Methods
- __construct() : mixed
- Create one order-level release-evaluation context.
- availableQuantity() : int|float
- Return the currently ready quantity for one subject.
- availableQuantityForLine() : int|float
- Return the currently ready quantity for one specific demand line.
- fillRatio() : float
- Return the current ready fill ratio across the whole demand.
- remainingQuantityForLine() : int|float
- Return the remaining requested quantity for one specific demand line.
- requestedQuantityForLine() : int|float
- Return the originally requested quantity for one specific demand line.
- shippedQuantity() : int|float
- Return the already planned shipped quantity for one subject.
- shippedQuantityForLine() : int|float
- Return the already planned shipped quantity for one specific demand line.
- totalAvailableQuantity() : int|float
- Return the total currently ready quantity across all subjects.
- totalRequestedQuantity() : int|float
- Return the total requested quantity across all demand lines.
Properties
$availableBySubject read-only
Quantities ready to ship now, keyed by subject key.
public
array<string|int, mixed>
$availableBySubject
$finalEvaluation read-only
True when the planner has reached its final release evaluation after all arrivals.
public
bool
$finalEvaluation
$lineSchedules read-only
Per-line schedules available to the current planning step.
public
array<string|int, mixed>
$lineSchedules
$request read-only
Original demand scheduling request being planned.
public
DemandScheduleRequest
$request
$shipments read-only
Shipments already planned before this context evaluation.
public
array<string|int, mixed>
$shipments
$shippedBySubject read-only
Quantities already shipped by prior planned shipments, keyed by subject key.
public
array<string|int, mixed>
$shippedBySubject
$time read-only
Candidate release time currently being evaluated.
public
int
$time
Methods
__construct()
Create one order-level release-evaluation context.
public
__construct(DemandScheduleRequest $request, array<int, DemandLineSchedule> $lineSchedules, int $time, bool $finalEvaluation, array<string, int|float> $availableBySubject, array<string, int|float> $shippedBySubject, array<int, DemandShipment> $shipments) : mixed
Parameters
- $request : DemandScheduleRequest
- $lineSchedules : array<int, DemandLineSchedule>
- $time : int
- $finalEvaluation : bool
- $availableBySubject : array<string, int|float>
- $shippedBySubject : array<string, int|float>
- $shipments : array<int, DemandShipment>
availableQuantity()
Return the currently ready quantity for one subject.
public
availableQuantity(string $subjectKey) : int|float
Parameters
- $subjectKey : string
Return values
int|floatavailableQuantityForLine()
Return the currently ready quantity for one specific demand line.
public
availableQuantityForLine(DemandLineSchedule $lineSchedule) : int|float
Parameters
- $lineSchedule : DemandLineSchedule
Return values
int|floatfillRatio()
Return the current ready fill ratio across the whole demand.
public
fillRatio() : float
Return values
floatremainingQuantityForLine()
Return the remaining requested quantity for one specific demand line.
public
remainingQuantityForLine(DemandLineSchedule $lineSchedule) : int|float
Parameters
- $lineSchedule : DemandLineSchedule
Return values
int|floatrequestedQuantityForLine()
Return the originally requested quantity for one specific demand line.
public
requestedQuantityForLine(DemandLineSchedule $lineSchedule) : int|float
Parameters
- $lineSchedule : DemandLineSchedule
Return values
int|floatshippedQuantity()
Return the already planned shipped quantity for one subject.
public
shippedQuantity(string $subjectKey) : int|float
Parameters
- $subjectKey : string
Return values
int|floatshippedQuantityForLine()
Return the already planned shipped quantity for one specific demand line.
public
shippedQuantityForLine(DemandLineSchedule $lineSchedule) : int|float
Parameters
- $lineSchedule : DemandLineSchedule
Return values
int|floattotalAvailableQuantity()
Return the total currently ready quantity across all subjects.
public
totalAvailableQuantity() : int|float
Return values
int|floattotalRequestedQuantity()
Return the total requested quantity across all demand lines.
public
totalRequestedQuantity() : int|float