MyToolThread Class Reference

#include <MyToolThread.h>

Inheritance diagram for MyToolThread:

Public Member Functions
	MyToolThread ()
	Simple constructor. More...
bool	Execute ()
	Executre function used to perform Tool perpose. More...
bool	Finalise ()
	Finalise funciton used to clean up resorces. More...
bool	Initialise (std::string configfile, DataModel &data)
	Initialise Function for setting up Tool resorces. More...

Static Private Member Functions
static void	Thread (Thread_args *arg)
	Function to be run by the thread in a loop. Make sure not to block in it. More...

Private Attributes
MyToolThread_args *	args
	thread args (also holds pointer to the thread) More...
Utilities *	m_util
	Pointer to utilities class to help with threading. More...

Detailed Description

This is a template for a Tool that produces a single thread that can be assigned a function seperate to the main thread. Please fill out the descripton and author information.

Author:

B.Richards

Date:

2019/05/28 10:44:00

Contact: b.ric.nosp@m.hard.nosp@m.s@qmu.nosp@m.l.ac.nosp@m..uk

Definition at line 36 of file MyToolThread.h.

Constructor & Destructor Documentation

MyToolThread::MyToolThread

(

)

Simple constructor.

Definition at line 8 of file MyToolThread.cpp.

Member Function Documentation

bool MyToolThread::Execute

(

)

Executre function used to perform Tool perpose.

Definition at line 30 of file MyToolThread.cpp.

bool MyToolThread::Finalise

(

)

Finalise funciton used to clean up resorces.

Definition at line 36 of file MyToolThread.cpp.

bool MyToolThread::Initialise	(	std::string	configfile,
		DataModel &	data
	)

Initialise Function for setting up Tool resorces.

Parameters

configfile	The path and name of the dynamic configuration file to read in.
data	A reference to the transient data class used to pass information between Tools.

Definition at line 11 of file MyToolThread.cpp.

void MyToolThread::Thread ( Thread_args *  arg )

staticprivate

Function to be run by the thread in a loop. Make sure not to block in it.

Definition at line 49 of file MyToolThread.cpp.

Member Data Documentation

MyToolThread_args* MyToolThread::args

private

thread args (also holds pointer to the thread)

Definition at line 51 of file MyToolThread.h.

Utilities* MyToolThread::m_util

private

Pointer to utilities class to help with threading.

Definition at line 50 of file MyToolThread.h.

---

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

• UserTools/template/MyToolThread.h
• UserTools/template/MyToolThread.cpp