TotemT1Organization Class Reference

#include <SimG4CMS/Forward/interface/TotemT1Organization.h>

Inheritance diagram for TotemT1Organization:

Public Types
enum	ObjectType {   Undefined = 0, Upper = 1, Lower = 2, InternalUpper = 3,   InternalLower = 4, Frame1 = 5, Frame2Left = 6, Frame2Right = 7,   Frame3Left = 8, Frame3Right = 9, Frame4Left = 10, Frame4Right = 11,   Frame5 = 12, Triangle6Left = 13, Triangle6Right = 14, MaxObjectTypes = 15 }

Public Member Functions
int	fromObjectTypeToInt (ObjectType objectType)
int	fromObjectTypeToInt (ObjectType objectType, int layer)
int	getCurrentCSC (void) const
int	getCurrentDetectorPosition (void) const
int	getCurrentLayer (void) const
ObjectType	getCurrentObjectType (void) const
int	getCurrentPlane (void) const
int	getCurrentUnitID (void) const
uint32_t	getUnitID (const G4Step *aStep) const override
void	setCurrentCSC (int currentCSC)
void	setCurrentDetectorPosition (int currentDetectorPosition)
void	setCurrentLayer (int currentLayer)
void	setCurrentObjectType (ObjectType currentObjectType)
void	setCurrentPlane (int currentPlane)
void	setCurrentUnitID (int currentUnitID)
	TotemT1Organization ()
	~TotemT1Organization () override
Public Member Functions inherited from TotemVDetectorOrganization
	TotemVDetectorOrganization ()
virtual	~TotemVDetectorOrganization ()

Private Member Functions
void	_checkDataUpdate (void) const
void	_checkUnitIDUpdate (void) const
void	_FromDataToUnitID (void)
void	_FromUnitIDToData (void)
uint32_t	getUnitID (const G4Step *aStep)

Private Attributes
int	_currentCSC
int	_currentDetectorPosition
int	_currentLayer
ObjectType	_currentObjectType
int	_currentPlane
int	_currentUnitID
bool	_needUpdateData
bool	_needUpdateUnitID

Detailed Description

Description: This class manages the UnitID that labels TotemT1 sensitive volumes

Usage: Used in TotemSD to get unique ID of sensitive detector element

Definition at line 28 of file TotemT1Organization.h.

Member Enumeration Documentation

ObjectType

enum TotemT1Organization::ObjectType

Enumerator
Undefined
Upper
Lower
InternalUpper
InternalLower
Frame1
Frame2Left
Frame2Right
Frame3Left
Frame3Right
Frame4Left
Frame4Right
Frame5
Triangle6Left
Triangle6Right
MaxObjectTypes

Definition at line 32 of file TotemT1Organization.h.

                  {
    Undefined = 0,
    Upper = 1,
    Lower = 2,
    InternalUpper = 3,
    InternalLower = 4,
    Frame1 = 5,
    Frame2Left = 6,
    Frame2Right = 7,
    Frame3Left = 8,
    Frame3Right = 9,
    Frame4Left = 10,
    Frame4Right = 11,
    Frame5 = 12,
    Triangle6Left = 13,
    Triangle6Right = 14,
    MaxObjectTypes = 15
  };

Constructor & Destructor Documentation

TotemT1Organization()

TotemT1Organization::TotemT1Organization

(

)

Definition at line 27 of file TotemT1Organization.cc.

    : _needUpdateUnitID(false),
      _needUpdateData(false),
      _currentUnitID(-1),
      _currentPlane(-1),
      _currentCSC(-1),
      _currentLayer(-1),
      _currentObjectType(Undefined) {
  edm::LogInfo("ForwardSim") << "Creating TotemT1Organization";
}

~TotemT1Organization()

TotemT1Organization::~TotemT1Organization ( )

override

Definition at line 38 of file TotemT1Organization.cc.

{}

Member Function Documentation

_checkDataUpdate()

void TotemT1Organization::_checkDataUpdate ( void  ) const

private

Definition at line 217 of file TotemT1Organization.cc.

                                                      {
  if (_needUpdateData) {
#ifdef SCRIVI
    LogDebug("ForwardSim") << "Data update needed.";
#endif
    const_cast<TotemT1Organization*>(this)->_FromUnitIDToData();
  } else {
#ifdef SCRIVI
    LogDebug("ForwardSim") << "Data update not needed.";
#endif
  }
}

