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

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

#include <AnalogVideoInterface.h>

Inherits openjaus::environment::VisualSensorInterface.

Inherited by openjaus::environment::services::AnalogVideo [virtual].

Public Member Functions

virtual ~AnalogVideoInterface ()
 
virtual ReportAnalogVideoSensorCapabilities getReportAnalogVideoSensorCapabilities (QueryAnalogVideoSensorCapabilities *queryAnalogVideoSensorCapabilities)=0
 Send a ReportAnalogVideoSensorCapabilities message Send a ReportAnalogVideoSensorCapabilities message. More...
 
virtual bool updateAnalogVideoSensorConfiguration (SetAnalogVideoSensorConfiguration *setAnalogVideoSensorConfiguration)=0
 Update the sensor user controllable configuration parameters according to the ones specified. More...
 
virtual ConfirmAnalogVideoSensorConfiguration getConfirmAnalogVideoSensorConfiguration (SetAnalogVideoSensorConfiguration *setAnalogVideoSensorConfiguration)=0
 Send sendConfirmAnalogVideoSensorConfiguration message Send sendConfirmAnalogVideoSensorConfiguration message. More...
 
virtual ReportAnalogVideoSensorConfiguration getReportAnalogVideoSensorConfiguration (QueryAnalogVideoSensorConfiguration *queryAnalogVideoSensorConfiguration)=0
 Send a ReportAnalogVideoSensorConfiguration message Send a ReportAnalogVideoSensorConfiguration message. More...
 
- Public Member Functions inherited from openjaus::environment::VisualSensorInterface
virtual ~VisualSensorInterface ()
 
virtual ReportVisualSensorGeometricProperties getReportVisualSensorGeometricProperties (QueryVisualSensorGeometricProperties *queryVisualSensorGeometricProperties)=0
 Send a ReportVisualSensorGeometricProperties message Send a ReportVisualSensorGeometricProperties message. More...
 
virtual ConfirmVisualSensorConfiguration getConfirmVisualSensorConfiguration (SetVisualSensorConfiguration *setVisualSensorConfiguration)=0
 Send sendConfirmVisualSensorConfiguration message Send sendConfirmVisualSensorConfiguration message. More...
 
virtual ReportVisualSensorConfiguration getReportVisualSensorConfiguration (QueryVisualSensorConfiguration *queryVisualSensorConfiguration)=0
 Send a ReportVisualSensorConfiguration message Send a ReportVisualSensorConfiguration message. More...
 
virtual bool updateVisualSensorConfiguration (SetVisualSensorConfiguration *setVisualSensorConfiguration)=0
 Update the sensor user controllable configuration parameters according to the ones specified. More...
 
virtual ReportVisualSensorCapabilities getReportVisualSensorCapabilities (QueryVisualSensorCapabilities *queryVisualSensorCapabilities)=0
 Send a ReportVisualSensorCapabilities message Send a ReportVisualSensorCapabilities message. More...
 
- Public Member Functions inherited from openjaus::core::AccessControlInterface
virtual ~AccessControlInterface ()
 
virtual void init ()=0
 
virtual void rejectController ()=0
 
virtual ReportControl getReportControl (QueryControl *queryControl)=0
 Send a Report Control message with the specified control value Send a Report Control message with the specified control value. More...
 
virtual ReportAuthority getReportAuthority (QueryAuthority *queryAuthority)=0
 Send a Report Authority message to querying client reporting the current authority value of this service Send a Report Authority message to querying client reporting the current authority value of this service. More...
 
virtual ReportTimeout getReportTimeout (QueryTimeout *queryTimeout)=0
 Send a Report Timeout message specifying the timeout period of this service Send a Report Timeout message specifying the timeout period of this service. More...
 
virtual bool setAuthority (RequestControl *requestControl)=0
 Set the current authority value of this service to the specified authority Set the current authority value of this service to the specified authority. More...
 
virtual bool setAuthority (SetAuthority *setAuthority)=0
 Set the current authority value of this service to the specified authority Set the current authority value of this service to the specified authority. More...
 
virtual bool resetTimer (RequestControl *requestControl)=0
 Reset the timer Reset the timer. More...
 
virtual bool sendConfirmControlNotAvailable (RequestControl *requestControl)=0
 Send a confirm control message with the specified response code to requesting client Send a confirm control message with the specified response code to requesting client. More...
 
virtual bool sendConfirmControlInsufficientAuthority (RequestControl *requestControl)=0
 Send a confirm control message with the specified response code to requesting client Send a confirm control message with the specified response code to requesting client. More...
 
virtual bool sendConfirmControlAccepted (RequestControl *requestControl)=0
 Send a confirm control message with the specified response code to requesting client Send a confirm control message with the specified response code to requesting client. More...
 
virtual bool sendRejectControlToController (RequestControl *requestControl)=0
 SendRejectControlToController action with input RequestControl. More...
 
virtual bool sendRejectControlNotAvailable (ReleaseControl *releaseControl)=0
 SendRejectControlNotAvailable action with input ReleaseControl. More...
 
virtual bool sendRejectControlReleased (ReleaseControl *releaseControl)=0
 SendRejectControlReleased action with input ReleaseControl. More...
 
virtual bool sendRejectControlReleased (DismissController *dismissController)=0
 SendRejectControlReleased action with input DismissController. More...
 
