AlgsExecutionStates Class Reference

#include <GaudiKernel/AlgsExecutionStates.h>

Collaboration diagram for AlgsExecutionStates:

Classes
class	Iterator

Public Types
enum	State : uint8_t {   INITIAL = 0, CONTROLREADY = 1, DATAREADY = 2, RESOURCELESS = 3,   SCHEDULED = 4, EVTACCEPTED = 5, EVTREJECTED = 6, ERROR = 7,   MAXVALUE = 8 }
	Execution states of the algorithms Must have contiguous integer values 0, 1... More...

Public Member Functions
	AlgsExecutionStates (unsigned int algsNumber, SmartIF< IMessageSvc > MS)
StatusCode	set (unsigned int iAlgo, State newState)
void	reset ()
bool	contains (State state) const
	check if the collection contains at least one state of requested type More...
bool	containsAny (std::initializer_list< State > l) const
	check if the collection contains at least one state of any listed types More...
bool	containsOnly (std::initializer_list< State > l) const
	check if the collection contains only states of listed types More...
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)

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 36 of file AlgsExecutionStates.h.

Member Enumeration Documentation

State

enum AlgsExecutionStates::State : uint8_t

Execution states of the algorithms Must have contiguous integer values 0, 1...

N

Enumerator
INITIAL
CONTROLREADY
DATAREADY
RESOURCELESS
SCHEDULED
EVTACCEPTED
EVTREJECTED
ERROR
MAXVALUE

Definition at line 40 of file AlgsExecutionStates.h.

             : uint8_t {
    INITIAL      = 0,
    CONTROLREADY = 1,
    DATAREADY    = 2,
    RESOURCELESS = 3,
    SCHEDULED    = 4,
    EVTACCEPTED  = 5,
    EVTREJECTED  = 6,
    ERROR        = 7,
    MAXVALUE     = 8 // Allows loop over all states
  };

Constructor & Destructor Documentation

AlgsExecutionStates()

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

inline

Definition at line 52 of file AlgsExecutionStates.h.

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

Member Function Documentation

begin()

Iterator AlgsExecutionStates::begin ( State  kind )

inline

Definition at line 116 of file AlgsExecutionStates.h.

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

contains()

bool AlgsExecutionStates::contains ( State  state ) const

inline

check if the collection contains at least one state of requested type

Definition at line 60 of file AlgsExecutionStates.h.

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

containsAny()

bool AlgsExecutionStates::containsAny ( std::initializer_list< State >  l ) const

inline

check if the collection contains at least one state of any listed types

Definition at line 63 of file AlgsExecutionStates.h.

                                                         {
    return std::find_first_of( m_states.begin(), m_states.end(), l.begin(), l.end() ) != m_states.end();
  }

containsOnly()

bool AlgsExecutionStates::containsOnly ( std::initializer_list< State >  l ) const

inline

check if the collection contains only states of listed types

Definition at line 68 of file AlgsExecutionStates.h.

                                                          {
    return std::all_of( m_states.begin(), m_states.end(),
                        [l]( State s ) { return std::find( l.begin(), l.end(), s ) != l.end(); } );
  };

end()

Iterator AlgsExecutionStates::end ( State  kind )

inline

Definition at line 117 of file AlgsExecutionStates.h.

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

log()

MsgStream AlgsExecutionStates::log ( )

inlineprivate

Definition at line 85 of file AlgsExecutionStates.h.

{ return {m_MS, "AlgsExecutionStates"}; }

operator[]()

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

inline

Definition at line 73 of file AlgsExecutionStates.h.

{ return m_states.at( i ); };

reset()

void AlgsExecutionStates::reset ( )

inline

Definition at line 57 of file AlgsExecutionStates.h.

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

set()

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

Definition at line 23 of file AlgsExecutionStates.cpp.

                                                                        {
  if ( iAlgo >= m_states.size() ) {
    log() << MSG::ERROR << "Index out of bound (" << iAlgo << " / " << m_states.size() << ")" << endmsg;
    return StatusCode::FAILURE;
  }
 
  // Allow cycling of a single state
  if ( m_states[iAlgo] == newState ) return StatusCode::SUCCESS;
 
  switch ( transition( m_states[iAlgo], newState ) ) {
  case transition( INITIAL, CONTROLREADY ):
    [[fallthrough]];
  case transition( CONTROLREADY, DATAREADY ):
    [[fallthrough]];
  case transition( DATAREADY, SCHEDULED ):
    [[fallthrough]];
  case transition( DATAREADY, RESOURCELESS ):
    [[fallthrough]];
  case transition( RESOURCELESS, SCHEDULED ):
    [[fallthrough]];
  case transition( SCHEDULED, ERROR ):
    [[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 " << m_states[iAlgo] << " to " << newState
          << " is not allowed" << endmsg;
    m_states[iAlgo] = ERROR;
    return StatusCode::FAILURE;
  }
}

size()

size_t AlgsExecutionStates::size ( ) const

inline

Definition at line 75 of file AlgsExecutionStates.h.

{ return m_states.size(); }

sizeOfSubset()

size_t AlgsExecutionStates::sizeOfSubset ( State  state ) const

inline

Definition at line 77 of file AlgsExecutionStates.h.

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

Member Data Documentation

m_MS

SmartIF<IMessageSvc> AlgsExecutionStates::m_MS

private

Definition at line 83 of file AlgsExecutionStates.h.

m_states

std::vector<State> AlgsExecutionStates::m_states

private

Definition at line 82 of file AlgsExecutionStates.h.

---

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

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