Constructor
class
new ClockEvent()
- Source:
Methods
function
clear()
Clear the event.
- Source:
function
isSet() → {boolean}
Indicate if the ClockEvent is set.
- Source:
Returns:
- True if the ClockEvent is set.
Type
boolean
function
set()
Set the event.
- Source:
function
(async) waitUntilRos(clock, until) → {Promise.<void>}
Wait until a time specified by a ROS clock.
Parameters:
| Name | Type | Description |
|---|---|---|
clock |
Clock | The clock to use for time synchronization. |
until |
bigint | The time to wait until. |
- Source:
Returns:
- A promise that resolves when the time is reached.
Type
Promise.<void>
function
(async) waitUntilSteady(clock, until) → {Promise.<void>}
Wait until a time specified by a steady clock.
Parameters:
| Name | Type | Description |
|---|---|---|
clock |
Clock | The clock to use for time synchronization. |
until |
bigint | The time to wait until. |
- Source:
Returns:
- A promise that resolves when the time is reached.
Type
Promise.<void>
function
(async) waitUntilSystem(clock, until) → {Promise.<void>}
Wait until a time specified by a system clock.
Parameters:
| Name | Type | Description |
|---|---|---|
clock |
Clock | The clock to use for time synchronization. |
until |
bigint | The time to wait until. |
- Source:
Returns:
- A promise that resolves when the time is reached.
Type
Promise.<void>