spikestream::AnalysisRunner Class Reference

#include <AnalysisRunner.h>

List of all members.

Signals
void	newResultsFound ()
void	progress (const QString &msg, unsigned int timeStep, unsigned int stepsCompleted, unsigned int totalSteps)
void	timeStepComplete (unsigned int timeStep)
Public Member Functions
	AnalysisRunner (const DBInfo &netDBInfo, const DBInfo &archDBInfo, const DBInfo &anaDBInfo)
	~AnalysisRunner ()
QString	getErrorMessage ()
bool	isError ()
void	prepareAnalysisTask (const AnalysisInfo &anaInfo, int firstTimeStep, int lastTimeStep)
void	reset ()
void	run ()
void	setError (const QString &message)
void	setTimeStepThreadCreationFunction (AbstractAnalysisTimeStepThread *(*createAnalysisTimeStepThread)(const DBInfo &netDBInfo, const DBInfo &archDBInfo, const DBInfo &anaDBInfo))
void	stop ()

---

Detailed Description

Sets up and runs an analysis that extends over one or more time steps.

Definition at line 17 of file AnalysisRunner.h.

---

Constructor & Destructor Documentation

AnalysisRunner::AnalysisRunner	(	const DBInfo &	netDBInfo,
		const DBInfo &	archDBInfo,
		const DBInfo &	anaDBInfo
	)

Constructor

Definition at line 15 of file AnalysisRunner.cpp.

AnalysisRunner::~AnalysisRunner

(

)

Destructor

Definition at line 27 of file AnalysisRunner.cpp.

---

Member Function Documentation

QString spikestream::AnalysisRunner::getErrorMessage

(

)

[inline]

Definition at line 23 of file AnalysisRunner.h.

bool spikestream::AnalysisRunner::isError

(

)

[inline]

Definition at line 24 of file AnalysisRunner.h.

void spikestream::AnalysisRunner::newResultsFound

(

)

[signal]

void AnalysisRunner::prepareAnalysisTask	(	const AnalysisInfo &	analysisInfo,
		int	firstTimeStep,
		int	lastTimeStep
	)

Sets up the class ready to carry out the analysis

Definition at line 36 of file AnalysisRunner.cpp.

void spikestream::AnalysisRunner::progress	(	const QString &	msg,
		unsigned int	timeStep,
		unsigned int	stepsCompleted,
		unsigned int	totalSteps
	)		[signal]

void AnalysisRunner::reset

(

)

Resets this class ready for another analysis. All information should be cleared.

Definition at line 213 of file AnalysisRunner.cpp.

void AnalysisRunner::run

(

)

Run method inherited from QThread. A parameter controls how many threads are launched at once. Each new thread is connected to appropriate signals and when it finishes a new thread is launched until all of the time steps have been analyzed.

Definition at line 63 of file AnalysisRunner.cpp.

void AnalysisRunner::setError

(

const QString &

message

)

Sets the thread into the error state

Definition at line 224 of file AnalysisRunner.cpp.

void AnalysisRunner::setTimeStepThreadCreationFunction

(

AbstractAnalysisTimeStepThread *(*)(const DBInfo &netDBInfo, const DBInfo &archDBInfo, const DBInfo &anaDBInfo)

createAnalysisTimeStepThread

)

Sets the function used to create new time step threads

Definition at line 108 of file AnalysisRunner.cpp.

void AnalysisRunner::stop

(

)

Stops the thread running

Definition at line 94 of file AnalysisRunner.cpp.

void spikestream::AnalysisRunner::timeStepComplete

(

unsigned int

timeStep

)

[signal]

---

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

• AnalysisRunner.h
• AnalysisRunner.cpp