OpenJAUS Software Development Kit  4.3.1
Public Member Functions | Protected Member Functions | Private Member Functions | List of all members
openjaus::core::Base Class Reference

Base Component implements the urn:jaus:jss:core:AccessControl, urn:jaus:jss:core:Time services. More...

#include <Base.h>

Inherits openjaus::core::services::AccessControl, openjaus::core::services::Time, and openjaus::core::EventsBase.

Inherited by openjaus::core::Managed, openjaus::environment::AnalogVideoSensor, openjaus::environment::DigitalVideoSensor, openjaus::environment::RangeSensor, openjaus::environment::StillImageSensor, openjaus::manipulator::ManipulatorEndEffectorPoseSensor, openjaus::manipulator::ManipulatorEndEffectorVelocityStateSensor, openjaus::manipulator::ManipulatorJointForceTorqueSensor, openjaus::manipulator::ManipulatorJointPositionSensor, openjaus::manipulator::ManipulatorJointVelocitySensor, openjaus::manipulator::PanTiltJointPositionDriver, openjaus::manipulator::PanTiltJointPositionSensor, openjaus::manipulator::PanTiltJointVelocitySensor, openjaus::manipulator::PrimitiveManipulator, openjaus::mobility::AccelerationStateSensor, openjaus::mobility::GlobalPoseSensor, openjaus::mobility::LocalPoseSensor, openjaus::mobility::VelocityStateSensor, openjaus::ugv::Annunciator, openjaus::ugv::Illumination, openjaus::ugv::Odometry, openjaus::ugv::PlatformSpecifications, and openjaus::ugv::PowerPlantManager.

Public Member Functions

OPENJAUS_DEPRECATED Base ()
 
 Base (const std::string &name)
 
virtual ~Base ()
 
- 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::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::Events
 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 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::StategetCurrentState ()
 
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))
 
- Public Member Functions inherited from openjaus::core::services::Time
 Time ()
 
virtual ~Time ()
 
virtual bool setTime (SetTime *setTime)
 SetTime action with input SetTime. More...
 
virtual ReportTime getReportTime (QueryTime *queryTime)
 Send action for ReportTime with input message QueryTime. More...
 
- Public Member Functions inherited from openjaus::core::TimeInterface
virtual ~TimeInterface ()
 
- Public Member Functions inherited from openjaus::core::EventsBase
OPENJAUS_DEPRECATED EventsBase ()
 
 EventsBase (const std::string &name)
 
virtual ~EventsBase ()
 
- Public Member Functions inherited from openjaus::core::services::DiscoveryClient
 DiscoveryClient ()
 
virtual ~DiscoveryClient ()
 
virtual bool processReportIdentification (ReportIdentification *reportIdentification)
 Executed when a ReportIdentification message is received. More...
 
virtual bool processReportConfiguration (ReportConfiguration *reportConfiguration)
 Executed when a ReportConfiguration message is received. More...
 
virtual bool processReportSubsystemList (ReportSubsystemList *reportSubsystemList)
 Executed when a ReportSubsystemList message is received. More...
 
virtual bool processReportServices (ReportServices *reportServices)
 Executed when a ReportServices message is received. More...
 
virtual bool processReportServiceList (ReportServiceList *reportServiceList)
 Executed when a ReportServicesList message is received. More...
 
bool broadcastQueryIdentificationToNode (SystemLevelEnumeration::SystemLevelEnum queryType)
 
bool broadcastQueryIdentificationToSubsystem (SystemLevelEnumeration::SystemLevelEnum queryType)
 
bool broadcastQueryIdentificationToSystem (SystemLevelEnumeration::SystemLevelEnum queryType)
 
bool queryIdentification (const openjaus::transport::Address &address, openjaus::core::SystemLevelEnumeration::SystemLevelEnum queryType)
 
bool queryConfiguration (const openjaus::transport::Address &address, openjaus::core::SystemLevelEnumeration::SystemLevelEnum queryType)
 
bool queryServiceListAllServices (const openjaus::transport::Address &address)
 
bool queryServiceList (const openjaus::transport::Address &address, openjaus::core::QSLSubsystemList &subsystemList)
 
bool registerServices (const openjaus::transport::Address &address)
 
- Public Member Functions inherited from openjaus::core::DiscoveryClientInterface
virtual ~DiscoveryClientInterface ()
 
