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

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

#include <VelocityStateSensorInterface.h>

Inherits openjaus::core::EventsInterface.

Inherited by openjaus::mobility::services::VelocityStateSensor [virtual].

Public Member Functions

virtual ~VelocityStateSensorInterface ()
 
virtual ReportVelocityState getReportVelocityState (QueryVelocityState *queryVelocityState)=0
 Send action for ReportVelocityState with input message QueryVelocityState. 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 VelocityStateSensorService ()
 Builds a default instance of the VelocityStateSensor Service and populates the URI and Version numbers. More...
 
static OPENJAUS_DEPRECATED std::string VelocityStateSensorUri ()
 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 Velocity State Sensor has the responsibility of reporting the instantaneous velocity of the platform. The velocity state of a rigid body is defined as the set of parameters that are necessary to calculate the velocity of any point in that rigid body. Six parameters are required to specify a velocity state of a rigid body in terms of some fixed reference coordinate system. The first three parameters represent the velocity components of a point in the rigid body that is coincident with the origin of the fixed reference. The second three components represent the instantaneous angular velocity components. It is possible to represent the six velocity state parameters as a screw, about which the rigid body is rotating and translating along at that instant. The reference frame for the velocity state sensor component is selected as a fixed coordinate system that at this instant is co-located with and aligned with the vehicle or system coordinate system. Thus the message data 'velocity x', 'velocity y', and 'velocity z' represents the current velocity of the subsystem's control point at this instant. For example if 'velocity x' has a value of 3 m/sec and 'velocity y' and 'velocity z' are zero, then the vehicle is moving in the forward direction at a velocity of 3 m/sec. The message data 'omega x', 'omega y', and 'omega z' represent the actual rate of change of orientation or angular velocity of the vehicle about its coordinate axes.



URI: urn:jaus:jss:mobility:VelocityStateSensor

Version: 1.0

Inherits From:

Constructor & Destructor Documentation

§ ~VelocityStateSensorInterface()

virtual openjaus::mobility::VelocityStateSensorInterface::~VelocityStateSensorInterface ( )
inlinevirtual

Member Function Documentation

§ getReportVelocityState()

virtual ReportVelocityState openjaus::mobility::VelocityStateSensorInterface::getReportVelocityState ( QueryVelocityState queryVelocityState)
pure virtual

Send action for ReportVelocityState with input message QueryVelocityState.

Parameters
[in]queryVelocityState- Input Trigger.
Returns
ReportVelocityState Output Message.

Implemented in openjaus::mobility::services::VelocityStateSensor.

§ VelocityStateSensorService()

static OPENJAUS_DEPRECATED model::Service openjaus::mobility::VelocityStateSensorInterface::VelocityStateSensorService ( )
inlinestatic
Returns
model::Service - The populated service.

§ VelocityStateSensorUri()

static OPENJAUS_DEPRECATED std::string openjaus::mobility::VelocityStateSensorInterface::VelocityStateSensorUri ( )
inlinestatic
Returns
std::string - Service URI

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