spikestream::AnalysisInfo Class Reference

#include <AnalysisInfo.h>

List of all members.

Public Member Functions
	AnalysisInfo ()
	AnalysisInfo (unsigned int analysisID, unsigned int networkID, unsigned int archiveID, const QDateTime &startDateTime, const QString &description, const QHash< QString, double > &parameterMap, unsigned int analysisType)
	AnalysisInfo (const AnalysisInfo &analysisInfo)
AnalysisInfo &	operator= (const AnalysisInfo &rhs)
unsigned int	getAnalyisType () const
unsigned int	getID () const
QString	getDescription () const
unsigned int	getNetworkID () const
unsigned int	getArchiveID () const
double	getParameter (const QString &paramKey)
QDateTime	getStartDateTime () const
unsigned int	getNumberOfThreads ()
QHash< QString, double > &	getParameterMap ()
QString	getParameterXML () const
void	reset ()
void	setDescription (const QString &description)
void	setNumberOfThreads (unsigned int numThreads)
void	setID (unsigned int id)
void	setAnalysisType (unsigned int typeID)
void	setArchiveID (unsigned int archiveID)
void	setNetworkID (unsigned int networkID)
void	setParameter (const QString &paramKey, double paramValue)

---

Detailed Description

Holds information about a particular analysis.

Definition at line 12 of file AnalysisInfo.h.

---

Constructor & Destructor Documentation

AnalysisInfo::AnalysisInfo

(

)

Empty constructor

Definition at line 10 of file AnalysisInfo.cpp.

AnalysisInfo::AnalysisInfo	(	unsigned int	analysisID,
		unsigned int	networkID,
		unsigned int	archiveID,
		const QDateTime &	startDateTime,
		const QString &	description,
		const QHash< QString, double > &	parameterMap,
		unsigned int	analysisType
	)

Standard constructor

Definition at line 16 of file AnalysisInfo.cpp.

AnalysisInfo::AnalysisInfo

(

const AnalysisInfo &

analysisInfo

)

Copy constructor

Definition at line 29 of file AnalysisInfo.cpp.

---

Member Function Documentation

unsigned int spikestream::AnalysisInfo::getAnalyisType

(

)

const [inline]

Definition at line 19 of file AnalysisInfo.h.

unsigned int spikestream::AnalysisInfo::getArchiveID

(

)

const [inline]

Definition at line 23 of file AnalysisInfo.h.

QString spikestream::AnalysisInfo::getDescription

(

)

const [inline]

Definition at line 21 of file AnalysisInfo.h.

unsigned int spikestream::AnalysisInfo::getID

(

)

const [inline]

Definition at line 20 of file AnalysisInfo.h.

unsigned int spikestream::AnalysisInfo::getNetworkID

(

)

const [inline]

Definition at line 22 of file AnalysisInfo.h.

unsigned int spikestream::AnalysisInfo::getNumberOfThreads

(

)

[inline]

Definition at line 26 of file AnalysisInfo.h.

double AnalysisInfo::getParameter

(

const QString &

paramKey

)

Returns the requested parameter or throws an exception if it does not exist.

Definition at line 65 of file AnalysisInfo.cpp.

QHash<QString, double>& spikestream::AnalysisInfo::getParameterMap

(

)

[inline]

Definition at line 27 of file AnalysisInfo.h.

QString AnalysisInfo::getParameterXML

(

)

const

Returns the parameter map in XML format

Definition at line 73 of file AnalysisInfo.cpp.

QDateTime spikestream::AnalysisInfo::getStartDateTime

(

)

const [inline]

Definition at line 25 of file AnalysisInfo.h.

AnalysisInfo & AnalysisInfo::operator=

(

const AnalysisInfo &

rhs

)

Assignment operator

Definition at line 46 of file AnalysisInfo.cpp.

void AnalysisInfo::reset

(

)

Resets the information to default empty values

Definition at line 88 of file AnalysisInfo.cpp.

void spikestream::AnalysisInfo::setAnalysisType

(

unsigned int

typeID

)

[inline]

Definition at line 33 of file AnalysisInfo.h.

void spikestream::AnalysisInfo::setArchiveID

(

unsigned int

archiveID

)

[inline]

Definition at line 34 of file AnalysisInfo.h.

void spikestream::AnalysisInfo::setDescription

(

const QString &

description

)

[inline]

Definition at line 30 of file AnalysisInfo.h.

void spikestream::AnalysisInfo::setID

(

unsigned int

id

)

[inline]

Definition at line 32 of file AnalysisInfo.h.

void spikestream::AnalysisInfo::setNetworkID

(

unsigned int

networkID

)

[inline]

Definition at line 35 of file AnalysisInfo.h.

void spikestream::AnalysisInfo::setNumberOfThreads

(

unsigned int

numThreads

)

[inline]

Definition at line 31 of file AnalysisInfo.h.

void AnalysisInfo::setParameter	(	const QString &	paramKey,
		double	paramValue
	)

Sets a parameter value

Definition at line 101 of file AnalysisInfo.cpp.

---

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

• AnalysisInfo.h
• AnalysisInfo.cpp