executor.h

Go to the documentation of this file.

#pragma once

/*+
________________________________________________________________________

 (C) dGB Beheer B.V.; (LICENSE) http://opendtect.org/OpendTect_license.txt
 Author:        A.H.Bril
 Date:          11-7-1996
________________________________________________________________________

-*/

#include "basicmod.h"
#include "task.h"
#include "namedobj.h"
#include "progressmeter.h"
#include "notify.h"
#include "od_iosfwd.h"

mExpClass(Basic) Executor : public SequentialTask
{
public:
                        Executor( const char* nm )
                            : SequentialTask(nm)
                            , prestep(this), poststep(this)     {}
    virtual             ~Executor()                     {}

    virtual int         doStep();

    inline bool         go( od_ostream* s=0, bool isfirst=true,
                            bool islast=true, int delaybtwnstepsinms=0 )
                        { return goImpl(s,isfirst,islast,delaybtwnstepsinms); }
    inline bool         go( od_ostream& s, bool isfirst=true,
                            bool islast=true, int delaybtwnstepsinms=0 )
                        { return goImpl(&s,isfirst,islast,delaybtwnstepsinms); }

    Notifier<Executor>  prestep;
    Notifier<Executor>  poststep; 

                        // Being a Task requires:
    virtual bool        execute()       { return go(); }

                        // Being an Executor requires:
    virtual uiString    message() const                 = 0;
    virtual uiString    nrDoneText() const              = 0;
    virtual od_int64    nrDone() const                  = 0;

protected:

    virtual bool        goImpl(od_ostream*,bool,bool,int);

};


mExpClass(Basic) ExecutorGroup : public Executor
{
public:
                        ExecutorGroup( const char* nm, bool parallel=false,
                                       bool ownsexecs=true );
    virtual             ~ExecutorGroup();
    virtual void        add( Executor* );
    uiString            message() const;
    virtual od_int64    totalNr() const;
    virtual od_int64    nrDone() const;
    uiString            nrDoneText() const;

    int                 nrExecutors() { return executors_.size(); }
    Executor*           getExecutor(int idx) { return executors_[idx]; }

    void                setNrDoneText(const uiString& txt)
                        { nrdonetext_ = txt; }

protected:

    virtual int         nextStep();
    virtual bool        goToNextExecutor();
    void                findNextSumStop();

    int                 sumstart_;
    int                 sumstop_;
    const bool          parallel_;
    int                 currentexec_;
    uiString            nrdonetext_;
    ObjectSet<Executor>& executors_;
    TypeSet<int>        executorres_;
    bool                ownsexecs_;

};


mExpClass(Basic) TextTaskRunner : public TaskRunner
{
public:
                        TextTaskRunner( od_ostream& strm )
                            : TaskRunner()
                            , strm_(strm)       {}

    bool                execute(Task&);

protected:

    od_ostream&         strm_;

};