OpenJAUS SAE SDK  6.0.0
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Private Attributes | List of all members
openjaus::core_v1_1::services::Management Class Reference

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

#include <Management.h>

Inherits openjaus::core_v1_1::ManagementInterface, and openjaus::core_v1_1::services::AccessControl.

Inherited by openjaus::core_v1_1::Managed [virtual], openjaus::manipulator_v1_0::services::ManipulatorActuatorForceTorqueDriver [virtual], openjaus::manipulator_v1_0::services::ManipulatorEndEffectorPoseDriver [virtual], openjaus::manipulator_v1_0::services::ManipulatorEndEffectorVelocityStateDriver [virtual], openjaus::manipulator_v1_0::services::ManipulatorJointPositionDriver [virtual], openjaus::manipulator_v1_0::services::ManipulatorJointVelocityDriver [virtual], openjaus::manipulator_v1_0::services::PanTiltJointPositionDriver [virtual], openjaus::manipulator_v1_0::services::PanTiltJointVelocityDriver [virtual], openjaus::manipulator_v1_0::services::PrimitiveEndEffector [virtual], openjaus::manipulator_v1_0::services::PrimitiveManipulator [virtual], openjaus::manipulator_v1_0::services::PrimitivePanTilt [virtual], openjaus::mobility_v1_0::services::GlobalVectorDriver [virtual], openjaus::mobility_v1_0::services::GlobalWaypointDriver [virtual], openjaus::mobility_v1_0::services::ListManager [virtual], openjaus::mobility_v1_0::services::LocalVectorDriver [virtual], openjaus::mobility_v1_0::services::LocalWaypointDriver [virtual], openjaus::mobility_v1_0::services::PrimitiveDriver [virtual], openjaus::mobility_v1_0::services::VelocityStateDriver [virtual], openjaus::ugv_v1_0::services::AckermannDriver [virtual], openjaus::ugv_v1_0::services::DriveTrainDriver [virtual], openjaus::ugv_v1_0::services::ParkingBrakeDriver [virtual], openjaus::ugv_v1_0::services::SkidSteerDriver [virtual], and openjaus::ugv_v1_0::services::StabilizerDriver [virtual].

Public Member Functions

 Management ()
 
virtual ~Management ()
 
virtual bool storeID (SetEmergency *setEmergency)
 StoreID action with input SetEmergency. More...
 
virtual bool deleteID (ClearEmergency *clearEmergency)
 DeleteID action with input ClearEmergency. More...
 
virtual ReportStatus getReportStatus (QueryStatus *queryStatus)
 Send action for ReportStatus with input message QueryStatus. 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 sendRejectControlNotAvailable (ReleaseControl *releaseControl)
 SendRejectControlNotAvailable action with input ReleaseControl. More...
 
virtual bool sendRejectControlToController (Reset *reset)
 SendRejectControlToController action with input Reset. More...
 
virtual bool sendRejectControlToController (Failure *failure)
 SendRejectControlToController action with input Failure. More...
 
virtual bool sendRejectControlToController (Shutdown *shutdown)
 SendRejectControlToController action with input Shutdown. More...
 
virtual bool sendRejectControlToController (RequestControl *requestControl)
 SendRejectControlToController action with input RequestControl. More...
 
virtual bool emptyStateStack (Failure *failure)
 EmptyStateStack action with input Failure. More...
 
virtual bool emptyStateStack (Shutdown *shutdown)
 EmptyStateStack action with input Shutdown. More...
 
virtual bool resetTimer (AccessControlTimeout *accessControlTimeout)
 ResetTimer action with input AccessControlTimeout. More...
 
virtual bool resetTimer (RequestControl *requestControl)
 ResetTimer action with input RequestControl. More...
 
virtual bool isIDStored (ClearEmergency *clearEmergency)
 isIDStored condition. More...
 
void initialized ()
 Fire the Management services' Initialized internal event Fire the Initialized internal event which will move the Management service from the Init state to the NotControlledStandby state. More...
 
void failed ()
 Fire the Management services' Failure internal event Fire the Failure internal event which will move the Management service to the Failure state. More...
 
core_v1_1::StatusEnumeration::StatusEnum getCurrentStatus ()
 Get the current status of the Management service (INIT, STANDBY, READY, etc) More...
 
std::string getCurrentStatusToString ()
 Get the current status of the Management service (INIT, STANDBY, READY, etc) More...
 
