fcf::devmgr::common::ActionsStd Class Reference

#include <actionsStd.hpp>

Inheritance diagram for fcf::devmgr::common::ActionsStd:

Public Member Functions
	ActionsStd (boost::asio::io_service &ios, rad::SMAdapter &sm, DataContext &data, DeviceFacade &device_facade)
void	notifyEvent (scxml4cpp::Event *e)
void	notifyStatus (std::set< scxml4cpp::State * > &status)
const std::string &	GetStatus ()
	ActionsStd. More...
void	State (const rad::AnyEvent &last_event)
void	Status (const rad::AnyEvent &last_event)
void	DevNames (const rad::AnyEvent &last_event)
void	Stop (const rad::AnyEvent &last_event)
void	Init (const rad::AnyEvent &last_event)
void	Enable (const rad::AnyEvent &last_event)
void	Disable (const rad::AnyEvent &last_event)
void	Reset (const rad::AnyEvent &last_event)
void	Config (const rad::AnyEvent &last_event)
void	SetLog (const rad::AnyEvent &last_event)
void	Exit (const rad::AnyEvent &last_event)
void	ExitNoReply (const rad::AnyEvent &last_event)
void	Simulate (const rad::AnyEvent &last_event)
	Implementation of the Simulate action. More...
void	StopSim (const rad::AnyEvent &last_event)
	Implementation of the StopSim action. More...
void	Ignore (const rad::AnyEvent &last_event)
	Implementation of the Ignore action. More...
void	StopIgn (const rad::AnyEvent &last_event)
void	HwReset (rad::AnyEvent const &last_event)
void	HwInit (rad::AnyEvent const &last_event)
void	HwEnable (rad::AnyEvent const &last_event)
void	HwDisable (rad::AnyEvent const &last_event)
void	BeginAcq (rad::AnyEvent const &last_event)
void	EndAcq (rad::AnyEvent const &last_event)
	ActionsStd (const ActionsStd &)=delete
ActionsStd &	operator= (const ActionsStd &)=delete
	Disable copy constructor. More...

Detailed Description

This class contains the implementation of the actions dealing with the following "standard" commands:

• ReqExit
• ReqStatus
• ReqDevNames
• ReqReset
• ReqStop
• ReqInit
• ReqConfig
• ReqEnable
• ReqDisable

and the following signals:

• SIGINT
• SIGTERM

In addition it implements the:

• scxml4cpp::StatusListener interface to receive the notification of change of state from the State Machine engine.
• rad::EventRejectListener interface to receive the notification of rejected event from the State Machine adapter.

Constructor & Destructor Documentation

fcf::devmgr::common::ActionsStd::ActionsStd	(	boost::asio::io_service &	ios,
		rad::SMAdapter &	sm,
		DataContext &	data,
		DeviceFacade &	device_facade
	)

Constructor.

Parameters

[in]	ios	Reference to the event loop.
[in]	sm	State machine reference
[in]	data	Data shared within the application among actions and activities.
[in]	device_facade	Device facade reference

fcf::devmgr::common::ActionsStd::ActionsStd ( const ActionsStd &  )

delete

Member Function Documentation

void fcf::devmgr::common::ActionsStd::BeginAcq

(

rad::AnyEvent const &

last_event

)

Implementation of the BeginAcq action.

Parameters

[in]

last_event

Last event received.

void fcf::devmgr::common::ActionsStd::Config

(

const rad::AnyEvent &

last_event

)

Implementation of the Config action. This action:

• reload the application configuration file,
• re-establish connection to the Runtime-DB,
• replies back for the originator of the ReqConfig request.

Parameters

[in]

last_event

Last event received which should be a Config event (the Config event is triggered by a ReqConfig request).

void fcf::devmgr::common::ActionsStd::DevNames

(

const rad::AnyEvent &

last_event

)

Implementation of the DevNames action. This action:

• replies back for the originator of the request with the list of devices managed by the server.

Parameters

[in]

last_event

Last event received which should be a DevNames event

void fcf::devmgr::common::ActionsStd::Disable

(

const rad::AnyEvent &

last_event

)

Implementation of the Disable action. This action:

• replies back for the originator of the ReqDisable request.

Parameters

[in]

last_event

Last event received which should be a Stop event (the Disable event is triggered by a ReqDisable request).

void fcf::devmgr::common::ActionsStd::Enable

(

const rad::AnyEvent &

last_event

)

Implementation of the Enable action. This action:

• replies back for the originator of the ReqEnable request.

Parameters

[in]

last_event

Last event received which should be a Stop event (the Enable event is triggered by a ReqEnable request).

void fcf::devmgr::common::ActionsStd::EndAcq

(

rad::AnyEvent const &

last_event

)

Implementation of the EndAcq action.

Parameters

[in]

last_event

Last event received.

void fcf::devmgr::common::ActionsStd::Exit

(

const rad::AnyEvent &

last_event

)

Implementation of the Exit action. This action:

• replies back for the originator of the ReqExit request.
• stops the event loop.

Parameters

[in]

last_event

Last event received which should be an Exit event (the Exit event is triggered by a ReqExit request).

