ATLAS Offline Software
Public Types | Public Member Functions | Static Public Member Functions | Private Attributes | List of all members
PileUpTimeEventIndex Class Reference

a struct encapsulating the identifier of a pile-up event More...

#include <PileUpTimeEventIndex.h>

Collaboration diagram for PileUpTimeEventIndex:

Public Types

enum  PileUpType {
  Unknown =-1, Signal =0, MinimumBias =1, Cavern =2,
  HaloGas =3, HighPtMinimumBias =4, ZeroBias =5, NTYPES
}
 
typedef long time_type
 
typedef unsigned long index_type
 

Public Member Functions

 PileUpTimeEventIndex ()
 
 PileUpTimeEventIndex (time_type time)
 
 PileUpTimeEventIndex (time_type time, index_type index)
 
 PileUpTimeEventIndex (time_type time, index_type index, PileUpType typ)
 
time_type time () const
 bunch xing time in ns More...
 
index_type index () const
 the index of the component event in PileUpEventInfo More...
 
PileUpType type () const
 the pileup type - minbias, cavern, beam halo, signal? More...
 

Static Public Member Functions

static const std::string & typeName (PileUpType typ)
 
static PileUpType ushortToType (unsigned short)
 

Private Attributes

short m_time
 
short m_index
 
PileUpType m_type
 

Detailed Description

a struct encapsulating the identifier of a pile-up event

Definition at line 12 of file PileUpTimeEventIndex.h.

Member Typedef Documentation

◆ index_type

typedef unsigned long PileUpTimeEventIndex::index_type

Definition at line 25 of file PileUpTimeEventIndex.h.

◆ time_type

Definition at line 24 of file PileUpTimeEventIndex.h.

Member Enumeration Documentation

◆ PileUpType

Enumerator
Unknown 
Signal 
MinimumBias 
Cavern 
HaloGas 
HighPtMinimumBias 
ZeroBias 
NTYPES 

Definition at line 14 of file PileUpTimeEventIndex.h.

14  {
15  Unknown=-1,
16  Signal=0,
17  MinimumBias=1,
18  Cavern=2,
19  HaloGas=3,
21  ZeroBias=5,
22  NTYPES
23  };

Constructor & Destructor Documentation

◆ PileUpTimeEventIndex() [1/4]

PileUpTimeEventIndex::PileUpTimeEventIndex ( )

Definition at line 57 of file PileUpTimeEventIndex.cxx.

◆ PileUpTimeEventIndex() [2/4]

PileUpTimeEventIndex::PileUpTimeEventIndex ( time_type  time)

Definition at line 59 of file PileUpTimeEventIndex.cxx.

59  :

◆ PileUpTimeEventIndex() [3/4]

PileUpTimeEventIndex::PileUpTimeEventIndex ( time_type  time,
index_type  index 
)

Definition at line 62 of file PileUpTimeEventIndex.cxx.

62  :

◆ PileUpTimeEventIndex() [4/4]

PileUpTimeEventIndex::PileUpTimeEventIndex ( time_type  time,
index_type  index,
PileUpType  typ 
)

Member Function Documentation

◆ index()

PileUpTimeEventIndex::index_type PileUpTimeEventIndex::index ( ) const

the index of the component event in PileUpEventInfo

Definition at line 76 of file PileUpTimeEventIndex.cxx.

76  {
77  return (index_type) m_index;
78 }

◆ time()

PileUpTimeEventIndex::time_type PileUpTimeEventIndex::time ( ) const

bunch xing time in ns

Definition at line 71 of file PileUpTimeEventIndex.cxx.

71  {
72  return m_time;
73 }

◆ type()

PileUpTimeEventIndex::PileUpType PileUpTimeEventIndex::type ( ) const

the pileup type - minbias, cavern, beam halo, signal?

Definition at line 81 of file PileUpTimeEventIndex.cxx.

81  {
82  return m_type;
83 }

◆ typeName()

