OpenJAUS Software Development Kit  4.3.1
Public Member Functions | Static Public Member Functions | List of all members
openjaus::core::EventsInterface Class Referenceabstract

Provides an abstract interface for the Events service. More...

#include <EventsInterface.h>

Inherits openjaus::core::TransportInterface.

Inherited by openjaus::core::AccessControlInterface [virtual], openjaus::core::ConfigurationInterface [virtual], openjaus::core::DiscoveryClientInterface [virtual], openjaus::core::DiscoveryInterface [virtual], openjaus::core::LivenessInterface [virtual], openjaus::core::services::Events [virtual], openjaus::hmi::AnalogControlInterface [virtual], openjaus::hmi::DrawingInterface [virtual], openjaus::hmi::KeyboardInterface [virtual], openjaus::hmi::PointingDeviceInterface [virtual], openjaus::manipulator::ManipulatorJointForceTorqueSensorInterface [virtual], openjaus::manipulator::ManipulatorJointPositionSensorInterface [virtual], openjaus::manipulator::ManipulatorJointVelocitySensorInterface [virtual], openjaus::manipulator::PanTiltJointPositionSensorInterface [virtual], openjaus::manipulator::PanTiltJointVelocitySensorInterface [virtual], openjaus::mobility::AccelerationStateSensorInterface [virtual], openjaus::mobility::VelocityStateSensorInterface [virtual], and openjaus::ugv::PlatformSpecificationsInterface [virtual].

Public Member Functions

virtual ~EventsInterface ()
 
virtual bool createEvent (CreateEvent *createEvent)=0
 CreateEvent action with input CreateEvent. More...
 
virtual bool processEvent (ProcessEventRequest *processEventRequest)=0
 ProcessEvent action with input ProcessEventRequest. More...
 
virtual bool resetEventTimer (CreateEvent *createEvent)=0
 ResetEventTimer action with input CreateEvent. More...
 
virtual bool resetEventTimer (UpdateEvent *updateEvent)=0
 ResetEventTimer action with input UpdateEvent. More...
 
virtual bool updateEvent (CreateEvent *createEvent)=0
 UpdateEvent action with input CreateEvent. More...
 
virtual bool updateEvent (UpdateEvent *updateEvent)=0
 UpdateEvent action with input UpdateEvent. More...
 
virtual bool cancelEvent (CancelEvent *cancelEvent)=0
 CancelEvent action with input CancelEvent. More...
 
virtual bool stopEventTimer (CancelEvent *cancelEvent)=0
 StopEventTimer action with input CancelEvent. More...
 
virtual RejectEventRequest getRejectEventRequest (CreateEvent *createEvent)=0
 Send action for RejectEventRequest with input message CreateEvent. More...
 
virtual RejectEventRequest getRejectEventRequest (UpdateEvent *updateEvent)=0
 Send action for RejectEventRequest with input message UpdateEvent. More...
 
virtual RejectEventRequest getRejectEventRequest (CancelEvent *cancelEvent)=0
 Send action for RejectEventRequest with input message CancelEvent. More...
 
virtual ConfirmEventRequest getConfirmEventRequest (CreateEvent *createEvent)=0
 Send action for ConfirmEventRequest with input message CreateEvent. More...
 
virtual ConfirmEventRequest getConfirmEventRequest (UpdateEvent *updateEvent)=0
 Send action for ConfirmEventRequest with input message UpdateEvent. More...
 
virtual ConfirmEventRequest getConfirmEventRequest (CancelEvent *cancelEvent)=0
 Send action for ConfirmEventRequest with input message CancelEvent. More...
 
virtual ReportEvents getReportEvents (QueryEvents *queryEvents)=0
 Send action for ReportEvents with input message QueryEvents. More...
 
virtual ReportEventTimeout getReportEventTimeout (QueryEventTimeout *queryEventTimeout)=0
 Send action for ReportEventTimeout with input message QueryEventTimeout. More...
 
virtual bool confirmEvent (ConfirmEventRequest *confirmEventRequest)=0
 ConfirmEvent action with input ConfirmEventRequest. More...
 
virtual bool rejectEvent (RejectEventRequest *rejectEventRequest)=0
 RejectEvent action with input RejectEventRequest. More...
 
virtual bool handleIncomingEvent (Event *event)=0
 HandleIncomingEvent action with input Event. More...
 
