rad::Activity Class Reference

#include <Activity.hpp>

Inheritance diagram for rad::Activity:

Public Member Functions
	Activity (const std::string &id, rad::SMAdapter &sm)
virtual	~Activity ()
virtual void	start ()
virtual void	stop ()
virtual void	run ()=0
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 ()
virtual void	run ()=0
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 ()
virtual void	run ()=0
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 is the base class for thread-based do-activities.

Todo:

: move to std::threads

: add common base class

: add fiber based activity

This class is the base class for thread-based do-activities.

Todo:

: move to std::threads

: add common base class

: add fiber based activity

This class is the base class for thread-based do-activities.

Todo:

: move to std::threads

: add common base class

: add fiber based activity

Constructor & Destructor Documentation

rad::Activity::Activity	(	const std::string &	id,
		rad::SMAdapter &	sm
	)

Parameters

[in]	id	Identifier of the do-activity.
[in]	sm	Reference to the StateMachine adapter.

rad::Activity::~Activity ( )

virtual

Reimplemented from scxml4cpp::Activity.

rad::Activity::Activity ( const Activity &  )

delete

rad::Activity::Activity	(	const std::string &	id,
		rad::SMAdapter &	sm
	)

virtual rad::Activity::~Activity ( )

virtual

Reimplemented from scxml4cpp::Activity.

rad::Activity::Activity ( const Activity &  )

delete

rad::Activity::Activity	(	const std::string &	id,
		rad::SMAdapter &	sm
	)

virtual rad::Activity::~Activity ( )

virtual

Reimplemented from scxml4cpp::Activity.

rad::Activity::Activity ( const Activity &  )

delete

Member Function Documentation

std::string rad::Activity::GetName

(

)

Returns

The name of the do-activity thread.

std::string rad::Activity::GetName

(

)

std::string rad::Activity::GetName

(

)

pthread_t rad::Activity::GetPThread

(

)

pthread_t rad::Activity::GetPThread

(

)

Returns

The pthread underlying to the std::thread implementation.

pthread_t rad::Activity::GetPThread

(

)

Activity& rad::Activity::operator= ( const Activity &  )

delete

Disable copy constructor.

Activity& rad::Activity::operator= ( const Activity &  )

delete

Disable copy constructor.

Activity& rad::Activity::operator= ( const Activity &  )

delete

Disable copy constructor.

virtual void rad::Activity::run ( )

pure virtual

Implements scxml4cpp::Activity.

Implemented in devmgr::common::TaskSetup, devmgr::common::TaskSetup, devmgr::common::TaskSetup, devmgr::common::ActivityRecovering, devmgr::common::ActivityRecovering, devmgr::common::ActivityRecovering, devmgr::common::ActivityEnabling, devmgr::common::ActivityInitialising, devmgr::common::ActivityEnabling, devmgr::common::ActivityInitialising, devmgr::common::ActivityEnabling, devmgr::common::ActivityInitialising, MyTestDoActivity, ctd::qatk::qapp2::ActivityBusy, ctd::qatk::qapp2::ActivityDisabling, ctd::qatk::qapp2::ActivityEnabling, ctd::qatk::qapp2::ActivityInitializing, ctd::qatk::qapp2::ActivityRecovering, ctd::qatk::qapp2::ActivityBusy, ctd::qatk::qapp2::ActivityDisabling, ctd::qatk::qapp2::ActivityEnabling, ctd::qatk::qapp2::ActivityInitializing, ctd::qatk::qapp2::ActivityRecovering, server::ActivityMoving, server2::ActivityMoving, server::ActivityMoving, and server2::ActivityMoving.

virtual void rad::Activity::run ( )

pure virtual

Implements scxml4cpp::Activity.

