SctData::ResultHeader Class Reference

This class contains the identifying information about a scan result. More...

#include <ResultHeader.h>

Inheritance diagram for SctData::ResultHeader:

[legend]Collaboration diagram for SctData::ResultHeader:

[legend]


Public Member Functions
	ResultHeader (unsigned int scanNumber, unsigned int runNumber, string moduleName, const ConfigurationVariable &variable)
	Construct a scan from it's identifying information.
	ResultHeader ()
	Should be used for IO only.
virtual string	getClassName () const throw ()
	Get the class name for this object.
virtual string	getUniqueID () const throw ()
	For objects to be stored, there must be some way of identifying them.
unsigned int	getScanNumber () const
void	setScanNumber (unsigned int scanNumber)
	Set the scan number.
unsigned int	getRunNumber () const
void	setRunNumber (unsigned int runNumber)
	Set the run number.
const string &	getModuleName () const
void	setModuleName (string name)
	Set the module name.
const ConfigurationVariable &	getVariable () const
void	setVariable (const ConfigurationVariable &var)
	Set the scan variable.
boost::posix_time::ptime	getStartTime () const
	Get the time the operation that resulted in this object started.
void	setStartTime (boost::posix_time::ptime start)
	Set the time the operation that resulted in this object started.
boost::posix_time::ptime	getEndTime () const
	Get the time the operation that resulted in this object ended.
void	setEndTime (boost::posix_time::ptime start)
	Set the time the operation that resulted in this object started.
string	getStartTimeString () const
	Gets the start time as a string.
void	setStartTimeString (string start)
	Sets the start time as a string.
string	getEndTimeString () const
	Gets the end time as a string.
void	setEndTimeString (string end)
	Sets the end time as a string.
bool	operator== (const ResultHeader &scan) const
	Equality operator.
Static Public Member Functions
string	getUniqueID (unsigned int runNumber, unsigned int scanNumber, const string &moduleName)
Protected Attributes
unsigned int	scanNumber
	The scan number;.
unsigned int	runNumber
	The run number.
string	moduleName
	The moduleName.
string	startTime
	The time the operation that resulted in this object started in ISO format, UTC.
string	endTime
	The time the operation that resulted in this object ended in ISO format, UTC.
const ConfigurationVariable *	variable
	The variable that was modified in this scan.

Detailed Description

This class contains the identifying information about a scan result.

It is entirely defined by a run number, a scan number, a module name and a scan type. The combination of the first 3 of those should be guarenteed to be unique.

Author:: Matthew Palmer

Definition at line 32 of file ResultHeader.h.

Constructor & Destructor Documentation

SctData::ResultHeader::ResultHeader ( unsigned int scanNumber,

unsigned int runNumber,

string moduleName,

const ConfigurationVariable & variable

)

Construct a scan from it's identifying information.

Note:
Nothrow

Definition at line 15 of file ResultHeader.cpp.

SctData::ResultHeader::ResultHeader ( )

Should be used for IO only.

Note:
Nothrow

Definition at line 19 of file ResultHeader.cpp.

Member Function Documentation

string SctData::ResultHeader::getClassName ( ) const throw () [virtual]

Get the class name for this object.
This is used to identify the precise type.
Returns:
the class name

Note:
Nothrow

Implements Sct::Streamable.
Definition at line 31 of file ResultHeader.cpp.

ptime SctData::ResultHeader::getEndTime ( ) const

Get the time the operation that resulted in this object ended.

Note:
Nothrow

Definition at line 52 of file ResultHeader.cpp.
References endTime.
Referenced by SctArchiving::IOManagerDB::prepareInsertion().

string SctData::ResultHeader::getEndTimeString ( ) const [inline]

Gets the end time as a string.

Note:
Nothrow

Definition at line 152 of file ResultHeader.h.
References endTime.
Referenced by SctData::IO::ResultHeaderStreamer_v1::write().

const string& SctData::ResultHeader::getModuleName ( ) const [inline]

Returns:
the module name

Note:
Nothrow

Definition at line 85 of file ResultHeader.h.
Referenced by SctDataDisplay::FitDisplayer::displayChannels(), SctDataDisplay::FitDisplayer::displayChips(), and SctData::IO::ResultHeaderStreamer_v1::write().

unsigned int SctData::ResultHeader::getRunNumber ( ) const [inline]

Returns:
the run number

Note:
Nothrow

Definition at line 70 of file ResultHeader.h.
Referenced by SctData::TestResult::getRunNumber(), and SctData::IO::ResultHeaderStreamer_v1::write().

unsigned int SctData::ResultHeader::getScanNumber ( ) const [inline]

Returns:
the scan number.

Note:
Nothrow

Definition at line 55 of file ResultHeader.h.
Referenced by SctDataDisplay::FitDisplayer::display(), and SctData::IO::ResultHeaderStreamer_v1::write().

ptime SctData::ResultHeader::getStartTime ( ) const

Get the time the operation that resulted in this object started.

Note:
Nothrow

Definition at line 43 of file ResultHeader.cpp.
References startTime.
Referenced by SctArchiving::IOManagerDB::prepareInsertion().

