survinfo.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:          9-4-1996
________________________________________________________________________

-*/

#include "basicmod.h"
#include "namedmonitorable.h"
#include "ranges.h"
#include "enums.h"
#include "zdomain.h"
#include "notify.h"
#include "survgeom3d.h"

class ascostream;

namespace Coords { class PositionSystem; }


mExpClass(Basic) SurveyInfo : public NamedMonitorable
{ mODTextTranslationClass(SurveyInfo);

    mGlobal(Basic) friend const SurveyInfo&     SI();


public:

    bool                has2D() const;
    bool                has3D() const;

    StepInterval<int>   inlRange(bool work) const;
    StepInterval<int>   crlRange(bool work) const;
    StepInterval<float> zRange(bool work) const;
    TrcKeyZSampling     sampling(bool work) const;
    int                 inlStep() const;
    int                 crlStep() const;
    float               zStep() const;
    float               inlDistance() const; 
    float               crlDistance() const;

    Coord               transform(const BinID&) const;
    BinID               transform(const Coord&) const;
    bool                xyInFeet() const;
    uiString            xyUnitString(bool abbrviated=true,
                                     bool withparens=true) const;
    const char*         fileXYUnitString(bool withparens=true) const;
    const ZDomain::Def& zDomain() const;
    float               showZ2UserFactor() const;
    uiString            zUnitString(bool withparens=true) const;
    const char*         fileZUnitString(bool withparens=true) const;
    mImplSimpleMonitoredGetSet(inline,depthsInFeet,setDepthsInFeet,
                                bool,depthsinfeet_,cParsChange());
                        // convenience (can be asked directly from zDomain)
    bool                zIsTime() const;
    bool                zInMeter() const;
    bool                zInFeet() const;

    Coord               minCoord(bool work) const;
    Coord               maxCoord(bool work) const;
    bool                isInside(const BinID&,bool work) const;
    bool                isReasonable(const BinID&) const;
    bool                isReasonable(const Coord&) const;
    Interval<int>       reasonableRange(bool inl) const;
    int                 maxNrTraces(bool work) const;
    bool                isRightHandSystem() const;
    float               angleXInl() const;
    void                checkInlRange(Interval<int>&,bool work) const;
    void                checkCrlRange(Interval<int>&,bool work) const;
    void                checkZRange(Interval<float>&,bool work) const;
    bool                includes(const BinID&,const float,bool work) const;

    void                snap(BinID&,const BinID& dir=BinID(0,0)) const;
    void                snapStep(BinID&,const BinID& dir=BinID(0,0))const;
    void                snapZ(float&,int direction=0) const;

    mImplSimpleMonitoredGetSet(inline,
                        seismicReferenceDatum,setSeismicReferenceDatum,
                        float,seisrefdatum_,cAuxDataChange());
    IOPar               getDefaultPars() const;
    void                setDefaultPar(const char* ky,const char* val,
                                        bool save2storage) const;
    void                setDefaultPars(const IOPar&,bool save2storage) const;
    void                removeKeyFromDefaultPars(const char* ky,
                                                 bool save2storage) const;
    void                putZDomain(IOPar&) const;
    void                setWorkRange(const TrcKeyZSampling&) const;
    void                getCreationData(IOPar&) const;

    RefMan<Survey::Geometry3D>          get3DGeometry(bool work) const;
    RefMan<Coords::PositionSystem>      getCoordSystem();
    ConstRefMan<Coords::PositionSystem> getCoordSystem() const;

    enum Pol2D          { No2D=0, Both2DAnd3D=1, Only2D=2 };
                        mDeclareEnumUtils(Pol2D);

    float               getArea(Interval<int> inl,Interval<int> crl) const;
    float               getArea(bool work) const;   
    Coord3              oneStepTranslation(const Coord3& planenormal) const;

                        // Contrary to normal assignment, only one of
                        // 'major' changes will be emitted.
    static ChangeType   cSetupChange()          { return 2; }
    static ChangeType   cRangeChange()          { return 3; }
    static ChangeType   cWorkRangeChange()      { return 4; }

                        // minor changes will be sent only if not a 'major' one
                        // is emitted.
    static ChangeType   cParsChange()           { return 6; }
    static ChangeType   cPol2DChange()          { return 7; }
    static ChangeType   cAuxDataChange()        { return 8; }
    static ChangeType   cCommentChange()        { return 9; }

    static bool         isMinorChange( ChangeType ct )
                        { return ct==cNoChange() || ct==cNameChange()
                              || ct>cRangeChange(); }
    static bool         isSetupChange( ChangeType ct )
                        { return ct==cEntireObjectChange()
                              || ct==cSetupChange(); }

protected:

    const BufferString  uniqueid_;
    BufferString        basepath_;      
    BufferString        dirname_;       
    ZDomain::Def&       zdef_;
    bool                depthsinfeet_;
    TrcKeyZSampling&    fullcs_;
    TrcKeyZSampling&    workcs_;
    float               seisrefdatum_;
    IOPar               defpars_;
    RefMan<Coords::PositionSystem> coordsystem_;

    Survey::Geometry3D* s3dgeom_;
    Survey::Geometry3D* work_s3dgeom_;

    Pos::IdxPair2Coord  b2c_;

    BinID               set3binids_[3];
    Coord               set3coords_[3];

    Pol2D               pol2d_;
    bool                pol2dknown_;

    BufferString        comments_;
    uiString            sipnm_;

    bool                wrapUpRead();

    mImplSimpleMonitoredGetSet(inline,comments,setComments,
                                BufferString,comments_,cCommentChange());
    TrcKeyZSampling&    gtSampling( bool work ) const
                        { return work ? workcs_ : fullcs_; }

private:

    // ugly, but hard to avoid:
    friend class        DBMan;
    friend class        uiSurveyManager;
    friend class        uiSurveyInfoEditor;

    Pos::IdxPair2Coord  rdb2c_;

                                // For DBMan only
    static uiRetVal     setSurveyLocation(const char*,const char*,bool);

public:

        // These fns are rarely used by non-specialist classes.

                        SurveyInfo();
                        ~SurveyInfo();
    mDeclMonitorableAssignment(SurveyInfo);

    Pos::IdxPair2Coord  binID2Coord() const;
    void                get3Pts(Coord c[3],BinID b[2],int& xline) const;

    mDeprecated bool    isClockWise() const { return isRightHandSystem(); }
    void                setZUnit(bool istime,bool infeet=false);

    static const char*  sKeyInlRange();
    static const char*  sKeyCrlRange();
    static const char*  sKeyXRange();
    static const char*  sKeyYRange();
    static const char*  sKeyZRange();
    static const char*  sKeyXYInFt();
    static const char*  sKeyDpthInFt(); 
    static const char*  sKeySurvDataType();
    static const char*  sKeySeismicRefDatum();
    static const char*  sSetupFileName()                { return ".survey"; }
    static const char*  sBasicSurveyName()              { return "BasicSurvey";}

    mImplSimpleMonitoredGetSet(inline,getDirName,setDirName,
                                BufferString,dirname_,cSetupChange());
    mImplSimpleMonitoredGetSet(inline,getBasePath,setBasePath,
                                BufferString,basepath_,cSetupChange());
    BufferString        getFullDirPath() const;
    static BufferString dirNameForName(const char*);

    Pol2D               survDataType() const;
    void                setSurvDataType(Pol2D) const;
    mImplSimpleMonitoredGet(sipName,uiString,sipnm_);
    void                setSipName(const uiString&);

        // Following fns are used by specialist classes. Don't use casually.

    bool                write(const char* basedir=0) const;
    void                saveDefaultPars(const char* basedir=0) const;
    void                saveComments(const char* basedir=0) const;
    static SurveyInfo*  read(const char*,uiRetVal&);
    void                setRange(const TrcKeyZSampling&);
    const char*         set3Pts(const Coord c[3],const BinID b[2],int xline);
    const uiString      set3PtsUiMsg(const Coord c[3],const BinID b[2],int);
    void                gen3Pts();
    bool                setCoordSystem(Coords::PositionSystem*);
    void                update3DGeometry();

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

    static uiRetVal     isValidDataRoot(const char*);
    static uiRetVal     isValidSurveyDir(const char*);

    bool                isFresh() const;
    void                setNotFresh() const;
    void                setFreshSetupData(const IOPar&) const;
    void                getFreshSetupData(IOPar&) const;

    mDeprecated IOPar&          defaultPars()
                                { return defpars_; }
    mDeprecated const IOPar&    pars() const
                                { return defpars_; }
    mDeprecated void            savePars(const char* basedir = 0) const
                                { saveDefaultPars(basedir); }
    mDeprecated IOPar&          getPars() const
                                { return const_cast<IOPar&>(defpars_); }
    mDeprecated BufferString    getDataDirName() const
                                { return getBasePath();}

    mDeprecated void            setRange( const TrcKeyZSampling& cs, bool work )
                                { work ? setWorkRange(cs) : setRange(cs); }
    mDeprecated const char*     getZUnitString( bool wp=true ) const
                                { return fileZUnitString( wp ); }
    mDeprecated uiString        getUiZUnitString( bool wp=true ) const
                                { return zUnitString( wp ); }
    mDeprecated const char*     getXYUnitString( bool wp=true ) const
                                { return fileXYUnitString( wp ); }
    mDeprecated uiString        getUiXYUnitString(bool a=true,bool p=true) const
                                { return xyUnitString( a, p ); }

    enum Unit           { Second, Meter, Feet };
    Unit                xyUnit() const;
    Unit                zUnit() const;
    static float        defaultXYtoZScale(Unit,Unit);
    float               zScale() const;
};


mGlobal(Basic) const SurveyInfo& SI();
mDeprecated mGlobal(Basic) SurveyInfo& eSI();