ctd::mptk::Manager Class Reference

IFW CTD Multiprocessing Toolkit Manager class. More...

#include <Manager.hpp>

Public Member Functions
	Manager ()
	~Manager ()
void	StartThreads ()
	Execute all threads registered. More...
void	PauseThreads ()
	Pause the threads. More...
void	StopThreads ()
	Request threads to end execution. More...
int16_t	WaitForThreadTerm (const double time_out=ctd::defines::NO_TIMEOUT)
	Wait for threads to terminate execution. Returns the number of threads running. More...
int16_t	NbOfThreadsRunning () const
	Returns the number of threads running; this includes the ones that may be paused. More...
MessageBus &	MsgBus ()
	Get reference to Message Bus. More...
std::string	Print () const
	Generate ASCII output providing a status of the object. More...
template<class THREAD_TYPE >
void	CreateThread (const std::string &thread_id, MessageBus &message_bus, const double period=0.1)
	Allocate new MPTK thread object of the given type. The allocated thread object is handled internally in the thread manager. More...
	Manager ()
	~Manager ()
void	StartThreads ()
	Execute all threads registered. More...
void	PauseThreads ()
	Pause the threads. More...
void	StopThreads ()
	Request threads to end execution. More...
int16_t	WaitForThreadTerm (const double time_out=ctd::defines::NO_TIMEOUT)
	Wait for threads to terminate execution. Returns the number of threads running. More...
int16_t	NbOfThreadsRunning () const
	Returns the number of threads running; this includes the ones that may be paused. More...
MessageBus &	MsgBus ()
	Get reference to Message Bus. More...
std::string	Print () const
	Generate ASCII output providing a status of the object. More...
template<class THREAD_TYPE >
void	CreateThread (const std::string &thread_id, MessageBus &message_bus, const double period=0.1)
	Allocate new MPTK thread object of the given type. The allocated thread object is handled internally in the thread manager. More...
	Manager ()
	~Manager ()
void	StartThreads ()
	Execute all threads registered. More...
void	PauseThreads ()
	Pause the threads. More...
void	StopThreads ()
	Request threads to end execution. More...
int16_t	WaitForThreadTerm (const double time_out=ctd::defines::NO_TIMEOUT)
	Wait for threads to terminate execution. Returns the number of threads running. More...
int16_t	NbOfThreadsRunning () const
	Returns the number of threads running; this includes the ones that may be paused. More...
MessageBus &	MsgBus ()
	Get reference to Message Bus. More...
std::string	Print () const
	Generate ASCII output providing a status of the object. More...
template<class THREAD_TYPE >
void	CreateThread (const std::string &thread_id, MessageBus &message_bus, const double period=0.1)
	Allocate new MPTK thread object of the given type. The allocated thread object is handled internally in the thread manager. More...

Detailed Description

IFW CTD Multiprocessing Toolkit Manager class.

Constructor & Destructor Documentation

ctd::mptk::Manager::Manager

(

)

ctd::mptk::Manager::~Manager

(

)

ctd::mptk::Manager::Manager

(

)

ctd::mptk::Manager::~Manager

(

)

ctd::mptk::Manager::Manager

(

)

ctd::mptk::Manager::~Manager

(

)

Member Function Documentation

template<class THREAD_TYPE >

void ctd::mptk::Manager::CreateThread ( const std::string &  thread_id, MessageBus &  message_bus, const double  period = 0.1  )

inline

Allocate new MPTK thread object of the given type. The allocated thread object is handled internally in the thread manager.

template<class THREAD_TYPE >

void ctd::mptk::Manager::CreateThread ( const std::string &  thread_id, MessageBus &  message_bus, const double  period = 0.1  )

inline

Allocate new MPTK thread object of the given type. The allocated thread object is handled internally in the thread manager.

template<class THREAD_TYPE >

void ctd::mptk::Manager::CreateThread ( const std::string &  thread_id, MessageBus &  message_bus, const double  period = 0.1  )

inline

Allocate new MPTK thread object of the given type. The allocated thread object is handled internally in the thread manager.

MessageBus & ctd::mptk::Manager::MsgBus

(

)

Get reference to Message Bus.

MessageBus& ctd::mptk::Manager::MsgBus

(

)

Get reference to Message Bus.

MessageBus& ctd::mptk::Manager::MsgBus

(

)

Get reference to Message Bus.

int16_t ctd::mptk::Manager::NbOfThreadsRunning

(

)

const

Returns the number of threads running; this includes the ones that may be paused.

int16_t ctd::mptk::Manager::NbOfThreadsRunning

(

)

const

Returns the number of threads running; this includes the ones that may be paused.

int16_t ctd::mptk::Manager::NbOfThreadsRunning

(

)

const

Returns the number of threads running; this includes the ones that may be paused.

void ctd::mptk::Manager::PauseThreads

(

)

Pause the threads.

void ctd::mptk::Manager::PauseThreads

(

)

Pause the threads.

void ctd::mptk::Manager::PauseThreads

(

)

Pause the threads.

std::string ctd::mptk::Manager::Print

(

)

const

Generate ASCII output providing a status of the object.

std::string ctd::mptk::Manager::Print

(

)

const

Generate ASCII output providing a status of the object.

std::string ctd::mptk::Manager::Print

(

)

const

Generate ASCII output providing a status of the object.

void ctd::mptk::Manager::StartThreads

(

)

Execute all threads registered.

void ctd::mptk::Manager::StartThreads

(

)

Execute all threads registered.

void ctd::mptk::Manager::StartThreads

(

)

Execute all threads registered.

void ctd::mptk::Manager::StopThreads

(

)

Request threads to end execution.

void ctd::mptk::Manager::StopThreads

(

)

Request threads to end execution.

void ctd::mptk::Manager::StopThreads

(

)

Request threads to end execution.

int16_t ctd::mptk::Manager::WaitForThreadTerm

(

const double

time_out = ctd::defines::NO_TIMEOUT

)

Wait for threads to terminate execution. Returns the number of threads running.

int16_t ctd::mptk::Manager::WaitForThreadTerm

(

const double

time_out = ctd::defines::NO_TIMEOUT

)

Wait for threads to terminate execution. Returns the number of threads running.

int16_t ctd::mptk::Manager::WaitForThreadTerm

(

const double

time_out = ctd::defines::NO_TIMEOUT

)

Wait for threads to terminate execution. Returns the number of threads running.

---

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

• ctd/mptk/src/include/ctd/mptk/Manager.hpp
• INTROOT/include/ctd/mptk/Manager.hpp
• INTROOT/sources/ctd/mptk/src/include/ctd/mptk/Manager.hpp
• ctd/mptk/src/Manager.cpp
• INTROOT/sources/ctd/mptk/src/Manager.cpp