NAIA  1.0.2
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups
Public Member Functions | Public Attributes | Private Member Functions | Private Attributes | List of all members
NAIA::HeaderData Class Reference

Container class for event Header info. More...

#include <Containers/Header.h>

Inheritance diagram for NAIA::HeaderData:
NAIA::Header

Public Member Functions

bool CheckMask (Category cat) const
 Check if event mask contains the given event category. More...
 
void SetMaskCategory (Category cat)
 Set the event mask (used only internally) More...
 
Category Mask () const
 Get the event Mask. More...
 
void Clear ()
 Clear container content. More...
 
void Dump () const
 Dump on screen container content. More...
 

Public Attributes

unsigned int Run = 0
 The current run. More...
 
unsigned int RunTag = 0
 The current run tag. More...
 
unsigned int EventNo = 0
 The current event number. More...
 
unsigned int UTCTime = 0
 UTC time (in seconds) of current event. More...
 

Private Member Functions

 ClassDef (HeaderData, 1)
 

Private Attributes

Category m_eventMask = Category::None
 

Detailed Description

Container class for event Header info.

This class holds data needed to identify the event and to quickly decide if the event is of interest for analysis or not.

Definition at line 27 of file Header.h.

Member Function Documentation

bool NAIA::HeaderData::CheckMask ( Category  cat) const
inline

Check if event mask contains the given event category.

Parameters
catThe bitmask against which we check the event categories. All bits in cat are required to be set in the event mask.

Definition at line 35 of file Header.h.

References m_eventMask, and NAIA::MatchAllBits().

NAIA::HeaderData::ClassDef ( HeaderData  ,
 
)
private
void NAIA::HeaderData::Clear ( )

Clear container content.

Definition at line 9 of file Header.cpp.

References m_eventMask, and NAIA::None.

Referenced by NAIA::Event::Clear().

void NAIA::HeaderData::Dump ( ) const

Dump on screen container content.

Definition at line 10 of file Header.cpp.

References EventNo, m_eventMask, Run, RunTag, and UTCTime.

Category NAIA::HeaderData::Mask ( ) const
inline

Get the event Mask.

Returns
the event Mask. See NAIA::Category for an explanation of every bit flag

Definition at line 49 of file Header.h.

References m_eventMask.

Referenced by NAIA::Event::CheckMask().

void NAIA::HeaderData::SetMaskCategory ( Category  cat)
inline

Set the event mask (used only internally)

Parameters
catthe event mask

Definition at line 42 of file Header.h.

References m_eventMask.

Referenced by NAIA::Event::SetMaskCategory().

Member Data Documentation

unsigned int NAIA::HeaderData::EventNo = 0

The current event number.

Definition at line 65 of file Header.h.

Referenced by Dump().

Category NAIA::HeaderData::m_eventMask = Category::None
private

Definition at line 73 of file Header.h.

Referenced by CheckMask(), Clear(), Dump(), Mask(), and SetMaskCategory().

unsigned int NAIA::HeaderData::Run = 0

The current run.

Definition at line 63 of file Header.h.

Referenced by Dump(), NAIA::NAIAChain::GetEventFileInfo(), and NAIA::NAIAChain::GetEventMCFileInfo().

unsigned int NAIA::HeaderData::RunTag = 0

The current run tag.

Definition at line 64 of file Header.h.

Referenced by Dump().

unsigned int NAIA::HeaderData::UTCTime = 0

UTC time (in seconds) of current event.

Definition at line 66 of file Header.h.

Referenced by Dump(), and NAIA::NAIAChain::GetEventRTIInfo().


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