EventID Class Reference

This class provides a unique identification for each event, in terms of run/event number and/or a time stamp. More...

#include <EventID.h>

Inheritance diagram for EventID:

Collaboration diagram for EventID:

Public Types
typedef EventIDBase::number_type	number_type

structors
number_type	m_detector_mask0
	detector mask0 - bit field indicating which TTC zones have been built into the event, one bit per zone, 32 bit unsigned
number_type	m_detector_mask1
	detector mask1 - bit field indicating which TTC zones have been built into the event, one bit per zone, 32 bit unsigned
number_type	m_detector_mask2
	detector mask2 - additional trigger bits
number_type	m_detector_mask3
	detector mask3 - additional trigger bits
	EventID ()
	EventID (number_type run_number, uint64_t event_number)
	EventID (number_type run_number, uint64_t event_number, number_type time_stamp)
	EventID (number_type run_number, uint64_t event_number, number_type time_stamp, number_type time_stamp_ns_offset, number_type lumi_block, number_type bunch_crossing_id)
	EventID (number_type run_number, uint64_t event_number, number_type time_stamp, number_type time_stamp_ns_offset, number_type lumi_block, number_type bunch_crossing_id, number_type detector_mask0, number_type detector_mask1, number_type detector_mask2=0, number_type detector_mask3=0)
virtual	~EventID ()
	EventID (const EventID &)=default
	EventID (EventID &&)=default
EventID &	operator= (const EventID &)=default
EventID &	operator= (EventID &&)=default
number_type	detector_mask0 (void) const
	detector mask0 - bit field indicating which TTC zones have been built into the event, one bit per zone, 32 bit unsigned
number_type	detector_mask1 (void) const
	detector mask1 - bit field indicating which TTC zones have been built into the event, one bit per zone, 32 bit unsigned
number_type	detector_mask2 (void) const
	detector mask0 - bit field indicating which TTC zones have been built into the event, one bit per zone, 32 bit unsigned
number_type	detector_mask3 (void) const
	detector mask1 - bit field indicating which TTC zones have been built into the event, one bit per zone, 32 bit unsigned
uint64_t	detector_mask (void) const
	detector mask - as a 64 bit number - only provides access to the combined 64 bits det mask, the newer 64 bits, adding up to the 128 bits, must be accessed directly by mask2,3
void	set_detector_mask (number_type detectorMask0, number_type detectorMask1, number_type detectorMask2=0, number_type detectorMask3=0)
	set detector mask
std::ostream &	operator<< (std::ostream &os, const EventID &rhs)
	Extraction operators.

Detailed Description

This class provides a unique identification for each event, in terms of run/event number and/or a time stamp.

Definition at line 35 of file EventID.h.

Member Typedef Documentation

number_type

typedef EventIDBase::number_type EventID::number_type

Definition at line 37 of file EventID.h.

Constructor & Destructor Documentation

EventID() [1/7]

EventID::EventID

(

)

Definition at line 18 of file EventID.cxx.

                 :
  EventIDBase()
{}

EventID() [2/7]

EventID::EventID	(	number_type	run_number,
		uint64_t	event_number )

Definition at line 22 of file EventID.cxx.

                                        :
  EventIDBase(run_number, event_number)
{}

EventID() [3/7]

EventID::EventID	(	number_type	run_number,
		uint64_t	event_number,
		number_type	time_stamp )

Definition at line 27 of file EventID.cxx.

                                         :
  EventIDBase(run_number, event_number, time_stamp)
{}

EventID() [4/7]

EventID::EventID	(	number_type	run_number,
		uint64_t	event_number,
		number_type	time_stamp,
		number_type	time_stamp_ns_offset,
		number_type	lumi_block,
		number_type	bunch_crossing_id )

Definition at line 33 of file EventID.cxx.

                                                :
  EventIDBase(run_number, event_number, time_stamp, time_stamp_ns_offset,
              lumi_block, bunch_crossing_id)
{}

EventID() [5/7]

EventID::EventID	(	number_type	run_number,
		uint64_t	event_number,
		number_type	time_stamp,
		number_type	time_stamp_ns_offset,
		number_type	lumi_block,
		number_type	bunch_crossing_id,
		number_type	detector_mask0,
		number_type	detector_mask1,
		number_type	detector_mask2 = 0,
		number_type	detector_mask3 = 0 )

