pathplanner::CancelCommandEvent Class Reference

Inheritance diagram for pathplanner::CancelCommandEvent:

Public Member Functions
	CancelCommandEvent (units::second_t timestamp, std::shared_ptr< frc2::Command > command)
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

CancelCommandEvent()

pathplanner::CancelCommandEvent::CancelCommandEvent ( units::second_t  timestamp, std::shared_ptr< frc2::Command >  command  )

inline

Create an event to cancel a command

Parameters

timestamp	The trajectory timestamp for this event
command	The command to cancel

Member Function Documentation

cancelEvent()

void pathplanner::CancelCommandEvent::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::CancelCommandEvent::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::CancelCommandEvent::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/CancelCommandEvent.h