Provides static methods for the VisualSensor service. More...

#include <VisualSensor.h>

Inherits openjaus::environment::VisualSensorInterface, and openjaus::core::services::AccessControl.

Inherited by openjaus::environment::AnalogVideoSensor [virtual], openjaus::environment::DigitalVideoSensor [virtual], openjaus::environment::services::AnalogVideo [virtual], openjaus::environment::services::DigitalVideo [virtual], openjaus::environment::services::StillImage [virtual], and openjaus::environment::StillImageSensor [virtual].

Public Member Functions
	VisualSensor ()

virtual	~VisualSensor ()

virtual ReportVisualSensorGeometricProperties	getReportVisualSensorGeometricProperties (QueryVisualSensorGeometricProperties *queryVisualSensorGeometricProperties)
	Send a ReportVisualSensorGeometricProperties message Send a ReportVisualSensorGeometricProperties message. More...

virtual ConfirmVisualSensorConfiguration	getConfirmVisualSensorConfiguration (SetVisualSensorConfiguration *setVisualSensorConfiguration)
	Send sendConfirmVisualSensorConfiguration message Send sendConfirmVisualSensorConfiguration message. More...

virtual ReportVisualSensorConfiguration	getReportVisualSensorConfiguration (QueryVisualSensorConfiguration *queryVisualSensorConfiguration)
	Send a ReportVisualSensorConfiguration message Send a ReportVisualSensorConfiguration message. More...

virtual bool	updateVisualSensorConfiguration (SetVisualSensorConfiguration *setVisualSensorConfiguration)
	Update the sensor user controllable configuration parameters according to the ones specified. More...

virtual ReportVisualSensorCapabilities	getReportVisualSensorCapabilities (QueryVisualSensorCapabilities *queryVisualSensorCapabilities)
	Send a ReportVisualSensorCapabilities message Send a ReportVisualSensorCapabilities message. More...

Public Member Functions inherited from openjaus::environment::VisualSensorInterface
virtual	~VisualSensorInterface ()

Public Member Functions inherited from openjaus::core::AccessControlInterface
virtual	~AccessControlInterface ()

Public Member Functions inherited from openjaus::core::EventsInterface
virtual	~EventsInterface ()

Public Member Functions inherited from openjaus::core::TransportInterface
virtual	~TransportInterface ()

Public Member Functions inherited from openjaus::core::services::AccessControl
	AccessControl ()

virtual	~AccessControl ()

virtual void	init ()

virtual void	rejectController ()

virtual ReportControl	getReportControl (QueryControl *queryControl)
	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)
	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)
	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)
	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)
	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)
	Reset the timer Reset the timer. More...

virtual bool	sendConfirmControlNotAvailable (RequestControl *requestControl)
	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)
	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)
	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)
	SendRejectControlToController action with input RequestControl. More...

virtual bool	sendRejectControlNotAvailable (ReleaseControl *releaseControl)
	SendRejectControlNotAvailable action with input ReleaseControl. More...

virtual bool	sendRejectControlReleased (ReleaseControl *releaseControl)
	SendRejectControlReleased action with input ReleaseControl. More...

virtual bool	sendRejectControlReleased (DismissController *dismissController)
	SendRejectControlReleased action with input DismissController. More...

virtual bool	storeAddress (RequestControl *requestControl)
	StoreAddress action with input RequestControl. More...

virtual bool	updateControlledList (ConfirmControl *confirmControl)
	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)
	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)
	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)
	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)
	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)
	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...

void	requestControl (transport::Address destination, void(*responseCallback)(const model::ControlResponse &response)=NULL)

void	requestControl (transport::Address destination, void(functionPointer)(void object, const model::ControlResponse &response), void *object)

void	releaseControl (transport::Address destination, void(*responseCallback)(const model::ControlResponse &response)=NULL)

void	releaseControl (transport::Address destination, void(functionPointer)(void object, const model::ControlResponse &response), void *object)

void	dismissController ()

Public Member Functions inherited from openjaus::core::services::Events
	Events ()

virtual	~Events ()

virtual bool	createEvent (CreateEvent *createEvent)
	CreateEvent action with input CreateEvent. More...

