MyToolMultiThread Class Reference

#include <MyToolMultiThread.h>

Inheritance diagram for MyToolMultiThread:

Public Member Functions
	MyToolMultiThread ()
	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
std::vector < MyToolMultiThread_args * >	args
	Vector of thread args (also holds pointers to the threads) More...
int	m_freethreads
	Keeps track of free threads. More...
Utilities *	m_util
	Pointer to utilities class to help with threading. More...

Detailed Description

This is a template for a Tool That employs mulitple threads. 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 38 of file MyToolMultiThread.h.

Constructor & Destructor Documentation

MyToolMultiThread::MyToolMultiThread

(

)

Simple constructor.

Definition at line 8 of file MyToolMultiThread.cpp.

Member Function Documentation

bool MyToolMultiThread::Execute

(

)

Executre function used to perform Tool perpose.

Definition at line 44 of file MyToolMultiThread.cpp.

bool MyToolMultiThread::Finalise

(

)

Finalise funciton used to clean up resorces.

Definition at line 69 of file MyToolMultiThread.cpp.

bool MyToolMultiThread::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 MyToolMultiThread.cpp.

void MyToolMultiThread::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 81 of file MyToolMultiThread.cpp.

Member Data Documentation

std::vector<MyToolMultiThread_args*> MyToolMultiThread::args

private

Vector of thread args (also holds pointers to the threads)

Definition at line 53 of file MyToolMultiThread.h.

int MyToolMultiThread::m_freethreads

private

Keeps track of free threads.

Definition at line 55 of file MyToolMultiThread.h.

Utilities* MyToolMultiThread::m_util

private

Pointer to utilities class to help with threading.

Definition at line 52 of file MyToolMultiThread.h.

---

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

• UserTools/template/MyToolMultiThread.h
• UserTools/template/MyToolMultiThread.cpp