virtual bool storeAddress (RequestControl *requestControl)=0
 StoreAddress action with input RequestControl. More...
 
virtual bool updateControlledList (ConfirmControl *confirmControl)=0
 Modifies list of controlled components based on confirm or reject messages Modifies list of controlled components based on confirm or reject messages. More...
 
virtual bool updateControlledList (RejectControl *rejectControl)=0
 Modifies list of controlled components based on confirm or reject messages Modifies list of controlled components based on confirm or reject messages. More...
 
virtual bool isDefaultAuthorityGreater (RequestControl *requestControl)=0
 True if the default authority code of this service is greater than the authority code of the client service that triggered the corresponding transition True if the default authority code of this service is greater than the authority code of the client service that triggered the corresponding transition. More...
 
virtual bool isCurrentAuthorityLess (RequestControl *requestControl)=0
 True if the current authority value of this service is less than the authority code of the client service that triggered the corresponding transition True if the current authority value of this service is less than the authority code of the client service that triggered the corresponding transition. More...
 
virtual bool isAuthorityValid (SetAuthority *setAuthority)=0
 True if the value of the authority code received from the client is less than or equal to the current authority value of this service, but greater than or equal to the receiving componentís default authority True if the value of the authority code received from the client is less than or equal to the current authority value of this service, but greater than or equal to the receiving componentís default authority. More...
 
virtual bool isControllingClient (model::Message *message)=0
 True if the message that triggered the transition is received from the client that is in control of this service True if the message that triggered the transition is received from the client that is in control of this service. 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 AnalogVideoService ()
 Builds a default instance of the AnalogVideo Service and populates the URI and Version numbers. More...
 
static OPENJAUS_DEPRECATED std::string AnalogVideoUri ()
 Static accessor for Service URI. More...
 
- Static Public Member Functions inherited from openjaus::environment::VisualSensorInterface
static OPENJAUS_DEPRECATED model::Service VisualSensorService ()
 Builds a default instance of the VisualSensor Service and populates the URI and Version numbers. More...
 
static OPENJAUS_DEPRECATED std::string VisualSensorUri ()
 Static accessor for Service URI. More...
 
- Static Public Member Functions inherited from openjaus::core::AccessControlInterface
static OPENJAUS_DEPRECATED model::Service AccessControlService ()
 Builds a default instance of the AccessControl Service and populates the URI and Version numbers. More...
 
static OPENJAUS_DEPRECATED std::string AccessControlUri ()
 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

This service provides access to the capabilities and configuration of the analog visual sensor, allowing the controlling component to set the visual sensor to a particular operational profile. The actual transmission of the video stream is outside the scope of this service.



URI: urn:jaus:jss:environmentSensing:AnalogVideo

Version: 1.0

Inherits From:

Constructor & Destructor Documentation

§ ~AnalogVideoInterface()

virtual openjaus::environment::AnalogVideoInterface::~AnalogVideoInterface ( )
inlinevirtual

Member Function Documentation

§ AnalogVideoService()

static OPENJAUS_DEPRECATED model::Service openjaus::environment::AnalogVideoInterface::AnalogVideoService ( )
inlinestatic
Returns
model::Service - The populated service.

§ AnalogVideoUri()

static OPENJAUS_DEPRECATED std::string openjaus::environment::AnalogVideoInterface::AnalogVideoUri ( )
inlinestatic
Returns
std::string - Service URI

§ getConfirmAnalogVideoSensorConfiguration()

virtual ConfirmAnalogVideoSensorConfiguration openjaus::environment::AnalogVideoInterface::getConfirmAnalogVideoSensorConfiguration ( SetAnalogVideoSensorConfiguration setAnalogVideoSensorConfiguration)
pure virtual
Parameters
[in]setAnalogVideoSensorConfiguration- Input Trigger.
Returns
ConfirmAnalogVideoSensorConfiguration Output Message.

Implemented in openjaus::environment::services::AnalogVideo.

§ getReportAnalogVideoSensorCapabilities()

virtual ReportAnalogVideoSensorCapabilities openjaus::environment::AnalogVideoInterface::getReportAnalogVideoSensorCapabilities ( QueryAnalogVideoSensorCapabilities queryAnalogVideoSensorCapabilities)
pure virtual
Parameters
[in]queryAnalogVideoSensorCapabilities- Input Trigger.
Returns
ReportAnalogVideoSensorCapabilities Output Message.

Implemented in openjaus::environment::services::AnalogVideo.

§ getReportAnalogVideoSensorConfiguration()

virtual ReportAnalogVideoSensorConfiguration openjaus::environment::AnalogVideoInterface::getReportAnalogVideoSensorConfiguration ( QueryAnalogVideoSensorConfiguration queryAnalogVideoSensorConfiguration)
pure virtual
Parameters
[in]queryAnalogVideoSensorConfiguration- Input Trigger.
Returns
ReportAnalogVideoSensorConfiguration Output Message.

Implemented in openjaus::environment::services::AnalogVideo.

§ updateAnalogVideoSensorConfiguration()

virtual bool openjaus::environment::AnalogVideoInterface::updateAnalogVideoSensorConfiguration ( SetAnalogVideoSensorConfiguration setAnalogVideoSensorConfiguration)
pure virtual

Update the sensor user controllable configuration parameters according to the ones specified.

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

Implemented in openjaus::environment::services::AnalogVideo.


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