void fcf::devmgr::common::ActionsStd::ExitNoReply

(

const rad::AnyEvent &

last_event

)

Implementation of the ExitNoReply action. This action:

• stops the event loop.

Parameters

[in]

last_event

Last event received which should be an ExitNoReply event (the ExitNoReply event is triggered by a SIGTERM, SIGINT signals).

const std::string & fcf::devmgr::common::ActionsStd::GetStatus

(

)

ActionsStd.

Returns

The last status notified by the State Machine.

void fcf::devmgr::common::ActionsStd::HwDisable

(

rad::AnyEvent const &

last_event

)

Implementation of the HwDisable action. This action triggers a disable of a set of controllers.

Parameters

[in]

last_event

Last event received.

void fcf::devmgr::common::ActionsStd::HwEnable

(

rad::AnyEvent const &

last_event

)

Implementation of the HwEnable action. This action triggers a enable of a set of controllers.

Parameters

[in]

last_event

Last event received.

void fcf::devmgr::common::ActionsStd::HwInit

(

rad::AnyEvent const &

last_event

)

Implementation of the HwInit action. This action triggers a init of a set of controllers.

Parameters

[in]

last_event

Last event received.

void fcf::devmgr::common::ActionsStd::HwReset

(

rad::AnyEvent const &

last_event

)

Implementation of the HwReset action. This action triggers a reset of a set of controllers.

Parameters

[in]

last_event

Last event received.

void fcf::devmgr::common::ActionsStd::Ignore

(

const rad::AnyEvent &

last_event

)

Implementation of the Ignore action.

Parameters

[in]

last_event

Last event received which should be a Ignore event

Ignore from the configuration one or more devices managed by the server. When a device is ignored, it will not forward commands to its controller and the server will ignore its state.

void fcf::devmgr::common::ActionsStd::Init

(

const rad::AnyEvent &

last_event

)

Implementation of the Init action. This action:

• re-initialize the application run-time data,
• replies back for the originator of the ReqInit request.

Parameters

[in]

last_event

Last event received which should be a Init event (the Init event is triggered by a ReqInit request).

void fcf::devmgr::common::ActionsStd::notifyEvent

(

scxml4cpp::Event *

e

)

Implementation of the scxml4cpp::EventListener interface to know when an event has been rejected/ignored/processed. It can be used to implement the event reject policy.

Parameters

[in]

e

Received event.

void fcf::devmgr::common::ActionsStd::notifyStatus

(

std::set< scxml4cpp::State * > &

status

)

Implementation of the scxml4cpp::StatusListener interface to receive the change of state notification.

Parameters

[in]

status

Current State Machine active states configuration.

ActionsStd& fcf::devmgr::common::ActionsStd::operator= ( const ActionsStd &  )

delete

Disable copy constructor.

void fcf::devmgr::common::ActionsStd::Reset

(

const rad::AnyEvent &

last_event

)

Implementation of the Reset action. This action:

• replies back for the originator of the ReqReset request.

Parameters

[in]

last_event

Last event received which should be a Stop event (the Disable event is triggered by a ReqReset request).

void fcf::devmgr::common::ActionsStd::SetLog

(

const rad::AnyEvent &

last_event

)

Implementation of the SetLog action. This action:

• changes the log level,
• replies back for the originator of the ReqSetLog request.

Parameters

[in]

last_event

Last event received which should be a SetLog event (the SetLog event is triggered by a ReqSetLog request).

void fcf::devmgr::common::ActionsStd::Simulate

(

const rad::AnyEvent &

last_event

)

Implementation of the Simulate action.

Parameters

[in]

last_event

Last event received which should be a Simulate event

Simulate one or more devices managed by the server

void fcf::devmgr::common::ActionsStd::State

(

const rad::AnyEvent &

last_event

)

Implementation of the State action. This action:

• replies back for the originator of the request with the current State Machine active state configuration.

Parameters

[in]

last_event

Last event received which should be a State event

void fcf::devmgr::common::ActionsStd::Status

(

const rad::AnyEvent &

last_event

)

Implementation of the Status action. This action:

• replies back for the originator of the request with the status of each device requested.

Parameters

[in]

last_event

Last event received which should be a Status event

void fcf::devmgr::common::ActionsStd::Stop

(

const rad::AnyEvent &

last_event

)

Implementation of the Stop action. This action:

• replies back for the originator of the ReqStop request.

Parameters

[in]

last_event

Last event received which should be a Stop event (the Stop event is triggered by a ReqStop request).

void fcf::devmgr::common::ActionsStd::StopIgn

(

const rad::AnyEvent &

last_event

)

Implementation of the StopIgn action.

Parameters

[in]

last_event

Last event received which should be a StopIgn event

void fcf::devmgr::common::ActionsStd::StopSim

(

const rad::AnyEvent &

last_event

)

Implementation of the StopSim action.

Parameters

[in]

last_event

Last event received which should be a StopSim event

Stop simulation of one or more devices managed by the server.

---

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

• devmgr/common/src/include/fcf/devmgr/common/actionsStd.hpp
• devmgr/common/src/actionsStd.cpp