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

#include <DrawingInterface.h>

Inherits openjaus::core::EventsInterface.

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

Public Member Functions
virtual	~DrawingInterface ()

virtual ReportDrawingDefinition	getReportDrawingDefinition (QueryDrawingDefinition *queryDrawingDefinition)=0
	send a report drawing definition message send a report drawing definition message More...

virtual ReportDataDefinition	getReportDataDefinition (QueryDataDefinition *queryDataDefinition)=0
	send a report data definition message send a report data definition message More...

virtual ReportData	getReportData (QueryData *queryData)=0
	send a report data message send a report data 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	DrawingService ()
	Builds a default instance of the Drawing Service and populates the URI and Version numbers. More...

static OPENJAUS_DEPRECATED std::string	DrawingUri ()
	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 Drawing Service allows remote assets to define a graphical output to an operator interface. A remote asset creates a Drawing Definition that it shall send to the operator interface. The Drawing Definition message consists of a series of commands that allow the remote asset to create a graphical representation and offer mechanisms for its control. Variable data can be represented in a Drawing Definition to allow the remote asset to update aspects of the display on the operator interface using a mechanism of Data Definition messages. Data Definition messages allow a remote asset to define a data structure that can be updated independent of the Drawing Definition. This may be used to update information such as joint angles reflecting the correct position and orientation displayed on the operator interface. Variable data is indicated within a Drawing Definition by the use of the Composite data type (section 3.2). A reference to a data structure element is substituted for the literal value if the Composite type has been set as variable data. A remote asset can then send Data messages that correspond with the Data Definition reference, allowing the operator interface to read the data and update the display accordingly. It is highly recommended that the operator interface creates an Event for the remote asset to send Report Drawing Definition and Report Data messages upon a change to receive any updates that may occur.

URI: % urn:jaus:jss:HMI:Drawing

Version: 1.0

Inherits From:

urn:jaus:jss:core:Events

Constructor & Destructor Documentation

§ ~DrawingInterface()

virtual openjaus::hmi::DrawingInterface::~DrawingInterface ( )

inlinevirtual

Member Function Documentation

§ DrawingService()

static OPENJAUS_DEPRECATED model::Service openjaus::hmi::DrawingInterface::DrawingService ( )

inlinestatic

Returns: model::Service - The populated service.

§ DrawingUri()

static OPENJAUS_DEPRECATED std::string openjaus::hmi::DrawingInterface::DrawingUri ( )

inlinestatic

Returns: std::string - Service URI

§ getReportData()

virtual ReportData openjaus::hmi::DrawingInterface::getReportData ( QueryData * queryData )

pure virtual

Parameters

[in] queryData - Input Trigger.

Returns: ReportData Output Message.

Implemented in openjaus::hmi::services::Drawing.

§ getReportDataDefinition()

virtual ReportDataDefinition openjaus::hmi::DrawingInterface::getReportDataDefinition ( QueryDataDefinition * queryDataDefinition )

pure virtual

Parameters

[in] queryDataDefinition - Input Trigger.

Returns: ReportDataDefinition Output Message.

Implemented in openjaus::hmi::services::Drawing.

§ getReportDrawingDefinition()

virtual ReportDrawingDefinition openjaus::hmi::DrawingInterface::getReportDrawingDefinition ( QueryDrawingDefinition * queryDrawingDefinition )

pure virtual

Parameters

[in] queryDrawingDefinition - Input Trigger.

Returns: ReportDrawingDefinition Output Message.

Implemented in openjaus::hmi::services::Drawing.

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

include/openjaus/hmi/DrawingInterface.h

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

§ ~DrawingInterface()

Member Function Documentation

§ DrawingService()

§ DrawingUri()

§ getReportData()

§ getReportDataDefinition()

§ getReportDrawingDefinition()