virtual bool handleReportEvents (ReportEvents *reportEvents)=0
 HandleReportEvents action with input ReportEvents. More...
 
virtual bool isSupported (CreateEvent *createEvent)=0
 isSupported condition. More...
 
virtual bool isSupported (UpdateEvent *updateEvent)=0
 isSupported condition. More...
 
virtual bool eventExists (CreateEvent *createEvent)=0
 eventExists condition. More...
 
virtual bool eventExists (UpdateEvent *updateEvent)=0
 eventExists condition. More...
 
virtual bool eventExists (CancelEvent *cancelEvent)=0
 eventExists condition. More...
 
- Public Member Functions inherited from openjaus::core::TransportInterface
virtual ~TransportInterface ()
 
virtual bool enqueue (model::Trigger *trigger)=0
 Convert the destination address into an unsigned integer such that the ComponentID maps to the least significant byte, NodeID to the next least significant byte and SubsystemID maps onto the remaining two bytes of the integer. More...
 
virtual bool broadcastLocalEnqueue (model::Trigger *trigger)=0
 Package the message as specified by the transport layer specification and send it to all endpoints in the local subsystem. More...
 
virtual bool broadcastGlobalEnqueue (model::Trigger *trigger)=0
 Package the message as specified by the transport layer specification and send it to all endpoints on all subsystems. More...
 
virtual bool sendMessage (model::Trigger *trigger)=0
 SendMessage action with input SendMessage. More...
 
virtual bool broadcastToNode (model::Trigger *trigger)=0
 Broadcasts message to all components within the local node Broadcasts message to all components within the local node. More...
 
virtual bool broadcastToSubsystem (model::Trigger *trigger)=0
 Broadcasts a given message to all nodes in the local subsystem (equivalent to broadcast local enqueue) Broadcasts a given message to all nodes in the local subsystem (equivalent to broadcast local enqueue) More...
 
virtual bool broadcastToSystem (model::Trigger *trigger)=0
 Broadcasts the message to all subsystems on the JAUS network (equivalent to broadcast global enqueue) Broadcasts the message to all subsystems on the JAUS network (equivalent to broadcast global enqueue) More...
 
virtual bool checkTransportPolicy (model::Trigger *trigger)=0
 CheckTransportPolicy action with input CheckTransportPolicy. More...
 
virtual ReportTransportPolicy getReportTransportPolicy (QueryTransportPolicy *queryTransportPolicy)=0
 Send action for ReportTransportPolicy with input message QueryTransportPolicy. More...
 
virtual bool storeTransportPolicy (ReportTransportPolicy *reportTransportPolicy)=0
 StoreTransportPolicy action with input ReportTransportPolicy. More...
 

Static Public Member Functions

static OPENJAUS_DEPRECATED model::Service EventsService ()
 Builds a default instance of the Events Service and populates the URI and Version numbers. More...
 
static OPENJAUS_DEPRECATED std::string EventsUri ()
 Static accessor for Service URI. More...
 
- Static Public Member Functions inherited from openjaus::core::TransportInterface
static OPENJAUS_DEPRECATED model::Service TransportService ()
 Builds a default instance of the Transport Service and populates the URI and Version numbers. More...
 
static OPENJAUS_DEPRECATED std::string TransportUri ()
 Static accessor for Service URI. More...
 

Detailed Description

This service is used to set up event notifications. Since this service does not contain any messages and data on which events can be setup, it is useful only when derived by other services that contain messages and data on which events can be defined.



URI: urn:jaus:jss:core:Events

Version: 1.1

Inherits From:

Constructor & Destructor Documentation

§ ~EventsInterface()

virtual openjaus::core::EventsInterface::~EventsInterface ( )
inlinevirtual

Member Function Documentation

§ cancelEvent()

virtual bool openjaus::core::EventsInterface::cancelEvent ( CancelEvent *  cancelEvent)
pure virtual

CancelEvent action with input CancelEvent.

Parameters
[in]cancelEvent- Input Trigger.
Returns
Whether the message was properly processed by this action.

Implemented in openjaus::core::services::Events.

§ confirmEvent()

virtual bool openjaus::core::EventsInterface::confirmEvent ( ConfirmEventRequest *  confirmEventRequest)
pure virtual

ConfirmEvent action with input ConfirmEventRequest.

