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

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

#include <AnalogControlInterface.h>

Inherits openjaus::core::EventsInterface.

Inherited by openjaus::hmi::services::AnalogControl [virtual].

Public Member Functions

virtual ~AnalogControlInterface ()
 
virtual ReportAnalogDevices getReportAnalogDevices (QueryAnalogDevices *queryAnalogDevices)=0
 send a report analog devices message send a report analog devices message More...
 
virtual ReportAnalogAction getReportAnalogAction (QueryAnalogAction *queryAnalogAction)=0
 send a report analog action message send a report analog action message More...
 
- Public Member Functions inherited from openjaus::core::EventsInterface
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 AnalogControlService ()
 Builds a default instance of the AnalogControl Service and populates the URI and Version numbers. More...
 
static OPENJAUS_DEPRECATED std::string AnalogControlUri ()
 Static accessor for Service URI. More...
 
- Static Public Member Functions inherited from openjaus::core::EventsInterface
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

The Analog Control Service is used to for the generation of analog operator interactions. Six fields represent the proportion of movement of an analog device in linear and rotational movement of the three cardinal axis. The Analog Control Service does not define co-ordinate systems. However, the interpretation of operator inputs shall assume the following orientation of movement. The longitudinal axis is positive in the forward direction, lateral movement is positive to the right and vertical movement is positive downwards. Rotational axial values increase in a clockwise direction when looking along the axis towards the greater positive value. Roll is rotation around the longitudinal axis, pitch around the lateral axis and yaw around the vertical axis. The remote asset may create an Event for the operator interface to send Report Analog Action messages. This event can either be upon a change or at a periodic frequency. Upon receipt of this event creation, the operator interface shall return Report Analog Action messages at the requested interval.



URI: urn:jaus:jss:HMI:AnalogControl

Version: 1.0

Inherits From:

Constructor & Destructor Documentation

§ ~AnalogControlInterface()

virtual openjaus::hmi::AnalogControlInterface::~AnalogControlInterface ( )
inlinevirtual

Member Function Documentation

§ AnalogControlService()

static OPENJAUS_DEPRECATED model::Service openjaus::hmi::AnalogControlInterface::AnalogControlService ( )
inlinestatic
Returns
model::Service - The populated service.

§ AnalogControlUri()

static OPENJAUS_DEPRECATED std::string openjaus::hmi::AnalogControlInterface::AnalogControlUri ( )
inlinestatic
Returns
std::string - Service URI

§ getReportAnalogAction()

virtual ReportAnalogAction openjaus::hmi::AnalogControlInterface::getReportAnalogAction ( QueryAnalogAction queryAnalogAction)
pure virtual
Parameters
[in]queryAnalogAction- Input Trigger.
Returns
ReportAnalogAction Output Message.

Implemented in openjaus::hmi::services::AnalogControl.

§ getReportAnalogDevices()

virtual ReportAnalogDevices openjaus::hmi::AnalogControlInterface::getReportAnalogDevices ( QueryAnalogDevices queryAnalogDevices)
pure virtual
Parameters
[in]queryAnalogDevices- Input Trigger.
Returns
ReportAnalogDevices Output Message.

Implemented in openjaus::hmi::services::AnalogControl.


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