References _needUpdateData, and LogDebug.

Referenced by getCurrentCSC(), getCurrentDetectorPosition(), getCurrentLayer(), getCurrentObjectType(), and getCurrentPlane().

_checkUnitIDUpdate()

void TotemT1Organization::_checkUnitIDUpdate ( void  ) const

private

Definition at line 204 of file TotemT1Organization.cc.

                                                        {
  if (_needUpdateUnitID) {
#ifdef SCRIVI
    LogDebug("ForwardSim") << "UnitID update needed.";
#endif
    const_cast<TotemT1Organization*>(this)->_FromDataToUnitID();
  } else {
#ifdef SCRIVI
    LogDebug("ForwardSim") << "UnitID update not needed.";
#endif
  }
}

References _needUpdateUnitID, and LogDebug.

Referenced by getCurrentUnitID().

_FromDataToUnitID()

void TotemT1Organization::_FromDataToUnitID ( void  )

private

Definition at line 278 of file TotemT1Organization.cc.

                                                 {
  int currDP, currPL, currCSC, currLA, currOT;
#ifdef SCRIVI
  LogDebug("ForwardSim") << " CURRENT DETECTOR POSITION (0-3) " << _currentDetectorPosition;
#endif
  switch (_currentDetectorPosition) {
    case 0:
      currDP = 0;
      break;
    case 1:
      currDP = 1;
      break;
    case 2:
      currDP = 2;
      break;
    case 3:
      currDP = 3;
      break;
    case 4:
      currDP = 4;
      break;
    default:
      _currentDetectorPosition = 0;
      currDP = 0;
      edm::LogInfo("ForwardSim") << "Invalid _currentDetectorPosition value (" << _currentDetectorPosition
                                 << "). Now is \"Undefined\"";
  }
 
  if (_currentPlane < -1) {
    edm::LogInfo("ForwardSim") << "Invalid _currentPlane value (" << _currentPlane << "). Now is -1";
    _currentPlane = -1;
  }
  currPL = _currentPlane + 1;
 
  if (_currentCSC < -1 || _currentCSC > 5) {
    edm::LogInfo("ForwardSim") << "Invalid _currentCSC value (" << _currentCSC << "). Now is -1";
    _currentCSC = -1;
  }
  currCSC = _currentCSC + 1;
 
  if (_currentLayer < -1) {
    edm::LogInfo("ForwardSim") << "Invalid _currentLayer value (" << _currentLayer << "). Now is -1";
    _currentLayer = -1;
  }
  currLA = _currentLayer + 1;
 
  currOT = fromObjectTypeToInt(_currentObjectType);
 
  // currDP:  0..2 (3)
  // currPL:  0..infty
  // currCSC: 0..6 (7)
  // currLA:  0..infty
  // currOT:  0..MaxObjectTypes-1 (MaxObjectTypes)
 
  TotemNumberMerger merger;
  int currPLA(merger.Merge(currPL, currLA));
 
  _currentUnitID = currDP * 100000 + 5 * (currCSC + 7 * (currOT + MaxObjectTypes * (currPLA)));
#ifdef SCRIVI
  LogDebug("ForwardSim") << "currDP=" << currDP << ", currPL=" << currPL << ", currCSC=" << currCSC
                         << ", currLA=" << currLA << ", currOT=" << currOT << ", currPLA=" << currPLA
                         << ", _currentUnitID=" << _currentUnitID;
#endif
 
  _needUpdateUnitID = false;
}

References _currentCSC, _currentDetectorPosition, _currentLayer, _currentObjectType, _currentPlane, _currentUnitID, _needUpdateUnitID, fromObjectTypeToInt(), LogDebug, MaxObjectTypes, and TotemNumberMerger::Merge().

_FromUnitIDToData()

void TotemT1Organization::_FromUnitIDToData ( void  )

private