- Public Member Functions inherited from openjaus::core_v1_1::ManagementInterface
virtual ~ManagementInterface ()
 
- Public Member Functions inherited from openjaus::core_v1_1::AccessControlInterface
virtual ~AccessControlInterface ()
 
- Public Member Functions inherited from openjaus::core_v1_1::EventsInterface
virtual ~EventsInterface ()
 
- Public Member Functions inherited from openjaus::core_v1_1::TransportInterface
virtual ~TransportInterface ()
 
- Public Member Functions inherited from openjaus::core_v1_1::services::AccessControl
 AccessControl ()
 
virtual ~AccessControl ()
 
virtual void init ()
 
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 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 sendRejectControlReleased (ReleaseControl *releaseControl)
 SendRejectControlReleased action with input ReleaseControl. More...
 
virtual bool sendRejectControlReleased (AccessControlTimeout *accessControlTimeout)
 SendRejectControlReleased action with input AccessControlTimeout. 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 OPENJAUS_DEPRECATED dismissController ()
 
uint8 getControllerAuthority () const
 
transport::Address getControllerAddress () const
 
- Public Member Functions inherited from openjaus::core_v1_1::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 resubscribe (uint32_t subscriptionId)
 
bool resubscribe (uint32_t subscriptionId, void(*callback)(const model::EventRequestResponseArgs &args))
 
bool resubscribe (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_v1_1::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...
 
transport::Address *& getComponentAddress ()
 
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))
 

Static Public Member Functions

static const char * uri ()
 The URI for the Service. More...
 
static model::Servicecreate ()
 Builds a default instance of the Management Service and populates the URI and Version numbers. More...
 
- Static Public Member Functions inherited from openjaus::core_v1_1::ManagementInterface
static OPENJAUS_DEPRECATED model::Service ManagementService ()
 Builds a default instance of the Management Service and populates the URI and Version numbers. More...
 
static OPENJAUS_DEPRECATED std::string ManagementUri ()
 Static accessor for Service URI. More...
 
- Static Public Member Functions inherited from openjaus::core_v1_1::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_v1_1::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_v1_1::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_v1_1::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_v1_1::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_v1_1::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...
 

Protected Member Functions

virtual void onEnterInit ()
 
virtual void onExitInit ()
 
virtual void onEnterNotControlledStandby ()
 
virtual void onExitNotControlledStandby ()
 
virtual void onEnterControlledStandby ()
 
virtual void onExitControlledStandby ()
 
virtual void onEnterReady ()
 
virtual void onExitReady ()
 
virtual void onPushToNotControlledEmergency ()
 
virtual void onPopFromNotControlledEmergency ()
 
virtual void OPENJAUS_DEPRECATED onPushToEmergency ()
 
virtual void OPENJAUS_DEPRECATED onPopFromEmergency ()
 
virtual void onPushToControlledEmergency ()
 
virtual void onPopFromControlledEmergency ()
 
virtual void onEnterFailure ()
 
virtual void onEnterShutdown ()
 
- Protected Member Functions inherited from openjaus::core_v1_1::services::AccessControl
void configure (AccessControlSettingsInterface *settings)
 
void setClientAuthority (uint8_t *authorityCode)
 
- Protected Member Functions inherited from openjaus::core_v1_1::services::Events
void configure (EventsSettingsInterface *settings)
 
void startService ()
 
void stopService ()
 
- Protected Member Functions inherited from openjaus::core_v1_1::services::Transport
void configure (services::TransportSettingsInterface *settings)
 
void setComponentAddress (transport::Address *address)
 
void setReceiveQueue (system::IPriorityQueue *queue)
 
void setExternalInterface (transport::Interface *interface)
 
void setNodeInterface (transport::Interface *interface)
 
void setInternalInterface (transport::Interface *interface)
 
void setJtcpInterface (transport::AS5669::JtcpInterface *interface)
 
void fireEvent (model::InternalEvent *event)
 
void sendToSelf (transport::Wrapper *wrapper)
 

Protected Attributes

model::StateMachine notControlledSM
 
model::StateMachine notControlledAvailableSM
 
model::StateMachine notControlledNotAvailableSM
 
model::StateMachine controlledSM
 
model::StateMachine controlledNotAvailableSM
 
model::StateMachine controlledAvailableSM
 
model::State notControlledAvailable
 
model::State notControlledNotAvailable
 
model::State notControlledStandby
 
model::State init
 
model::State shutdown
 
