The Gaudi Framework  master (e68eea06)
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Static Public Attributes | Private Attributes | Friends | List of all members
EventContext Class Reference

This class represents an entry point to all the event specific data. More...

#include <GaudiKernel/EventContext.h>

Collaboration diagram for EventContext:
Collaboration graph
[legend]

Public Types

using ContextID_t = size_t
 
using ContextEvt_t = size_t
 

Public Member Functions

 EventContext ()=default
 
 EventContext (const ContextEvt_t e, const ContextID_t s=INVALID_CONTEXT_ID, const ContextID_t subSlot=INVALID_CONTEXT_ID)
 
ContextEvt_t evt () const
 
ContextID_t slot () const
 
ContextID_t subSlot () const
 
bool usesSubSlot () const
 
bool valid () const
 
const EventIDBase & eventID () const
 
void set (const ContextEvt_t e=0, const ContextID_t s=INVALID_CONTEXT_ID, const ContextID_t subSlot=INVALID_CONTEXT_ID)
 
void setEvt (const ContextEvt_t e)
 
void setSlot (const ContextID_t s)
 
void setSubSlot (const ContextID_t subslot)
 
void setValid (const bool b=true)
 
void setEventID (const EventIDBase &e)
 
template<typename ValueType, typename... Args>
auto & emplaceExtension (Args &&... args)
 
template<typename T>
auto & setExtension (T &&t)
 
void resetExtension ()
 
std::any detachExtension ()
 
template<typename T>
auto & getExtension ()
 
template<typename T>
const auto & getExtension () const
 
template<typename T>
T * tryGetExtension () noexcept
 
template<typename T>
const T * tryGetExtension () const noexcept
 
bool hasExtension () const
 
template<typename T>
bool hasExtension () const
 
const std::type_info & getExtensionType () const
 

Static Public Attributes

static constexpr ContextID_t INVALID_CONTEXT_ID = std::numeric_limits<ContextID_t>::max()
 
static constexpr ContextEvt_t INVALID_CONTEXT_EVT = std::numeric_limits<ContextEvt_t>::max()
 

Private Attributes

EventIDBase m_eid {}
 
ContextEvt_t m_evt_num { INVALID_CONTEXT_EVT }
 
ContextID_t m_evt_slot { INVALID_CONTEXT_ID }
 
ContextID_t m_sub_slot { INVALID_CONTEXT_ID }
 
bool m_valid { false }
 
std::any m_extension
 

Friends

std::ostream & operator<< (std::ostream &os, const EventContext &ctx)
 
std::ostream & operator<< (std::ostream &os, const EventContext *ctx)
 

Detailed Description

This class represents an entry point to all the event specific data.

It is needed to make the algorithm "aware" of the event it is operating on. This was not needed in the serial version of Gaudi where the assumption of 1-event-at-the-time processing was implicit.

This class has nothing to do with the AlgContextSvc or the Context of the EvtSelector!

Author
Danilo Piparo, Charles Leggett
Date
2012

Definition at line 35 of file EventContext.h.

Member Typedef Documentation

◆ ContextEvt_t

using EventContext::ContextEvt_t = size_t

Definition at line 38 of file EventContext.h.

◆ ContextID_t

using EventContext::ContextID_t = size_t

Definition at line 37 of file EventContext.h.

Constructor & Destructor Documentation

◆ EventContext() [1/2]

EventContext::EventContext ( )
default

◆ EventContext() [2/2]

EventContext::EventContext ( const ContextEvt_t e,
const ContextID_t s = INVALID_CONTEXT_ID,
const ContextID_t subSlot = INVALID_CONTEXT_ID )
inlineexplicit

Definition at line 45 of file EventContext.h.

