Sct::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.
Sct::UniqueID	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.
UniqueID &	operator= (const UniqueID &other)
	set equal to operator
bool	operator== (const UniqueID &other) const
	equality test operator
bool	operator!= (const UniqueID &other) const
	non-equality test operator
Protected Member Functions
	UniqueID ()
Private Attributes
unsigned int	runNumber
unsigned int	scanNumber
string	nameAsString
string	module
Friends
class	IOName

---

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 34 of file UniqueID.cpp. References module, nameAsString, runNumber, and scanNumber.

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

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

---

Member Function Documentation

string SctData::UniqueID::getModule (   )  const

Returns the module serial number Does not throw. Definition at line 66 of file UniqueID.cpp. References module.

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

Returns the run number Does not throw. Definition at line 70 of file UniqueID.cpp. References runNumber. Referenced by SctFitter::FitterWorkerGroup::work().

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

Returns the scan number Does not throw. Definition at line 74 of file UniqueID.cpp. References scanNumber. Referenced by SctFitter::FitterWorkerGroup::work().

UniqueID SctData::UniqueID::getUniqueID (   )  const

Returns the unique ID Does not throw. Definition at line 57 of file UniqueID.cpp. References nameAsString. Referenced by SctData::RawScanResult::getUniqueID(), and SctData::FitScanResult::getUniqueID().

SctData::UniqueID::operator string (   )  const

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

bool SctData::UniqueID::operator!= (  const UniqueID &  other  )  const

non-equality test operator Definition at line 29 of file UniqueID.cpp.

UniqueID & SctData::UniqueID::operator= (  const UniqueID &  other  )

set equal to operator Definition at line 14 of file UniqueID.cpp. References module, nameAsString, runNumber, and scanNumber.

bool SctData::UniqueID::operator== (  const UniqueID &  other  )  const

equality test operator Definition at line 22 of file UniqueID.cpp. References module, nameAsString, runNumber, and scanNumber.

---

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

• UniqueID.h
• UniqueID.cpp

---