ifw-ccf 5.0.2
Loading...
Searching...
No Matches
Public Member Functions | List of all members
ifw::ccf::control::AcqThread Class Reference

CCF Acquisition Thread, handling the reception of image data from the camera. More...

#include <acqThread.hpp>

Inheritance diagram for ifw::ccf::control::AcqThread:
ifw::ccf::mptk::Thread

Public Member Functions

 AcqThread (const std::string &thread_name, ifw::ccf::mptk::MessageBus &message_bus, const double period=0.1)
 Acquisition Thread, handling the interfacing and data acquisition from the camera.
 
virtual ~AcqThread ()
 
void Initialise ()
 
void ResetCounters ()
 Reset counters for the internal household.
 
void SetInputQ (std::shared_ptr< ifw::ccf::common::FrameQueue > &queue)
 Set reference to the Application Input Queue.
 
ifw::ccf::common::FrameQueueGetInputQ ()
 Get refrence to the Application Input Queue.
 
virtual void UserLogic ()
 Acquisition Thread user logic.
 
ifw::ccf::common::FrameStatisticsGetFrameStat ()
 Get reference to frame handling statistics.
 
- Public Member Functions inherited from ifw::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.
 
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.
 
MessageBusMsgBus ()
 Get acces to the MessageBus associated with this thread object.
 
std::string ToString () const
 Generate ASCII output providing a status of the object.
 

Additional Inherited Members

- Public Types inherited from ifw::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 ifw::ccf::mptk::Thread
static std::map< std::string, Thread * > s_thread_registry
 

Detailed Description

CCF Acquisition Thread, handling the reception of image data from the camera.

Constructor & Destructor Documentation

◆ AcqThread()

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

Acquisition Thread, handling the interfacing and data acquisition from the camera.

◆ ~AcqThread()

ifw::ccf::control::AcqThread::~AcqThread ( )
virtual

Member Function Documentation

◆ GetFrameStat()

ifw::ccf::common::FrameStatistics & ifw::ccf::control::AcqThread::GetFrameStat ( )

Get reference to frame handling statistics.

◆ GetInputQ()

ifw::ccf::common::FrameQueue & ifw::ccf::control::AcqThread::GetInputQ ( )

Get refrence to the Application Input Queue.

◆ Initialise()

void ifw::ccf::control::AcqThread::Initialise ( )

◆ ResetCounters()

void ifw::ccf::control::AcqThread::ResetCounters ( )

Reset counters for the internal household.

◆ SetInputQ()

void ifw::ccf::control::AcqThread::SetInputQ ( std::shared_ptr< ifw::ccf::common::FrameQueue > & queue)

Set reference to the Application Input Queue.

◆ UserLogic()

void ifw::ccf::control::AcqThread::UserLogic ( )
virtual

Acquisition Thread user logic.

Reimplemented from ifw::ccf::mptk::Thread.


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