Coords::CoordSystem Class Reference

#include <coordsystem.h>

Inheritance diagram for Coords::CoordSystem:

Public Types
enum	StringType {   Default , URN , WKT , JSON ,   URL }
Public Types inherited from ObjectWithName
typedef OD::String	name_type

Public Member Functions
virtual CoordSystem *	clone () const =0
virtual Coord	convertFrom (const Coord &, const CoordSystem &from) const
virtual Coord	convertTo (const Coord &, const CoordSystem &to) const
virtual uiString	description () const =0
void	fillPar (IOPar &) const
virtual RefMan< CoordSystem >	fromString (const char *, BufferString *msg=nullptr) const =0
virtual bool	geographicTransformOK () const =0
virtual CoordSystem *	getGeodeticSystem () const
virtual BufferString	getUnitName () const
virtual bool	isFeet () const
virtual bool	isGeodetic () const
virtual bool	isLatLong () const =0
virtual bool	isMeter () const
virtual bool	isOK () const =0
virtual bool	isOrthogonal () const =0
virtual bool	isProjection () const
virtual bool	isWGS84 () const
bool	operator!= (const CoordSystem &) const
bool	operator== (const CoordSystem &) const
virtual BufferString	summary () const =0
virtual BufferString	toString (StringType=Default, bool withsystem=false) const =0
bool	usePar (const IOPar &)
Public Member Functions inherited from SharedObject
	SharedObject (const char *nm=nullptr)
Public Member Functions inherited from NamedCallBacker
	NamedCallBacker (const char *nm=nullptr)
	NamedCallBacker (const NamedCallBacker &)=delete
	~NamedCallBacker ()
virtual Notifier< NamedCallBacker > &	objectToBeDeleted () const
NamedCallBacker &	operator= (const NamedCallBacker &)=delete
bool	operator== (const NamedCallBacker &oth) const
bool	operator== (const NamedObject &oth) const
Public Member Functions inherited from CallBacker
	CallBacker ()
	CallBacker (const CallBacker &)
virtual	~CallBacker ()
bool	attachCB (const NotifierAccess &, const CallBack &, bool onlyifnew=false) const
bool	attachCB (const NotifierAccess *notif, const CallBack &cb, bool onlyifnew=false) const
void	detachAllNotifiers () const
	Call from the destructor of your inherited object.
void	detachCB (const NotifierAccess &, const CallBack &) const
void	detachCB (const NotifierAccess *notif, const CallBack &cb) const
virtual bool	isCapsule () const
bool	isNotifierAttached (const NotifierAccess *) const
	Only for debugging purposes, don't use.
CallBacker &	operator= (const CallBacker &)=delete
void	stopReceivingNotifications () const
virtual CallBacker *	trueCaller ()
Public Member Functions inherited from NamedObject
	NamedObject (const char *nm=nullptr)
	NamedObject (const NamedObject &oth)
virtual	~NamedObject ()
virtual BufferString	getName () const
bool	getNameFromPar (const IOPar &)
const name_type &	name () const override
NamedObject &	operator= (const NamedObject &)
bool	operator== (const NamedObject &oth) const
virtual void	setName (const char *nm)
Public Member Functions inherited from ObjectWithName
virtual	~ObjectWithName ()
bool	hasName (const char *nm) const
bool	hasName (const name_type &nm) const
void	putNameInPar (IOPar &) const
Public Member Functions inherited from RefCount::Referenced
void	addObserver (WeakPtrBase *obs)
	Not for normal use. May become private.
int	nrRefs () const
	Only for expert use.
void	ref () const
bool	refIfReffed () const
	Don't use in production, for debugging.
void	removeObserver (WeakPtrBase *obs)
	Not for normal use. May become private.
bool	tryRef () const
	Not for normal use. May become private.
void	unRef () const
void	unRefNoDelete () const

Static Public Member Functions
static Coord	convert (const Coord &, const CoordSystem &from, const CoordSystem &to)
static RefMan< CoordSystem >	createSystem (const char *str, BufferString &msgs)
static RefMan< CoordSystem >	createSystem (const IOPar &)
	Creates subclass with settings.
static void	getSystemNames (bool onlyorthogonal, bool onlyprojection, uiStringSet &, ObjectSet< IOPar > &)
	Creates the subclasses without settings.
