MyTool Class Reference

#include <MyTool.h>

Inheritance diagram for MyTool:

Public Member Functions
	MyTool ()
	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...

Private Types
enum	LogLevel {   FATAL =-1, ERROR =0, WARN =1, INFO =2,   DEBUG1 =3, DEBUG2 =4, DEBUG3 =5 }
	Log level enumerations. More...

Private Member Functions
void	StreamToLog (int level)

Private Attributes
std::stringstream	m_ss
	For easy formatting of Log messages. More...
util::Stopwatch *	m_stopwatch
	The stopwatch, if we're using one. More...
std::string	m_stopwatch_file
	Image filename to save the histogram to, if required. More...
int	m_verbose
	Verbosity level, as defined in tool parameter file. More...

Detailed Description

This is a balnk template for a Tool used by the script to generate a new custom tool. 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 20 of file MyTool.h.

Member Enumeration Documentation

enum MyTool::LogLevel

private

Log level enumerations.

Enumerator
FATAL
ERROR
WARN
INFO
DEBUG1
DEBUG2
DEBUG3

Definition at line 53 of file MyTool.h.

Constructor & Destructor Documentation

MyTool::MyTool

(

)

Simple constructor.

Definition at line 3 of file MyTool.cpp.

Member Function Documentation

bool MyTool::Execute

(

)

Executre function used to perform Tool perpose.

Definition at line 40 of file MyTool.cpp.

bool MyTool::Finalise

(

)

Finalise funciton used to clean up resorces.

Definition at line 52 of file MyTool.cpp.

bool MyTool::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.

YOUR CODE HERE

Definition at line 6 of file MyTool.cpp.

void MyTool::StreamToLog ( int  level )

inlineprivate

Print the current value of the streamer at the set log level, then clear the streamer

Definition at line 47 of file MyTool.h.

Member Data Documentation

std::stringstream MyTool::m_ss

private

For easy formatting of Log messages.

Definition at line 43 of file MyTool.h.

util::Stopwatch* MyTool::m_stopwatch

private

The stopwatch, if we're using one.

Definition at line 35 of file MyTool.h.

std::string MyTool::m_stopwatch_file

private

Image filename to save the histogram to, if required.

Definition at line 37 of file MyTool.h.

int MyTool::m_verbose

private

Verbosity level, as defined in tool parameter file.

Definition at line 40 of file MyTool.h.

---

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

• UserTools/template/MyTool.h
• UserTools/template/MyTool.cpp