Project
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
o2::dataformats::MCEventHeader Class Reference

#include <MCEventHeader.h>

Inherits FairMCEventHeader.

Public Member Functions

 MCEventHeader ()=default
 
 MCEventHeader (const MCEventHeader &rhs)=default
 
MCEventHeader & operator= (const MCEventHeader &rhs)=default
 
 ~MCEventHeader () override=default
 
void setEmbeddingFileName (std::string const &value)
 
void setEmbeddingEventIndex (Int_t value)
 
int getEmbeddedIndex () const
 
void clearInfo ()
 
template<typename T >
void putInfo (std::string const &key, T const &value)
 
bool hasInfo (std::string const &key) const
 
template<typename T >
const T & getInfo (std::string const &key, bool &isvalid) const
 
void print () const
 
void printInfo () const
 prints a summary of info keys/types attached to this header
 
void copyInfoFrom (MCEventHeader const &other)
 inits info fields from another Event header
 
virtual void Reset ()
 
MCEventStats & getMCEventStats ()
 
void setDetId2HitBitLUT (std::vector< int > const &v)
 
std::vector< int > const & getDetId2HitBitLUT () const
 

Static Public Member Functions

static void extractFileFromKinematics (std::string_view kinefilename, std::string_view targetfilename)
 create a standalone ROOT file/tree with only the MCHeader branch
 

Protected Member Functions

 ClassDefOverride (MCEventHeader, 4)
 

Protected Attributes

std::string mEmbeddingFileName
 
Int_t mEmbeddingEventIndex = 0
 
MCEventStats mEventStats {}
 
std::vector< int > mDetId2HitBitIndex
 
o2::utils::RootSerializableKeyValueStore mEventInfo
 

Detailed Description

Definition at line 101 of file MCEventHeader.h.

Constructor & Destructor Documentation

◆ MCEventHeader() [1/2]

o2::dataformats::MCEventHeader::MCEventHeader ( )
default

◆ MCEventHeader() [2/2]

o2::dataformats::MCEventHeader::MCEventHeader ( const MCEventHeader &  rhs)
default

◆ ~MCEventHeader()

o2::dataformats::MCEventHeader::~MCEventHeader ( )
overridedefault

Member Function Documentation

◆ ClassDefOverride()

o2::dataformats::MCEventHeader::ClassDefOverride ( MCEventHeader  ,
4   
)
protected

◆ clearInfo()

void o2::dataformats::MCEventHeader::clearInfo ( )
inline

methods to handle stored information

Definition at line 117 of file MCEventHeader.h.

◆ copyInfoFrom()

void o2::dataformats::MCEventHeader::copyInfoFrom ( MCEventHeader const &  other)
inline

inits info fields from another Event header

Definition at line 154 of file MCEventHeader.h.

◆ extractFileFromKinematics()

void o2::dataformats::MCEventHeader::extractFileFromKinematics ( std::string_view  kinefilename,
std::string_view  targetfilename 
)
static

create a standalone ROOT file/tree with only the MCHeader branch

Definition at line 39 of file MCEventHeader.cxx.

◆ getDetId2HitBitLUT()

std::vector< int > const & o2::dataformats::MCEventHeader::getDetId2HitBitLUT ( ) const
inline

Definition at line 165 of file MCEventHeader.h.

◆ getEmbeddedIndex()

int o2::dataformats::MCEventHeader::getEmbeddedIndex ( ) const
inline

Definition at line 113 of file MCEventHeader.h.

◆ getInfo()

template<typename T >
const T & o2::dataformats::MCEventHeader::getInfo ( std::string const &  key,
bool &  isvalid 
) const
inline

Definition at line 134 of file MCEventHeader.h.

◆ getMCEventStats()

MCEventStats & o2::dataformats::MCEventHeader::getMCEventStats ( )
inline

Definition at line 162 of file MCEventHeader.h.

◆ hasInfo()

bool o2::dataformats::MCEventHeader::hasInfo ( std::string const &  key) const
inline

Definition at line 128 of file MCEventHeader.h.

◆ operator=()

MCEventHeader & o2::dataformats::MCEventHeader::operator= ( const MCEventHeader &  rhs)
default

◆ print()

void o2::dataformats::MCEventHeader::print ( ) const

Definition at line 65 of file MCEventHeader.cxx.

◆ printInfo()

void o2::dataformats::MCEventHeader::printInfo ( ) const
inline

prints a summary of info keys/types attached to this header

Definition at line 148 of file MCEventHeader.h.

◆ putInfo()

template<typename T >
void o2::dataformats::MCEventHeader::putInfo ( std::string const &  key,
T const &  value 
)
inline

Definition at line 123 of file MCEventHeader.h.

◆ Reset()

void o2::dataformats::MCEventHeader::Reset ( )
virtual

methods

reset

Definition at line 28 of file MCEventHeader.cxx.

◆ setDetId2HitBitLUT()

void o2::dataformats::MCEventHeader::setDetId2HitBitLUT ( std::vector< int > const &  v)
inline

Definition at line 164 of file MCEventHeader.h.

◆ setEmbeddingEventIndex()

void o2::dataformats::MCEventHeader::setEmbeddingEventIndex ( Int_t  value)
inline

Definition at line 112 of file MCEventHeader.h.

◆ setEmbeddingFileName()

void o2::dataformats::MCEventHeader::setEmbeddingFileName ( std::string const &  value)
inline

setters

Definition at line 111 of file MCEventHeader.h.

Member Data Documentation

◆ mDetId2HitBitIndex

std::vector<int> o2::dataformats::MCEventHeader::mDetId2HitBitIndex
protected

Definition at line 177 of file MCEventHeader.h.

◆ mEmbeddingEventIndex

Int_t o2::dataformats::MCEventHeader::mEmbeddingEventIndex = 0
protected

Definition at line 172 of file MCEventHeader.h.

◆ mEmbeddingFileName

std::string o2::dataformats::MCEventHeader::mEmbeddingFileName
protected

Definition at line 171 of file MCEventHeader.h.

◆ mEventInfo

o2::utils::RootSerializableKeyValueStore o2::dataformats::MCEventHeader::mEventInfo
protected

Definition at line 178 of file MCEventHeader.h.

◆ mEventStats

MCEventStats o2::dataformats::MCEventHeader::mEventStats {}
protected

Definition at line 176 of file MCEventHeader.h.

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