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 : unsigned short {   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)
	~AlgsExecutionStates ()
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 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 28 of file AlgsExecutionStates.h.

Member Enumeration Documentation

enum AlgsExecutionStates::State : unsigned short

Execution states of the algorithms.

Enumerator
INITIAL
CONTROLREADY
DATAREADY
SCHEDULED
EVTACCEPTED
EVTREJECTED
ERROR

Definition at line 32 of file AlgsExecutionStates.h.

               : unsigned short {
        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 44 of file AlgsExecutionStates.h.

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

AlgsExecutionStates::~AlgsExecutionStates ( )

inline

Definition at line 48 of file AlgsExecutionStates.h.

{};

Member Function Documentation

bool AlgsExecutionStates::algsPresent ( State  state ) const

inline

Definition at line 54 of file AlgsExecutionStates.h.

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

bool AlgsExecutionStates::allAlgsExecuted ( )

inline

Definition at line 58 of file AlgsExecutionStates.h.

                          {
        int execAlgos=std::count_if(m_states.begin(),m_states.end(),[](State s) {return (s == EVTACCEPTED || s== EVTREJECTED);});
        return m_states.size() == (unsigned int)execAlgos;
    };

Iterator AlgsExecutionStates::begin ( State  kind )

inline

Definition at line 135 of file AlgsExecutionStates.h.

    {
        return(Iterator(Iterator::POS::BEGIN, kind, m_states));
    }

Iterator AlgsExecutionStates::end ( State  kind )

inline

Definition at line 140 of file AlgsExecutionStates.h.

    {
        return(Iterator(Iterator::POS::END, kind, m_states));
    }

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

inline

Definition at line 63 of file AlgsExecutionStates.h.

                                                   {

        return m_states.at(i);

    };

void AlgsExecutionStates::reset ( )

inline

Definition at line 52 of file AlgsExecutionStates.h.

{m_states.assign(m_states.size(),INITIAL);};

size_t AlgsExecutionStates::size ( ) const

inline

Definition at line 69 of file AlgsExecutionStates.h.

                        {
        return m_states.size();
    }

size_t AlgsExecutionStates::sizeOfSubset ( State  state ) const

inline

Definition at line 73 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 14 of file AlgsExecutionStates.cpp.

                                                                             {

    MsgStream log(m_MS, "AlgExecutionStates");
    const unsigned int states_size = m_states.size();

    if (iAlgo>=states_size){
        log << MSG::ERROR  << "Index out of bound ("
                << iAlgo << " and the size of the states vector is "
                << states_size << ")" << endmsg;

        return StatusCode::FAILURE;
    }

    switch (newState) {
    case INITIAL:
        log << MSG::ERROR  << "[AlgIndex " << iAlgo <<"] Transition to INITIAL is not defined.";
        return StatusCode::FAILURE;
        //
    case CONTROLREADY:
        if (m_states[iAlgo]!=INITIAL){
            log << MSG::ERROR  << "[AlgIndex " << iAlgo <<"] Transition to CONTROLREADY possible only from INITIAL state! The state is " << m_states[iAlgo] << endmsg;
            return StatusCode::FAILURE;
        } else {
            m_states[iAlgo]=CONTROLREADY;
            return StatusCode::SUCCESS;
        }
        //
    case DATAREADY:
        if (m_states[iAlgo]!=CONTROLREADY){
            log << MSG::ERROR   << "[AlgIndex " << iAlgo <<"] Transition to DATAREADY possible only from CONTROLREADY state!The state is " << m_states[iAlgo] << endmsg;
            return StatusCode::FAILURE;
        } else {
            m_states[iAlgo]=DATAREADY;
            return StatusCode::SUCCESS;
        }
    case SCHEDULED:
        if (m_states[iAlgo]!=DATAREADY){
            log << MSG::ERROR   << "[AlgIndex " << iAlgo <<"] Transition to SCHEDULED possible only from DATAREADY state! The state is " << m_states[iAlgo] << endmsg;
            return StatusCode::FAILURE;
        } else {
            m_states[iAlgo]=SCHEDULED;
            return StatusCode::SUCCESS;
        }
        //
    case EVTACCEPTED:
        if (m_states[iAlgo]!=SCHEDULED){
            log << MSG::ERROR   << "[AlgIndex " << iAlgo <<"] Transition to EVTACCEPTED possible only from SCHEDULED state! The state is " << m_states[iAlgo] << endmsg;
            return StatusCode::FAILURE;
        } else {
            m_states[iAlgo]=EVTACCEPTED;
            return StatusCode::SUCCESS;
        }
        //
    case EVTREJECTED:
        if (m_states[iAlgo]!=SCHEDULED){
            log << MSG::ERROR   << "[AlgIndex " << iAlgo <<"] Transition to EVTREJECT possible only from SCHEDULED state! The state is " << m_states[iAlgo] << endmsg;
            return StatusCode::FAILURE;
        } else {
            m_states[iAlgo]=EVTREJECTED;
            return StatusCode::SUCCESS;
        }
    default:
        //
        m_states[iAlgo]=ERROR;
        return StatusCode::SUCCESS;
    }

    return StatusCode::FAILURE;
}

Member Data Documentation

SmartIF<IMessageSvc> AlgsExecutionStates::m_MS

private

Definition at line 79 of file AlgsExecutionStates.h.

std::vector<State> AlgsExecutionStates::m_states

private

Definition at line 78 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 42 of file AlgsExecutionStates.h.

---

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

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