Implemented in devmgr::common::TaskSetup, devmgr::common::TaskSetup, devmgr::common::TaskSetup, devmgr::common::ActivityRecovering, devmgr::common::ActivityRecovering, devmgr::common::ActivityRecovering, devmgr::common::ActivityEnabling, devmgr::common::ActivityInitialising, devmgr::common::ActivityEnabling, devmgr::common::ActivityInitialising, devmgr::common::ActivityEnabling, devmgr::common::ActivityInitialising, MyTestDoActivity, ctd::qatk::qapp2::ActivityBusy, ctd::qatk::qapp2::ActivityDisabling, ctd::qatk::qapp2::ActivityEnabling, ctd::qatk::qapp2::ActivityInitializing, ctd::qatk::qapp2::ActivityRecovering, ctd::qatk::qapp2::ActivityBusy, ctd::qatk::qapp2::ActivityDisabling, ctd::qatk::qapp2::ActivityEnabling, ctd::qatk::qapp2::ActivityInitializing, ctd::qatk::qapp2::ActivityRecovering, server::ActivityMoving, server2::ActivityMoving, server::ActivityMoving, and server2::ActivityMoving.

virtual void rad::Activity::run ( )

pure virtual

Implements scxml4cpp::Activity.

Implemented in devmgr::common::TaskSetup, devmgr::common::TaskSetup, devmgr::common::TaskSetup, devmgr::common::ActivityRecovering, devmgr::common::ActivityRecovering, devmgr::common::ActivityRecovering, devmgr::common::ActivityEnabling, devmgr::common::ActivityInitialising, devmgr::common::ActivityEnabling, devmgr::common::ActivityInitialising, devmgr::common::ActivityEnabling, devmgr::common::ActivityInitialising, MyTestDoActivity, ctd::qatk::qapp2::ActivityBusy, ctd::qatk::qapp2::ActivityDisabling, ctd::qatk::qapp2::ActivityEnabling, ctd::qatk::qapp2::ActivityInitializing, ctd::qatk::qapp2::ActivityRecovering, ctd::qatk::qapp2::ActivityBusy, ctd::qatk::qapp2::ActivityDisabling, ctd::qatk::qapp2::ActivityEnabling, ctd::qatk::qapp2::ActivityInitializing, ctd::qatk::qapp2::ActivityRecovering, server::ActivityMoving, server2::ActivityMoving, server::ActivityMoving, and server2::ActivityMoving.

int rad::Activity::SetName

(

const std::string &

name

)

Parameters

[in]

Name

for the thread.

Returns

error code or 0 if successfull

int rad::Activity::SetName

(

const std::string &

name

)

int rad::Activity::SetName

(

const std::string &

name

)

void rad::Activity::start ( )

virtual

Helper method to start a do-activity thread.

Implements scxml4cpp::Activity.

virtual void rad::Activity::start ( )

virtual

Implements scxml4cpp::Activity.

virtual void rad::Activity::start ( )

virtual

Implements scxml4cpp::Activity.

virtual void rad::Activity::stop ( )

virtual

Implements scxml4cpp::Activity.

virtual void rad::Activity::stop ( )

virtual

Implements scxml4cpp::Activity.

void rad::Activity::stop ( )

virtual

Helper method to stop a do-activity thread.

Implements scxml4cpp::Activity.

void rad::Activity::TriggerInternalEvent

(

UniqueEvent &&

e

)

void rad::Activity::TriggerInternalEvent

(

UniqueEvent &&

e

)

Helper method to trigger an internal event and propagate it to the main thread.

Parameters

[in]

e

Event to trigger/propagate.

void rad::Activity::TriggerInternalEvent

(

UniqueEvent &&

e

)

---

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

• INTROOT/include/rad/Activity.hpp
• INTROOT/sources/tools/rad/cpp/sm/src/include/rad/Activity.hpp
• tools/rad/cpp/sm/src/include/rad/Activity.hpp
• INTROOT/sources/tools/rad/cpp/sm/src/Activity.cpp
• tools/rad/cpp/sm/src/Activity.cpp