rad::ActivityPthread Class Reference

#include <ActivityPthread.hpp>

Inheritance diagram for rad::ActivityPthread:

Public Member Functions
	ActivityPthread (const std::string &id, rad::SMAdapter &sm, const int cpu=-1, const int priotity=-1)
virtual	~ActivityPthread ()
virtual void	start ()
virtual void	stop ()
virtual void	run ()=0
std::string	GetName ()
int	SetName (const std::string &name)
int	GetCPU () const
int	GetConfiguredCPU () const
int	GetPriority ()
int	GetConfiguredPriority () const
rad::SMAdapter &	GetSM ()
void	TriggerInternalEvent (UniqueEvent &&e)
	ActivityPthread (const ActivityPthread &)=delete
ActivityPthread &	operator= (const ActivityPthread &)=delete
	Disable copy constructor. More...
	ActivityPthread (const std::string &id, rad::SMAdapter &sm, const int cpu=-1, const int priotity=-1)
virtual	~ActivityPthread ()
virtual void	start ()
virtual void	stop ()
virtual void	run ()=0
std::string	GetName ()
int	SetName (const std::string &name)
int	GetCPU () const
int	GetConfiguredCPU () const
int	GetPriority ()
int	GetConfiguredPriority () const
rad::SMAdapter &	GetSM ()
void	TriggerInternalEvent (UniqueEvent &&e)
	ActivityPthread (const ActivityPthread &)=delete
ActivityPthread &	operator= (const ActivityPthread &)=delete
	Disable copy constructor. More...
	ActivityPthread (const std::string &id, rad::SMAdapter &sm, const int cpu=-1, const int priotity=-1)
virtual	~ActivityPthread ()
virtual void	start ()
virtual void	stop ()
virtual void	run ()=0
std::string	GetName ()
int	SetName (const std::string &name)
int	GetCPU () const
int	GetConfiguredCPU () const
int	GetPriority ()
int	GetConfiguredPriority () const
rad::SMAdapter &	GetSM ()
void	TriggerInternalEvent (UniqueEvent &&e)
	ActivityPthread (const ActivityPthread &)=delete
ActivityPthread &	operator= (const ActivityPthread &)=delete
	Disable copy constructor. More...
Public Member Functions inherited from scxml4cpp::Activity
	Activity (const std::string &id)
virtual	~Activity ()
bool	isRunning ()
void	setRunning (const bool running)
std::string	getId () const
void	setId (const std::string &id)
	Activity (const std::string &id)
virtual	~Activity ()
bool	isRunning ()
void	setRunning (const bool running)
std::string	getId () const
void	setId (const std::string &id)
	Activity (const std::string &id)
virtual	~Activity ()
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 pthread-based do-activities.

Todo:

: move to std::threads

: add common base class

: add fiber based activity

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

Todo:

: move to std::threads

: add common base class

: add fiber based activity

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

Todo:

: move to std::threads

: add common base class

: add fiber based activity

Constructor & Destructor Documentation

rad::ActivityPthread::ActivityPthread	(	const std::string &	id,
		rad::SMAdapter &	sm,
		const int	cpu = -1,
		const int	priority = -1
	)

Parameters

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

rad::ActivityPthread::~ActivityPthread ( )

virtual

rad::ActivityPthread::ActivityPthread ( const ActivityPthread &  )

delete

rad::ActivityPthread::ActivityPthread	(	const std::string &	id,
		rad::SMAdapter &	sm,
		const int	cpu = -1,
		const int	priotity = -1
	)

virtual rad::ActivityPthread::~ActivityPthread ( )

virtual

rad::ActivityPthread::ActivityPthread ( const ActivityPthread &  )

delete

rad::ActivityPthread::ActivityPthread	(	const std::string &	id,
		rad::SMAdapter &	sm,
		const int	cpu = -1,
		const int	priotity = -1
	)

virtual rad::ActivityPthread::~ActivityPthread ( )

virtual

rad::ActivityPthread::ActivityPthread ( const ActivityPthread &  )

delete

Member Function Documentation

int rad::ActivityPthread::GetConfiguredCPU

(

)

const

Returns

the CPU on which the thread was configured to run.

int rad::ActivityPthread::GetConfiguredCPU

(

)

const

int rad::ActivityPthread::GetConfiguredCPU

(

)

const

int rad::ActivityPthread::GetConfiguredPriority

(

)

const

Returns

the configured priority for this thread.

int rad::ActivityPthread::GetConfiguredPriority

(

)

const

int rad::ActivityPthread::GetConfiguredPriority

(

)

const

int rad::ActivityPthread::GetCPU

(

)

const

int rad::ActivityPthread::GetCPU

(

)

const

Returns

the CPU on which the thread is running. It has to be invoked from the running method, otherwise it returns the CPU where the main thread is running.

int rad::ActivityPthread::GetCPU

(

)

const

std::string rad::ActivityPthread::GetName

(

)

std::string rad::ActivityPthread::GetName

(

)

std::string rad::ActivityPthread::GetName

(

)

Returns

The name of the do-activity thread.

int rad::ActivityPthread::GetPriority

(

)

Returns

the priority of this thread (> 0) or the error code (< 0).

int rad::ActivityPthread::GetPriority

(

)

int rad::ActivityPthread::GetPriority

(

)

rad::SMAdapter& rad::ActivityPthread::GetSM

(

)

rad::SMAdapter & rad::ActivityPthread::GetSM

(

)

rad::SMAdapter& rad::ActivityPthread::GetSM

(

)

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

delete

Disable copy constructor.

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

delete

Disable copy constructor.

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

delete

Disable copy constructor.

virtual void rad::ActivityPthread::run ( )

pure virtual

Implements scxml4cpp::Activity.

Implemented in MyTestDoActivityPthread.

virtual void rad::ActivityPthread::run ( )

pure virtual

Implements scxml4cpp::Activity.

Implemented in MyTestDoActivityPthread.

virtual void rad::ActivityPthread::run ( )

pure virtual

Implements scxml4cpp::Activity.

Implemented in MyTestDoActivityPthread.

int rad::ActivityPthread::SetName

(

const std::string &

name

)

int rad::ActivityPthread::SetName

(

const std::string &

name

)

Parameters

[in]

Name

for the thread.

Returns

error code or 0 if successfull

int rad::ActivityPthread::SetName

(

const std::string &

name

)

virtual void rad::ActivityPthread::start ( )

virtual

Implements scxml4cpp::Activity.

void rad::ActivityPthread::start ( )

virtual

Helper method to start a do-activity thread.

Implements scxml4cpp::Activity.

virtual void rad::ActivityPthread::start ( )

virtual

Implements scxml4cpp::Activity.

virtual void rad::ActivityPthread::stop ( )

virtual

Implements scxml4cpp::Activity.

virtual void rad::ActivityPthread::stop ( )

virtual

Implements scxml4cpp::Activity.

void rad::ActivityPthread::stop ( )

virtual

Helper method to stop a do-activity thread.

Implements scxml4cpp::Activity.

void rad::ActivityPthread::TriggerInternalEvent

(

UniqueEvent &&

e

)

void rad::ActivityPthread::TriggerInternalEvent

(

UniqueEvent &&

e

)

void rad::ActivityPthread::TriggerInternalEvent

(

UniqueEvent &&

e

)

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

Parameters

[in]

e

Event to trigger/propagate.

---

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

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