static const CoordSystem *	getWGS84LLSystem ()
static void	initRepository (NotifierAccess *=nullptr)
static const char *	sKeyFactoryName ()
static const char *	sKeyUiName ()
static BufferString	sWGS84ProjDispString ()
Static Public Member Functions inherited from SharedObject
static Notifier< SharedObject > &	instanceCreated ()
Static Public Member Functions inherited from CallBacker
static void	createReceiverForCurrentThread ()
static void	removeReceiverForCurrentThread ()
Static Public Member Functions inherited from RefCount::Referenced
static bool	isSane (const Referenced *)

Protected Member Functions
	~CoordSystem ()
virtual void	doFillPar (IOPar &) const =0
virtual bool	doUsePar (const IOPar &)=0
virtual Coord	fromGeographic (const LatLong &, bool wgs84) const =0
virtual LatLong	toGeographic (const Coord &, bool wgs84) const =0
Protected Member Functions inherited from SharedObject
	~SharedObject ()
Protected Member Functions inherited from NamedCallBacker
void	sendDelNotif () const
Protected Member Functions inherited from RefCount::Referenced
	Referenced ()
	Referenced (const Referenced &)
virtual	~Referenced ()
Referenced &	operator= (const Referenced &)

Friends
class	::LatLong

Additional Inherited Members
Protected Attributes inherited from NamedCallBacker
Threads::Atomic< bool >	delalreadytriggered_
Notifier< NamedCallBacker >	delnotif_
Protected Attributes inherited from NamedObject
BufferString	name_

Detailed Description

Base class for Coord systems, these are all two-dimensional and coordinates can be stored in Coord. They may use any projection, but they must be able to return Geographic coordinates using either the WGS84 datum or its own datum if applicable.

<>

Member Enumeration Documentation

StringType

enum Coords::CoordSystem::StringType

Enumerator
Default
URN
WKT
JSON
URL

Constructor & Destructor Documentation

~CoordSystem()

Coords::CoordSystem::~CoordSystem ( )

protected

Member Function Documentation

clone()

virtual CoordSystem * Coords::CoordSystem::clone ( ) const

pure virtual

Implemented in Coords::UnlocatedXY, Coords::AnchorBasedXY, and Coords::ProjectionBasedSystem.

convert()

static Coord Coords::CoordSystem::convert ( const Coord & , const CoordSystem & from, const CoordSystem & to )

static

convertFrom()

virtual Coord Coords::CoordSystem::convertFrom ( const Coord & , const CoordSystem & from ) const

virtual

Reimplemented in Coords::ProjectionBasedSystem.

convertTo()

virtual Coord Coords::CoordSystem::convertTo ( const Coord & , const CoordSystem & to ) const

virtual

Reimplemented in Coords::ProjectionBasedSystem.

createSystem() [1/2]

static RefMan< CoordSystem > Coords::CoordSystem::createSystem ( const char * str, BufferString & msgs )

static

createSystem() [2/2]

static RefMan< CoordSystem > Coords::CoordSystem::createSystem ( const IOPar & )

static

Creates subclass with settings.

Gets a list of coord systems and the corresponding IOPars to create them. IOPars become yours!

description()

virtual uiString Coords::CoordSystem::description ( ) const

pure virtual

Implemented in Coords::UnlocatedXY, Coords::AnchorBasedXY, and Coords::ProjectionBasedSystem.

doFillPar()

virtual void Coords::CoordSystem::doFillPar ( IOPar & ) const

protectedpure virtual

Implemented in Coords::UnlocatedXY, Coords::AnchorBasedXY, and Coords::ProjectionBasedSystem.

doUsePar()

virtual bool Coords::CoordSystem::doUsePar ( const IOPar & )

protectedpure virtual

Implemented in Coords::UnlocatedXY, Coords::AnchorBasedXY, and Coords::ProjectionBasedSystem.

fillPar()

void Coords::CoordSystem::fillPar

(

IOPar &

)

const

fromGeographic()

virtual Coord Coords::CoordSystem::fromGeographic ( const LatLong & , bool wgs84 ) const

protectedpure virtual

Implemented in Coords::UnlocatedXY, Coords::AnchorBasedXY, and Coords::ProjectionBasedSystem.

fromString()

virtual RefMan< CoordSystem > Coords::CoordSystem::fromString ( const char * , BufferString * msg = nullptr ) const

pure virtual