Definition at line 44 of file EventID.cxx.

  :
  EventIDBase(run_number, event_number, time_stamp, time_stamp_ns_offset,
              lumi_block, bunch_crossing_id),
  m_detector_mask0(detector_mask0),
  m_detector_mask1(detector_mask1),
  m_detector_mask2(detector_mask2),
  m_detector_mask3(detector_mask3)
{}

~EventID()

EventID::~EventID ( )

virtual

Definition at line 64 of file EventID.cxx.

{}

EventID() [6/7]

EventID::EventID ( const EventID & )

default

EventID() [7/7]

EventID::EventID ( EventID && )

default

Member Function Documentation

detector_mask()

uint64_t EventID::detector_mask ( void ) const

inline

detector mask - as a 64 bit number - only provides access to the combined 64 bits det mask, the newer 64 bits, adding up to the 128 bits, must be accessed directly by mask2,3

Definition at line 155 of file EventID.h.

                                 {
  uint64_t result = m_detector_mask1;
 
  result = result << 32;
  result |= m_detector_mask0;
  return(result);
}

detector_mask0()

EventID::number_type EventID::detector_mask0 ( void ) const

inline

detector mask0 - bit field indicating which TTC zones have been built into the event, one bit per zone, 32 bit unsigned

Definition at line 131 of file EventID.h.

                                  {
  return m_detector_mask0;
}

detector_mask1()

EventID::number_type EventID::detector_mask1 ( void ) const

inline

detector mask1 - bit field indicating which TTC zones have been built into the event, one bit per zone, 32 bit unsigned

Definition at line 137 of file EventID.h.

                                  {
  return m_detector_mask1;
}

detector_mask2()

EventID::number_type EventID::detector_mask2 ( void ) const

inline

detector mask0 - bit field indicating which TTC zones have been built into the event, one bit per zone, 32 bit unsigned

Definition at line 143 of file EventID.h.

                                  {
  return m_detector_mask2;
}

detector_mask3()

EventID::number_type EventID::detector_mask3 ( void ) const

inline

detector mask1 - bit field indicating which TTC zones have been built into the event, one bit per zone, 32 bit unsigned

Definition at line 149 of file EventID.h.

                                  {
  return m_detector_mask3;
}

operator=() [1/2]

EventID & EventID::operator= ( const EventID & )

default

operator=() [2/2]

EventID & EventID::operator= ( EventID && )

default

set_detector_mask()

void EventID::set_detector_mask	(	number_type	detectorMask0,
		number_type	detectorMask1,
		number_type	detectorMask2 = 0,
		number_type	detectorMask3 = 0 )

set detector mask

Definition at line 70 of file EventID.cxx.

                                                      {
  m_detector_mask0 = detectorMask0;
  m_detector_mask1 = detectorMask1;
  m_detector_mask2 = detectorMask2;
  m_detector_mask3 = detectorMask3;
}

Friends And Related Symbol Documentation

operator<<

std::ostream & operator<< ( std::ostream & os, const EventID & rhs )

friend

Extraction operators.

Definition at line 163 of file EventID.h.

                                                                    {
  os << "[Run,Evt,Lumi,Time,BunchCross,DetMask] = ["
     << rhs.run_number()
     << "," << rhs.event_number()
     << "," << rhs.lumi_block()
     << "," << rhs.time_stamp()
     << ":" << rhs.time_stamp_ns_offset()
     << "," << rhs.bunch_crossing_id()
     << ",0x" << std::hex << rhs.detector_mask()
     << ",0x" << std::hex << rhs.detector_mask2()
     << ",0x" << std::hex << rhs.detector_mask3() << std::dec
     << "]";
  return os;
}

Member Data Documentation

m_detector_mask0

number_type EventID::m_detector_mask0

private

Initial value:

{
    0
  }

detector mask0 - bit field indicating which TTC zones have been built into the event, one bit per zone, 32 bit unsigned

Definition at line 104 of file EventID.h.

                               {
    0
  };

m_detector_mask1

number_type EventID::m_detector_mask1

private

Initial value:

{
    0
  }

detector mask1 - bit field indicating which TTC zones have been built into the event, one bit per zone, 32 bit unsigned

Definition at line 110 of file EventID.h.

                               {
    0
  };

m_detector_mask2

number_type EventID::m_detector_mask2

private

Initial value:

{
    0
  }

detector mask2 - additional trigger bits

Definition at line 115 of file EventID.h.

                               {
    0
  };

m_detector_mask3

number_type EventID::m_detector_mask3

private

Initial value:

{
    0
  }

detector mask3 - additional trigger bits

Definition at line 120 of file EventID.h.

                               {
    0
  };

---

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

• EventID.h
• EventID.cxx