pathplanner::TriggerEvent Class Reference

Inheritance diagram for pathplanner::TriggerEvent:

Public Member Functions
	TriggerEvent (units::second_t timestamp, std::string name, bool active)
void	handleEvent (EventScheduler *eventScheduler) override
void	cancelEvent (EventScheduler *eventScheduler) override
std::shared_ptr< Event >	copyWithTimestamp (units::second_t timestamp) override
Public Member Functions inherited from pathplanner::Event
constexpr	Event (units::second_t timestamp)
constexpr units::second_t	getTimestamp () const
constexpr void	setTimestamp (units::second_t timestamp)
virtual void	handleEvent (EventScheduler *eventScheduler)=0
virtual void	cancelEvent (EventScheduler *eventScheduler)=0
virtual std::shared_ptr< Event >	copyWithTimestamp (units::second_t timestamp)=0

Constructor & Destructor Documentation

TriggerEvent()

pathplanner::TriggerEvent::TriggerEvent ( units::second_t  timestamp, std::string  name, bool  active  )

inline

Create an event for changing the value of a named trigger

Parameters

timestamp	The trajectory timestamp of this event
name	The name of the trigger to control
active	Should the trigger be activated by this event

Member Function Documentation

cancelEvent()

void pathplanner::TriggerEvent::cancelEvent ( EventScheduler *  eventScheduler )

inlineoverridevirtual

Cancel this event. This will be called if a path following command ends before this event gets handled.

Parameters

eventScheduler

Reference to the EventScheduler handling this event

Implements pathplanner::Event.

copyWithTimestamp()

std::shared_ptr< Event > pathplanner::TriggerEvent::copyWithTimestamp ( units::second_t  timestamp )

inlineoverridevirtual

Copy this event with a different timestamp

Parameters

timestamp

The new timestamp

Returns

Copied event with new time

Implements pathplanner::Event.

handleEvent()

void pathplanner::TriggerEvent::handleEvent ( EventScheduler *  eventScheduler )

inlineoverridevirtual

Handle this event

Parameters

eventScheduler

Pointer to the EventScheduler handling this event

Implements pathplanner::Event.

---

The documentation for this class was generated from the following file:

• src/main/native/include/pathplanner/lib/events/TriggerEvent.h