Implemented in Coords::UnlocatedXY, Coords::AnchorBasedXY, and Coords::ProjectionBasedSystem.

geographicTransformOK()

virtual bool Coords::CoordSystem::geographicTransformOK ( ) const

pure virtual

Implemented in Coords::UnlocatedXY, Coords::AnchorBasedXY, and Coords::ProjectionBasedSystem.

getGeodeticSystem()

virtual CoordSystem * Coords::CoordSystem::getGeodeticSystem ( ) const

inlinevirtual

Reimplemented in Coords::ProjectionBasedSystem.

getSystemNames()

static void Coords::CoordSystem::getSystemNames ( bool onlyorthogonal, bool onlyprojection, uiStringSet & , ObjectSet< IOPar > &  )

static

Creates the subclasses without settings.

getUnitName()

virtual BufferString Coords::CoordSystem::getUnitName ( ) const

inlinevirtual

Reimplemented in Coords::ProjectionBasedSystem.

getWGS84LLSystem()

static const CoordSystem * Coords::CoordSystem::getWGS84LLSystem ( )

static

initRepository()

static void Coords::CoordSystem::initRepository ( NotifierAccess * = nullptr )

static

To be called from initGeneral with a pointer to survey change notifier.

isFeet()

virtual bool Coords::CoordSystem::isFeet ( ) const

inlinevirtual

Reimplemented in Coords::UnlocatedXY, Coords::AnchorBasedXY, and Coords::ProjectionBasedSystem.

isGeodetic()

virtual bool Coords::CoordSystem::isGeodetic ( ) const

inlinevirtual

isLatLong()

virtual bool Coords::CoordSystem::isLatLong ( ) const

pure virtual

Implemented in Coords::UnlocatedXY, Coords::AnchorBasedXY, and Coords::ProjectionBasedSystem.

isMeter()

virtual bool Coords::CoordSystem::isMeter ( ) const

inlinevirtual

Reimplemented in Coords::UnlocatedXY, Coords::AnchorBasedXY, and Coords::ProjectionBasedSystem.

isOK()

virtual bool Coords::CoordSystem::isOK ( ) const

pure virtual

Implemented in Coords::UnlocatedXY, Coords::AnchorBasedXY, and Coords::ProjectionBasedSystem.

isOrthogonal()

virtual bool Coords::CoordSystem::isOrthogonal ( ) const

pure virtual

Implemented in Coords::UnlocatedXY, Coords::AnchorBasedXY, and Coords::ProjectionBasedSystem.

isProjection()

virtual bool Coords::CoordSystem::isProjection ( ) const

inlinevirtual

Reimplemented in Coords::ProjectionBasedSystem.

isWGS84()

virtual bool Coords::CoordSystem::isWGS84 ( ) const

inlinevirtual

Reimplemented in Coords::ProjectionBasedSystem.

operator!=()

bool Coords::CoordSystem::operator!=

(

const CoordSystem &

)

const

operator==()

bool Coords::CoordSystem::operator==

(

const CoordSystem &

)

const

sKeyFactoryName()

static const char * Coords::CoordSystem::sKeyFactoryName ( )

static

sKeyUiName()

static const char * Coords::CoordSystem::sKeyUiName ( )

static

summary()

virtual BufferString Coords::CoordSystem::summary ( ) const

pure virtual

Implemented in Coords::UnlocatedXY, Coords::AnchorBasedXY, and Coords::ProjectionBasedSystem.

sWGS84ProjDispString()

static BufferString Coords::CoordSystem::sWGS84ProjDispString ( )

static

toGeographic()

virtual LatLong Coords::CoordSystem::toGeographic ( const Coord & , bool wgs84 ) const

protectedpure virtual

Implemented in Coords::UnlocatedXY, Coords::AnchorBasedXY, and Coords::ProjectionBasedSystem.

toString()

virtual BufferString Coords::CoordSystem::toString ( StringType = Default, bool withsystem = false ) const

pure virtual

Returns string. If withsystem is turned on it will start with the factory name of the system, followed by a space.

Implemented in Coords::UnlocatedXY, Coords::AnchorBasedXY, and Coords::ProjectionBasedSystem.

usePar()

bool Coords::CoordSystem::usePar

(

const IOPar &

)

Friends And Related Symbol Documentation

::LatLong

friend class ::LatLong

friend