AlgExecStateRef Class Reference

wrapper on an Algorithm state. More...

#include </builds/gaudi/Gaudi/GaudiKernel/include/GaudiKernel/IAlgExecStateSvc.h>

Collaboration diagram for AlgExecStateRef:

Public Types
enum struct	AlgKey : size_t
using	State = AlgExecState::State

Public Member Functions
	AlgExecStateRef (IAlgExecStateSvc &svc, const EventContext &ctx, AlgKey algKey)
bool	filterPassed () const
void	setFilterPassed (bool f=true)
State	state () const
void	setState (State s)
void	setState (State s, const StatusCode &sc)
const StatusCode &	execStatus () const
void	setExecStatus (const StatusCode &sc=StatusCode::SUCCESS)
void	reset ()

Private Attributes
IAlgExecStateSvc &	m_svc
const EventContext &	m_ctx
AlgKey	m_algKey

Friends
std::ostream &	operator<< (std::ostream &ost, const AlgExecStateRef &s)

Detailed Description

wrapper on an Algorithm state.

Practically a reference to the IAlgExecStateSvc, an EventContext and a size_t identifying the algorithm involved It forwards all calls to the equivalent API of the IAlgExecStateSvc

Definition at line 32 of file IAlgExecStateSvc.h.

Member Typedef Documentation

State

using AlgExecStateRef::State = AlgExecState::State

Definition at line 34 of file IAlgExecStateSvc.h.

Member Enumeration Documentation

AlgKey

enum struct AlgExecStateRef::AlgKey : size_t

strong

Definition at line 35 of file IAlgExecStateSvc.h.

: size_t {};

Constructor & Destructor Documentation

AlgExecStateRef()

AlgExecStateRef::AlgExecStateRef ( IAlgExecStateSvc & svc, const EventContext & ctx, AlgKey algKey )

inline

Definition at line 36 of file IAlgExecStateSvc.h.

      : m_svc{ svc }, m_ctx{ ctx }, m_algKey{ algKey } {}

Member Function Documentation

execStatus()

const StatusCode & AlgExecStateRef::execStatus ( ) const

inline

Definition at line 155 of file IAlgExecStateSvc.h.

{ return m_svc.execStatus( m_ctx, m_algKey ); }

filterPassed()

bool AlgExecStateRef::filterPassed ( ) const

inline

Definition at line 148 of file IAlgExecStateSvc.h.

{ return m_svc.filterPassed( m_ctx, m_algKey ); }

reset()

void AlgExecStateRef::reset ( )

inline

Definition at line 157 of file IAlgExecStateSvc.h.

{ m_svc.reset( m_ctx ); }

setExecStatus()

void AlgExecStateRef::setExecStatus ( const StatusCode & sc = StatusCode::SUCCESS )

inline

Definition at line 156 of file IAlgExecStateSvc.h.

{ m_svc.setExecStatus( m_ctx, m_algKey, sc ); }

setFilterPassed()

void AlgExecStateRef::setFilterPassed ( bool f = true )

inline

Definition at line 149 of file IAlgExecStateSvc.h.

{ m_svc.setFilterPassed( m_ctx, m_algKey, f ); }

setState() [1/2]

void AlgExecStateRef::setState ( AlgExecStateRef::State s )

inline

Definition at line 151 of file IAlgExecStateSvc.h.

{ m_svc.setState( m_ctx, m_algKey, s ); }

setState() [2/2]

void AlgExecStateRef::setState ( AlgExecStateRef::State s, const StatusCode & sc )

inline

Definition at line 152 of file IAlgExecStateSvc.h.

                                                                                    {
  m_svc.setState( m_ctx, m_algKey, s, sc );
}

state()

AlgExecStateRef::State AlgExecStateRef::state ( ) const

inline

Definition at line 150 of file IAlgExecStateSvc.h.

{ return m_svc.state( m_ctx, m_algKey ); }

Friends And Related Symbol Documentation

operator<<

std::ostream & operator<< ( std::ostream & ost, const AlgExecStateRef & s )

friend

Definition at line 158 of file IAlgExecStateSvc.h.

                                                                           {
  s.m_svc.dump( ost, s.m_ctx, s.m_algKey );
  return ost;
}

Member Data Documentation

m_algKey

AlgKey AlgExecStateRef::m_algKey

private

Definition at line 52 of file IAlgExecStateSvc.h.

m_ctx

const EventContext& AlgExecStateRef::m_ctx

private

Definition at line 51 of file IAlgExecStateSvc.h.

m_svc

IAlgExecStateSvc& AlgExecStateRef::m_svc

private

Definition at line 50 of file IAlgExecStateSvc.h.

---

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

• GaudiKernel/include/GaudiKernel/IAlgExecStateSvc.h