- Public Member Functions inherited from openjaus::core::services::Discovery
 Discovery ()
 
virtual ~Discovery ()
 
virtual bool publishServices (RegisterServices *registerServices)
 PublishServices action with input RegisterServices. More...
 
virtual ReportIdentification getReportIdentification (QueryIdentification *queryIdentification)
 Send a Report Identification message to the component that sent the query. More...
 
virtual ReportConfiguration getReportConfiguration (QueryConfiguration *queryConfiguration)
 Send a Report Configuration message to the component that sent the query. More...
 
virtual ReportSubsystemList getReportSubsystemList (QuerySubsystemList *querySubsystemList)
 Send a Report Subsystems List message to the component that sent the query. More...
 
virtual ReportServices getReportServices (QueryServices *queryServices)
 Send a Report Services message to the component that sent the query. More...
 
virtual ReportServiceList getReportServiceList (QueryServiceList *queryServiceList)
 Send a Report Service List message to the component that sent the query Send a Report Service List message to the component that sent the query. More...
 
void startService ()
 
void stopService ()
 
- Public Member Functions inherited from openjaus::core::DiscoveryInterface
virtual ~DiscoveryInterface ()
 
- Public Member Functions inherited from openjaus::core::services::Liveness
 Liveness ()
 
virtual ~Liveness ()
 
virtual ReportHeartbeatPulse getReportHeartbeatPulse (QueryHeartbeatPulse *queryHeartbeatPulse)
 Send a Report Heartbeat Pulse message to the component that sent the query Send a Report Heartbeat Pulse message to the component that sent the query. More...
 
virtual bool processHeartbeat (ReportHeartbeatPulse *reportHeartbeatPulse)
 Processes ReportHeatbeat Messages to see if a new JAUS entity exists Processes ReportHeatbeat Messages to see if a new JAUS entity exists. More...
 
virtual bool processStopped (ReportStopped *reportStopped)
 Processes ReportStopped Messages Processes ReportStopped Messages. More...
 
- Public Member Functions inherited from openjaus::core::LivenessInterface
virtual ~LivenessInterface ()
 
- Public Member Functions inherited from openjaus::core::services::Configuration
 Configuration ()
 
virtual ~Configuration ()
 
virtual bool sendJausAddress (QueryJausAddress *queryJausAddress)
 SendJausAddress action with input QueryJausAddress. More...
 
virtual bool setThisJausAddress (ReportJausAddress *reportJausAddress)
 SetThisJausAddress action with input ReportJausAddress. More...
 
void setSystemTree (model::SystemTree *systemTree)
 
void configure (ConfigurationSettingsInterface *settings)
 
void startService ()
 
void stopService ()
 
- Public Member Functions inherited from openjaus::core::ConfigurationInterface
virtual ~ConfigurationInterface ()
 
- Public Member Functions inherited from openjaus::core::Events
OPENJAUS_DEPRECATED Events ()
 
 Events (const std::string &name)
 
virtual ~Events ()
 
- Public Member Functions inherited from openjaus::core::Transport
OPENJAUS_DEPRECATED Transport ()
 
 Transport (const std::string &name)
 
virtual ~Transport ()
 
- Public Member Functions inherited from openjaus::model::Component
virtual ~Component ()
 
 Component (const std::string &name)
 
 Component (const Component &copy)
 
std::string getName () const
 Accessor to get the value of name. More...
 
uint8_t getAuthority () const
 Accessor to get the value of authority. More...
 
bool setAuthority (uint8_t authority)
 Accessor to set value of authority. More...
 
const std::vector< StateMachineRunner *> & getRunners () const
 Accessor to get the value of runners. More...
 
bool setRunners (const StateMachineRunner &runners)
 Accessor to set value of runners. More...
 
const std::vector< transport::Interface *> & getInterfaces () const
 Accessor to get the value of interfaces. More...
 
bool setInterfaces (const transport::Interface &interfaces)
 Accessor to set value of interfaces. More...
 
SystemTreegetSystemTree () const
 Accessor to get the value of systemTree. More...
 
bool setSystemTree (SystemTree *systemTree)
 Accessor to set value of systemTree. More...
 
std::vector< Service *> * getImplements () const
 Accessor to get the value of implements. More...
 
bool setImplements (Service *implements)
 Accessor to set value of implements. More...
 