Definition at line 230 of file TotemT1Organization.cc.

                                                 {
  int currDP, currCSC, currOT, currPLA;
  unsigned long currPL, currLA;
 
  // currDP:  0..4 (5)
  // currPL:  0..infty
  // currCSC: 0..6 (7)
  // currLA:  0..infty
  // currOT:  0..MaxObjectTypes-1 (MaxObjectTypes)
 
  currDP = (_currentUnitID / 100000) % 5;  // 3;
  currCSC = (_currentUnitID / 5) % 7;
  currOT = (_currentUnitID / (5 * 7)) % MaxObjectTypes;
  currPLA = _currentUnitID / (5 * 7 * MaxObjectTypes);
 
  TotemNumberMerger splitter;
  splitter.Split(currPLA, currPL, currLA);
 
#ifdef SCRIVI
  LogDebug("ForwardSim") << "currDP=" << currDP << ", currPL=" << currPL << ", currCSC=" << currCSC
                         << ", currLA=" << currLA << ", currOT=" << currOT << ", currPLA=" << currPLA
                         << ", _currentUnitID=" << _currentUnitID;
#endif
  _currentPlane = currPL - 1;
  _currentCSC = currCSC - 1;
  _currentLayer = currLA - 1;
  _currentObjectType = static_cast<ObjectType>(currOT);
 
  switch (currDP) {
    case 0:
      _currentDetectorPosition = 0;
      break;
    case 1:
      _currentDetectorPosition = 1;
      break;
    case 2:
      _currentDetectorPosition = 2;
      break;
    case 3:
      _currentDetectorPosition = 3;
      break;
    case 4:
      _currentDetectorPosition = 4;
      break;
  }
  _needUpdateData = false;
}

References _currentCSC, _currentDetectorPosition, _currentLayer, _currentObjectType, _currentPlane, _currentUnitID, _needUpdateData, LogDebug, MaxObjectTypes, and confdb::splitter().

fromObjectTypeToInt() [1/2]

int TotemT1Organization::fromObjectTypeToInt

(

ObjectType

objectType

)

Definition at line 187 of file TotemT1Organization.cc.

                                                                   {
  int result(static_cast<int>(objectType));
  if (result < 0 || result >= MaxObjectTypes) {
    result = 0;
    edm::LogInfo("ForwardSim") << "Invalid ObjectType value (" << objectType << "). Now is \"Undefined\"";
  }
  return result;
}

References MaxObjectTypes, and mps_fire::result.

Referenced by _FromDataToUnitID(), and fromObjectTypeToInt().

fromObjectTypeToInt() [2/2]

int TotemT1Organization::fromObjectTypeToInt	(	ObjectType	objectType,
		int	layer
	)

Definition at line 196 of file TotemT1Organization.cc.

                                                                              {
  return fromObjectTypeToInt(objectType) + layer * MaxObjectTypes;
}

References fromObjectTypeToInt(), and MaxObjectTypes.

getCurrentCSC()

int TotemT1Organization::getCurrentCSC

(

void

)

const

Definition at line 139 of file TotemT1Organization.cc.

                                                  {
  _checkDataUpdate();
#ifdef SCRIVI
  LogDebug("ForwardSim") << "getCurrentCSC()=" << _currentCSC;
#endif
  return _currentCSC;
}

References _checkDataUpdate(), _currentCSC, and LogDebug.

getCurrentDetectorPosition()

int TotemT1Organization::getCurrentDetectorPosition

(

void

)

const

Definition at line 106 of file TotemT1Organization.cc.

                                                               {
  _checkDataUpdate();
#ifdef SCRIVI
  LogDebug("ForwardSim") << "getCurrentDetectorPosition()=" << _currentDetectorPosition;
#endif
  return _currentDetectorPosition;
}

References _checkDataUpdate(), _currentDetectorPosition, and LogDebug.

getCurrentLayer()

int TotemT1Organization::getCurrentLayer

(

void

)

const

Definition at line 155 of file TotemT1Organization.cc.

                                                    {
  _checkDataUpdate();
#ifdef SCRIVI
  LogDebug("ForwardSim") << "getCurrentLayer()=" << _currentLayer;
#endif
  return _currentLayer;
}

References _checkDataUpdate(), _currentLayer, and LogDebug.

getCurrentObjectType()

TotemT1Organization::ObjectType TotemT1Organization::getCurrentObjectType

(

void

)

const

Definition at line 171 of file TotemT1Organization.cc.

                                                                                   {
  _checkDataUpdate();
#ifdef SCRIVI
  LogDebug("ForwardSim") << "getCurrentObjectType()=" << _currentObjectType;
#endif
  return _currentObjectType;
}

