Class to identify a wire inside the CDC. More...

#include <WireID.h>

Inheritance diagram for WireID:

Public Member Functions
	WireID (unsigned short eWire=65535)
	Constructor taking the encoded wire number.

	WireID (const WireID &wireID)
	Copy constructor.

	WireID (unsigned short iSuperLayer, unsigned short iLayer, unsigned short iWire)
	Constructor using the official numbering scheme.

	WireID (unsigned short iCLayer, unsigned short iWire)
	Constructor using continuous layer numbers as used in the geometry build-up for the simulation.

WireID &	operator= (const WireID &wireID)
	Assignment operator.

WireID &	operator= (unsigned short eWire)
	Assignment from unsigned short.

	operator unsigned short () const
	Convert to unsigned short.

bool	operator== (const WireID &rhs) const
	Check for equality.

bool	operator< (const WireID &rhs) const
	Order by unique id.

void	setWireID (unsigned short iSuperLayer, unsigned short iLayer, unsigned short iWire)
	Setter using official numbering.

void	setWireID (unsigned short iCLayer, unsigned short iWire)
	Setter using numbering of geometry build-up.

void	setWireID (unsigned short eWire)
	Setter using the encoded wire number.

unsigned short	getISuperLayer () const
	Getter for Super-Layer.

unsigned short	getILayer () const
	Getter for layer within the Super-Layer.

unsigned short	getIWire () const
	Getter for wire within the layer.

unsigned short	getICLayer () const
	Getter for continuous layer numbering.

unsigned short	getEWire () const
	Getter for encoded wire number.

Private Member Functions
	ClassDef (WireID, 2)
	ROOT Macro.

Private Attributes
unsigned short	m_eWire
	Internal storage for the wire identifier in the encoded form.

Detailed Description

Class to identify a wire inside the CDC.

There are three representations for this:

Super-Layer, Layer within the Super-Layer, Wire within the Layer as documented here,
Layer as continuous counted through all Super-Layers, Wire within the Layer,
Wire number encoded into a single unsigned short. This works as following:
SuperLayer: bits 1 - 4 (/4096)
Layer: bits 5 - 7 (% 4096, / 512)
Wire: bits 8 - 16 (% 512)
Note: These operations could as well be achieved by bit-shifting operations.

Definition at line 34 of file WireID.h.

Constructor & Destructor Documentation

◆ WireID() [1/4]

WireID ( unsigned short eWire = 65535 )

inlineexplicit

Constructor taking the encoded wire number.

Parameters

eWire Number of wire using the encoded format. Careful - wires are not continuously within the encoded number. The default is set to the maximum allowed value, as 0 corresponds already to some wire. This assigned value does NOT correspond to any real wire.

Definition at line 45 of file WireID.h.

    {
      m_eWire = eWire;
    }

◆ WireID() [2/4]

WireID ( const WireID & wireID )

inline

Copy constructor.

Definition at line 51 of file WireID.h.

                                 : TObject(wireID)
    {
      m_eWire = wireID.m_eWire;
    }

◆ WireID() [3/4]

WireID	(	unsigned short	iSuperLayer,
		unsigned short	iLayer,
		unsigned short	iWire
	)

Constructor using the official numbering scheme.

Parameters

iSuperLayer	Number of Super-Layer.
iLayer	Number of Layer within the Super-Layer.
iWire	Wire number within the layer.

Definition at line 35 of file WireID.cc.

{
  setWireID(iSuperLayer, iLayer, iWire);
}

◆ WireID() [4/4]

WireID	(	unsigned short	iCLayer,
		unsigned short	iWire
	)

Constructor using continuous layer numbers as used in the geometry build-up for the simulation.

Parameters

iCLayer	Number of Layer counted continuously over the full CDC.
iWire	Number of Wire within the layer equivalenty to the official numbering.

Definition at line 30 of file WireID.cc.

{
  setWireID(iCLayer, iWire);
}

Member Function Documentation

◆ getEWire()

unsigned short getEWire ( ) const

inline

Getter for encoded wire number.

Definition at line 154 of file WireID.h.

    {
      return m_eWire;
    }