const std::string & PileUpTimeEventIndex::typeName ( PileUpType  typ)
static

Definition at line 13 of file PileUpTimeEventIndex.cxx.

13  {
14  static const std::string typNam[PileUpTimeEventIndex::NTYPES + 1] =
15  {
16  "Unknown" /*-1*/, "Signal" /*0*/, "MinimumBias" /*1*/, "Cavern" /*2*/,
17  "HaloGas" /*3*/, "HighPtMinimumBias" /*4*/, "ZeroBias"/*5*/
18  };
19 
20  assert(typ < PileUpTimeEventIndex::NTYPES);
21  return typNam[typ + 1];
22 }

◆ ushortToType()

PileUpTimeEventIndex::PileUpType PileUpTimeEventIndex::ushortToType ( unsigned short  uType)
static

Definition at line 25 of file PileUpTimeEventIndex.cxx.

25  {
27  switch (uType) {
28  case 0: puType = PileUpTimeEventIndex::Signal;
29  break;
30 
31  case 1: puType = PileUpTimeEventIndex::MinimumBias;
32  break;
33 
34  case 2: puType = PileUpTimeEventIndex::Cavern;
35  break;
36 
37  case 3: puType = PileUpTimeEventIndex::HaloGas;
38  break;
39 
41  break;
42 
43  case 5: puType = PileUpTimeEventIndex::ZeroBias;
44  break;
45 
46  default:
47  std::ostringstream merr;
48  merr <<
49  "PileUpTimeEventIndex::ushortToType FATAL: invalid PileUpType specified "
50  << uType;
51  std::cerr << merr.str() << std::endl;
52  throw GaudiException(merr.str(), "PileUpTimeEventIndex::ushortToType", StatusCode::FAILURE);
53  }
54  return puType;
55 }

Member Data Documentation

◆ m_index

short PileUpTimeEventIndex::m_index
private

Definition at line 43 of file PileUpTimeEventIndex.h.

◆ m_time

short PileUpTimeEventIndex::m_time
private

Definition at line 42 of file PileUpTimeEventIndex.h.

◆ m_type

PileUpType PileUpTimeEventIndex::m_type
private

Definition at line 44 of file PileUpTimeEventIndex.h.


The documentation for this class was generated from the following files:
PileUpTimeEventIndex::Cavern
@ Cavern
Definition: PileUpTimeEventIndex.h:18
index
Definition: index.py:1
PileUpTimeEventIndex::PileUpType
PileUpType
Definition: PileUpTimeEventIndex.h:14
PileUpTimeEventIndex::m_index
short m_index
Definition: PileUpTimeEventIndex.h:43
PileUpTimeEventIndex::m_time
short m_time
Definition: PileUpTimeEventIndex.h:42
PileUpTimeEventIndex::MinimumBias
@ MinimumBias
Definition: PileUpTimeEventIndex.h:17
PileUpTimeEventIndex::HaloGas
@ HaloGas
Definition: PileUpTimeEventIndex.h:19
PileUpTimeEventIndex::ZeroBias
@ ZeroBias
Definition: PileUpTimeEventIndex.h:21
PileUpTimeEventIndex::Signal
@ Signal
Definition: PileUpTimeEventIndex.h:16
PileUpTimeEventIndex::time
time_type time() const
bunch xing time in ns
Definition: PileUpTimeEventIndex.cxx:71
PileUpTimeEventIndex::m_type
PileUpType m_type
Definition: PileUpTimeEventIndex.h:44
PileUpTimeEventIndex::HighPtMinimumBias
@ HighPtMinimumBias
Definition: PileUpTimeEventIndex.h:20
PileUpTimeEventIndex::NTYPES
@ NTYPES
Definition: PileUpTimeEventIndex.h:22
PileUpTimeEventIndex::Unknown
@ Unknown
Definition: PileUpTimeEventIndex.h:15
index_type
unsigned int index_type
Definition: FPGATrackSimSGToRawHitsTool.h:37