xAOD::EventInfo_v1::SubEvent Class Reference

Class describing the properties of one pileup sub-event. More...

#include <EventInfo_v1.h>

Collaboration diagram for xAOD::EventInfo_v1::SubEvent:

Public Member Functions
	SubEvent (int16_t time, uint16_t index, PileUpType type, const ElementLink< EventInfoContainer_v1 > &link)
	Constructor giving all relevant information to the object. More...
int16_t	time () const
	Get the time wrt. the signal event (which has time() == 0) More...
uint16_t	index () const
	Get the index of the sub-event. More...
PileUpType	type () const
	Get the type of the pileup event. More...
const std::string &	typeName () const
	The string name of the type. More...
const ElementLink< EventInfoContainer_v1 > &	link () const
	Get a link to the EventInfo object describing the pileup event. More...
const EventInfo_v1 *	ptr () const
	Get a pointer to the EventInfo object describing the pileup event. More...

Private Attributes
int16_t	m_time
	The time wrt. the signal event. More...
uint16_t	m_index
	The index of the pileup event. More...
PileUpType	m_type
	The type of the pileup event. More...
ElementLink< EventInfoContainer_v1 >	m_link
	Link to the EventInfo object in question. More...

Detailed Description

Class describing the properties of one pileup sub-event.

This class mirrors the setup of PileUpEventInfo::SubEvent. But uses a bit simpler structure on its inside.

Definition at line 286 of file EventInfo_v1.h.

Constructor & Destructor Documentation

SubEvent()

xAOD::EventInfo_v1::SubEvent::SubEvent	(	int16_t	time,
		uint16_t	index,
		PileUpType	type,
		const ElementLink< EventInfoContainer_v1 > &	link
	)

Constructor giving all relevant information to the object.

Definition at line 443 of file EventInfo_v1.cxx.

      : m_time( time ), m_index( index ), m_type( type ), m_link( link ) {
 
   }

Member Function Documentation

index()

uint16_t xAOD::EventInfo_v1::SubEvent::index

(

)

const

Get the index of the sub-event.

Definition at line 455 of file EventInfo_v1.cxx.

                                              {
 
      return m_index;
   }

link()

const ElementLink< EventInfoContainer_v1 > & xAOD::EventInfo_v1::SubEvent::link

(

)

const

Get a link to the EventInfo object describing the pileup event.

Definition at line 496 of file EventInfo_v1.cxx.

                                    {
 
      return m_link;
   }

ptr()

const EventInfo_v1 * xAOD::EventInfo_v1::SubEvent::ptr

(

)

const

Get a pointer to the EventInfo object describing the pileup event.

Definition at line 501 of file EventInfo_v1.cxx.

                                                       {
 
      if( m_link.isValid() ) {
         return *m_link;
      } else {
         return nullptr;
      }
   }

time()

int16_t xAOD::EventInfo_v1::SubEvent::time

(

)

const

Get the time wrt. the signal event (which has time() == 0)

Definition at line 450 of file EventInfo_v1.cxx.

                                            {
 
      return m_time;
   }

type()

EventInfo_v1::PileUpType xAOD::EventInfo_v1::SubEvent::type

(

)

const

Get the type of the pileup event.

Definition at line 460 of file EventInfo_v1.cxx.

                                                           {
 
      return m_type;
   }

typeName()

const std::string & xAOD::EventInfo_v1::SubEvent::typeName

(

)

const

The string name of the type.

Definition at line 465 of file EventInfo_v1.cxx.

                                                         {
 
      // This is a really inefficienct implementation, but didn't
      // feel like writing a short and efficient implementation for C++11,
      // and a longer but still efficient version for C++03. This is a
      // medium-sized, slow implementation that works everywhere... :-P
      if( m_type == Signal ) {
         static const std::string name = "Signal";
         return name;
      } else if( m_type == MinimumBias ) {
         static const std::string name = "MinimumBias";
         return name;
      } else if( m_type == Cavern ) {
         static const std::string name = "Cavern";
         return name;
      } else if( m_type == HaloGas ) {
         static const std::string name = "HaloGas";
         return name;
      } else if( m_type == HighPtMinimumBias ) {
         static const std::string name = "HighPtMinimumBias";
         return name;
      } else if( m_type == ZeroBias ) {
         static const std::string name = "ZeroBias";
         return name;
      } else {
         static const std::string name = "Unknown";
         return name;
      }
   }

Member Data Documentation

m_index

uint16_t xAOD::EventInfo_v1::SubEvent::m_index

private

The index of the pileup event.

Definition at line 309 of file EventInfo_v1.h.

m_link

ElementLink< EventInfoContainer_v1 > xAOD::EventInfo_v1::SubEvent::m_link

private

Link to the EventInfo object in question.

Definition at line 312 of file EventInfo_v1.h.

m_time

int16_t xAOD::EventInfo_v1::SubEvent::m_time

private

The time wrt. the signal event.

Definition at line 308 of file EventInfo_v1.h.

m_type

PileUpType xAOD::EventInfo_v1::SubEvent::m_type

private

The type of the pileup event.

Definition at line 310 of file EventInfo_v1.h.

---

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

• EventInfo_v1.h
• EventInfo_v1.cxx