◆ getICLayer()

unsigned short getICLayer ( ) const

Getter for continuous layer numbering.

Definition at line 24 of file WireID.cc.

{
  if (getISuperLayer() == 0) { return getILayer(); }
  return 8 + (getISuperLayer() - 1) * 6 + getILayer();
}

◆ getILayer()

unsigned short getILayer ( ) const

inline

Getter for layer within the Super-Layer.

Definition at line 136 of file WireID.h.

    {
      return ((m_eWire % 4096) / 512);
    }

◆ getISuperLayer()

unsigned short getISuperLayer ( ) const

inline

Getter for Super-Layer.

Definition at line 130 of file WireID.h.

    {
      return (m_eWire / 4096);
    }

◆ getIWire()

unsigned short getIWire ( ) const

inline

Getter for wire within the layer.

This getter works for the official numbering scheme as well as the one used in the geometry build-up.

Definition at line 145 of file WireID.h.

    {
      return (m_eWire % 512);
    }

◆ operator unsigned short()

operator unsigned short ( ) const

inline

Convert to unsigned short.

Definition at line 92 of file WireID.h.

    {
      return getEWire();
    }

◆ operator<()

bool operator< ( const WireID & rhs ) const

inline

Order by unique id.

Definition at line 104 of file WireID.h.

    {
      return getEWire() < rhs.getEWire();
    }

◆ operator=() [1/2]

WireID & operator= ( const WireID & wireID )

inline

Assignment operator.

Definition at line 74 of file WireID.h.

    {
      m_eWire = wireID.m_eWire;
      static_cast<TObject>(*this) = wireID;
      return *this;
    }

◆ operator=() [2/2]

WireID & operator= ( unsigned short eWire )

inline

Assignment from unsigned short.

Parameters

eWire This parameter should be the wire number in the encoded format.

Definition at line 85 of file WireID.h.

    {
      m_eWire = eWire;
      return *this;
    }

◆ operator==()

bool operator== ( const WireID & rhs ) const

inline

Check for equality.

Definition at line 98 of file WireID.h.

    {
      return getEWire() == rhs.getEWire();
    }

◆ setWireID() [1/3]

void setWireID ( unsigned short eWire )

inline

Setter using the encoded wire number.

Definition at line 122 of file WireID.h.

    {
      B2DEBUG(250, "setWireID called with " << eWire);
      m_eWire = eWire;
    }

◆ setWireID() [2/3]

void setWireID	(	unsigned short	iCLayer,
		unsigned short	iWire
	)

Setter using numbering of geometry build-up.

Definition at line 14 of file WireID.cc.

{
  B2DEBUG(250, "setWireID called with " << iCLayer << ", " << iWire);
  if (iCLayer < 8) {
    setWireID(0, iCLayer, iWire);
  } else {
    setWireID(((iCLayer - 8) / 6) + 1, (iCLayer - 2) % 6, iWire);
  }
}

◆ setWireID() [3/3]

void setWireID	(	unsigned short	iSuperLayer,
		unsigned short	iLayer,
		unsigned short	iWire
	)

inline

Setter using official numbering.

Definition at line 112 of file WireID.h.

    {
      B2DEBUG(250, "setWireID called with " << iSuperLayer << ", " << iLayer << ", " << iWire);
      m_eWire = iWire + 512 * iLayer + 4096 * iSuperLayer;
    }

Member Data Documentation

◆ m_eWire

unsigned short m_eWire

private

Internal storage for the wire identifier in the encoded form.

Definition at line 161 of file WireID.h.

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

cdc/dataobjects/include/WireID.h
cdc/dataobjects/src/WireID.cc

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ WireID() [1/4]

◆ WireID() [2/4]

◆ WireID() [3/4]

◆ WireID() [4/4]

Member Function Documentation

◆ getEWire()

◆ getICLayer()

◆ getILayer()

◆ getISuperLayer()

◆ getIWire()

◆ operator unsigned short()

◆ operator<()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==()

◆ setWireID() [1/3]

◆ setWireID() [2/3]

◆ setWireID() [3/3]

Member Data Documentation

◆ m_eWire