Inheritance diagram for pathplanner::OneShotTriggerEvent:

Public Member Functions
	OneShotTriggerEvent (units::second_t timestamp, std::string name)

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

◆ OneShotTriggerEvent()

pathplanner::OneShotTriggerEvent::OneShotTriggerEvent	(	units::second_t	timestamp,
		std::string	name
	)

inline

Create an event for activating a trigger, then deactivating it the next loop

Parameters

timestamp	The trajectory timestamp of this event
name	The name of the trigger to control

void pathplanner::OneShotTriggerEvent::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

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

inlineoverridevirtual

Copy this event with a different timestamp

Parameters

timestamp The new timestamp

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

inlineoverridevirtual

Handle this event

Parameters

eventScheduler Pointer to the EventScheduler handling this event

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