Class: ClockEvent

ClockEvent()

- Class representing a ClockEvent in ROS

Constructor

new ClockEvent()

Source:

Methods

clear()

Clear the event.
Source:

isSet() → {boolean}

Indicate if the ClockEvent is set.
Source:
Returns:
- True if the ClockEvent is set.
Type
boolean

set()

Set the event.
Source:

(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>

(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>

(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>