ComponentgetInheritsFrom () const
 Accessor to get the value of inheritsFrom. More...
 
bool setInheritsFrom (Component *inheritsFrom)
 Accessor to set value of inheritsFrom. More...
 
const ComponentInfogetInfo () const
 Accessor to get the value of info. More...
 
const transport::AddressgetAddress () const
 Accessor to get the value of address. More...
 
void run ()
 Operation run. More...
 
void stop ()
 Operation stop. More...
 
virtual std::string toString () const
 
OPENJAUS_DEPRECATED Component ()
 
OPENJAUS_DEPRECATED bool setName (std::string name)
 
std::string toXml (unsigned char level=0) const
 

Protected Member Functions

virtual void configureServices ()
 
- 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 Member Functions inherited from openjaus::core::services::Time
void configure (TimeSettingsInterface *settings)
 
- Protected Member Functions inherited from openjaus::core::EventsBase
virtual void startServices ()
 
virtual void stopServices ()
 
void removeService (std::string uri)
 
- Protected Member Functions inherited from openjaus::core::services::DiscoveryClient
void startServiceInternal ()
 
void setSystemTree (model::SystemTree *systemTree)
 
void setServices (std::vector< model::Service *> *services)
 
void configure (DiscoveryClientSettingsInterface *settings)
 
void startService ()
 
void stopService ()
 
- Protected Member Functions inherited from openjaus::core::services::Discovery
void setSystemTree (model::SystemTree *systemTree)
 
void setServices (std::vector< model::Service *> *serviceList)
 
void configure (DiscoverySettingsInterface *settings)
 
- Protected Member Functions inherited from openjaus::core::services::Liveness
void setSystemTree (model::SystemTree *systemTree)
 
void configure (LivenessSettingsInterface *settings)
 
void startService ()
 
void stopService ()
 
- Protected Member Functions inherited from openjaus::core::services::Configuration
void setAddress (uint16_t subsystemId, uint8_t nodeId, uint8_t componentId)
 
- Protected Member Functions inherited from openjaus::core::Transport
transport::InterfacegetSubsystemJudpInterface ()
 
transport::InterfacegetNodeJudpInterface ()
 
transport::InterfacegetComponentJudpInterface ()
 
bool isSubsInterfaceEnabled ()
 
bool isNodeInterfaceEnabled ()
 
system::PriorityQueue *const getReceiveQueue ()
 
virtual core::services::TransportSettingsInterfaceloadTransportSettings ()
 
virtual transport::AS5669::JudpSettingsInterfaceloadJudpSettings ()
 
virtual transport::InterfacecreateSubsystemJudpInterface ()
 
virtual transport::InterfacecreateNodeJudpInterface ()
 
virtual transport::InterfacecreateComponentJudpInterface ()
 

Private Member Functions

void configureAccessControlService ()
 
void configureTimeService ()
 
void removeTimeService ()
 

Additional Inherited Members

- Static Public Member Functions inherited from openjaus::core::services::AccessControl
static const char * uri ()
 The URI for the Service. More...
 
static model::Servicecreate ()
 Builds a default instance of the AccessControl Service and populates the URI and Version numbers. 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::Events
static const char * uri ()
 The URI for the Service. More...
 
static model::Servicecreate ()
 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::Servicecreate ()
 Builds a default instance of the Transport Service and populates the URI and Version numbers. More...
 
- Static Public Member Functions inherited from openjaus::core::services::Time
static const char * uri ()
 The URI for the Service. More...
 
static model::Servicecreate ()
 Builds a default instance of the Time Service and populates the URI and Version numbers. More...
 
- Static Public Member Functions inherited from openjaus::core::TimeInterface
static OPENJAUS_DEPRECATED model::Service TimeService ()
 Builds a default instance of the Time Service and populates the URI and Version numbers. More...
 
static OPENJAUS_DEPRECATED std::string TimeUri ()
 Static accessor for Service URI. More...
 
- Static Public Member Functions inherited from openjaus::core::services::DiscoveryClient
static const char * uri ()
 The URI for the Service. More...
 
static model::Servicecreate ()
 Builds a default instance of the DiscoveryClient Service and populates the URI and Version numbers. More...
 
