TimedSlot
in package
FinalYes
One slot at one point on a discrete time axis.
Table of Contents
Properties
- $key : string
- $slot : Slot
- $space : TimedSlotSpace
- $timeIndex : int
- $timeKey : string
Methods
- __construct() : mixed
- Create one timed slot from a base slot and any accepted time expression.
- __toString() : string
- Return the canonical `slot@time` serialization for this timed slot.
- at() : self
- Return the same base slot positioned at another point on the same time axis.
- dimension() : string|null
- Return one base-slot dimension value from this timed slot.
- equals() : bool
- Compare two timed slots by their canonical serialized keys.
- humanKey() : string
- Return one human-readable `slot@time` serialization for display.
- isNil() : bool
- Return true when the wrapped base slot is the nil boundary slot.
Properties
$key read-only
public
string
$key
$slot read-only
public
Slot
$slot
$space read-only
public
TimedSlotSpace
$space
$timeIndex read-only
public
int
$timeIndex
$timeKey read-only
public
string
$timeKey
Methods
__construct()
Create one timed slot from a base slot and any accepted time expression.
public
__construct(Slot $slot, int $timeIndex, string $timeKey, TimedSlotSpace $space) : mixed
Parameters
- $slot : Slot
- $timeIndex : int
- $timeKey : string
- $space : TimedSlotSpace
__toString()
Return the canonical `slot@time` serialization for this timed slot.
public
__toString() : string
Return values
stringat()
Return the same base slot positioned at another point on the same time axis.
public
at(DateTimeImmutable|int|string $time) : self
Parameters
- $time : DateTimeImmutable|int|string
Return values
selfdimension()
Return one base-slot dimension value from this timed slot.
public
dimension(non-empty-string $name) : string|null
Parameters
- $name : non-empty-string
Return values
string|nullequals()
Compare two timed slots by their canonical serialized keys.
public
equals(self $other) : bool
Parameters
- $other : self
Return values
boolhumanKey()
Return one human-readable `slot@time` serialization for display.
public
humanKey() : string
Return values
stringisNil()
Return true when the wrapped base slot is the nil boundary slot.
public
isNil() : bool