ifw-ccf 5.0.2
Loading...
Searching...
No Matches
Public Member Functions | List of all members
TestThread1 Class Reference
Inheritance diagram for TestThread1:
ifw::ccf::mptk::Thread

Public Member Functions

 TestThread1 (const std::string &thread_name, ifw::ccf::mptk::MessageBus &message_bus, const double period=0.1)
 
 ~TestThread1 ()
 
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.
 
- 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

Constructor & Destructor Documentation

◆ TestThread1()

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

◆ ~TestThread1()

TestThread1::~TestThread1 ( )
inline

Member Function Documentation

◆ UserLogic()

void TestThread1::UserLogic ( )
inlinevirtual

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.

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


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