| Classes | Job Modules | Data Objects | Services | Algorithms | Tools | Packages | Directories | Tracs |

In This Package:

IStage Class Reference

Interface class for Stage tool. More...

#include <IStage.h>

Inheritance diagram for IStage:

[legend]
Collaboration diagram for IStage:
[legend]
List of all members.

Public Types

 SUCCESS
 NO_INTERFACE
 VERSMISMATCH
 LAST_ERROR
enum  Status

Public Member Functions

virtual FFTimeStamp currentTime () const =0
 get current time Time: (definition) the earliest (smallest) time of all the processors that it own.
virtual StatusCode nextElement (IStageData *&pIStgData, bool erase=true)=0
 run Pop out the first element with smallest time from stage data.
virtual StatusCode pushElement (IStageData *pIStgData)=0
 push an element into stage data
virtual const std::string & type () const =0
virtual const IInterfaceparent () const =0
virtual StatusCode configure ()=0
virtual StatusCode initialize ()=0
virtual StatusCode start ()=0
virtual StatusCode stop ()=0
virtual StatusCode finalize ()=0
virtual StatusCode terminate ()=0
virtual StatusCode reinitialize ()=0
virtual StatusCode restart ()=0
virtual Gaudi::StateMachine::State FSMState () const =0
virtual StatusCode sysInitialize ()=0
virtual StatusCode sysStart ()=0
virtual StatusCode sysStop ()=0
virtual StatusCode sysFinalize ()=0
virtual StatusCode sysReinitialize ()=0
virtual StatusCode sysRestart ()=0
virtual unsigned long refCount () const =0
virtual const std::string & name () const =0
virtual StatusCode queryInterface (const InterfaceID &riid, void **ppvInterface)=0
virtual unsigned long addRef ()=0
virtual unsigned long release ()=0

Static Public Member Functions

static const InterfaceIDinterfaceID ()
 Retrieve interface ID.

Public Attributes

 SUCCESS
 NO_INTERFACE
 VERSMISMATCH
 LAST_ERROR

Detailed Description

Interface class for Stage tool.

Author:
Zhe Wang, Mar. 16, 2008

Definition at line 20 of file IStage.h.


Member Function Documentation

static const InterfaceID& IStage::interfaceID (  )  [inline, static]

Retrieve interface ID.

Reimplemented from IAlgTool.

Definition at line 24 of file IStage.h.

00024 { return IID_IStage; }

virtual FFTimeStamp IStage::currentTime (  )  const [pure virtual]

get current time Time: (definition) the earliest (smallest) time of all the processors that it own.

Like a stage has two processors, alg1 and alg2, the data provided by them has minimum time t, then t is the stage time.

Implemented in Stage.

virtual StatusCode IStage::nextElement ( IStageData *&  pIStgData,
bool  erase = true 
) [pure virtual]

run Pop out the first element with smallest time from stage data.

Multiple processors can share the same stage data by reading passing "erase=false". The last processor in the chain must call with erase="true" and delete the resulting IStageData when it is finished using it.

Implemented in Stage.

virtual StatusCode IStage::pushElement ( IStageData pIStgData  )  [pure virtual]

push an element into stage data

Implemented in Stage.


The documentation for this class was generated from the following file:
| Classes | Job Modules | Data Objects | Services | Algorithms | Tools | Packages | Directories | Tracs |

Generated on Mon Apr 11 20:36:10 2011 for Stage by doxygen 1.4.7