survinfo.h

#ifndef survinfo_h
#define survinfo_h

/*+
________________________________________________________________________

 (C) dGB Beheer B.V.; (LICENSE) http://opendtect.org/OpendTect_license.txt
 Author:        A.H.Bril
 Date:          9-4-1996
 RCS:           $Id: survinfo.h,v 1.98 2010-08-26 11:39:30 cvsjaap Exp $
________________________________________________________________________

-*/
 
 
#include "namedobj.h"
#include "ranges.h"
#include "rcol2coord.h"
#include "enums.h"
class ascostream;
class IOPar;
class CubeSampling;
class LatLong2Coord;


mClass SurveyInfo : public NamedObject
{

    mGlobal friend const SurveyInfo&    SI();

public:

                        ~SurveyInfo();
    bool                isValid() const         { return valid_; }
    bool                has2D() const;
    bool                has3D() const;

    StepInterval<int>   inlRange(bool work) const;
    StepInterval<int>   crlRange(bool work) const;
    const StepInterval<float>& zRange( bool work ) const;
    int                 inlStep() const;
    int                 crlStep() const;
    float               zStep() const;
    float               inlDistance() const; 
    float               crlDistance() const;
    float               computeArea(const Interval<int>& inl,
                             const Interval<int>& crl) const;   
    float               computeArea(bool work) const ;          

    Coord3              oneStepTranslation(const Coord3& planenormal) const;

    const CubeSampling& sampling( bool work ) const
                        { return work ? wcs_ : cs_; }

    Coord               transform( const BinID& b ) const
                        { return b2c_.transform(b); }
    BinID               transform(const Coord&) const;
    enum Unit           { Second, Meter, Feet };
    Unit                xyUnit() const;
    Unit                zUnit() const;
    inline bool         xyInFeet() const        { return xyinfeet_;}
    inline bool         zIsTime() const         { return zistime_; }
    inline bool         zInMeter() const        { return !zistime_ &&!zinfeet_;}
    inline bool         zInFeet() const         { return !zistime_ && zinfeet_;}
    const char*         getXYUnitString(bool withparens=true) const;
    const char*         getZUnitString(bool withparens=true) const;
    float               zFactor() const;
    static float        zFactor(bool time);
    bool                depthsInFeetByDefault() 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;
    int                 maxNrTraces(bool work) 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&,BinID direction=BinID(0,0)) const;
    void                snapStep(BinID&,BinID direction=BinID(0,0)) const;
    void                snapZ(float&,int direction=0) const;

    const IOPar&        pars() const                    { return pars_; }
    void                putZDomain(IOPar&) const;

    // Some public fns moved to bottom because they are rarely used; some fns
    // that have 'no user servicable parts inside' are at the very bottom

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

protected:

                        SurveyInfo();
    bool                valid_;

    BufferString        datadir;
    BufferString        dirname;

    bool                zistime_;
    bool                zinfeet_; 
    bool                xyinfeet_; 
    BufferString        comment_;
    BufferString        wsprojnm_;
    BufferString        wspwd_;
    CubeSampling&       cs_;
    CubeSampling&       wcs_;
    IOPar&              pars_;

    RCol2Coord          b2c_;
    LatLong2Coord&      ll2c_;
    BinID               set3binids[3];
    Coord               set3coords[3];

    Pol2D               survdatatype_;
    bool                survdatatypeknown_;

    static SurveyInfo*  theinst_;
 
    static void         deleteInstance();
    void                handleLineRead(const BufferString&,const char*);
    bool                wrapUpRead();
    void                writeSpecLines(ascostream&) const;

    void                setTr(RCol2Coord::RCTransform&,const char*);
    void                putTr(const RCol2Coord::RCTransform&,
                                ascostream&,const char*) const;

private:

    // ugly, but hard to avoid:
    friend class                IOMan;
    friend class                uiSurvey;
    friend class                uiSurveyInfoEditor;

    RCol2Coord::RCTransform     rdxtr;
    RCol2Coord::RCTransform     rdytr;

public:

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

    void                setWorkRange(const CubeSampling&);
    Notifier<SurveyInfo> workRangeChg;

    const RCol2Coord&   binID2Coord() const     { return b2c_; }
    void                get3Pts(Coord c[3],BinID b[2],int& xline) const;
    const LatLong2Coord& latlong2Coord() const  { return ll2c_; }
    bool                isClockWise() const;
    float               computeAngleXInl() const;
    void                setXYInFeet( bool yn=true ) { xyinfeet_ = yn; }
    void                setZUnit(bool istime,bool infeet=false);
    static float        defaultXYtoZScale(Unit,Unit);
    float               zScale() const;
    static const char*  sKeyInlRange();
    static const char*  sKeyCrlRange();
    static const char*  sKeyXRange();
    static const char*  sKeyYRange();
    static const char*  sKeyZRange();
    static const char*  sKeyWSProjName();
    static const char*  sKeyXYInFt();
    static const char*  sKeyDpthInFt(); 
    static const char*  sKeySurvDataType();

    BufferString        getDirName() const      { return dirname; }

                        DeclareEnumUtils(Pol2D);
    Pol2D               survDataType() const    { return survdatatype_; }
    void                setSurvDataType( Pol2D typ )    { survdatatype_ = typ; }

    const char*         comment() const         { return comment_.buf(); }

    const char*         getWSProjName() const   { return wsprojnm_.buf(); }
                        // Password only in memory this session
    const char*         getWSPwd() const        { return wspwd_.buf(); }

        // These fns are used by specialist classes. Know what you are doing!

                        SurveyInfo(const SurveyInfo&);
    SurveyInfo&         operator =(const SurveyInfo&);

    RCol2Coord&         getBinID2Coord() const
                        { return const_cast<SurveyInfo*>(this)->b2c_; }
    LatLong2Coord&      getLatlong2Coord() const
                        { return const_cast<SurveyInfo*>(this)->ll2c_; }
    IOPar&              getPars() const 
                        { return const_cast<SurveyInfo*>(this)->pars_; }

    bool                write(const char* basedir=0) const;
    void                savePars(const char* basedir=0) const;
    static SurveyInfo*  read(const char*);
    void                setRange(const CubeSampling&,bool);
    const char*         set3Pts(const Coord c[3],const BinID b[2],int xline);
    void                gen3Pts();
    void                setComment( const char* s )     { comment_ = s; }
    void                setInvalid() const;

    void                setWSProjName( const char* nm ) const
                        { const_cast<SurveyInfo*>(this)->wsprojnm_ = nm; }
    void                setWSPwd( const char* nm ) const
                        { const_cast<SurveyInfo*>(this)->wspwd_ = nm; }

};


mGlobal const SurveyInfo& SI();


#endif