seismscprov.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:          Jan 2007
________________________________________________________________________

*/


#include "seiscommon.h"
#include "arraynd.h"
#include "rowcol.h"
#include "objectset.h"
#include "uistring.h"

template <class T> class Array2D;
class IOObj;
class SeisTrc;
class SeisTrcBuf;


namespace Seis
{

class SelData;
class Provider;


mExpClass(Seis) MSCProvider
{ mODTextTranslationClass(Seis::MSCProvider);
public:

                        MSCProvider(const DBKey&);
    virtual             ~MSCProvider();

    bool                is2D() const;
    BufferString        name() const; // cube name

                        // use the following after prepareWork
                        // but before the first next()
    void                forceFloatData( bool yn )
                        { intofloats_ = yn; }
    void                setStepout(int,int,bool required);
    void                setStepout(Array2D<bool>* mask);
    void                setStepoutStep( int i, int c )
                        { stepoutstep_.row() = i; stepoutstep_.col() = c; }
    int                 inlStepout( bool req ) const
                        { return req ? reqstepout_.row() : desstepout_.row(); }
    int                 crlStepout( bool req ) const
                        { return req ? reqstepout_.col() : desstepout_.col(); }
    void                setSelData(Seis::SelData*);

    enum AdvanceState   { NewPosition, Buffering, EndReached, Error };
    AdvanceState        advance();
    uiString            errMsg() const          { return uirv_; }

    BinID               getPos() const;
    int                 getTrcNr() const;
    SeisTrc*            get(int deltainl,int deltacrl);
    SeisTrc*            get(const BinID&);
    const SeisTrc*      get( int i, int c ) const
                        { return const_cast<MSCProvider*>(this)->get(i,c); }
    const SeisTrc*      get( const BinID& bid ) const
                        { return const_cast<MSCProvider*>(this)->get(bid); }

    int                 comparePos(const MSCProvider&) const;
    int                 estimatedNrTraces() const; 

    Provider*           provider()              { return prov_; }
    const Provider*     provider() const        { return prov_; }

protected:

    Provider*           prov_;
    ObjectSet<SeisTrcBuf> tbufs_;
    RowCol              reqstepout_;
    RowCol              desstepout_;
    RowCol              stepoutstep_;
    Array2D<bool>*      reqmask_;
    bool                intofloats_;
    bool                workstarted_;
    bool                atend_;

    uiRetVal            uirv_;
    int                 curlinenr_;
    mutable int         estnrtrcs_;

                        // Indexes of new pos ready, equals -1 while buffering.
    int                 bufidx_;
    int                 trcidx_;
                        // Indexes of next position to be examined.
    int                 pivotidx_;
    int                 pivotidy_;

    bool                startWork();
    bool                readTrace(SeisTrc&);
    bool                isReqBoxFilled() const;
    bool                doAdvance();

};

} // namespace Seis

mDeprecated typedef Seis::MSCProvider SeisMSCProvider;