---

SctData::ScanHeader Class Reference

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

#include <ScanHeader.h>

Inheritance diagram for SctData::ScanHeader:

Public Member Functions
	ScanHeader (unsigned int scanNumber, unsigned int runNumber, string moduleName, const ConfigurationVariable &variable) throw ()
	ScanHeader () throw ()
	IO use only.
virtual	~ScanHeader () throw ()
	Deletes this object and any references it holds.
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 throw ()
unsigned int	getRunNumber () const throw ()
const string &	getModuleName () const throw ()
const ConfigurationVariable &	getVariable () const throw ()
bool	operator== (const ScanHeader &scan) const throw ()
	Equality operator.
Static Public Member Functions
string	getUniqueID (unsigned int runNumber, unsigned int scanNumber, const string &moduleName) throw ()
Protected Attributes
unsigned int	scanNumber
	The scan number;.
unsigned int	runNumber
	The run number.
string	moduleName
	The moduleName.
const ConfigurationVariable *	variable
	The variable that was modified in this scan.
Friends
class	ScanHeaderIOHelper

---

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 26 of file ScanHeader.h.

---

Constructor & Destructor Documentation

SctData::ScanHeader::ScanHeader (  unsigned int    scanNumber, unsigned int    runNumber, string    moduleName, const ConfigurationVariable &    variable )  throw ()

Definition at line 11 of file ScanHeader.cpp.

SctData::ScanHeader::ScanHeader (    )  throw ()

IO use only. Definition at line 14 of file ScanHeader.cpp.

SctData::ScanHeader::~ScanHeader (    )  throw () [virtual]

Deletes this object and any references it holds. Definition at line 16 of file ScanHeader.cpp.

---

Member Function Documentation

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

Get the class name for this object. This is used to identify the precise type. Todo: We could use typeid instead here, but that would probably mean removing the namespace stuff. Returns: the class name Implements Sct::Streamable. Definition at line 27 of file ScanHeader.cpp.

const string& SctData::ScanHeader::getModuleName (    )  const throw () [inline]

Returns: the module name Definition at line 66 of file ScanHeader.h. Referenced by SctData::IO::ScanHeaderStreamer::write().

unsigned int SctData::ScanHeader::getRunNumber (    )  const throw () [inline]

Returns: the run number Definition at line 60 of file ScanHeader.h. Referenced by SctData::IO::ScanHeaderStreamer::write().

unsigned int SctData::ScanHeader::getScanNumber (    )  const throw () [inline]

Returns: the scan number. Definition at line 54 of file ScanHeader.h. Referenced by SctData::IO::ScanHeaderStreamer::write().

string SctData::ScanHeader::getUniqueID (  unsigned int    runNumber, unsigned int    scanNumber, const string &    moduleName )  throw () [static]

Definition at line 35 of file ScanHeader.cpp.

string SctData::ScanHeader::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 31 of file ScanHeader.cpp.

const ConfigurationVariable& SctData::ScanHeader::getVariable (    )  const throw () [inline]

Returns: the scan type Definition at line 72 of file ScanHeader.h. References variable. Referenced by SctData::IO::ScanHeaderStreamer::write().

bool SctData::ScanHeader::operator== (  const ScanHeader &    scan )  const throw ()

Equality operator. Returns: true if scan has the same scan number, run number, module number and scan type as this one. Definition at line 18 of file ScanHeader.cpp.

---

Friends And Related Function Documentation

friend class ScanHeaderIOHelper [friend]

Definition at line 89 of file ScanHeader.h.

---

Field Documentation

string SctData::ScanHeader::moduleName [protected]

The moduleName. Definition at line 86 of file ScanHeader.h. Referenced by SctData::ScanResultWriter::writeHeader().

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

The run number. Definition at line 85 of file ScanHeader.h. Referenced by SctData::ScanResultWriter::writeHeader().

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

The scan number;. Definition at line 84 of file ScanHeader.h. Referenced by SctData::ScanResultWriter::writeHeader().

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

The variable that was modified in this scan. Definition at line 87 of file ScanHeader.h. Referenced by getVariable().

---

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

• ScanHeader.h
• ScanHeader.cpp

---