virtual bool	processEvent (ProcessEventRequest *processEventRequest)
	ProcessEvent action with input ProcessEventRequest. More...

virtual bool	resetEventTimer (CreateEvent *createEvent)
	ResetEventTimer action with input CreateEvent. More...

virtual bool	resetEventTimer (UpdateEvent *updateEvent)
	ResetEventTimer action with input UpdateEvent. More...

virtual bool	updateEvent (CreateEvent *createEvent)
	UpdateEvent action with input CreateEvent. More...

virtual bool	updateEvent (UpdateEvent *updateEvent)
	UpdateEvent action with input UpdateEvent. More...

virtual bool	cancelEvent (CancelEvent *cancelEvent)
	CancelEvent action with input CancelEvent. More...

virtual bool	stopEventTimer (CancelEvent *cancelEvent)
	StopEventTimer action with input CancelEvent. More...

virtual RejectEventRequest	getRejectEventRequest (CreateEvent *createEvent)
	Send action for RejectEventRequest with input message CreateEvent. More...

virtual RejectEventRequest	getRejectEventRequest (UpdateEvent *updateEvent)
	Send action for RejectEventRequest with input message UpdateEvent. More...

virtual RejectEventRequest	getRejectEventRequest (CancelEvent *cancelEvent)
	Send action for RejectEventRequest with input message CancelEvent. More...

virtual ConfirmEventRequest	getConfirmEventRequest (CreateEvent *createEvent)
	Send action for ConfirmEventRequest with input message CreateEvent. More...

virtual ConfirmEventRequest	getConfirmEventRequest (UpdateEvent *updateEvent)
	Send action for ConfirmEventRequest with input message UpdateEvent. More...

virtual ConfirmEventRequest	getConfirmEventRequest (CancelEvent *cancelEvent)
	Send action for ConfirmEventRequest with input message CancelEvent. More...

virtual ReportEvents	getReportEvents (QueryEvents *queryEvents)
	Send action for ReportEvents with input message QueryEvents. More...

virtual ReportEventTimeout	getReportEventTimeout (QueryEventTimeout *queryEventTimeout)
	Send action for ReportEventTimeout with input message QueryEventTimeout. More...

virtual bool	confirmEvent (ConfirmEventRequest *confirmEventRequest)
	ConfirmEvent action with input ConfirmEventRequest. More...

virtual bool	rejectEvent (RejectEventRequest *rejectEventRequest)
	RejectEvent action with input RejectEventRequest. More...

virtual bool	handleIncomingEvent (Event *event)
	HandleIncomingEvent action with input Event. More...

virtual bool	handleReportEvents (ReportEvents *reportEvents)
	HandleReportEvents action with input ReportEvents. More...

virtual bool	isSupported (CreateEvent *createEvent)
	isSupported condition. More...

virtual bool	isSupported (UpdateEvent *updateEvent)
	isSupported condition. More...

virtual bool	eventExists (CreateEvent *createEvent)
	eventExists condition. More...

virtual bool	eventExists (UpdateEvent *updateEvent)
	eventExists condition. More...

virtual bool	eventExists (CancelEvent *cancelEvent)
	eventExists condition. More...

bool	createOutgoingPeriodicEvent (uint8_t eventId, double rateHz, model::Message *query)

bool	createOutgoingOnChangeEvent (uint8_t eventId, model::Message *query)

OPENJAUS_DEPRECATED bool	publish (model::Message *message)

OPENJAUS_DEPRECATED bool	unpublish (model::Message *message)

OPENJAUS_DEPRECATED bool	publish (uint16 messageId)

bool	publish (uint16 messageId, double maximumRate_Hz, model::ConnectionType type)

bool	unpublish (uint16 messageId)

bool	notifyChanged (uint16 messageId)

uint32_t	subscribePeriodic (transport::Address &address, model::Message *query, double rate_Hz)

uint32_t	subscribePeriodic (transport::Address &address, model::Message query, double rate_Hz, void(subscribeCallback)(const model::EventRequestResponseArgs &args))

uint32_t	subscribePeriodic (transport::Address &address, model::Message query, double rate_Hz, void(subscribeCallback)(void object, const model::EventRequestResponseArgs &args), void object)

uint32_t	subscribeOnChange (transport::Address &address, model::Message *query)

