| # Gaudi Framework, version v25r0 |

Home |  | Generated: Mon Feb 17 2014

- Main Page
- Related Pages
- Modules
- Namespaces
- Classes
- Files

- Class List
- Class Index
- Class Hierarchy
- Class Members

All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Public Member Functions | List of all members
IStateful Class Referenceabstract

Interface for classes that implement the Gaudi State Machine. More...

`#include <GaudiKernel/IStateful.h>`

Inheritance diagram for IStateful:
[legend]
Collaboration diagram for IStateful:
[legend]

## Public Member Functions
| DeclareInterfaceID (IStateful, 1, 0)
| InterfaceID.
virtual | ~IStateful ()
virtual StatusCode | configure ()=0
| Configuration (from OFFLINE to CONFIGURED).
virtual StatusCode | initialize ()=0
| Initialization (from CONFIGURED to INITIALIZED).
virtual StatusCode | start ()=0
| Start (from INITIALIZED to RUNNING).
virtual StatusCode | stop ()=0
| Stop (from RUNNING to INITIALIZED).
virtual StatusCode | finalize ()=0
| Finalize (from INITIALIZED to CONFIGURED).
virtual StatusCode | terminate ()=0
| Initialization (from CONFIGURED to OFFLINE).
virtual StatusCode | reinitialize ()=0
| Initialization (from INITIALIZED or RUNNING to INITIALIZED, via CONFIGURED).
virtual StatusCode | restart ()=0
| Initialization (from RUNNING to RUNNING, via INITIALIZED).
virtual Gaudi::StateMachine::State | FSMState () const =0
| Get the current state.
virtual Gaudi::StateMachine::State | targetFSMState () const =0
| When we are in the middle of a transition, get the state where the transition is leading us.
Public Member Functions inherited from IInterface
virtual void * | i_cast (const InterfaceID &) const =0
| main cast function
virtual std::vector< std::string > | getInterfaceNames () const =0
| Returns a vector of strings containing the names of all the implemented interfaces.
virtual unsigned long | addRef ()=0
| Increment the reference count of Interface instance.
virtual unsigned long | release ()=0
| Release Interface instance.
virtual unsigned long | refCount () const =0
| Current reference count.
virtual StatusCode | queryInterface (const InterfaceID &ti, void **pp)=0
| Set the void** to the pointer to the requested interface of the instance.
virtual | ~IInterface ()
| Virtual destructor.

## Additional Inherited Members
Public Types inherited from IInterface
enum | Status { SUCCESS = 1, NO_INTERFACE, VERSMISMATCH, LAST_ERROR }
| Return status. More...
typedef Gaudi::InterfaceId < IInterface, 0, 0 > | iid
| Interface ID.
typedef mpl::set1< iid > | ext_iids
| Extra interfaces.
Static Public Member Functions inherited from IInterface
static const InterfaceID & | interfaceID ()
| Return an instance of InterfaceID identifying the interface.

## Detailed Description

Interface for classes that implement the Gaudi State Machine.

Author
  Marco Clemencic

Date
  2008-05-15

Definition at line 17 of file IStateful.h.

## Constructor & Destructor Documentation

virtual IStateful::~IStateful | ( |  | ) |
| inline virtual

Definition at line 22 of file IStateful.h.

{} //< Virtual destructor.

## Member Function Documentation

virtual StatusCode IStateful::configure | ( |  | ) |
| pure virtual

Configuration (from OFFLINE to CONFIGURED).

Implemented in ComponentManager.

IStateful::DeclareInterfaceID | ( | IStateful | ,
|  | 1 | ,
|  | 0 |
| ) |  |

InterfaceID.

virtual StatusCode IStateful::finalize | ( |  | ) |
| pure virtual

Finalize (from INITIALIZED to CONFIGURED).

Implemented in ServiceManager, AlgorithmManager, and ComponentManager.

virtual Gaudi::StateMachine::State IStateful::FSMState | ( |  | ) | const
| pure virtual

Get the current state.

Implemented in ComponentManager.

virtual StatusCode IStateful::initialize | ( |  | ) |
| pure virtual

Initialization (from CONFIGURED to INITIALIZED).

Implemented in ServiceManager, AlgorithmManager, and ComponentManager.

virtual StatusCode IStateful::reinitialize | ( |  | ) |
| pure virtual

Initialization (from INITIALIZED or RUNNING to INITIALIZED, via CONFIGURED).

Implemented in ServiceManager, AlgorithmManager, and ComponentManager.

virtual StatusCode IStateful::restart | ( |  | ) |
| pure virtual

Initialization (from RUNNING to RUNNING, via INITIALIZED).

Implemented in ServiceManager, AlgorithmManager, and ComponentManager.

virtual StatusCode IStateful::start | ( |  | ) |
| pure virtual

Start (from INITIALIZED to RUNNING).

Implemented in ServiceManager, AlgorithmManager, and ComponentManager.

virtual StatusCode IStateful::stop | ( |  | ) |
| pure virtual

Stop (from RUNNING to INITIALIZED).

Implemented in ServiceManager, AlgorithmManager, and ComponentManager.

virtual Gaudi::StateMachine::State IStateful::targetFSMState | ( |  | ) | const
| pure virtual

When we are in the middle of a transition, get the state where the transition is leading us.

Otherwise it returns the same state as state().

Implemented in ComponentManager.

virtual StatusCode IStateful::terminate | ( |  | ) |
| pure virtual

Initialization (from CONFIGURED to OFFLINE).

Implemented in ComponentManager.

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

- /afs/cern.ch/sw/Gaudi/releases/GAUDI/GAUDI_v25r0/GaudiKernel/GaudiKernel/IStateful.h