model::State notControlledEmergency
 
model::State failure
 
model::State controlledAvailable
 
model::State controlledNotAvailable
 
model::State emergency
 
model::State standby
 
model::State ready
 
- Protected Attributes inherited from openjaus::core_v1_1::services::AccessControl
model::StateMachine accessStateMachine
 
model::State notControlled
 
model::State controlled
 
- Protected Attributes inherited from openjaus::core_v1_1::services::Transport
model::StateMachine receive
 
model::State receivingState
 

Private Attributes

InitializedTransition initializedTransition
 
NotControlledNotAvailableDefaultLoop notControlledNotAvailableDefaultLoop
 
NotControlledFailureTransition notControlledFailureTransition
 
PushToNotControlledEmergency pushToNotControlledEmergency
 
PopFromNotControlledEmergency popFromNotControlledEmergency
 
ManagementNotControlledDefaultLoop managementNotControlledDefaultLoop
 
Pause pause
 
ToReady toReady
 
ResetTransition resetTransition
 
ControlledFailureTransition controlledFailureTransition
 
ShutdownTransition shutdownTransition
 
ManagementControlledLoop managementControlledLoop
 
PushToControlledEmergency pushToControlledEmergency
 
PopFromControlledEmergency popFromControlledEmergency
 
ControlledNotAvailableDefaultLoop controlledNotAvailableDefaultLoop
 
ControlledEmergencyLoop controlledEmergencyLoop
 
ControlAvailableReleaseControlTransition controlAvailableReleaseControlTransition
 
ControlAvailableRequestControlTransition controlAvailableRequestControlTransition
 
std::vector< transport::AddressstoredIds
 

Detailed Description

Constructor & Destructor Documentation

◆ Management()

openjaus::core_v1_1::services::Management::Management ( )

◆ ~Management()

openjaus::core_v1_1::services::Management::~Management ( )
virtual

Member Function Documentation

◆ create()

model::Service * openjaus::core_v1_1::services::Management::create ( )
static
Returns
model::Service - The populated service.

◆ deleteID()

bool openjaus::core_v1_1::services::Management::deleteID ( ClearEmergency clearEmergency)
virtual

DeleteID action with input ClearEmergency.

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

Implements openjaus::core_v1_1::ManagementInterface.

◆ emptyStateStack() [1/2]

bool openjaus::core_v1_1::services::Management::emptyStateStack ( Failure failure)
virtual

EmptyStateStack action with input Failure.

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

Implements openjaus::core_v1_1::ManagementInterface.

◆ emptyStateStack() [2/2]

bool openjaus::core_v1_1::services::Management::emptyStateStack ( Shutdown shutdown)
virtual

EmptyStateStack action with input Shutdown.

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

Implements openjaus::core_v1_1::ManagementInterface.

◆ failed()

void openjaus::core_v1_1::services::Management::failed ( )

◆ getCurrentStatus()

core_v1_1::StatusEnumeration::StatusEnum openjaus::core_v1_1::services::Management::getCurrentStatus ( )
Returns
The current status as a core_v1_1StatusEnumeration::StatusEnum.

◆ getCurrentStatusToString()

std::string openjaus::core_v1_1::services::Management::getCurrentStatusToString ( )
Returns
The current status as a std::string.

◆ getReportStatus()

core_v1_1::ReportStatus openjaus::core_v1_1::services::Management::getReportStatus ( QueryStatus queryStatus)
virtual

Send action for ReportStatus with input message QueryStatus.

Parameters
[in]queryStatus- Input Trigger.
Returns
ReportStatus Output Message.

Implements openjaus::core_v1_1::ManagementInterface.

◆ initialized()

void openjaus::core_v1_1::services::Management::initialized ( )

◆ isIDStored()

bool openjaus::core_v1_1::services::Management::isIDStored ( ClearEmergency clearEmergency)
virtual

isIDStored condition.

Parameters
[in]clearEmergency- Input Trigger.
Returns
Whether the condition is true.

Implements openjaus::core_v1_1::ManagementInterface.

◆ onEnterControlledStandby()

void openjaus::core_v1_1::services::Management::onEnterControlledStandby ( )
protectedvirtual

◆ onEnterFailure()

void openjaus::core_v1_1::services::Management::onEnterFailure ( )
protectedvirtual

◆ onEnterInit()

void openjaus::core_v1_1::services::Management::onEnterInit ( )
protectedvirtual

◆ onEnterNotControlledStandby()

