SctData::UniqueID Class Reference

This is a simple class to facilitate constructing and parsing uniqueIDs. More...

#include <UniqueID.h>

Public Member Functions
	UniqueID (string uniqueID)
	Constructs from a string envoded uniqueID.
	UniqueID (unsigned int runNumber, unsigned int scanNumber, string module)
	Constructs a UniqueID from its constituents.
string	getUniqueID () const
	Returns the unique ID Does not throw.
	operator string () const
	Returns getUniqueID() Does not throw.
string	getModule () const
	Returns the module serial number Does not throw.
unsigned int	getRunNumber () const
	Returns the run number Does not throw.
unsigned int	getScanNumber () const
	Returns the scan number Does not throw.
Private Attributes
unsigned int	runNumber
unsigned int	scanNumber
string	uniqueID
string	module

---

Detailed Description

This is a simple class to facilitate constructing and parsing uniqueIDs.

All classes in this package should use this type of uniqueID.

Author:

Matthew Palmer

Definition at line 16 of file UniqueID.h.

---

Constructor & Destructor Documentation

SctData::UniqueID::UniqueID (  string  uniqueID  )

Constructs from a string envoded uniqueID. throws InvalidArgumentError if the format of uniqueID is not correct Definition at line 11 of file UniqueID.cpp.

SctData::UniqueID::UniqueID (  unsigned int  runNumber, unsigned int  scanNumber, string  module )

Constructs a UniqueID from its constituents. Does not throw Definition at line 27 of file UniqueID.cpp.

---

Member Function Documentation

string SctData::UniqueID::getModule (   )  const

Returns the module serial number Does not throw. Definition at line 43 of file UniqueID.cpp. Referenced by SctArchiving::IOManagerDB::prepareInsertion().

unsigned int SctData::UniqueID::getRunNumber (   )  const

Returns the run number Does not throw. Definition at line 47 of file UniqueID.cpp. Referenced by SctArchiving::IOManagerDB::prepareInsertion().

unsigned int SctData::UniqueID::getScanNumber (   )  const

Returns the scan number Does not throw. Definition at line 51 of file UniqueID.cpp. Referenced by SctAnalysis::AnalysisAlgorithm::addFitScanResult(), SctAnalysis::AnalysisAlgorithm::addRawScanResult(), and SctArchiving::IOManagerDB::prepareInsertion().

string SctData::UniqueID::getUniqueID (   )  const

Returns the unique ID Does not throw. Definition at line 34 of file UniqueID.cpp. Referenced by operator string().

SctData::UniqueID::operator string (   )  const

Returns getUniqueID() Does not throw. Definition at line 39 of file UniqueID.cpp. References getUniqueID().

Here is the call graph for this function:

---

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

• UniqueID.h
• UniqueID.cpp

---