devmgr::common::TaskSetup Class Reference

#include <taskSetup.hpp>

Inheritance diagram for devmgr::common::TaskSetup:

Public Member Functions
	TaskSetup (const std::string &id, rad::SMAdapter &sm, DataContext &data_ctx, DeviceFacade &device_facade, modif::ReqSetup setup)
	Class constructor. More...
virtual	~TaskSetup ()
	Default destructor. More...
virtual void	run ()
	Thread run method. More...
	TaskSetup (const TaskSetup &)=delete
	Disable copy constructor. More...
TaskSetup &	operator= (const TaskSetup &)=delete
	Disable assignment operator. More...
	TaskSetup (const std::string &id, rad::SMAdapter &sm, DataContext &data_ctx, DeviceFacade &device_facade, modif::ReqSetup setup)
	Class constructor. More...
virtual	~TaskSetup ()
	Default destructor. More...
virtual void	run ()
	Thread run method. More...
	TaskSetup (const TaskSetup &)=delete
	Disable copy constructor. More...
TaskSetup &	operator= (const TaskSetup &)=delete
	Disable assignment operator. More...
	TaskSetup (const std::string &id, rad::SMAdapter &sm, DataContext &data_ctx, DeviceFacade &device_facade, modif::ReqSetup setup)
	Class constructor. More...
virtual	~TaskSetup ()
	Default destructor. More...
virtual void	run ()
	Thread run method. More...
	TaskSetup (const TaskSetup &)=delete
	Disable copy constructor. More...
TaskSetup &	operator= (const TaskSetup &)=delete
	Disable assignment operator. More...
Public Member Functions inherited from rad::Activity
	Activity (const std::string &id, rad::SMAdapter &sm)
virtual	~Activity ()
virtual void	start ()
virtual void	stop ()
std::string	GetName ()
int	SetName (const std::string &name)
pthread_t	GetPThread ()
void	TriggerInternalEvent (UniqueEvent &&e)
	Activity (const Activity &)=delete
Activity &	operator= (const Activity &)=delete
	Disable copy constructor. More...
	Activity (const std::string &id, rad::SMAdapter &sm)
virtual	~Activity ()
virtual void	start ()
virtual void	stop ()
std::string	GetName ()
int	SetName (const std::string &name)
pthread_t	GetPThread ()
void	TriggerInternalEvent (UniqueEvent &&e)
	Activity (const Activity &)=delete
Activity &	operator= (const Activity &)=delete
	Disable copy constructor. More...
	Activity (const std::string &id, rad::SMAdapter &sm)
virtual	~Activity ()
virtual void	start ()
virtual void	stop ()
std::string	GetName ()
int	SetName (const std::string &name)
pthread_t	GetPThread ()
void	TriggerInternalEvent (UniqueEvent &&e)
	Activity (const Activity &)=delete
Activity &	operator= (const Activity &)=delete
	Disable copy constructor. More...
Public Member Functions inherited from scxml4cpp::Activity
	Activity (const std::string &id)
bool	isRunning ()
void	setRunning (const bool running)
std::string	getId () const
void	setId (const std::string &id)
	Activity (const std::string &id)
bool	isRunning ()
void	setRunning (const bool running)
std::string	getId () const
void	setId (const std::string &id)
	Activity (const std::string &id)
bool	isRunning ()
void	setRunning (const bool running)
std::string	getId () const
void	setId (const std::string &id)

Detailed Description

This class implements a worker thread to manage a setup command. The thread will be active until the setup finishes succesfully or when an error or timeout occurs. When the server receives a STOP command, the thread shall be stopped.

The TaskSetup reports the outcome of the setup action through events. The three events used are: SetupDone, SetupTimeout and SetupError.

This worker class prevent the Device Manager to block when managing parallel setup events.

Several worker threads can be running concurrently. Handling of conflicts between devices addressed in several setups shall be handled at the controller side.

See Also

rad::Activity

Constructor & Destructor Documentation

devmgr::common::TaskSetup::TaskSetup	(	const std::string &	id,
		rad::SMAdapter &	sm,
		DataContext &	data_ctx,
		DeviceFacade &	device_facade,
		modif::ReqSetup	setup
	)

Class constructor.

Parameters

[in]	id	Thread ID
[in,out]	sm	Reference to SM object
[in,out]	data_ctx	Reference to data context object
[in,out]	device_facade	Reference to device facade object
[in]	setup	Copy of setup request object

devmgr::common::TaskSetup::~TaskSetup ( )

virtual

Default destructor.

devmgr::common::TaskSetup::TaskSetup ( const TaskSetup &  )

delete

Disable copy constructor.

devmgr::common::TaskSetup::TaskSetup	(	const std::string &	id,
		rad::SMAdapter &	sm,
		DataContext &	data_ctx,
		DeviceFacade &	device_facade,
		modif::ReqSetup	setup
	)

Class constructor.

Parameters

[in]	id	Thread ID
[in,out]	sm	Reference to SM object
[in,out]	data_ctx	Reference to data context object
[in,out]	device_facade	Reference to device facade object
[in]	setup	Copy of setup request object

virtual devmgr::common::TaskSetup::~TaskSetup ( )

virtual

Default destructor.

devmgr::common::TaskSetup::TaskSetup ( const TaskSetup &  )

delete

Disable copy constructor.

devmgr::common::TaskSetup::TaskSetup	(	const std::string &	id,
		rad::SMAdapter &	sm,
		DataContext &	data_ctx,
		DeviceFacade &	device_facade,
		modif::ReqSetup	setup
	)

Class constructor.

Parameters

[in]	id	Thread ID
[in,out]	sm	Reference to SM object
[in,out]	data_ctx	Reference to data context object
[in,out]	device_facade	Reference to device facade object
[in]	setup	Copy of setup request object

virtual devmgr::common::TaskSetup::~TaskSetup ( )

virtual

Default destructor.

devmgr::common::TaskSetup::TaskSetup ( const TaskSetup &  )

delete

Disable copy constructor.

Member Function Documentation

TaskSetup& devmgr::common::TaskSetup::operator= ( const TaskSetup &  )

delete

Disable assignment operator.

TaskSetup& devmgr::common::TaskSetup::operator= ( const TaskSetup &  )

delete

Disable assignment operator.

TaskSetup& devmgr::common::TaskSetup::operator= ( const TaskSetup &  )

delete

Disable assignment operator.

void devmgr::common::TaskSetup::run ( )

virtual

Thread run method.

Do-activity to perform the actions of a setup command. The specific actions are defined by the payload of the setup message.

Implements rad::Activity.

virtual void devmgr::common::TaskSetup::run ( )

virtual

Thread run method.

Do-activity to perform the actions of a setup command. The specific actions are defined by the payload of the setup message.

Implements rad::Activity.

virtual void devmgr::common::TaskSetup::run ( )

virtual

Thread run method.

Do-activity to perform the actions of a setup command. The specific actions are defined by the payload of the setup message.

Implements rad::Activity.

---

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

• fcf/devmgr/common/src/include/devmgr/common/taskSetup.hpp
• INTROOT/include/devmgr/common/taskSetup.hpp
• INTROOT/sources/fcf/devmgr/common/src/include/devmgr/common/taskSetup.hpp
• fcf/devmgr/common/src/taskSetup.cpp
• INTROOT/sources/fcf/devmgr/common/src/taskSetup.cpp