void openjaus::core_v1_1::services::Management::onEnterNotControlledStandby ( )
protectedvirtual

◆ onEnterReady()

void openjaus::core_v1_1::services::Management::onEnterReady ( )
protectedvirtual

◆ onEnterShutdown()

void openjaus::core_v1_1::services::Management::onEnterShutdown ( )
protectedvirtual

◆ onExitControlledStandby()

void openjaus::core_v1_1::services::Management::onExitControlledStandby ( )
protectedvirtual

◆ onExitInit()

void openjaus::core_v1_1::services::Management::onExitInit ( )
protectedvirtual

◆ onExitNotControlledStandby()

void openjaus::core_v1_1::services::Management::onExitNotControlledStandby ( )
protectedvirtual

◆ onExitReady()

void openjaus::core_v1_1::services::Management::onExitReady ( )
protectedvirtual

◆ onPopFromControlledEmergency()

void openjaus::core_v1_1::services::Management::onPopFromControlledEmergency ( )
protectedvirtual

◆ onPopFromEmergency()

void openjaus::core_v1_1::services::Management::onPopFromEmergency ( )
protectedvirtual

◆ onPopFromNotControlledEmergency()

void openjaus::core_v1_1::services::Management::onPopFromNotControlledEmergency ( )
protectedvirtual

◆ onPushToControlledEmergency()

void openjaus::core_v1_1::services::Management::onPushToControlledEmergency ( )
protectedvirtual

◆ onPushToEmergency()

void openjaus::core_v1_1::services::Management::onPushToEmergency ( )
protectedvirtual

◆ onPushToNotControlledEmergency()

void openjaus::core_v1_1::services::Management::onPushToNotControlledEmergency ( )
protectedvirtual

◆ resetTimer() [1/2]

bool openjaus::core_v1_1::services::Management::resetTimer ( AccessControlTimeout accessControlTimeout)
virtual

ResetTimer action with input AccessControlTimeout.

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

Implements openjaus::core_v1_1::ManagementInterface.

◆ resetTimer() [2/2]

bool openjaus::core_v1_1::services::Management::resetTimer ( RequestControl requestControl)
virtual

ResetTimer action with input RequestControl.

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

Implements openjaus::core_v1_1::ManagementInterface.

◆ sendConfirmControlNotAvailable()

bool openjaus::core_v1_1::services::Management::sendConfirmControlNotAvailable ( RequestControl requestControl)
virtual
Parameters
[in]requestControl- Input Trigger.
Returns
Whether the message was properly processed by this action.

Implements openjaus::core_v1_1::ManagementInterface.

◆ sendRejectControlNotAvailable()

bool openjaus::core_v1_1::services::Management::sendRejectControlNotAvailable ( ReleaseControl releaseControl)
virtual

SendRejectControlNotAvailable action with input ReleaseControl.

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

Implements openjaus::core_v1_1::ManagementInterface.

◆ sendRejectControlToController() [1/4]

bool openjaus::core_v1_1::services::Management::sendRejectControlToController ( Reset reset)
virtual

SendRejectControlToController action with input Reset.

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

Implements openjaus::core_v1_1::ManagementInterface.

◆ sendRejectControlToController() [2/4]

bool openjaus::core_v1_1::services::Management::sendRejectControlToController ( Failure failure)
virtual

SendRejectControlToController action with input Failure.

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

Implements openjaus::core_v1_1::ManagementInterface.

◆ sendRejectControlToController() [3/4]

bool openjaus::core_v1_1::services::Management::sendRejectControlToController ( Shutdown shutdown)
virtual

SendRejectControlToController action with input Shutdown.

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

Implements openjaus::core_v1_1::ManagementInterface.

◆ sendRejectControlToController() [4/4]

bool openjaus::core_v1_1::services::Management::sendRejectControlToController ( RequestControl requestControl)
virtual

SendRejectControlToController action with input RequestControl.

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

Implements openjaus::core_v1_1::ManagementInterface.

◆ storeID()

bool openjaus::core_v1_1::services::Management::storeID ( SetEmergency setEmergency)
virtual

StoreID action with input SetEmergency.

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

Implements openjaus::core_v1_1::ManagementInterface.

◆ uri()

const char * openjaus::core_v1_1::services::Management::uri ( )
static
Returns
const char* - The URI.

Member Data Documentation

◆ controlAvailableReleaseControlTransition