References _checkDataUpdate(), _currentObjectType, and LogDebug.

getCurrentPlane()

int TotemT1Organization::getCurrentPlane

(

void

)

const

Definition at line 122 of file TotemT1Organization.cc.

                                                    {
  _checkDataUpdate();
 
#ifdef SCRIVI
  LogDebug("ForwardSim") << "getCurrentPlane()=" << _currentPlane;
#endif
  return _currentPlane;
}

References _checkDataUpdate(), _currentPlane, and LogDebug.

getCurrentUnitID()

int TotemT1Organization::getCurrentUnitID

(

void

)

const

Definition at line 89 of file TotemT1Organization.cc.

                                                     {
  _checkUnitIDUpdate();
#ifdef SCRIVI
  LogDebug("ForwardSim") << "getCurrentUnitID()=" << _currentUnitID;
  << endl;
#endif
  return _currentUnitID;
}

References _checkUnitIDUpdate(), _currentUnitID, and LogDebug.

Referenced by getUnitID().

getUnitID() [1/2]

uint32_t TotemT1Organization::getUnitID ( const G4Step *  aStep )

private

Definition at line 48 of file TotemT1Organization.cc.

                                                            {
  int currLAOT;
  const G4VTouchable* touch = aStep->GetPreStepPoint()->GetTouchable();
  G4VPhysicalVolume* physVol;
  int ii = 0;
  for (ii = 0; ii < touch->GetHistoryDepth(); ii++) {
    physVol = touch->GetVolume(ii);
 
#ifdef SCRIVI
    LogDebug("ForwardSim") << "physVol=" << physVol->GetName() << ", level=" << ii
                           << ", physVol->GetCopyNo()=" << physVol->GetCopyNo();
#endif
 
    if (physVol->GetName() == "TotemT1" && physVol->GetCopyNo() == 1)
      _currentDetectorPosition = 1;
    if (physVol->GetName() == "TotemT1" && physVol->GetCopyNo() == 2)
      _currentDetectorPosition = 2;
  }
 
  touch = aStep->GetPreStepPoint()->GetTouchable();
  physVol = touch->GetVolume(0);
 
  currLAOT = physVol->GetCopyNo();
  _currentObjectType = static_cast<ObjectType>(currLAOT % MaxObjectTypes);
  _currentLayer = currLAOT / MaxObjectTypes;
  _currentPlane = -1;
  _currentCSC = -1;
 
  if (touch->GetVolume(1)) {
    _currentCSC = touch->GetVolume(1)->GetCopyNo();
    if (touch->GetVolume(2))
      _currentPlane = touch->GetVolume(2)->GetCopyNo();
  }
#ifdef SCRIVI
  LogDebug("ForwardSim") << "CURRENT CSC " << _currentCSC << "\n"
                         << "CURRENT PLANE " << _currentPlane;
#endif
  _needUpdateUnitID = true;
  return getCurrentUnitID();
}

References _currentCSC, _currentDetectorPosition, _currentLayer, _currentObjectType, _currentPlane, _needUpdateUnitID, getCurrentUnitID(), cuy::ii, LogDebug, and MaxObjectTypes.

getUnitID() [2/2]

uint32_t TotemT1Organization::getUnitID ( const G4Step *  aStep ) const

overridevirtual

Implements TotemVDetectorOrganization.

Definition at line 44 of file TotemT1Organization.cc.

                                                                  {
  return const_cast<TotemT1Organization*>(this)->getUnitID(aStep);
}

setCurrentCSC()

void TotemT1Organization::setCurrentCSC

(

int

currentCSC

)

Definition at line 147 of file TotemT1Organization.cc.

                                                       {
#ifdef SCRIVI
  LogDebug("ForwardSim") << "_currentCSC=" << currentCSC;
#endif
  _currentCSC = currentCSC;
  _needUpdateUnitID = true;
}

References _currentCSC, _needUpdateUnitID, and LogDebug.

setCurrentDetectorPosition()

void TotemT1Organization::setCurrentDetectorPosition

(

int

currentDetectorPosition

)

Definition at line 114 of file TotemT1Organization.cc.

                                                                                 {
#ifdef SCRIVI
  LogDebug("ForwardSim") << "_currentDetectorPosition=" << currentDetectorPosition;
#endif
  _currentDetectorPosition = currentDetectorPosition;
  _needUpdateUnitID = true;
}

