Const::DetectorSet Class Reference

The DetectorSet class for sets of detector IDs in the form of EDetector values. More...

#include <Const.h>

Inheritance diagram for Const::DetectorSet:

Classes
class	Iterator
	Iterator. More...

Public Member Functions
	DetectorSet ()
	Default constructor.
	DetectorSet (const DetectorSet &)=default
	Copy constructor.
DetectorSet &	operator= (const DetectorSet &)=default
	Assignment operator.
	DetectorSet (EDetector det)
	Constructor for a set containing one detector ID.
virtual	~DetectorSet ()
	Destructor.
Iterator	begin () const
	Beginning iterator.
Iterator	end () const
	Ending iterator.
DetectorSet &	operator+= (const DetectorSet &set)
	Addition of another set to this one.
DetectorSet &	operator-= (const DetectorSet &set)
	Subtraction of another set from this one.
bool	operator== (const DetectorSet &set) const
	Equality operator.
bool	operator!= (const DetectorSet &set) const
	Inequality operator.
bool	contains (const DetectorSet &set) const
	Check whether this set contains another set.
bool	contains (const Iterator &it) const
	Check whether this set contains detector specified by iterator.
int	getIndex (EDetector det) const
	Getter for the index of a given detector in this set.
size_t	size () const
	Getter for number of detector IDs in this set.
std::string	__str__ () const
	String for printing in python.

Private Member Functions
	DetectorSet (uint16_t bits)
	Constructor.
	ClassDef (DetectorSet, 1)
	Class version.

Static Private Member Functions
static uint16_t	getBit (EDetector det)
	Conversion of detector ID to bit pattern.
static EDetector	getDetector (uint16_t bit)
	Conversion of bit pattern to detector ID.

Private Attributes
uint16_t	m_bits
	The internal representation of the set as bit pattern.

Detailed Description

The DetectorSet class for sets of detector IDs in the form of EDetector values.

Only detectors may be included, not subdetectors.

Definition at line 80 of file Const.h.

Constructor & Destructor Documentation

DetectorSet() [1/3]

DetectorSet ( )

inline

Default constructor.

Definition at line 179 of file Const.h.

: m_bits(0) {}

DetectorSet() [2/3]

DetectorSet ( EDetector  det )

inline

Constructor for a set containing one detector ID.

Parameters

det	The ID of the detector.

Definition at line 190 of file Const.h.

: m_bits(getBit(det)) {}

~DetectorSet()

virtual ~DetectorSet ( )

inlinevirtual

Destructor.

Definition at line 195 of file Const.h.

{};

DetectorSet() [3/3]

DetectorSet ( uint16_t  bits )

inlineexplicitprivate

Constructor.

Parameters

bits	The internal representation of the set as bit pattern.

Definition at line 269 of file Const.h.

: m_bits(bits) {};

Member Function Documentation

__str__()

std::string __str__

(

)

const

String for printing in python.

Definition at line 297 of file UnitConst.cc.

{
  std::string result = "<set: ";
  const std::string detectorNames[] = {"invalidDetector", "PXD", "SVD", "CDC", "TOP", "ARICH", "ECL", "KLM", "IR", "TRG", "DAQ", "BEAST", "TEST"};
  for (size_t index = 1; index <= Const::TEST; index++) {
    if (contains(EDetector(index))) {
      if (result.size() > 6) {
        result += ",";
      }
      result += detectorNames[index];
    }
  }
  result += ">";
  return result;
}

begin()

Const::DetectorSet::Iterator begin

(

)

const

Beginning iterator.

Definition at line 208 of file UnitConst.cc.

{
  uint16_t setBit = 1;
  while ((m_bits & setBit) == 0) {
    setBit = setBit << 1;
    if (setBit >= 0x1000)
      return Const::DetectorSet::Iterator(0, m_bits, invalidDetector);
  }
  return Const::DetectorSet::Iterator(0, m_bits, setBit);
}

contains() [1/2]

bool contains ( const DetectorSet &  set ) const

inline

Check whether this set contains another set.

Parameters

set	The other set of detector IDs.

