Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes

SequentialTask Class Reference

Inheritance diagram for SequentialTask:
Task NamedObject CallBacker Executor ExecutorGroup

List of all members.

Public Member Functions

 SequentialTask (const char *nm=0)
virtual ~SequentialTask ()
void setProgressMeter (ProgressMeter *)
 Must be called before execute().
virtual int doStep ()
bool execute ()

Static Public Member Functions

static int ErrorOccurred ()
static int Finished ()
static int MoreToDo ()
static int WarningAvailable ()

Protected Member Functions

virtual int nextStep ()=0

Protected Attributes

ProgressMeterprogressmeter_

Detailed Description

The generalization of something (e.g. a computation) where the steps must be done in sequence, i.e. not parallely.


Constructor & Destructor Documentation

SequentialTask::SequentialTask ( const char *  nm = 0  )  [inline]
virtual SequentialTask::~SequentialTask (  )  [inline, virtual]

Member Function Documentation

virtual int SequentialTask::doStep (  )  [virtual]
Return values:
MoreToDo() Not finished. Call me again.
Finished() Nothing more to do.
ErrorOccurred() Something went wrong.
Note:
if function returns a value greater than cMoreToDo(), it should be interpreted as cMoreToDo().

Reimplemented in Executor.

static int SequentialTask::ErrorOccurred (  )  [inline, static]
bool SequentialTask::execute (  )  [virtual]

Implements Task.

static int SequentialTask::Finished (  )  [inline, static]
static int SequentialTask::MoreToDo (  )  [inline, static]
virtual int SequentialTask::nextStep (  )  [protected, pure virtual]
Return values:
MoreToDo() Not finished. Call me again.
Finished() Nothing more to do.
ErrorOccurred() Something went wrong.
Note:
if function returns a value greater than cMoreToDo(), it should be interpreted as cMoreToDo().

Implemented in ExecutorGroup.

void SequentialTask::setProgressMeter ( ProgressMeter  )  [virtual]

Must be called before execute().

Reimplemented from Task.

static int SequentialTask::WarningAvailable (  )  [inline, static]

Member Data Documentation