47 : m_evt_num( e ), m_evt_slot( s ), m_sub_slot( subSlot ) {
48 m_valid = ( e != INVALID_CONTEXT_EVT && s != INVALID_CONTEXT_ID );
49 }
EventContext::subSlot
ContextID_t subSlot() const
Definition EventContext.h:53
EventContext::m_sub_slot
ContextID_t m_sub_slot
Definition EventContext.h:139
EventContext::m_evt_slot
ContextID_t m_evt_slot
Definition EventContext.h:138
EventContext::INVALID_CONTEXT_EVT
static constexpr ContextEvt_t INVALID_CONTEXT_EVT
Definition EventContext.h:41
EventContext::m_evt_num
ContextEvt_t m_evt_num
Definition EventContext.h:137
EventContext::INVALID_CONTEXT_ID
static constexpr ContextID_t INVALID_CONTEXT_ID
Definition EventContext.h:40

Member Function Documentation

◆ detachExtension()

std::any EventContext::detachExtension ( )
inline

Definition at line 101 of file EventContext.h.

101{ return std::move( m_extension ); }
EventContext::m_extension
std::any m_extension
Definition EventContext.h:142

◆ emplaceExtension()

template<typename ValueType, typename... Args>
auto & EventContext::emplaceExtension ( Args &&... args)
inline

Definition at line 89 of file EventContext.h.

89 {
90 return m_extension.emplace<ValueType>( std::forward<Args>( args )... );
91 }

◆ eventID()

const EventIDBase & EventContext::eventID ( ) const
inline

Definition at line 56 of file EventContext.h.

56{ return m_eid; }
EventContext::m_eid
EventIDBase m_eid
Definition EventContext.h:136

◆ evt()

ContextEvt_t EventContext::evt ( ) const
inline

Definition at line 51 of file EventContext.h.

51{ return m_evt_num; }

◆ getExtension() [1/2]

template<typename T>
auto & EventContext::getExtension ( )
inline

Definition at line 104 of file EventContext.h.

104 {
105 return std::any_cast<std::decay_t<T>&>( m_extension );
106 }

◆ getExtension() [2/2]

template<typename T>
const auto & EventContext::getExtension ( ) const
inline

Definition at line 109 of file EventContext.h.

109 {
110 return std::any_cast<std::decay_t<T> const&>( m_extension );
111 }

◆ getExtensionType()

const std::type_info & EventContext::getExtensionType ( ) const
inline

Definition at line 130 of file EventContext.h.

130{ return m_extension.type(); }

◆ hasExtension() [1/2]

bool EventContext::hasExtension ( ) const
inline

Definition at line 123 of file EventContext.h.

123{ return m_extension.has_value(); }

◆ hasExtension() [2/2]

template<typename T>
bool EventContext::hasExtension ( ) const
inline

Definition at line 126 of file EventContext.h.

126 {
127 return hasExtension() && m_extension.type() == typeid( std::decay_t<T> );
128 }
EventContext::hasExtension
bool hasExtension() const
Definition EventContext.h:123

◆ resetExtension()

void EventContext::resetExtension ( )
inline

Definition at line 99 of file EventContext.h.

99{ m_extension.reset(); }

◆ set()

void EventContext::set ( const ContextEvt_t e = 0,
const ContextID_t s = INVALID_CONTEXT_ID,
const ContextID_t subSlot = INVALID_CONTEXT_ID )
inline

Definition at line 58 of file EventContext.h.

59 {
60 m_valid = ( e != INVALID_CONTEXT_EVT && s != INVALID_CONTEXT_ID );
61 m_evt_num = e;
62 m_evt_slot = s;
63 m_sub_slot = subSlot;
64 }

◆ setEventID()

void EventContext::setEventID ( const EventIDBase & e)
inline

Definition at line 86 of file EventContext.h.

86{ m_eid = e; }

◆ setEvt()

void EventContext::setEvt ( const ContextEvt_t e)
inline

Definition at line 66 of file EventContext.h.

66 {
67 if ( e == INVALID_CONTEXT_EVT ) setValid( false );
68 m_evt_num = e;
69 }
EventContext::setValid
void setValid(const bool b=true)
Definition EventContext.h:78

◆ setExtension()

template<typename T>
auto & EventContext::setExtension ( T && t)
inline

Definition at line 94 of file EventContext.h.

94 {
95 m_extension = std::forward<T>( t );
96 return getExtension<T>();
97 }
EventContext::getExtension
auto & getExtension()
Definition EventContext.h:104