uint32_t	subscribeOnChange (transport::Address &address, model::Message query, void(subscribeCallback)(const model::EventRequestResponseArgs &args))

uint32_t	subscribeOnChange (transport::Address &address, model::Message query, void(subscribeCallback)(void object, const model::EventRequestResponseArgs &args), void object)

bool	unsubscribe (uint32_t subscriptionId)

bool	unsubscribe (uint32_t subscriptionId, void(*callback)(const model::EventRequestResponseArgs &args))

bool	unsubscribe (uint32_t subscriptionId, void(callback)(void object, const model::EventRequestResponseArgs &args), void *object)

bool	isActive (uint32 subscriptionId)

uint8	getEventId (uint32 subscriptionId)

double	getConfirmedRate_Hz (uint32 subscriptionId)

bool	updatePeriodic (uint32 subscriptionId, double rate_Hz)

Public Member Functions inherited from openjaus::core::services::Transport
	Transport ()

virtual	~Transport ()

virtual bool	enqueue (model::Trigger *trigger)
	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)
	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)
	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)
	SendMessage action with input SendMessage. More...

virtual bool	broadcastToNode (model::Trigger *trigger)
	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)
	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)
	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)
	CheckTransportPolicy action with input CheckTransportPolicy. More...

virtual ReportTransportPolicy	getReportTransportPolicy (QueryTransportPolicy *queryTransportPolicy)
	Send action for ReportTransportPolicy with input message QueryTransportPolicy. More...

virtual bool	storeTransportPolicy (ReportTransportPolicy *reportTransportPolicy)
	StoreTransportPolicy action with input ReportTransportPolicy. More...

model::State *	getCurrentState ()

void	addAckNakCallback (void(*callback)(const transport::AckNakEventArgs &args))
	Adds a static callback that will execute when an ACK/NAK events occurs on the JUDP Interface. More...

void	addAckNakCallback (void(callback)(void object, const transport::AckNakEventArgs &args), void *object)
	Adds a class callback that will execute when an ACK/NAK events occurs on the JUDP Interface. More...

template<class MessageType , class CallbackClass >
void	addMessageCallback (bool(CallbackClass::callback)(MessageType &messageRef), CallbackClass object)

template<class CallbackClass >
void	addMessageCallback (bool(CallbackClass::callback)(model::Trigger trigger), CallbackClass *object)

template<class MessageType >
void	addMessageCallback (bool(*callback)(MessageType &messageRef))

Static Public Member Functions
static const char *	uri ()
	The URI for the Service. More...

static model::Service *	create ()
	Builds a default instance of the VisualSensor Service and populates the URI and Version numbers. 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...

Static Public Member Functions inherited from openjaus::core::services::AccessControl
static const char *	uri ()
	The URI for the Service. More...

static model::Service *	create ()
	Builds a default instance of the AccessControl Service and populates the URI and Version numbers. More...

Static Public Member Functions inherited from openjaus::core::services::Events
static const char *	uri ()
	The URI for the Service. More...

static model::Service *	create ()
	Builds a default instance of the Events Service and populates the URI and Version numbers. More...

Static Public Member Functions inherited from openjaus::core::services::Transport
static const char *	uri ()
	The URI for the Service. More...

static model::Service *	create ()
	Builds a default instance of the Transport Service and populates the URI and Version numbers. More...

Private Attributes
VisualSensorDefaultLoop	visualSensorDefaultLoop

VisualSensorControlledLoop	visualSensorControlledLoop

Additional Inherited Members
Protected Member Functions inherited from openjaus::core::services::AccessControl
void	configure (AccessControlSettingsInterface *settings)

void	setClientAuthority (uint8_t *authorityCode)

Protected Member Functions inherited from openjaus::core::services::Events
void	configure (EventsSettingsInterface *settings)

void	startService ()

void	stopService ()

Protected Member Functions inherited from openjaus::core::services::Transport
void	configure (services::TransportSettingsInterface *settings)

void	setComponentAddress (transport::Address *address)

void	setReceiveQueue (system::PriorityQueue *queue)

void	setSubsInterface (transport::Interface *interface)

void	setNodeInterface (transport::Interface *interface)

