EventPublishingInterface Class Referenceabstract

A publisher the server navigator will use to notify others about events. More...

#include <armarx/navigation/server/event_publishing/EventPublishingInterface.h>

+ Inheritance diagram for EventPublishingInterface:

Public Member Functions

virtual void globalPlanningFailed (const core::GlobalPlanningFailedEvent &event)=0
 
virtual void globalTrajectoryUpdated (const global_planning::GlobalPlannerResult &res)=0
 
virtual void goalReached (const core::GoalReachedEvent &event)=0
 Will be called whenever the navigator reached the goal. More...
 
virtual void internalError (const core::InternalErrorEvent &event)=0
 Will be called whenever an internal error occurs. More...
 
virtual void localPlanningFailed (const core::LocalPlanningFailedEvent &event)=0
 
virtual void localTrajectoryUpdated (const local_planning::LocalPlannerResult &res)=0
 
virtual void movementStarted (const core::MovementStartedEvent &event)=0
 
virtual void safetyStopTriggered (const core::SafetyStopTriggeredEvent &event)=0
 Will be called whenever a safety stop is triggered. More...
 
virtual void safetyThrottlingTriggered (const core::SafetyThrottlingTriggeredEvent &event)=0
 Will be called whenever safety throttling is triggered to a certain degree (configurable). More...
 
virtual void userAbortTriggered (const core::UserAbortTriggeredEvent &event)=0
 Will be called whenever the user aborts the current navigation. More...
 
virtual void waypointReached (const core::WaypointReachedEvent &event)=0
 Will be called whenever the navigator reached a user-defined waypoint. More...
 
virtual ~EventPublishingInterface ()=default
 

Detailed Description

A publisher the server navigator will use to notify others about events.

Definition at line 16 of file EventPublishingInterface.h.

Constructor & Destructor Documentation

◆ ~EventPublishingInterface()

virtual ~EventPublishingInterface ( )
virtualdefault

Member Function Documentation

◆ globalPlanningFailed()

virtual void globalPlanningFailed ( const core::GlobalPlanningFailedEvent event)
pure virtual

Implemented in SimpleEventHandler, and MemoryPublisher.

◆ globalTrajectoryUpdated()

virtual void globalTrajectoryUpdated ( const global_planning::GlobalPlannerResult res)
pure virtual

Implemented in MemoryPublisher, and SimpleEventHandler.

+ Here is the caller graph for this function:

◆ goalReached()

virtual void goalReached ( const core::GoalReachedEvent event)
pure virtual

Will be called whenever the navigator reached the goal.

Implemented in SimpleEventHandler, and MemoryPublisher.

+ Here is the caller graph for this function:

◆ internalError()

virtual void internalError ( const core::InternalErrorEvent event)
pure virtual

Will be called whenever an internal error occurs.

Implemented in SimpleEventHandler, and MemoryPublisher.

◆ localPlanningFailed()

virtual void localPlanningFailed ( const core::LocalPlanningFailedEvent event)
pure virtual

Implemented in SimpleEventHandler, and MemoryPublisher.

◆ localTrajectoryUpdated()

virtual void localTrajectoryUpdated ( const local_planning::LocalPlannerResult res)
pure virtual

Implemented in MemoryPublisher, and SimpleEventHandler.

◆ movementStarted()

virtual void movementStarted ( const core::MovementStartedEvent event)
pure virtual

Implemented in SimpleEventHandler, and MemoryPublisher.

◆ safetyStopTriggered()

virtual void safetyStopTriggered ( const core::SafetyStopTriggeredEvent event)
pure virtual

Will be called whenever a safety stop is triggered.

Implemented in SimpleEventHandler, and MemoryPublisher.

◆ safetyThrottlingTriggered()

virtual void safetyThrottlingTriggered ( const core::SafetyThrottlingTriggeredEvent event)
pure virtual

Will be called whenever safety throttling is triggered to a certain degree (configurable).

Implemented in SimpleEventHandler, and MemoryPublisher.

◆ userAbortTriggered()

virtual void userAbortTriggered ( const core::UserAbortTriggeredEvent event)
pure virtual

Will be called whenever the user aborts the current navigation.

Implemented in SimpleEventHandler, and MemoryPublisher.

◆ waypointReached()

virtual void waypointReached ( const core::WaypointReachedEvent event)
pure virtual

Will be called whenever the navigator reached a user-defined waypoint.

Implemented in SimpleEventHandler, and MemoryPublisher.


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