Definition at line 235 of file Const.h.

{return (m_bits & set.m_bits) == set.m_bits;}

contains() [2/2]

bool contains ( const Iterator &  it ) const

inline

Check whether this set contains detector specified by iterator.

Parameters

[in]

it

Iterator.

Definition at line 241 of file Const.h.

      {
        return (m_bits & it.getSetBit()) != 0;
      }

end()

Const::DetectorSet::Iterator end

(

)

const

Ending iterator.

Definition at line 219 of file UnitConst.cc.

{
  return Const::DetectorSet::Iterator(0, m_bits, invalidDetector);
}

getBit()

unsigned short getBit ( Const::EDetector  det )

staticprivate

Conversion of detector ID to bit pattern.

Parameters

det	The detector ID.

Returns

The bit pattern representing the given detector ID.

Definition at line 245 of file UnitConst.cc.

{
  if (det == 0 || det > 0x100) {
    B2ERROR("Const::DetectorSet::getBit() called for an invalid detector "
            "identifier (possibly a subdetector):" << det);
    return 0;
  }
  if (det > TEST) {
    B2ERROR("Const::DetectorSet::getBit(): Invalid detector ID");
  }
  return (1 << (det - 1));
}

getDetector()

Const::EDetector getDetector ( uint16_t  bit )

staticprivate

Conversion of bit pattern to detector ID.

Parameters

bit	The bit pattern.

Returns

The detector ID corresponding to the given bit pattern.

Definition at line 258 of file UnitConst.cc.

{
  switch (bit) {
    case 0x0001: return PXD;
    case 0x0002: return SVD;
    case 0x0004: return CDC;
    case 0x0008: return TOP;
    case 0x0010: return ARICH;
    case 0x0020: return ECL;
    case 0x0040: return KLM;
    case 0x0080: return IR;
    case 0x0100: return TRG;
    case 0x0200: return DAQ;
    case 0x0400: return BEAST;
    case 0x0800: return TEST;
    default: return invalidDetector;
  }
}

getIndex()

int getIndex

(

EDetector

det

)

const

Getter for the index of a given detector in this set.

Parameters

det	The detector ID.

Returns

Index of the detector ID in this set, or -1 if the detector ID is not in this set.

Definition at line 277 of file UnitConst.cc.

{
  unsigned short bit = getBit(det);
  if ((m_bits & bit) == 0) return -1;
  int index = 0;
  for (unsigned short setBit = 1; setBit < bit; setBit *= 2) {
    if ((m_bits & setBit) != 0) ++index;
  }
  return index;
}

operator!=()

bool operator!= ( const DetectorSet &  set ) const

inline

Inequality operator.

Parameters

set	The other set of detector IDs.

Definition at line 229 of file Const.h.

{return m_bits != set.m_bits;}

operator+=()

DetectorSet & operator+= ( const DetectorSet &  set )

inline

Addition of another set to this one.

Parameters

set	The other set of detector IDs.

Definition at line 211 of file Const.h.

{m_bits |= set.m_bits; return *this;}

operator-=()

DetectorSet & operator-= ( const DetectorSet &  set )

inline

Subtraction of another set from this one.

Parameters

set	The other set of detector IDs.

Definition at line 217 of file Const.h.

{m_bits &= ~set.m_bits; return *this;}

operator==()

bool operator== ( const DetectorSet &  set ) const

inline

Equality operator.

Parameters

set	The other set of detector IDs.

Definition at line 223 of file Const.h.

{return m_bits == set.m_bits;}

size()

size_t size

(

)

const

Getter for number of detector IDs in this set.

Definition at line 288 of file UnitConst.cc.

{
  int size = 0;
  for (unsigned short setBit = 1; setBit < 0x1000; setBit *= 2) {
    if ((m_bits & setBit) != 0) ++size;
  }
  return size;
}

Member Data Documentation

m_bits

uint16_t m_bits

private

The internal representation of the set as bit pattern.

Definition at line 286 of file Const.h.

---

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

• framework/gearbox/include/Const.h
• framework/gearbox/src/UnitConst.cc