string SctData::ResultHeader::getStartTimeString ( ) const [inline]

Gets the start time as a string.

Note:
Nothrow

Definition at line 140 of file ResultHeader.h.
References startTime.
Referenced by SctData::IO::ResultHeaderStreamer_v1::write().

string SctData::ResultHeader::getUniqueID ( ) const throw () [virtual]

For objects to be stored, there must be some way of identifying them.
This function must be implemented to return some unique identifier for objects of this precise className
Returns:
a unique string for this class

Exceptions:

LogicError if the class is unable to generate a uniqueID for some reason

Implements Sct::Serializable.
Definition at line 35 of file ResultHeader.cpp.
Referenced by SctDataDisplay::FitDisplayer::display(), and SctArchiving::IOManagerDB::prepareInsertion().

const ConfigurationVariable& SctData::ResultHeader::getVariable ( ) const [inline]

Returns:
the scan type

Note:
Nothrow

Definition at line 100 of file ResultHeader.h.
References variable.
Referenced by SctAnalysis::StrobeDelayAlgorithm::analyze(), SctAnalysis::RxThresholdAlgorithm::analyze(), SctAnalysis::RxDelayAlgorithm::analyze(), and SctData::IO::ResultHeaderStreamer_v1::write().

bool SctData::ResultHeader::operator== ( const ResultHeader & scan ) const

Equality operator.

Returns:
true if scan has the same scan number, run number, module number and scan type as this one.

Note:
Nothrow

Definition at line 22 of file ResultHeader.cpp.
References moduleName, runNumber, scanNumber, and variable.

void SctData::ResultHeader::setEndTime ( boost::posix_time::ptime start )

Set the time the operation that resulted in this object started.

Note:
Nothrow

Definition at line 56 of file ResultHeader.cpp.
References endTime.

void SctData::ResultHeader::setEndTimeString ( string end ) [inline]

Sets the end time as a string.

Note:
Nothrow

Definition at line 158 of file ResultHeader.h.
References endTime.
Referenced by SctData::IO::ResultHeaderStreamer_v1::read().

void SctData::ResultHeader::setModuleName ( string name ) [inline]

Set the module name.

Note:
Nothrow

Definition at line 93 of file ResultHeader.h.
Referenced by SctData::IO::ResultHeaderStreamer_v1::read().

void SctData::ResultHeader::setRunNumber ( unsigned int runNumber ) [inline]

Set the run number.

Note:
Nothrow

Definition at line 78 of file ResultHeader.h.
Referenced by SctData::IO::ResultHeaderStreamer_v1::read().

void SctData::ResultHeader::setScanNumber ( unsigned int scanNumber ) [inline]

Set the scan number.

Note:
Nothrow

Definition at line 63 of file ResultHeader.h.
Referenced by SctData::IO::ResultHeaderStreamer_v1::read().

void SctData::ResultHeader::setStartTime ( boost::posix_time::ptime start )

Set the time the operation that resulted in this object started.

Note:
Nothrow

Definition at line 47 of file ResultHeader.cpp.
References startTime.

void SctData::ResultHeader::setStartTimeString ( string start ) [inline]

Sets the start time as a string.

Note:
Nothrow

Definition at line 146 of file ResultHeader.h.
References startTime.
Referenced by SctData::IO::ResultHeaderStreamer_v1::read().

void SctData::ResultHeader::setVariable ( const ConfigurationVariable & var ) [inline]

Set the scan variable.

Note:
Nothrow

Definition at line 108 of file ResultHeader.h.
References variable.
Referenced by SctData::IO::ResultHeaderStreamer_v1::read().

Field Documentation

string SctData::ResultHeader::endTime [protected]

The time the operation that resulted in this object ended in ISO format, UTC.

Definition at line 174 of file ResultHeader.h.
Referenced by getEndTime(), getEndTimeString(), setEndTime(), and setEndTimeString().

string SctData::ResultHeader::moduleName [protected]

The moduleName.

Definition at line 172 of file ResultHeader.h.
Referenced by operator==().

unsigned int SctData::ResultHeader::runNumber [protected]

The run number.

Definition at line 171 of file ResultHeader.h.
Referenced by operator==().

unsigned int SctData::ResultHeader::scanNumber [protected]

The scan number;.

Definition at line 170 of file ResultHeader.h.
Referenced by operator==().

string SctData::ResultHeader::startTime [protected]

The time the operation that resulted in this object started in ISO format, UTC.

Definition at line 173 of file ResultHeader.h.
Referenced by getStartTime(), getStartTimeString(), setStartTime(), and setStartTimeString().

const ConfigurationVariable* SctData::ResultHeader::variable [protected]

The variable that was modified in this scan.

Definition at line 175 of file ResultHeader.h.
Referenced by getVariable(), operator==(), and setVariable().

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

Generated on Thu Jul 15 09:52:52 2004 for SCT DAQ/DCS Software - C++ by

1.3.5

SctData::ResultHeader Class Reference

Public Member Functions

Static Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Field Documentation