The Gaudi Framework  master (37c0b60a)
AlgExecState Class Reference

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

Collaboration diagram for AlgExecState:

Public Types

enum  State { None = 0, Executing = 1, Done = 2 }
 

Public Member Functions

bool filterPassed () const
 
State state () const
 
const StatusCodeexecStatus () const
 
void setFilterPassed (bool f=true)
 
void setState (State s)
 
void setState (State s, const StatusCode &sc)
 
void setExecStatus (const StatusCode &sc=StatusCode::SUCCESS)
 
void reset ()
 

Private Attributes

bool m_filterPassed { true }
 
State m_state { State::None }
 
StatusCode m_execStatus { StatusCode::FAILURE }
 

Friends

std::ostreamoperator<< (std::ostream &ost, const AlgExecState &s)
 

Detailed Description

Definition at line 36 of file IAlgExecStateSvc.h.

Member Enumeration Documentation

◆ State

Enumerator
None 
Executing 
Done 

Definition at line 38 of file IAlgExecStateSvc.h.

38 { None = 0, Executing = 1, Done = 2 };

Member Function Documentation

◆ execStatus()

const StatusCode& AlgExecState::execStatus ( ) const
inline

Definition at line 42 of file IAlgExecStateSvc.h.

42 { return m_execStatus; }

◆ filterPassed()

bool AlgExecState::filterPassed ( ) const
inline

Definition at line 40 of file IAlgExecStateSvc.h.

40 { return m_filterPassed; }

◆ reset()

void AlgExecState::reset ( )
inline

Definition at line 51 of file IAlgExecStateSvc.h.

51 { *this = AlgExecState{}; }

◆ setExecStatus()

void AlgExecState::setExecStatus ( const StatusCode sc = StatusCode::SUCCESS)
inline

Definition at line 50 of file IAlgExecStateSvc.h.

50 { m_execStatus = sc; }

◆ setFilterPassed()

void AlgExecState::setFilterPassed ( bool  f = true)
inline

Definition at line 44 of file IAlgExecStateSvc.h.

44 { m_filterPassed = f; }

◆ setState() [1/2]

void AlgExecState::setState ( State  s)
inline

Definition at line 45 of file IAlgExecStateSvc.h.

45 { m_state = s; }

◆ setState() [2/2]

void AlgExecState::setState ( State  s,
const StatusCode sc 
)
inline

Definition at line 46 of file IAlgExecStateSvc.h.

46  {
47  m_state = s;
48  m_execStatus = sc;
49  }

◆ state()

State AlgExecState::state ( ) const
inline

Definition at line 41 of file IAlgExecStateSvc.h.

41 { return m_state; }

Friends And Related Function Documentation

◆ operator<<

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

Definition at line 53 of file IAlgExecStateSvc.h.

53  {
54  ost << "e: ";
55  switch ( s.state() ) {
56  case AlgExecState::State::None:
57  return ost << "n";
58  case AlgExecState::State::Executing:
59  return ost << "e";
60  default:
61  return ost << "d f: " << s.filterPassed() << " sc: " << s.execStatus();
62  }
63  }

Member Data Documentation

◆ m_execStatus

StatusCode AlgExecState::m_execStatus { StatusCode::FAILURE }
private

Definition at line 68 of file IAlgExecStateSvc.h.

◆ m_filterPassed

bool AlgExecState::m_filterPassed { true }
private

Definition at line 66 of file IAlgExecStateSvc.h.

◆ m_state

State AlgExecState::m_state { State::None }
private

Definition at line 67 of file IAlgExecStateSvc.h.


The documentation for this class was generated from the following file:
gaudirun.s
string s
Definition: gaudirun.py:346
AlgExecState::m_state
State m_state
Definition: IAlgExecStateSvc.h:67
AlgExecState::Done
@ Done
Definition: IAlgExecStateSvc.h:38
AlgExecState::m_filterPassed
bool m_filterPassed
Definition: IAlgExecStateSvc.h:66
AlgExecState::Executing
@ Executing
Definition: IAlgExecStateSvc.h:38
AlgExecState::None
@ None
Definition: IAlgExecStateSvc.h:38
AlgExecState::m_execStatus
StatusCode m_execStatus
Definition: IAlgExecStateSvc.h:68
AlgExecState
Definition: IAlgExecStateSvc.h:36