Parameters
[in]confirmEventRequest- Input Trigger.
Returns
Whether the message was properly processed by this action.

Implemented in openjaus::core::services::Events.

§ createEvent()

virtual bool openjaus::core::EventsInterface::createEvent ( CreateEvent *  createEvent)
pure virtual

CreateEvent action with input CreateEvent.

Parameters
[in]createEvent- Input Trigger.
Returns
Whether the message was properly processed by this action.

Implemented in openjaus::core::services::Events.

§ eventExists() [1/3]

virtual bool openjaus::core::EventsInterface::eventExists ( CreateEvent *  createEvent)
pure virtual

eventExists condition.

Parameters
[in]createEvent- Input Trigger.
Returns
Whether the condition is true.

Implemented in openjaus::core::services::Events.

§ eventExists() [2/3]

virtual bool openjaus::core::EventsInterface::eventExists ( UpdateEvent *  updateEvent)
pure virtual

eventExists condition.

Parameters
[in]updateEvent- Input Trigger.
Returns
Whether the condition is true.

Implemented in openjaus::core::services::Events.

§ eventExists() [3/3]

virtual bool openjaus::core::EventsInterface::eventExists ( CancelEvent *  cancelEvent)
pure virtual

eventExists condition.

Parameters
[in]cancelEvent- Input Trigger.
Returns
Whether the condition is true.

Implemented in openjaus::core::services::Events.

§ EventsService()

static OPENJAUS_DEPRECATED model::Service openjaus::core::EventsInterface::EventsService ( )
inlinestatic
Returns
model::Service - The populated service.

§ EventsUri()

static OPENJAUS_DEPRECATED std::string openjaus::core::EventsInterface::EventsUri ( )
inlinestatic
Returns
std::string - Service URI

§ getConfirmEventRequest() [1/3]

virtual ConfirmEventRequest openjaus::core::EventsInterface::getConfirmEventRequest ( CreateEvent *  createEvent)
pure virtual

Send action for ConfirmEventRequest with input message CreateEvent.

Parameters
[in]createEvent- Input Trigger.
Returns
ConfirmEventRequest Output Message.

Implemented in openjaus::core::services::Events.

§ getConfirmEventRequest() [2/3]

virtual ConfirmEventRequest openjaus::core::EventsInterface::getConfirmEventRequest ( UpdateEvent *  updateEvent)
pure virtual

Send action for ConfirmEventRequest with input message UpdateEvent.

Parameters
[in]updateEvent- Input Trigger.
Returns
ConfirmEventRequest Output Message.

Implemented in openjaus::core::services::Events.

§ getConfirmEventRequest() [3/3]

virtual ConfirmEventRequest openjaus::core::EventsInterface::getConfirmEventRequest ( CancelEvent *  cancelEvent)
pure virtual

Send action for ConfirmEventRequest with input message CancelEvent.

Parameters
[in]cancelEvent- Input Trigger.
Returns
ConfirmEventRequest Output Message.

Implemented in openjaus::core::services::Events.

§ getRejectEventRequest() [1/3]

virtual RejectEventRequest openjaus::core::EventsInterface::getRejectEventRequest ( CreateEvent *  createEvent)
pure virtual

Send action for RejectEventRequest with input message CreateEvent.

Parameters
[in]createEvent- Input Trigger.
Returns
RejectEventRequest Output Message.

Implemented in openjaus::core::services::Events.

§ getRejectEventRequest() [2/3]

virtual RejectEventRequest openjaus::core::EventsInterface::getRejectEventRequest ( UpdateEvent *  updateEvent)
pure virtual

Send action for RejectEventRequest with input message UpdateEvent.

Parameters
[in]updateEvent- Input Trigger.
Returns
RejectEventRequest Output Message.

Implemented in openjaus::core::services::Events.

§ getRejectEventRequest() [3/3]

virtual RejectEventRequest openjaus::core::EventsInterface::getRejectEventRequest ( CancelEvent *  cancelEvent)
pure virtual

Send action for RejectEventRequest with input message CancelEvent.

Parameters
[in]cancelEvent- Input Trigger.
Returns
RejectEventRequest Output Message.

Implemented in openjaus::core::services::Events.

§ getReportEvents()

virtual ReportEvents openjaus::core::EventsInterface::getReportEvents ( QueryEvents *  queryEvents)
pure virtual

Send action for ReportEvents with input message QueryEvents.

