Main Page | Modules | Namespace List | Class Hierarchy | Alphabetical List | Data Structures | File List | Namespace Members | Data Fields | Globals | Related Pages

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.

UniqueIDoperator= (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


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

Sct::UniqueID::UniqueID string  uniqueID  ) 
 

Constructs from a string envoded uniqueID.

throws InvalidArgumentError if the format of uniqueID is not correct

Sct::UniqueID::UniqueID unsigned int  runNumber,
unsigned int  scanNumber,
string  module
 

Constructs a UniqueID from its constituents.

Does not throw


Member Function Documentation

string Sct::UniqueID::getModule  )  const
 

Returns the module serial number Does not throw.

Referenced by SctArchiving::IOManagerDB::read().

unsigned int Sct::UniqueID::getRunNumber  )  const
 

Returns the run number Does not throw.

Referenced by SctArchiving::IOManagerDB::read().

unsigned int Sct::UniqueID::getScanNumber  )  const
 

Returns the scan number Does not throw.

Referenced by SctAnalysis::AnalysisAlgorithm::addFitScanResult(), SctAnalysis::AnalysisAlgorithm::addRawScanResult(), and SctArchiving::IOManagerDB::read().

Sct::UniqueID Sct::UniqueID::getUniqueID  )  const
 

Returns the unique ID Does not throw.

Referenced by SctData::RawScanResult::getUniqueID(), SctData::FitScanResult::getUniqueID(), and SctArchiving::IOManagerDB::read().

Sct::UniqueID::operator string  )  const
 

Returns getUniqueID() Does not throw.

bool Sct::UniqueID::operator!= const UniqueID other  )  const
 

non-equality test operator

UniqueID& Sct::UniqueID::operator= const UniqueID other  ) 
 

set equal to operator

bool Sct::UniqueID::operator== const UniqueID other  )  const
 

equality test operator


The documentation for this class was generated from the following file:
Generated on Fri Dec 16 19:39:30 2005 for SCT DAQ/DCS Software - C++ by doxygen 1.3.5