References _currentDetectorPosition, _needUpdateUnitID, and LogDebug.

Referenced by TotemT1NumberingScheme::TotemT1NumberingScheme().

setCurrentLayer()

void TotemT1Organization::setCurrentLayer

(

int

currentLayer

)

Definition at line 163 of file TotemT1Organization.cc.

                                                           {
#ifdef SCRIVI
  LogDebug("ForwardSim") << "_currentLayer=" << currentLayer;
#endif
  _currentLayer = currentLayer;
  _needUpdateUnitID = true;
}

References _currentLayer, _needUpdateUnitID, and LogDebug.

setCurrentObjectType()

void TotemT1Organization::setCurrentObjectType

(

ObjectType

currentObjectType

)

Definition at line 179 of file TotemT1Organization.cc.

                                                                            {
#ifdef SCRIVI
  LogDebug("ForwardSim") << "_currentObjectType=" << currentObjectType;
#endif
  _currentObjectType = currentObjectType;
  _needUpdateUnitID = true;
}

References _currentObjectType, _needUpdateUnitID, and LogDebug.

setCurrentPlane()

void TotemT1Organization::setCurrentPlane

(

int

currentPlane

)

Definition at line 131 of file TotemT1Organization.cc.

                                                           {
#ifdef SCRIVI
  LogDebug("ForwardSim") << "_currentPlane=" << currentPlane;
#endif
  _currentPlane = currentPlane;
  _needUpdateUnitID = true;
}

References _currentPlane, _needUpdateUnitID, and LogDebug.

setCurrentUnitID()

void TotemT1Organization::setCurrentUnitID

(

int

currentUnitID

)

Definition at line 98 of file TotemT1Organization.cc.

                                                             {
#ifdef SCRIVI
  LogDebug("ForwardSim") << "_currentUnitID=" << currentUnitID;
#endif
  _currentUnitID = currentUnitID;
  _needUpdateData = true;
}

References _currentUnitID, _needUpdateData, and LogDebug.

Member Data Documentation

_currentCSC

int TotemT1Organization::_currentCSC

private

Definition at line 104 of file TotemT1Organization.h.

Referenced by _FromDataToUnitID(), _FromUnitIDToData(), getCurrentCSC(), getUnitID(), and setCurrentCSC().

_currentDetectorPosition

int TotemT1Organization::_currentDetectorPosition

private

Definition at line 102 of file TotemT1Organization.h.

Referenced by _FromDataToUnitID(), _FromUnitIDToData(), getCurrentDetectorPosition(), getUnitID(), and setCurrentDetectorPosition().

_currentLayer

int TotemT1Organization::_currentLayer

private

Definition at line 105 of file TotemT1Organization.h.

Referenced by _FromDataToUnitID(), _FromUnitIDToData(), getCurrentLayer(), getUnitID(), and setCurrentLayer().

_currentObjectType

ObjectType TotemT1Organization::_currentObjectType

private

Definition at line 106 of file TotemT1Organization.h.

Referenced by _FromDataToUnitID(), _FromUnitIDToData(), getCurrentObjectType(), getUnitID(), and setCurrentObjectType().

_currentPlane

int TotemT1Organization::_currentPlane

private

Definition at line 103 of file TotemT1Organization.h.

Referenced by _FromDataToUnitID(), _FromUnitIDToData(), getCurrentPlane(), getUnitID(), and setCurrentPlane().

_currentUnitID

int TotemT1Organization::_currentUnitID

private

Definition at line 101 of file TotemT1Organization.h.

Referenced by _FromDataToUnitID(), _FromUnitIDToData(), getCurrentUnitID(), and setCurrentUnitID().

_needUpdateData

bool TotemT1Organization::_needUpdateData

private

Definition at line 100 of file TotemT1Organization.h.

Referenced by _checkDataUpdate(), _FromUnitIDToData(), and setCurrentUnitID().

_needUpdateUnitID

bool TotemT1Organization::_needUpdateUnitID

private

Definition at line 99 of file TotemT1Organization.h.

Referenced by _checkUnitIDUpdate(), _FromDataToUnitID(), getUnitID(), setCurrentCSC(), setCurrentDetectorPosition(), setCurrentLayer(), setCurrentObjectType(), and setCurrentPlane().