Events
pathplannerlib Index / Pathplannerlib / Events
Auto-generated documentation for pathplannerlib.events module.
CancelCommandEvent
Show source in events.py:223
Signature
class CancelCommandEvent(Event):
def __init__(self, timestamp: float, command: Command): ...
See also
CancelCommandEvent().cancelEvent
Show source in events.py:240
Signature
@override
def cancelEvent(self, eventScheduler: "EventScheduler") -> None: ...
CancelCommandEvent().copyWithTime
Show source in events.py:245
Signature
@override
def copyWithTime(self, timestamp: float) -> Event: ...
See also
CancelCommandEvent().handleEvent
Show source in events.py:236
Signature
@override
def handleEvent(self, eventScheduler: "EventScheduler") -> None: ...
Event
Show source in events.py:11
Signature
class Event:
def __init__(self, timestamp: float): ...
Event().cancelEvent
Show source in events.py:31
Signature
def cancelEvent(self, eventScheduler: "EventScheduler") -> None: ...
Event().copyWithTime
Show source in events.py:34
Signature
def copyWithTime(self, timestamp: float) -> "Event": ...
Event().getTimestamp
Show source in events.py:22
Signature
def getTimestamp(self) -> float: ...
Event().handleEvent
Show source in events.py:28
Signature
def handleEvent(self, eventScheduler: "EventScheduler") -> None: ...
Event().setTimestamp
Show source in events.py:25
Signature
def setTimestamp(self, timestamp: float): ...
EventScheduler
Show source in events.py:38
Signature
class EventScheduler:
def __init__(self): ...
EventScheduler().cancelCommand
Show source in events.py:142
Cancel a command on this scheduler. Do not call this.
Arguments
command - The command to cancel
Signature
def cancelCommand(self, command: Command) -> None: ...
EventScheduler().end
Show source in events.py:86
End commands currently being run by this scheduler. This should be called from the end method of
the command running this scheduler.
Signature
def end(self) -> None: ...
EventScheduler().execute
Show source in events.py:63
Run the scheduler. This should be called from the execute method of the command running this scheduler.
Arguments
time - The current time along the trajectory
Signature
def execute(self, time: float) -> None: ...
EventScheduler.getEventLoop
Show source in events.py:119
Signature
@staticmethod
def getEventLoop() -> EventLoop: ...
EventScheduler.getSchedulerRequirements
Show source in events.py:103
Get the event requirements for the given path
Arguments
path - The path to get all requirements for
Returns
Set of event requirements for the given path
Signature
@staticmethod
def getSchedulerRequirements(path: "PathPlannerPath") -> set[Subsystem]: ...
EventScheduler().initialize
Show source in events.py:51
Initialize the EventScheduler for the given trajectory. This should be called from the initialize
method of the command running this scheduler.
Arguments
trajectory - The trajectory this scheduler should handle events for
Signature
def initialize(self, trajectory: "PathPlannerTrajectory") -> None: ...
EventScheduler().scheduleCommand
Show source in events.py:123
Schedule a command on this scheduler. This will cancel other commands that share requirements
with the given command. Do not call this.
Arguments
command - The command to schedule
Signature
def scheduleCommand(self, command: Command) -> None: ...
EventTrigger
Show source in events.py:156
Signature
class EventTrigger(Trigger):
def __init__(self, name: str, eventLoop: EventLoop = None): ...
EventTrigger.pollCondition
Show source in events.py:167
Signature
@staticmethod
def pollCondition(name: str) -> Callable[[], bool]: ...
EventTrigger.setCondition
Show source in events.py:163
Signature
@staticmethod
def setCondition(name: str, value: bool) -> None: ...
OneShotTriggerEvent
Show source in events.py:310
Signature
class OneShotTriggerEvent(Event):
def __init__(self, timestamp: float, name: str): ...
See also
OneShotTriggerEvent().cancelEvent
Show source in events.py:333
Signature
@override
def cancelEvent(self, eventScheduler: "EventScheduler") -> None: ...
OneShotTriggerEvent().copyWithTime
Show source in events.py:338
Signature
@override
def copyWithTime(self, timestamp: float) -> Event: ...
See also
OneShotTriggerEvent().handleEvent
Show source in events.py:326
Signature
@override
def handleEvent(self, eventScheduler: "EventScheduler") -> None: ...
PointTowardsZoneEvent
Show source in events.py:280
Signature
class PointTowardsZoneEvent(Event):
def __init__(self, timestamp: float, name: str, active: bool): ...
See also
PointTowardsZoneEvent().cancelEvent
Show source in events.py:300
Signature
@override
def cancelEvent(self, eventScheduler: "EventScheduler") -> None: ...
PointTowardsZoneEvent().copyWithTime
Show source in events.py:305
Signature
@override
def copyWithTime(self, timestamp: float) -> Event: ...
See also
PointTowardsZoneEvent().handleEvent
Show source in events.py:296
Signature
@override
def handleEvent(self, eventScheduler: "EventScheduler") -> None: ...
PointTowardsZoneTrigger
Show source in events.py:176
Signature
class PointTowardsZoneTrigger(Trigger):
def __init__(self, name: str, eventLoop: EventLoop = None): ...
PointTowardsZoneTrigger.pollCondition
Show source in events.py:187
Signature
@staticmethod
def pollCondition(name: str) -> Callable[[], bool]: ...
PointTowardsZoneTrigger.setWithinZone
Show source in events.py:183
Signature
@staticmethod
def setWithinZone(name: str, withinZone: bool) -> None: ...
ScheduleCommandEvent
Show source in events.py:196
Signature
class ScheduleCommandEvent(Event):
def __init__(self, timestamp: float, command: Command): ...
See also
ScheduleCommandEvent().cancelEvent
Show source in events.py:213
Signature
@override
def cancelEvent(self, eventScheduler: "EventScheduler") -> None: ...
ScheduleCommandEvent().copyWithTime
Show source in events.py:218
Signature
@override
def copyWithTime(self, timestamp: float) -> Event: ...
See also
ScheduleCommandEvent().handleEvent
Show source in events.py:209
Signature
@override
def handleEvent(self, eventScheduler: "EventScheduler") -> None: ...
TriggerEvent
Show source in events.py:250
Signature
class TriggerEvent(Event):
def __init__(self, timestamp: float, name: str, active: bool): ...
See also
TriggerEvent().cancelEvent
Show source in events.py:270
Signature
@override
def cancelEvent(self, eventScheduler: "EventScheduler") -> None: ...
TriggerEvent().copyWithTime
Show source in events.py:275
Signature
@override
def copyWithTime(self, timestamp: float) -> Event: ...
See also
TriggerEvent().handleEvent
Show source in events.py:266
Signature
@override
def handleEvent(self, eventScheduler: "EventScheduler") -> None: ...