- Static Public Member Functions inherited from openjaus::core::DiscoveryClientInterface
static OPENJAUS_DEPRECATED model::Service DiscoveryClientService ()
 Builds a default instance of the DiscoveryClient Service and populates the URI and Version numbers. More...
 
static OPENJAUS_DEPRECATED std::string DiscoveryClientUri ()
 Static accessor for Service URI. More...
 
- Static Public Member Functions inherited from openjaus::core::services::Discovery
static const char * uri ()
 The URI for the Service. More...
 
static model::Servicecreate ()
 Builds a default instance of the Discovery Service and populates the URI and Version numbers. More...
 
- Static Public Member Functions inherited from openjaus::core::DiscoveryInterface
static OPENJAUS_DEPRECATED model::Service DiscoveryService ()
 Builds a default instance of the Discovery Service and populates the URI and Version numbers. More...
 
static OPENJAUS_DEPRECATED std::string DiscoveryUri ()
 Static accessor for Service URI. More...
 
- Static Public Member Functions inherited from openjaus::core::services::Liveness
static const char * uri ()
 The URI for the Service. More...
 
static model::Servicecreate ()
 Builds a default instance of the Liveness Service and populates the URI and Version numbers. More...
 
- Static Public Member Functions inherited from openjaus::core::LivenessInterface
static OPENJAUS_DEPRECATED model::Service LivenessService ()
 Builds a default instance of the Liveness Service and populates the URI and Version numbers. More...
 
static OPENJAUS_DEPRECATED std::string LivenessUri ()
 Static accessor for Service URI. More...
 
- Static Public Member Functions inherited from openjaus::core::services::Configuration
static const char * uri ()
 The URI for the Service. More...
 
static model::Servicecreate ()
 Builds a default instance of the Configuration Service and populates the URI and Version numbers. More...
 
- Static Public Member Functions inherited from openjaus::core::ConfigurationInterface
static OPENJAUS_DEPRECATED model::Service ConfigurationService ()
 Builds a default instance of the Configuration Service and populates the URI and Version numbers. More...
 
static OPENJAUS_DEPRECATED std::string ConfigurationUri ()
 Static accessor for Service URI. More...
 
- Static Public Attributes inherited from openjaus::model::Component
static const uint8_t DEFAULT_AUTHORITY = 127
 
- 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
 
- Protected Attributes inherited from openjaus::model::Component
uint8_t authority
 
std::vector< StateMachineRunner *> runners
 
std::vector< transport::Interface *> interfaces
 
SystemTreesystemTree
 
std::vector< Service *> * implements
 
ComponentinheritsFrom
 

Detailed Description

The Base component provides an implementation of the following service(s). This component can be extended for customized functionality or used via instantiation.

AccessControl Service

The Access Control service offers a basic interface for acquiring preemptable exclusive control to one or more related services that utilize this function. Once the exclusive control is established, the related services shall only execute commands originating from the controlling component. The authority code parameter of this service is used for preemption and is to be set equal to that of its controlling client. This service always grants control to the highest authority client that is requesting exclusive control. Commands from all other clients are ignored unless from a client with higher authority. service maintains two values, a default value and a current value of a field called authority code. The default value is the value that the service is pre-configured with. Access is provided to clients based on the value of their authority code in comparison to the current value of this service. transitions between the Available and NotAvailable nested states are behaviors that are deferred to service definitions that derive from this service.



URI: urn:jaus:jss:core:AccessControl

Version: 1.1

Inherits From:
urn:jaus:jss:core:Events
Time Service

The Time Service allows clients to query and set the system time for the component. Note that exclusive control is required to set the time, but is not required to query it.



URI: urn:jaus:jss:core:Time

Version: 1.1

Inherits From:
urn:jaus:jss:core:AccessControl

Constructor & Destructor Documentation

§ Base() [1/2]

openjaus::core::Base::Base ( )

§ Base() [2/2]

openjaus::core::Base::Base ( const std::string &  name)

§ ~Base()

openjaus::core::Base::~Base ( )
virtual

Member Function Documentation

§ configureAccessControlService()

void openjaus::core::Base::configureAccessControlService ( )
private

§ configureServices()

void openjaus::core::Base::configureServices ( )
protectedvirtual

Reimplemented from openjaus::core::EventsBase.

§ configureTimeService()

void openjaus::core::Base::configureTimeService ( )
private

§ removeTimeService()

void openjaus::core::Base::removeTimeService ( )
private

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