AlgsExecutionStates Class Reference

The AlgsExecutionStates encodes the state machine for the execution of algorithms within a single event. More...

#include <GaudiKernel/AlgsExecutionStates.h>

Collaboration diagram for AlgsExecutionStates:

Classes
class	Iterator

Public Types
enum	State : uint8_t {   INITIAL = 0, CONTROLREADY = 1, DATAREADY = 2, SCHEDULED = 3,   EVTACCEPTED = 4, EVTREJECTED = 5, ERROR = 6 }
	Execution states of the algorithms. More...

Public Member Functions
	AlgsExecutionStates (unsigned int algsNumber, SmartIF< IMessageSvc > MS)
StatusCode	updateState (unsigned int iAlgo, State newState)
void	reset ()
bool	algsPresent (State state) const
bool	allAlgsExecuted ()
const State &	operator[] (unsigned int i) const
size_t	size () const
size_t	sizeOfSubset (State state) const
Iterator	begin (State kind)
Iterator	end (State kind)

Static Public Attributes
static std::map< State, std::string >	stateNames

Private Member Functions
MsgStream	log ()

Private Attributes
std::vector< State >	m_states
SmartIF< IMessageSvc >	m_MS

Detailed Description

The AlgsExecutionStates encodes the state machine for the execution of algorithms within a single event.

It is used by the concurrent schedulers

Author

Benedikt Hegner

Danilo Piparo

Version

1.0

Definition at line 27 of file AlgsExecutionStates.h.

Member Enumeration Documentation

enum AlgsExecutionStates::State : uint8_t

Execution states of the algorithms.

Enumerator
INITIAL
CONTROLREADY
DATAREADY
SCHEDULED
EVTACCEPTED
EVTREJECTED
ERROR

Definition at line 31 of file AlgsExecutionStates.h.

             : uint8_t {
    INITIAL      = 0,
    CONTROLREADY = 1,
    DATAREADY    = 2,
    SCHEDULED    = 3,
    EVTACCEPTED  = 4,
    EVTREJECTED  = 5,
    ERROR        = 6
  };

Constructor & Destructor Documentation

AlgsExecutionStates::AlgsExecutionStates ( unsigned int  algsNumber, SmartIF< IMessageSvc >  MS  )

inline

Definition at line 43 of file AlgsExecutionStates.h.

      : m_states( algsNumber, INITIAL ), m_MS( std::move( MS ) ){};

Member Function Documentation

bool AlgsExecutionStates::algsPresent ( State  state ) const

inline

Definition at line 50 of file AlgsExecutionStates.h.

  {
    return std::find( m_states.begin(), m_states.end(), state ) != m_states.end();
  }

bool AlgsExecutionStates::allAlgsExecuted ( )

inline

Definition at line 55 of file AlgsExecutionStates.h.

  {
    return std::all_of( m_states.begin(), m_states.end(),
                        []( State s ) { return s == EVTACCEPTED || s == EVTREJECTED; } );
  };

Iterator AlgsExecutionStates::begin ( State  kind )

inline

Definition at line 110 of file AlgsExecutionStates.h.

{ return {kind, m_states, m_states.begin()}; }

Iterator AlgsExecutionStates::end ( State  kind )

inline

Definition at line 111 of file AlgsExecutionStates.h.

{ return {kind, m_states, m_states.end()}; }

MsgStream AlgsExecutionStates::log ( )

inlineprivate

Definition at line 74 of file AlgsExecutionStates.h.

{ return {m_MS, "AlgsExecutionStates"}; }

const State& AlgsExecutionStates::operator[] ( unsigned int  i ) const

inline

Definition at line 61 of file AlgsExecutionStates.h.

{ return m_states.at( i ); };

void AlgsExecutionStates::reset ( )

inline

Definition at line 48 of file AlgsExecutionStates.h.

{ std::fill( m_states.begin(), m_states.end(), INITIAL ); };

size_t AlgsExecutionStates::size ( ) const

inline

Definition at line 63 of file AlgsExecutionStates.h.

{ return m_states.size(); }

size_t AlgsExecutionStates::sizeOfSubset ( State  state ) const

inline

Definition at line 65 of file AlgsExecutionStates.h.

  {
    return std::count_if( m_states.begin(), m_states.end(), [&]( State s ) { return s == state; } );
  }

StatusCode AlgsExecutionStates::updateState	(	unsigned int	iAlgo,
		State	newState
	)

Definition at line 18 of file AlgsExecutionStates.cpp.

{
  if ( iAlgo >= m_states.size() ) {
    log() << MSG::ERROR << "Index out of bound (" << iAlgo << " / " << m_states.size() << ")" << endmsg;
    return StatusCode::FAILURE;
  }

  switch ( transition( m_states[iAlgo], newState ) ) {
  case transition( INITIAL, CONTROLREADY ):   // Fallthrough
  case transition( CONTROLREADY, DATAREADY ): // Fallthrough
  case transition( DATAREADY, SCHEDULED ):    // Fallthrough
  case transition( SCHEDULED, EVTACCEPTED ):  // Fallthrough
  case transition( SCHEDULED, EVTREJECTED ):
    m_states[iAlgo] = newState;
    return StatusCode::SUCCESS;
  default:
    log() << MSG::ERROR << "[AlgIndex " << iAlgo << "] Transition from " << stateNames.at( m_states[iAlgo] ) << " to "
          << stateNames.at( newState ) << " is not allowed" << endmsg;
    m_states[iAlgo] = ERROR;
    return StatusCode::FAILURE;
  }
}

Member Data Documentation

SmartIF<IMessageSvc> AlgsExecutionStates::m_MS

private

Definition at line 72 of file AlgsExecutionStates.h.

std::vector<State> AlgsExecutionStates::m_states

private

Definition at line 71 of file AlgsExecutionStates.h.

std::map< AlgsExecutionStates::State, std::string > AlgsExecutionStates::stateNames

static

Initial value:

= {
    {INITIAL, "INITIAL"},         {CONTROLREADY, "CONTROLREADY"}, {DATAREADY, "DATAREADY"}, {SCHEDULED, "SCHEDULED"},
    {EVTACCEPTED, "EVTACCEPTED"}, {EVTREJECTED, "EVTREJECTED"},   {ERROR, "ERROR"}}

Definition at line 41 of file AlgsExecutionStates.h.

---

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

• GaudiHive/src/AlgsExecutionStates.h
• GaudiHive/src/AlgsExecutionStates.cpp