openjaus::core::Managed Class Reference

Managed Component implements the urn:jaus:jss:core:Management services. More...

#include <Managed.h>

Inherits openjaus::core::Base, and openjaus::core::ManagementInterface.

Inherited by openjaus::mobility::GlobalVectorDriver, openjaus::mobility::GlobalWaypointDriver, openjaus::mobility::ListManaged, openjaus::mobility::LocalVectorDriver, openjaus::mobility::LocalWaypointDriver, openjaus::mobility::PrimitiveDriver, and openjaus::mobility::VelocityStateDriver.

List of all members.

Public Member Functions
	Managed ()
virtual	~Managed ()
virtual bool	storeID (SetEmergency *setEmergency)
	StoreID action with input SetEmergency.
virtual bool	deleteID (ClearEmergency *clearEmergency)
	DeleteID action with input ClearEmergency.
virtual core::ReportStatus	getReportStatus (QueryStatus *queryStatus)
	Send action for ReportStatus with input message QueryStatus.
virtual bool	isControllingClient (Reset *reset)
	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.
virtual bool	isIDStored (ClearEmergency *clearEmergency)
	isIDStored condition.
Protected Attributes
ToReady	toReady
Pause	pause
ResetTransition	resetTransition
ShutdownTransition	shutdownTransition
PushToEmergency	pushToEmergency
PopFromEmergency	popFromEmergency
ManagementLoopback	managementLoopback
model::State	standby
model::State	ready
model::State	init
model::State	shutdown
model::State	emergency
model::StateMachine	standbyReady
std::vector< transport::Address >	storedIds

---

Detailed Description

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

Management Service

The Management Service provides a state machine for component life-cycle management to help clients understand how the component will react to commands and queries.

URI: urn:jaus:jss:core:Management

Version: 1.1

Inherits From:

urn:jaus:jss:core:AccessControl

---

Constructor & Destructor Documentation

openjaus::core::Managed::Managed

(

)

openjaus::core::Managed::~Managed

(

)

[virtual]

---

Member Function Documentation

bool openjaus::core::Managed::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::ManagementInterface.

core::ReportStatus openjaus::core::Managed::getReportStatus

(

QueryStatus *

queryStatus

)

[virtual]

Send action for ReportStatus with input message QueryStatus.

Parameters:

[in]

queryStatus

- Input Trigger.

Returns:

ReportStatus Output Message.

Implements openjaus::core::ManagementInterface.

bool openjaus::core::Managed::isControllingClient

(

Reset *

reset

)

[virtual]

Parameters:

[in]

reset

- Input Trigger.

Returns:

Whether the condition is true.

Implements openjaus::core::ManagementInterface.

bool openjaus::core::Managed::isIDStored

(

ClearEmergency *

clearEmergency

)

[virtual]

isIDStored condition.

Parameters:

[in]

clearEmergency

- Input Trigger.

Returns:

Whether the condition is true.

Implements openjaus::core::ManagementInterface.

bool openjaus::core::Managed::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::ManagementInterface.

---

Member Data Documentation

model::State openjaus::core::Managed::emergency [protected]

model::State openjaus::core::Managed::init [protected]

ManagementLoopback openjaus::core::Managed::managementLoopback [protected]

Pause openjaus::core::Managed::pause [protected]

PopFromEmergency openjaus::core::Managed::popFromEmergency [protected]

PushToEmergency openjaus::core::Managed::pushToEmergency [protected]

model::State openjaus::core::Managed::ready [protected]

ResetTransition openjaus::core::Managed::resetTransition [protected]

model::State openjaus::core::Managed::shutdown [protected]

ShutdownTransition openjaus::core::Managed::shutdownTransition [protected]

model::State openjaus::core::Managed::standby [protected]

model::StateMachine openjaus::core::Managed::standbyReady [protected]

std::vector< transport::Address > openjaus::core::Managed::storedIds [protected]

ToReady openjaus::core::Managed::toReady [protected]

---

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

• include/openjaus/core/Managed.h
• src/openjaus/core/Managed.cpp