coordsystem.h

Go to the documentation of this file.

#ifndef coordsystem_h
#define coordsystem_h

/*+
________________________________________________________________________

 (C) dGB Beheer B.V.; (LICENSE) http://opendtect.org/OpendTect_license.txt
 Author:        K. Tingdahl
 Date:          August 2016
________________________________________________________________________

-*/

#include "factory.h"

#include "bufstring.h"
#include "callback.h"
#include "coord.h"
#include "latlong.h"
#include "refcount.h"

namespace Coords
{

mExpClass(Basic) CoordSystem : CallBacker
{ mRefCountImpl(CoordSystem);
public:

    bool                        operator==(const CoordSystem&) const;

    static void                 initRepository(NotifierAccess* = 0);
                                mDefineFactoryInClass(CoordSystem,factory);

    static void                 getSystemNames(bool onlyorthogonal,
                                               bool onlyprojection,
                                               uiStringSet&,
                                               ObjectSet<IOPar>&);
    static RefMan<CoordSystem> createSystem(const IOPar&);
    virtual CoordSystem*        clone() const                           = 0;

    virtual uiString            description() const                     = 0;
    virtual BufferString        summary() const                         = 0;

    virtual bool                isOK() const                            = 0;

    virtual bool                geographicTransformOK() const           = 0;

    static Coord                convert(const Coord&,const CoordSystem& from,
                                        const CoordSystem& to);
    Coord                       convertFrom(const Coord&,
                                        const CoordSystem& from) const;

    virtual uiString            toUiString(const Coord&) const;
    virtual BufferString        toString(const Coord&,
                                         bool withsystem=false) const;
    virtual Coord               fromString(const char*) const;

    virtual bool                isOrthogonal() const    = 0;
    virtual bool                isProjection() const    { return false; }
    virtual bool                isFeet() const          { return false; }
    virtual bool                isMeter() const         { return false; }

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

    static const char*          sKeyFactoryName();
    static const char*          sKeyUiName();

protected:

    virtual LatLong             toGeographic(const Coord&,
                                             bool wgs84) const          = 0;
    virtual Coord               fromGeographic(const LatLong&,
                                               bool wgs84) const        = 0;
    virtual void                doFillPar(IOPar&) const                 = 0;
    virtual bool                doUsePar(const IOPar&)                  = 0;

private:

    friend class ::LatLong;
};


mExpClass(Basic) UnlocatedXY : public CoordSystem
{ mODTextTranslationClass(UnlocatedXY);
public:
    mDefaultFactoryInstantiation( CoordSystem,UnlocatedXY,"Unlocated XY",
                                 tr("Unlocated XY") );

                        UnlocatedXY();

    virtual CoordSystem*        clone() const;
    virtual uiString    description() const { return
                           tr("Coordinate system in an undefined projection.");}
    virtual BufferString summary() const
                                { return sFactoryKeyword(); }

    void                setIsFeet( bool isfeet ) { isfeet_ = isfeet; }
    bool                geographicTransformOK() const   { return false; }

    virtual bool        isOK() const            { return true; }
    virtual bool        isOrthogonal() const    { return true; }
    virtual bool        isFeet() const          { return isfeet_; }
    virtual bool        isMeter() const         { return !isfeet_; }

private:

    virtual LatLong     toGeographic(const Coord&,bool wgs84) const;
    virtual Coord       fromGeographic(const LatLong&,bool wgs84) const;
    virtual bool        doUsePar(const IOPar&);
    virtual void        doFillPar(IOPar&) const;

    bool                isfeet_;
};


mExpClass(Basic) AnchorBasedXY : public CoordSystem
{ mODTextTranslationClass(AnchorBasedXY);
public:
    mDefaultFactoryInstantiation( CoordSystem,AnchorBasedXY,"AnchorBased XY",
                                 tr("Anchor Point Based XY") );

                        AnchorBasedXY();
                        AnchorBasedXY(const LatLong&,const Coord&);
    virtual CoordSystem* clone() const;
    virtual uiString    description() const { return
                                tr("Coordinate system has an anchor point "
                                    "for which Latitude/Longitude is known");}
    virtual BufferString summary() const;

    void                setIsFeet( bool isfeet ) { isfeet_ = isfeet; }
    bool                geographicTransformOK() const;
    void                setLatLongEstimate(const LatLong&,const Coord&);

    virtual bool        isOK() const            { return true; }
    virtual bool        isOrthogonal() const    { return true; }
    virtual bool        isFeet() const          { return isfeet_; }
    virtual bool        isMeter() const         { return !isfeet_; }

    const Coord&        refCoord() const { return refcoord_; }
    const LatLong&      refLatLong() const { return reflatlng_; }

private:

    virtual LatLong     toGeographic(const Coord&,bool wgs84) const;
    virtual Coord       fromGeographic(const LatLong&,bool wgs84) const;

    bool                isfeet_;
    Coord               refcoord_;
    LatLong             reflatlng_;

    double              lngdist_;

    virtual bool        doUsePar(const IOPar&);
    virtual void        doFillPar(IOPar&) const;

};

} // namespace Coords

#endif