void	setComponentInterface (transport::Interface *interface)

void	setJtcpInterface (transport::AS5669::JtcpInterface *interface)

void	fireEvent (model::InternalEvent *event)

void	sendToSelf (transport::Wrapper *wrapper)

transport::Address *&	getComponentAddress ()

Protected Attributes inherited from openjaus::core::services::AccessControl
model::StateMachine	accessStateMachine

model::State	notControlled

model::State	controlled

Protected Attributes inherited from openjaus::core::services::Transport
model::StateMachine	receive

model::State	receivingState

Detailed Description

Constructor & Destructor Documentation

§ VisualSensor()

openjaus::environment::services::VisualSensor::VisualSensor ( )

§ ~VisualSensor()

openjaus::environment::services::VisualSensor::~VisualSensor ( )

virtual

Member Function Documentation

§ create()

model::Service * openjaus::environment::services::VisualSensor::create ( )

static

Returns: model::Service - The populated service.

§ getConfirmVisualSensorConfiguration()

environment::ConfirmVisualSensorConfiguration openjaus::environment::services::VisualSensor::getConfirmVisualSensorConfiguration ( SetVisualSensorConfiguration * setVisualSensorConfiguration )

virtual

Parameters

[in] setVisualSensorConfiguration - Input Trigger.

Returns: ConfirmVisualSensorConfiguration Output Message.

Implements openjaus::environment::VisualSensorInterface.

§ getReportVisualSensorCapabilities()

environment::ReportVisualSensorCapabilities openjaus::environment::services::VisualSensor::getReportVisualSensorCapabilities ( QueryVisualSensorCapabilities * queryVisualSensorCapabilities )

virtual

Parameters

[in] queryVisualSensorCapabilities - Input Trigger.

Returns: ReportVisualSensorCapabilities Output Message.

Implements openjaus::environment::VisualSensorInterface.

§ getReportVisualSensorConfiguration()

environment::ReportVisualSensorConfiguration openjaus::environment::services::VisualSensor::getReportVisualSensorConfiguration ( QueryVisualSensorConfiguration * queryVisualSensorConfiguration )

virtual

Parameters

[in] queryVisualSensorConfiguration - Input Trigger.

Returns: ReportVisualSensorConfiguration Output Message.

Implements openjaus::environment::VisualSensorInterface.

§ getReportVisualSensorGeometricProperties()

environment::ReportVisualSensorGeometricProperties openjaus::environment::services::VisualSensor::getReportVisualSensorGeometricProperties ( QueryVisualSensorGeometricProperties * queryVisualSensorGeometricProperties )

virtual

Parameters

[in] queryVisualSensorGeometricProperties - Input Trigger.

Returns: ReportVisualSensorGeometricProperties Output Message.

Implements openjaus::environment::VisualSensorInterface.

§ updateVisualSensorConfiguration()

bool openjaus::environment::services::VisualSensor::updateVisualSensorConfiguration ( SetVisualSensorConfiguration * setVisualSensorConfiguration )

virtual

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

Parameters

[in] setVisualSensorConfiguration - Input Trigger.

Returns: Whether the message was properly processed by this action.

Implements openjaus::environment::VisualSensorInterface.

§ uri()

const char * openjaus::environment::services::VisualSensor::uri ( )

static

Returns: const char* - The URI.

Member Data Documentation

§ visualSensorControlledLoop

VisualSensorControlledLoop openjaus::environment::services::VisualSensor::visualSensorControlledLoop

private

§ visualSensorDefaultLoop

VisualSensorDefaultLoop openjaus::environment::services::VisualSensor::visualSensorDefaultLoop

private

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

include/openjaus/environment/Services/VisualSensor.h
src/openjaus/environment/Services/VisualSensor.cpp

Public Member Functions

Static Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

§ VisualSensor()

§ ~VisualSensor()

Member Function Documentation

§ create()

§ getConfirmVisualSensorConfiguration()

§ getReportVisualSensorCapabilities()

§ getReportVisualSensorConfiguration()

§ getReportVisualSensorGeometricProperties()

§ updateVisualSensorConfiguration()

§ uri()

Member Data Documentation

§ visualSensorControlledLoop

§ visualSensorDefaultLoop