fcf::devmgr::common::ActionsSetup< EVENT_TYPE, EXCEPTION_TYPE > Class Template Reference

#include <actionsSetup.hpp>

Inheritance diagram for fcf::devmgr::common::ActionsSetup< EVENT_TYPE, EXCEPTION_TYPE >:

Public Types
using	SetupRequest = std::optional< typename EVENT_TYPE::payload_t >
using	ActivityMap = std::map< std::string, std::shared_ptr< scxml4cpp::Activity >>
using	RequestMap = std::map< std::string, SetupRequest >
using	ActivityPair = std::pair< std::string, std::shared_ptr< scxml4cpp::Activity >>
using	RequestPair = std::pair< std::string, SetupRequest >

Public Member Functions
	ActionsSetup (std::string name, boost::asio::io_service &ios, rad::SMAdapter &sm, DataContext &data_ctx, DeviceFacade &device_facade)
virtual void	Start (rad::AnyEvent const &last_event)
virtual void	Stop (rad::AnyEvent const &last_event)
virtual void	Done (rad::AnyEvent const &last_event)
virtual void	Error (rad::AnyEvent const &last_event)
virtual void	Timeout (rad::AnyEvent const &last_event)
	ActionsSetup (const ActionsSetup &)=delete
	Disable copy constructor. More...
ActionsSetup &	operator= (const ActionsSetup &)=delete
	Disable assignment operator. More...

Detailed Description

template<typename EVENT_TYPE, typename EXCEPTION_TYPE>
class fcf::devmgr::common::ActionsSetup< EVENT_TYPE, EXCEPTION_TYPE >

Class grouping the actions related to the Setup event.

Member Typedef Documentation

template<typename EVENT_TYPE , typename EXCEPTION_TYPE >

using fcf::devmgr::common::ActionsSetup< EVENT_TYPE, EXCEPTION_TYPE >::ActivityMap = std::map<std::string,std::shared_ptr<scxml4cpp::Activity>>

template<typename EVENT_TYPE , typename EXCEPTION_TYPE >

using fcf::devmgr::common::ActionsSetup< EVENT_TYPE, EXCEPTION_TYPE >::ActivityPair = std::pair<std::string, std::shared_ptr<scxml4cpp::Activity>>

template<typename EVENT_TYPE , typename EXCEPTION_TYPE >

using fcf::devmgr::common::ActionsSetup< EVENT_TYPE, EXCEPTION_TYPE >::RequestMap = std::map<std::string, SetupRequest>

template<typename EVENT_TYPE , typename EXCEPTION_TYPE >

using fcf::devmgr::common::ActionsSetup< EVENT_TYPE, EXCEPTION_TYPE >::RequestPair = std::pair<std::string, SetupRequest>

template<typename EVENT_TYPE , typename EXCEPTION_TYPE >

using fcf::devmgr::common::ActionsSetup< EVENT_TYPE, EXCEPTION_TYPE >::SetupRequest = std::optional<typename EVENT_TYPE::payload_t>

Constructor & Destructor Documentation

template<typename EVENT_TYPE , typename EXCEPTION_TYPE >

fcf::devmgr::common::ActionsSetup< EVENT_TYPE, EXCEPTION_TYPE >::ActionsSetup	(	std::string	name,
		boost::asio::io_service &	ios,
		rad::SMAdapter &	sm,
		DataContext &	data_ctx,
		DeviceFacade &	device_facade
	)

Constructor.

Parameters

[in]	name	Action group name
[in]	ios	Reference to the event loop.
[in]	sm	State machine reference
[in]	data_ctx	Data shared within the application among actions and activities.
[in]	device_facade	Facade to all devices handled by the manager.

template<typename EVENT_TYPE , typename EXCEPTION_TYPE >

fcf::devmgr::common::ActionsSetup< EVENT_TYPE, EXCEPTION_TYPE >::ActionsSetup ( const ActionsSetup< EVENT_TYPE, EXCEPTION_TYPE > &  )

delete

Disable copy constructor.

Member Function Documentation

template<typename EVENT_TYPE , typename EXCEPTION_TYPE >

virtual void fcf::devmgr::common::ActionsSetup< EVENT_TYPE, EXCEPTION_TYPE >::Done ( rad::AnyEvent const &  last_event )

virtual

Implementation of the Done callback. This method implements the actions when the Setup event was finalized.

Parameters

[in]

last_event

Last event received.

template<typename EVENT_TYPE , typename EXCEPTION_TYPE >

virtual void fcf::devmgr::common::ActionsSetup< EVENT_TYPE, EXCEPTION_TYPE >::Error ( rad::AnyEvent const &  last_event )

virtual

Implementation of the Error callback. This method implements the actions when the Setup event was finalized with an error.

Parameters

[in]

last_event

Last event received.

template<typename EVENT_TYPE , typename EXCEPTION_TYPE >

ActionsSetup& fcf::devmgr::common::ActionsSetup< EVENT_TYPE, EXCEPTION_TYPE >::operator= ( const ActionsSetup< EVENT_TYPE, EXCEPTION_TYPE > &  )

delete

Disable assignment operator.

template<typename EVENT_TYPE , typename EXCEPTION_TYPE >

virtual void fcf::devmgr::common::ActionsSetup< EVENT_TYPE, EXCEPTION_TYPE >::Start ( rad::AnyEvent const &  last_event )

virtual

Implementation of the Start callback.

Parameters

[in]

last_event

Last event received which should be a Start event (the Start event is triggered by a ReqSetup request).

template<typename EVENT_TYPE , typename EXCEPTION_TYPE >

virtual void fcf::devmgr::common::ActionsSetup< EVENT_TYPE, EXCEPTION_TYPE >::Stop ( rad::AnyEvent const &  last_event )

virtual

Implementation of the Stop callback. This callback:

• 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).

template<typename EVENT_TYPE , typename EXCEPTION_TYPE >

virtual void fcf::devmgr::common::ActionsSetup< EVENT_TYPE, EXCEPTION_TYPE >::Timeout ( rad::AnyEvent const &  last_event )

virtual

Implementation of the Timeout callback. This method implements the actions when the Setup event was finalized unexpectly.

Parameters

[in]

last_event

Last event received.

---

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

• devmgr/common/src/include/fcf/devmgr/common/actionsSetup.hpp