Package org.wpilib.commands3

Interface SchedulerEvent

All Known Implementing Classes:

SchedulerEvent.Canceled, SchedulerEvent.Completed, SchedulerEvent.CompletedWithError, SchedulerEvent.Interrupted, SchedulerEvent.Mounted, SchedulerEvent.Scheduled, SchedulerEvent.Yielded

public sealed interface SchedulerEvent
permits SchedulerEvent.Scheduled, SchedulerEvent.Mounted, SchedulerEvent.Yielded, SchedulerEvent.Completed, SchedulerEvent.CompletedWithError, SchedulerEvent.Canceled, SchedulerEvent.Interrupted

An event that occurs during scheduler processing. This can range from a command being scheduled by a trigger or manual call to Scheduler.schedule(Command) to a command being interrupted by another. Event listeners can be registered with a scheduler via Scheduler.addEventListener(Consumer). All events have a timestamp to indicate when the event occurred.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final record	SchedulerEvent.Canceled	An event marking when a command was canceled.
static final record	SchedulerEvent.Completed	An event marking when a command completed naturally.
static final record	SchedulerEvent.CompletedWithError	An event marking when a command threw or encountered an unhanded exception.
static final record	SchedulerEvent.Interrupted	An event marking when a command was interrupted by another.
static final record	SchedulerEvent.Mounted	An event marking when a command starts running.
static final record	SchedulerEvent.Scheduled	An event marking when a command is scheduled in Scheduler.schedule(Command).
static final record	SchedulerEvent.Yielded	An event marking when a command yielded control with Coroutine.yield().

Method Summary

Modifier and Type	Method	Description
long	timestampMicros()	The timestamp for when the event occurred.

Method Details

timestampMicros

long timestampMicros()

The timestamp for when the event occurred. Measured in microseconds since some arbitrary start time.

Returns:

The event timestamp.

See Also:

• RobotController.getTime()