volprocchain.h

Go to the documentation of this file.

#ifndef volprocchain_h
#define volprocchain_h

/*+
________________________________________________________________________

 (C) dGB Beheer B.V.; (LICENSE) http://opendtect.org/OpendTect_license.txt
 Author:        K. Tingdahl
 Date:          October 2006
 RCS:           $Id$
________________________________________________________________________


-*/

#include "volumeprocessingmod.h"
#include "volprocstep.h"
#include "multiid.h"
#include "refcount.h"
#include "threadlock.h"

class Scaler;

namespace VolProc
{

mExpClass(VolumeProcessing) Chain
{ mRefCountImpl(Chain); mODTextTranslationClass(Chain);
public:
                                Chain();

    mExpClass(VolumeProcessing) Connection
    {
    public:
                        Connection( Step::ID outpstep=Step::cUndefID(),
                            Step::OutputSlotID outpslot=Step::cUndefSlotID(),
                            Step::ID inpstep=Step::cUndefID(),
                            Step::InputSlotID inpslot=Step::cUndefSlotID());

        bool            isUdf() const;
        bool            operator==(const Connection&) const;
        bool            operator!=(const Connection&) const;

        void            fillPar(IOPar&,const char* key) const;
        bool            usePar(const IOPar&,const char* key);

        Step::ID                inputstepid_;
        Step::InputSlotID       inputslotid_;

        Step::ID                outputstepid_;
        Step::OutputSlotID      outputslotid_;
    };

    mExpClass(VolumeProcessing) Web
    {
    public:
        bool                    addConnection(const Connection&);
        void                    removeConnection(const Connection&);
        void                    getConnections(Step::ID,bool input,
                                               TypeSet<Connection>&) const;
        TypeSet<Connection>&            getConnections()
                                        { return connections_; }
        const TypeSet<Connection>&      getConnections() const
                                        { return connections_; }
    private:
        TypeSet<Connection>     connections_;
    };

    bool                        addConnection(const Connection&);
    void                        removeConnection(const Connection&);
    void                        updateConnections();
    const Web&                  getWeb() const  { return web_; }

    void                        setZStep( float z, bool zist )
                                { zstep_=z; zist_ = zist; }
    float                       getZStep() const        { return zstep_; }
    bool                        zIsT() const            { return zist_; }

    int                         nrSteps() const;
    Step*                       getStep(int);
    Step*                       getStepFromName(const char*);
    const Step*                 getStepFromName(const char*) const;
    Step*                       getStepFromID(Step::ID);
    const Step*                 getStepFromID(Step::ID) const;
    int                         indexOf(const Step*) const;
    void                        addStep(Step*);
    void                        insertStep(int,Step*);
    void                        swapSteps(int,int);
    void                        removeStep(int);
    const ObjectSet<Step>&      getSteps() const        { return steps_; }
    int                         getNrUsers(Step::ID,Step::InputSlotID) const;

    bool                        setOutputSlot(Step::ID,Step::OutputSlotID);
    void                        setOutputScalers(const ObjectSet<Scaler>&);
    const ObjectSet<Scaler>&    getOutputScalers() const;

    const VelocityDesc*         getVelDesc() const;

    void                        fillPar(IOPar&) const;
    bool                        usePar(const IOPar&);

    void                        setStorageID(const MultiID& mid);
    const MultiID&              storageID() const { return storageid_; }
    uiString                    name() const;

    bool                        areSamplesIndependent() const;
    bool                        needsFullVolume() const;
    uiString                    errMsg() const;

    Step::ID                    getNewStepID() { return freeid_++; }

private:

    friend                      class ChainExecutor;

    bool                        validConnection(const Connection&) const;

    static const char*          sKeyNrSteps()       { return "Nr Steps"; }
    static const char*          sKeyStepType()      { return "Type"; }
    static const char*          sKeyNrConnections() { return "Nr Connections"; }
    static const char*          sKeyConnection(int idx,BufferString&);

    Step::ID                    outputstepid_;
    Step::OutputSlotID          outputslotid_;

    MultiID                     storageid_;
    ObjectSet<Step>             steps_;
    Web                         web_;

    float                       zstep_;
    bool                        zist_;

    uiString                    errmsg_;
    Threads::Atomic<int>        freeid_;
    ObjectSet<Scaler>           outcompscalers_;

};

} // namespace VolProc

#include "volprocchainexec.h" // this include will go after 6.0

#endif