/search.css" rel="stylesheet" type="text/css"/> /search.js">
| Classes | Job Modules | Data Objects | Services | Algorithms | Tools | Packages | Directories | Tracs |

In This Package:

Public Member Functions | Static Public Member Functions
IStage Class Reference

Interface class for Stage tool. More...

#include <IStage.h>

Inheritance diagram for IStage:
Inheritance graph
[legend]

List of all members.

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

Static Public Member Functions

static const InterfaceID & interfaceID ()
 Retrieve interface ID.

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.

Definition at line 24 of file IStage.h.

{ 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 Fri May 16 2014 10:07:33 for Stage by doxygen 1.7.4