ControlAvailableReleaseControlTransition openjaus::core_v1_1::services::Management::controlAvailableReleaseControlTransition
private

◆ controlAvailableRequestControlTransition

ControlAvailableRequestControlTransition openjaus::core_v1_1::services::Management::controlAvailableRequestControlTransition
private

◆ controlledAvailable

model::State openjaus::core_v1_1::services::Management::controlledAvailable
protected

◆ controlledAvailableSM

model::StateMachine openjaus::core_v1_1::services::Management::controlledAvailableSM
protected

◆ controlledEmergencyLoop

ControlledEmergencyLoop openjaus::core_v1_1::services::Management::controlledEmergencyLoop
private

◆ controlledFailureTransition

ControlledFailureTransition openjaus::core_v1_1::services::Management::controlledFailureTransition
private

◆ controlledNotAvailable

model::State openjaus::core_v1_1::services::Management::controlledNotAvailable
protected

◆ controlledNotAvailableDefaultLoop

ControlledNotAvailableDefaultLoop openjaus::core_v1_1::services::Management::controlledNotAvailableDefaultLoop
private

◆ controlledNotAvailableSM

model::StateMachine openjaus::core_v1_1::services::Management::controlledNotAvailableSM
protected

◆ controlledSM

model::StateMachine openjaus::core_v1_1::services::Management::controlledSM
protected

◆ emergency

model::State openjaus::core_v1_1::services::Management::emergency
protected

◆ failure

model::State openjaus::core_v1_1::services::Management::failure
protected

◆ init

model::State openjaus::core_v1_1::services::Management::init
protected

◆ initializedTransition

InitializedTransition openjaus::core_v1_1::services::Management::initializedTransition
private

◆ managementControlledLoop

ManagementControlledLoop openjaus::core_v1_1::services::Management::managementControlledLoop
private

◆ managementNotControlledDefaultLoop

ManagementNotControlledDefaultLoop openjaus::core_v1_1::services::Management::managementNotControlledDefaultLoop
private

◆ notControlledAvailable

model::State openjaus::core_v1_1::services::Management::notControlledAvailable
protected

◆ notControlledAvailableSM

model::StateMachine openjaus::core_v1_1::services::Management::notControlledAvailableSM
protected

◆ notControlledEmergency

model::State openjaus::core_v1_1::services::Management::notControlledEmergency
protected

◆ notControlledFailureTransition

NotControlledFailureTransition openjaus::core_v1_1::services::Management::notControlledFailureTransition
private

◆ notControlledNotAvailable

model::State openjaus::core_v1_1::services::Management::notControlledNotAvailable
protected

◆ notControlledNotAvailableDefaultLoop

NotControlledNotAvailableDefaultLoop openjaus::core_v1_1::services::Management::notControlledNotAvailableDefaultLoop
private

◆ notControlledNotAvailableSM

model::StateMachine openjaus::core_v1_1::services::Management::notControlledNotAvailableSM
protected

◆ notControlledSM

model::StateMachine openjaus::core_v1_1::services::Management::notControlledSM
protected

◆ notControlledStandby

model::State openjaus::core_v1_1::services::Management::notControlledStandby
protected

◆ pause

Pause openjaus::core_v1_1::services::Management::pause
private

◆ popFromControlledEmergency

PopFromControlledEmergency openjaus::core_v1_1::services::Management::popFromControlledEmergency
private

◆ popFromNotControlledEmergency

PopFromNotControlledEmergency openjaus::core_v1_1::services::Management::popFromNotControlledEmergency
private

◆ pushToControlledEmergency

PushToControlledEmergency openjaus::core_v1_1::services::Management::pushToControlledEmergency
private

◆ pushToNotControlledEmergency

PushToNotControlledEmergency openjaus::core_v1_1::services::Management::pushToNotControlledEmergency
private

◆ ready

model::State openjaus::core_v1_1::services::Management::ready
protected

◆ resetTransition

ResetTransition openjaus::core_v1_1::services::Management::resetTransition
private

◆ shutdown

model::State openjaus::core_v1_1::services::Management::shutdown
protected

◆ shutdownTransition

ShutdownTransition openjaus::core_v1_1::services::Management::shutdownTransition
private

◆ standby

model::State openjaus::core_v1_1::services::Management::standby
protected

◆ storedIds

std::vector< transport::Address > openjaus::core_v1_1::services::Management::storedIds
private

◆ toReady

ToReady openjaus::core_v1_1::services::Management::toReady
private

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