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

#include <GaudiKernel/EventContext.h>

Collaboration diagram for EventContext:

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)

template<typename T >
auto &	getExtension ()

template<typename T >
const auto &	getExtension () const

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}

::evt_context_detail::any	m_extension

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 31 of file EventContext.h.

Member Typedef Documentation

using EventContext::ContextEvt_t = size_t

Definition at line 34 of file EventContext.h.

using EventContext::ContextID_t = size_t

Definition at line 33 of file EventContext.h.

Constructor & Destructor Documentation

EventContext::EventContext ( )

default

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

inline

Definition at line 41 of file EventContext.h.

       : m_evt_num( e ), m_evt_slot( s ), m_sub_slot( subSlot ) {
     m_valid = ( e != INVALID_CONTEXT_EVT && s != INVALID_CONTEXT_ID );
   }

Member Function Documentation

template<typename ValueType , typename... Args>

auto& EventContext::emplaceExtension ( Args &&... args )

inline

Definition at line 85 of file EventContext.h.

                                            {
 #if __cplusplus >= 201703
     return m_extension.emplace<ValueType>( std::forward<Args>( args )... );
 #else
     return setExtension( ValueType( std::forward<Args>( args )... ) );
 #endif
   }

const EventIDBase& EventContext::eventID ( ) const

inline

Definition at line 52 of file EventContext.h.

52 { return m_eid; }

EventContext::m_eid

EventIDBase m_eid

Definition: EventContext.h:125

ContextEvt_t EventContext::evt ( ) const

inline

Definition at line 47 of file EventContext.h.

47 { return m_evt_num; }

EventContext::m_evt_num

ContextEvt_t m_evt_num

Definition: EventContext.h:126

template<typename T >

auto& EventContext::getExtension ( )

inline

Definition at line 100 of file EventContext.h.

                        {
     return ::evt_context_detail::any_cast<std::decay_t<T>&>( m_extension );
   }

template<typename T >

const auto& EventContext::getExtension ( ) const

inline

Definition at line 105 of file EventContext.h.

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

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

inline

Definition at line 122 of file EventContext.h.

122 { return m_extension.type(); }

EventContext::m_extension

::evt_context_detail::any m_extension

Definition: EventContext.h:131

bool EventContext::hasExtension ( ) const

inline

Definition at line 109 of file EventContext.h.

                             {
 #if __cplusplus >= 201703
     return m_extension.has_value();
 #else
     return !m_extension.empty();
 #endif
   }

template<typename T >

bool EventContext::hasExtension ( ) const

inline

Definition at line 118 of file EventContext.h.

                             {
     return hasExtension() && m_extension.type() == typeid( std::decay_t<T> );
   }

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 54 of file EventContext.h.

                                                              {
     m_valid    = ( e != INVALID_CONTEXT_EVT && s != INVALID_CONTEXT_ID );
     m_evt_num  = e;
     m_evt_slot = s;
     m_sub_slot = subSlot;
   }

void EventContext::setEventID ( const EventIDBase & e )

inline

Definition at line 82 of file EventContext.h.

82 { m_eid = e; }

EventContext::m_eid

EventIDBase m_eid

Definition: EventContext.h:125

void EventContext::setEvt ( const ContextEvt_t e )

inline

Definition at line 62 of file EventContext.h.

                                       {
     if ( e == INVALID_CONTEXT_EVT ) setValid( false );
     m_evt_num = e;
   }

template<typename T >

auto& EventContext::setExtension ( T && t )

inline

Definition at line 94 of file EventContext.h.

                               {
     m_extension = std::forward<T>( t );
     return getExtension<T>();
   }

void EventContext::setSlot ( const ContextID_t s )

inline

Definition at line 67 of file EventContext.h.

                                       {
     if ( s == INVALID_CONTEXT_ID ) setValid( false );
     m_evt_slot = s;
   }

void EventContext::setSubSlot ( const ContextID_t subslot )

inline

Definition at line 72 of file EventContext.h.

72 { m_sub_slot = subslot; }

EventContext::m_sub_slot

ContextID_t m_sub_slot

Definition: EventContext.h:128

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

inline

Definition at line 74 of file EventContext.h.

                                        {
     m_valid = b;
     if ( !m_valid ) {
       m_evt_slot = INVALID_CONTEXT_ID;
       m_evt_num  = INVALID_CONTEXT_EVT;
     }
   }