Parameters
[in]queryEvents- Input Trigger.
Returns
ReportEvents Output Message.

Implemented in openjaus::core::services::Events.

§ getReportEventTimeout()

virtual ReportEventTimeout openjaus::core::EventsInterface::getReportEventTimeout ( QueryEventTimeout *  queryEventTimeout)
pure virtual

Send action for ReportEventTimeout with input message QueryEventTimeout.

Parameters
[in]queryEventTimeout- Input Trigger.
Returns
ReportEventTimeout Output Message.

Implemented in openjaus::core::services::Events.

§ handleIncomingEvent()

virtual bool openjaus::core::EventsInterface::handleIncomingEvent ( Event *  event)
pure virtual

HandleIncomingEvent action with input Event.

Parameters
[in]event- Input Trigger.
Returns
Whether the message was properly processed by this action.

Implemented in openjaus::core::services::Events.

§ handleReportEvents()

virtual bool openjaus::core::EventsInterface::handleReportEvents ( ReportEvents *  reportEvents)
pure virtual

HandleReportEvents action with input ReportEvents.

Parameters
[in]reportEvents- Input Trigger.
Returns
Whether the message was properly processed by this action.

Implemented in openjaus::core::services::Events.

§ isSupported() [1/2]

virtual bool openjaus::core::EventsInterface::isSupported ( CreateEvent *  createEvent)
pure virtual

isSupported condition.

Parameters
[in]createEvent- Input Trigger.
Returns
Whether the condition is true.

Implemented in openjaus::core::services::Events.

§ isSupported() [2/2]

virtual bool openjaus::core::EventsInterface::isSupported ( UpdateEvent *  updateEvent)
pure virtual

isSupported condition.

Parameters
[in]updateEvent- Input Trigger.
Returns
Whether the condition is true.

Implemented in openjaus::core::services::Events.

§ processEvent()

virtual bool openjaus::core::EventsInterface::processEvent ( ProcessEventRequest *  processEventRequest)
pure virtual

ProcessEvent action with input ProcessEventRequest.

Parameters
[in]processEventRequest- Input Trigger.
Returns
Whether the message was properly processed by this action.

Implemented in openjaus::core::services::Events.

§ rejectEvent()

virtual bool openjaus::core::EventsInterface::rejectEvent ( RejectEventRequest *  rejectEventRequest)
pure virtual

RejectEvent action with input RejectEventRequest.

Parameters
[in]rejectEventRequest- Input Trigger.
Returns
Whether the message was properly processed by this action.

Implemented in openjaus::core::services::Events.

§ resetEventTimer() [1/2]

virtual bool openjaus::core::EventsInterface::resetEventTimer ( CreateEvent *  createEvent)
pure virtual

ResetEventTimer action with input CreateEvent.

Parameters
[in]createEvent- Input Trigger.
Returns
Whether the message was properly processed by this action.

Implemented in openjaus::core::services::Events.

§ resetEventTimer() [2/2]

virtual bool openjaus::core::EventsInterface::resetEventTimer ( UpdateEvent *  updateEvent)
pure virtual

ResetEventTimer action with input UpdateEvent.

Parameters
[in]updateEvent- Input Trigger.
Returns
Whether the message was properly processed by this action.

Implemented in openjaus::core::services::Events.

§ stopEventTimer()

virtual bool openjaus::core::EventsInterface::stopEventTimer ( CancelEvent *  cancelEvent)
pure virtual

StopEventTimer action with input CancelEvent.

Parameters
[in]cancelEvent- Input Trigger.
Returns
Whether the message was properly processed by this action.

Implemented in openjaus::core::services::Events.

§ updateEvent() [1/2]

virtual bool openjaus::core::EventsInterface::updateEvent ( CreateEvent *  createEvent)
pure virtual

UpdateEvent action with input CreateEvent.

Parameters
[in]createEvent- Input Trigger.
Returns
Whether the message was properly processed by this action.

Implemented in openjaus::core::services::Events.

§ updateEvent() [2/2]

virtual bool openjaus::core::EventsInterface::updateEvent ( UpdateEvent *  updateEvent)
pure virtual

UpdateEvent action with input UpdateEvent.

Parameters
[in]updateEvent- Input Trigger.
Returns
Whether the message was properly processed by this action.

Implemented in openjaus::core::services::Events.

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