Publisher Thread MPTK Thread implementation (see also ccf::mptk::Thread). More...

#include <pubThread.hpp>

Inheritance diagram for ccf::control::PubThread:

Public Member Functions
	PubThread (const std::string &thread_name, ccf::mptk::MessageBus &message_bus, const double period=0.1)

virtual	~PubThread ()

void	Initialise ()
	Initialise this thread (object).

virtual void	UserLogic ()
	Use logic invoked periodically (ccf::mptk::Thread).

void	SetProcThrOutputQ (std::shared_ptr< ccf::common::FrameQueue > &queue)
	Set reference to the Output Queue of this Processing Thread.

ccf::common::FrameQueue &	GetProcThrOutputQ ()
	Get reference to the Output Queue of this Processing Thread.

void	SetStatus (const ccf::PubStatus status)
	Set the Publishing Status of this Publisher Thread.

ccf::PubStatus	GetStatus () const
	Return Publishing Status of this Publisher Thread.

void	AddPublisher (ccf::common::PubBase &pub_obj)

uint8_t	NbOfPublishers () const

const ccf::common::PubBase &	GetPublisher (const uint16_t nb) const
	Get the reference to a specific Data Publisher registered in this Publisher Thread (object).

ccf::common::PubBase &	GetPublisher ()
	Get the reference to the internal publisher object.

const std::list< ccf::common::PubBase * > &	GetPublishers () const
	Get the list of internal Data Publisher (objects).

void	SetParentProcThreadName (const std::string &parent_proc_thread_name)
	Set the name of the parent Processing Thread in the object.

const std::string &	GetParentProcThreadName () const
	Return the name of the parent Processing Thread from the object.

ccf::common::FrameStatistics &	GetFrameStat ()
	Get reference to frame handling statistics.

Public Member Functions inherited from ccf::mptk::Thread
	Thread (const std::string &thread_name, MessageBus &message_bus, const double period=0.1)
	Constructor method, setting up the internal members.

virtual	~Thread ()

void	SetPriority (const int prio=-1)
	If invoked, it will run the thread in real-time mode with the given priority [0; 99].

std::string	GetName () const
	Return the thread Name.

void	Run ()
	Method to invoke the user provided business logic of the thread. The method executes internally a loop.

virtual void	UserLogic ()
	User provided business logic. The UserLogic method need not execute an internal loop. It is taken care of by the Control() method. Instead the UserLogic() method should (normally) execute it business logic, and return control to the Control() method, which will take of the thread management.

void	Start ()
	Start the thread execution.

void	Stop ()
	Stop the thread execution.

void	Pause ()
	Pause the thread execution.

void	Continue ()
	Continue a paused thread execution.

double	GetDrift () const

bool	GetExecFlag ()
	Check the Thread Execution Flag. The Thread Execution Flag shall be called regularly in the thread, at least during every internal cycle (of LogicUser()). The behavior is as follows: THREAD_EXEC_RUNNING: Return immediately with true. THREAD_EXEC_PAUSED: Wait internally for flag to change to THREAD_EXEC_RUN/_STOP. TRHEAD_EXEC_STOPPED: Return immediately with false. Thread LogicUser() shall return.

ThreadExecControl	GetExecFlag () const
	Return the value of the Thread Execution Flag.

bool	Terminated ()
	Returns true if thread no longer running.

MessageBus &	MsgBus ()
	Get acces to the MessageBus associated with this thread object.

std::string	ToString () const
	Generate ASCII output providing a status of the object.

Public Member Functions inherited from ccf::Base
	Base ()

	~Base ()

const std::string &	GetClassName () const
	Return the allocated name of the class.

Static Public Member Functions
static void	SetStatusAll (const ccf::PubStatus status)
	Set the Publishing Status of all Publisher Threads running.

Static Public Member Functions inherited from ccf::Base
static ccf::mptk::Manager &	Mptk ()
	Return reference to internal MPTK instance (singleton).

Additional Inherited Members
Public Types inherited from ccf::mptk::Thread
enum	ThreadExecControl { THREAD_EXEC_STOPPED = 1 , THREAD_EXEC_RUNNING , THREAD_EXEC_PAUSED }
	Thread execution control/status. More...

Static Public Attributes inherited from ccf::mptk::Thread
static std::map< std::string, Thread * >	s_thread_registry

Protected Member Functions inherited from ccf::Base
void	SetClassName (const std::string &class_name)
	Set the name of the class in question.

Detailed Description

Publisher Thread MPTK Thread implementation (see also ccf::mptk::Thread).

Constructor & Destructor Documentation

◆ PubThread()

ccf::control::PubThread::PubThread	(	const std::string &	thread_name,
		ccf::mptk::MessageBus &	message_bus,
		const double	period = `0.1`
	)

See ccf::mptk::Thread. Expects name of the type: "Proc::<name>"!

◆ ~PubThread()

ccf::control::PubThread::~PubThread ( )

virtual

Member Function Documentation

◆ AddPublisher()

void ccf::control::PubThread::AddPublisher ( ccf::common::PubBase & pub_obj )

Register a new Data Publisher in the Publisher Thread. Note: For the moment only one Data Publisher is supported.

◆ GetFrameStat()

ccf::common::FrameStatistics & ccf::control::PubThread::GetFrameStat ( )

Get reference to frame handling statistics.

◆ GetParentProcThreadName()

const std::string & ccf::control::PubThread::GetParentProcThreadName ( ) const

Return the name of the parent Processing Thread from the object.

◆ GetProcThrOutputQ()

ccf::common::FrameQueue & ccf::control::PubThread::GetProcThrOutputQ ( )

Get reference to the Output Queue of this Processing Thread.

◆ GetPublisher() [1/2]

ccf::common::PubBase & ccf::control::PubThread::GetPublisher ( )

Get the reference to the internal publisher object.

◆ GetPublisher() [2/2]

const ccf::common::PubBase & ccf::control::PubThread::GetPublisher ( const uint16_t nb ) const

Get the reference to a specific Data Publisher registered in this Publisher Thread (object).

◆ GetPublishers()

const std::list< ccf::common::PubBase * > & ccf::control::PubThread::GetPublishers ( ) const

Get the list of internal Data Publisher (objects).

◆ GetStatus()

ccf::PubStatus ccf::control::PubThread::GetStatus ( ) const

Return Publishing Status of this Publisher Thread.

◆ Initialise()

void ccf::control::PubThread::Initialise ( )

Initialise this thread (object).

◆ NbOfPublishers()

uint8_t ccf::control::PubThread::NbOfPublishers ( ) const

Return the number of internal Data Publishers. Note: For the moment only one Data Publisher is supported.

◆ SetParentProcThreadName()

void ccf::control::PubThread::SetParentProcThreadName ( const std::string & parent_proc_thread_name )

Set the name of the parent Processing Thread in the object.

◆ SetProcThrOutputQ()

void ccf::control::PubThread::SetProcThrOutputQ ( std::shared_ptr< ccf::common::FrameQueue > & queue )

Set reference to the Output Queue of this Processing Thread.

◆ SetStatus()

void ccf::control::PubThread::SetStatus ( const ccf::PubStatus status )

Set the Publishing Status of this Publisher Thread.

◆ SetStatusAll()

void ccf::control::PubThread::SetStatusAll ( const ccf::PubStatus status )

static

Set the Publishing Status of all Publisher Threads running.

◆ UserLogic()

void ccf::control::PubThread::UserLogic ( )