◆ setSlot()

void EventContext::setSlot ( const ContextID_t s)
inline

Definition at line 71 of file EventContext.h.

71 {
72 if ( s == INVALID_CONTEXT_ID ) setValid( false );
73 m_evt_slot = s;
74 }

◆ setSubSlot()

void EventContext::setSubSlot ( const ContextID_t subslot)
inline

Definition at line 76 of file EventContext.h.

76{ m_sub_slot = subslot; }

◆ setValid()

void EventContext::setValid ( const bool b = true)
inline

Definition at line 78 of file EventContext.h.

78 {
79 m_valid = b;
80 if ( !m_valid ) {
81 m_evt_slot = INVALID_CONTEXT_ID;
82 m_evt_num = INVALID_CONTEXT_EVT;
83 }
84 }

◆ slot()

ContextID_t EventContext::slot ( ) const
inline

Definition at line 52 of file EventContext.h.

52{ return m_evt_slot; }

◆ subSlot()

ContextID_t EventContext::subSlot ( ) const
inline

Definition at line 53 of file EventContext.h.

53{ return m_sub_slot; }

◆ tryGetExtension() [1/2]

template<typename T>
const T * EventContext::tryGetExtension ( ) const
inlinenoexcept

Definition at line 119 of file EventContext.h.

119 {
120 return std::any_cast<T>( &m_extension );
121 }

◆ tryGetExtension() [2/2]

template<typename T>
T * EventContext::tryGetExtension ( )
inlinenoexcept

Definition at line 114 of file EventContext.h.

114 {
115 return std::any_cast<T>( &m_extension );
116 }

◆ usesSubSlot()

bool EventContext::usesSubSlot ( ) const
inline

Definition at line 54 of file EventContext.h.

54{ return m_sub_slot != INVALID_CONTEXT_ID; }

◆ valid()

bool EventContext::valid ( ) const
inline

Definition at line 55 of file EventContext.h.

55{ return m_valid; }

Friends And Related Symbol Documentation

◆ operator<< [1/2]

std::ostream & operator<< ( std::ostream & os,
const EventContext & ctx )
friend

Definition at line 13 of file EventContext.cpp.

13{ return os << std::format( "{}", ctx ); }

◆ operator<< [2/2]

std::ostream & operator<< ( std::ostream & os,
const EventContext * ctx )
friend

Definition at line 15 of file EventContext.cpp.

15 {
16 if ( c ) { return os << std::format( "{}", *c ); }
17 return os << "INVALID";
18}

Member Data Documentation

◆ INVALID_CONTEXT_EVT

ContextEvt_t EventContext::INVALID_CONTEXT_EVT = std::numeric_limits<ContextEvt_t>::max()
staticconstexpr

Definition at line 41 of file EventContext.h.

◆ INVALID_CONTEXT_ID

ContextID_t EventContext::INVALID_CONTEXT_ID = std::numeric_limits<ContextID_t>::max()
staticconstexpr

Definition at line 40 of file EventContext.h.

◆ m_eid

EventIDBase EventContext::m_eid {}
private

Definition at line 136 of file EventContext.h.

136{};

◆ m_evt_num

ContextEvt_t EventContext::m_evt_num { INVALID_CONTEXT_EVT }
private

Definition at line 137 of file EventContext.h.

137{ INVALID_CONTEXT_EVT };

◆ m_evt_slot

ContextID_t EventContext::m_evt_slot { INVALID_CONTEXT_ID }
private

Definition at line 138 of file EventContext.h.

138{ INVALID_CONTEXT_ID };

◆ m_extension

std::any EventContext::m_extension
private

Definition at line 142 of file EventContext.h.

◆ m_sub_slot

ContextID_t EventContext::m_sub_slot { INVALID_CONTEXT_ID }
private

Definition at line 139 of file EventContext.h.

139{ INVALID_CONTEXT_ID };

◆ m_valid

bool EventContext::m_valid { false }
private

Definition at line 140 of file EventContext.h.

140{ false };
The documentation for this class was generated from the following file: