DtUtmCoord Class Reference

Instances of DtUtmCoord are used to represent UTM coordinates. More...

Inheritance diagram for DtUtmCoord:

Collaboration diagram for DtUtmCoord:

Public Member Functions
	DtUtmCoord (DtUtmReferencePoint *refPt=DtGlobalUtmReferencePoint())
	default constructor
	DtUtmCoord (double east, double north, double up, DtUtmReferencePoint *refPt=DtGlobalUtmReferencePoint())
	constructor
	DtUtmCoord (const DtGeodeticCoord &geodetic, DtUtmReferencePoint *refPt=DtGlobalUtmReferencePoint())
	Constructor; construct UTM from geodetic.
virtual	~DtUtmCoord ()
	destructor
	DtUtmCoord (const DtUtmCoord &src)
	copy constructor
DtUtmCoord &	operator= (const DtUtmCoord &src)
	assignment operator
DtUtmCoord &	operator= (const DtGeodeticCoord &geodetic)
	Assignment operator; convert geodetic to UTM.
virtual DtUtmCoord &	setGeodetic (const DtGeodeticCoord &geodetic)
	Set from geodetic coordinate (convert geodetic to UTM).
virtual void	getGeodetic (DtGeodeticCoord &geodetic) const
	Get geodetic coordinate equivalent (convert UTM to geodetic).
virtual DtGeodeticCoord	geodetic () const
	Get geodetic coordinate equivalent (convert UTM to geodetic).
virtual DtUtmCoord &	setGeocentric (const DtVector &geocentric)
	Set from geocentric coordinate (convert geocentric to UTM).
virtual void	getGeocentric (DtVector &geocentric) const
	Get geocentric coordinate equivalent (convert UTM to geocentric).
virtual DtVector	geocentric () const
	Get geocentric coordinate equivalent (convert UTM to geocentric).
virtual void	setEast (DtFloat64 east)
	Set/Get east component.
virtual DtFloat64	east () const
virtual void	setNorth (DtFloat64 north)
	Set/Get north component.
virtual DtFloat64	north () const
virtual void	setUp (DtFloat64 up)
	Set/Get up component.
virtual DtFloat64	up () const
virtual double	gridDeclination () const
	Get the heading that northing is off of north.
Public Member Functions inherited from DtVector
	DtVector ()
	DtVector (const double &x, const double &y, const double &z)
	Construct from three doubles.
	~DtVector ()
	destructor
	DtVector (const DtVector &vec)
	copy constructor
DtVector &	operator= (const DtVector &vec)
	assignment operator
void	setToZero ()
	set Vector to all zeros
DtVector &	operator+= (const DtVector &other)
	adds other to this vector
DtVector &	operator-= (const DtVector &other)
	subtracts other from this vector (this - other)
double &	operator[] (int ind)
	Get the value for the specified subscript. (int version)
double	operator[] (int ind) const
	A const version to get the value for the specified subscript.
double &	operator[] (DtVectorOffset ind)
	Get the value for the specified subscript. (enum version)
double	operator[] (DtVectorOffset ind) const
	a const version to get the value for the specified subscript. (enum version)
int	operator== (const DtVector &vec) const
	Get whether another vector equals this vector.
int	operator!= (const DtVector &vec) const
	Get whether another vector does not equal this vector.
DtString	string () const
	Get a string representation of the vector.
double	magnitudeSquared () const
	Get the magnitude of the vector squared, i.e.
void	normalize ()
	Normalize the vector; i.e., magnitude = 1.
bool	isNormalized () const
	Returns true of the vector is Normalized.
DtVector	crossProduct (const DtVector &v) const
	Compute cross product with another vector.
double	dotProduct (const DtVector &v) const
	Compute dot product with another vector.
bool	approxEq (const DtVector &v, const double &tolerance) const
	check if the vector is zero-ed out withing the tolerance passed
bool	magnitudeIsZero () const
	check if the magnitude of this vector is zero
bool	magnitudeIsZero (double tolerance) const
	check if the magnitude of this vector is zero, within the tolerance passed.
std::ostream &	printDataToStream (std::ostream &str) const
	prints out a formated string to the stream
const double &	x () const
	gets/sets the x component of a Vector
void	setX (const double &x)
	gets/sets the x component of a Vector
const double &	y () const
	gets/sets the y component of a Vector
void	setY (const double &y)
	gets/sets the y component of a Vector
const double &	z () const
	gets/sets the z component of a Vector
void	setZ (const double &z)
	gets/sets the z component of a Vector
	operator double * ()
	operator const double * () const

Protected Attributes
DtUtmReferencePoint *	myRefPt
Protected Attributes inherited from DtVector
double	myRep [3]

Additional Inherited Members
Static Public Member Functions inherited from DtVector
static const DtVector &	zero ()
	Get a zeroed vector.
static const DtVector &	i ()
	Get a (1,0,0) vector.
static const DtVector &	j ()
	Get a (0,1,0) vector.
static const DtVector &	k ()
	Get a (0,0,1) vector.
static const DtVector &	ones ()
	Get a vector set to all ones.

Detailed Description

Instances of DtUtmCoord are used to represent UTM coordinates.

Universal Transverse Mercator projection coordinate with respect to reference set by DtUtmInit.

Note

For coordinate conversions, either DtUtmInit must be called first or the default constructor parameter should not be used.

Constructor & Destructor Documentation

DtUtmCoord::DtUtmCoord

(

DtUtmReferencePoint *

refPt = DtGlobalUtmReferencePoint()

)

default constructor

DtUtmCoord::DtUtmCoord	(	double	east,
		double	north,
		double	up,
		DtUtmReferencePoint *	refPt = DtGlobalUtmReferencePoint()
	)

constructor

DtUtmCoord::DtUtmCoord	(	const DtGeodeticCoord &	geodetic,
		DtUtmReferencePoint *	refPt = DtGlobalUtmReferencePoint()
	)

Constructor; construct UTM from geodetic.

virtual DtUtmCoord::~DtUtmCoord ( )

virtual

destructor

DtUtmCoord::DtUtmCoord

(

const DtUtmCoord &

src

)

copy constructor

Member Function Documentation

DtFloat64 DtUtmCoord::east ( ) const

inlinevirtual

virtual DtVector DtUtmCoord::geocentric ( ) const

virtual

Get geocentric coordinate equivalent (convert UTM to geocentric).

Note that this is not returning a reference.

Exceptions

DtException

if the UTM reference point is not initialized.

virtual DtGeodeticCoord DtUtmCoord::geodetic ( ) const

virtual

Get geodetic coordinate equivalent (convert UTM to geodetic).

Note that this is not returning a reference.

Exceptions

DtException

if the UTM reference point is not initialized.

virtual void DtUtmCoord::getGeocentric ( DtVector &  geocentric ) const

virtual

Get geocentric coordinate equivalent (convert UTM to geocentric).

Exceptions

DtException

if the UTM reference point is not initialized.

virtual void DtUtmCoord::getGeodetic ( DtGeodeticCoord &  geodetic ) const

virtual

Get geodetic coordinate equivalent (convert UTM to geodetic).

Exceptions

DtException

if the UTM reference point is not initialized.

virtual double DtUtmCoord::gridDeclination ( ) const

virtual

Get the heading that northing is off of north.

DtFloat64 DtUtmCoord::north ( ) const

inlinevirtual

DtUtmCoord& DtUtmCoord::operator=

(

const DtUtmCoord &

src

)

assignment operator

DtUtmCoord& DtUtmCoord::operator=

(

const DtGeodeticCoord &

geodetic

)

Assignment operator; convert geodetic to UTM.

void DtUtmCoord::setEast ( DtFloat64  east )

inlinevirtual

Set/Get east component.

inline functions

virtual DtUtmCoord& DtUtmCoord::setGeocentric ( const DtVector &  geocentric )

virtual

Set from geocentric coordinate (convert geocentric to UTM).

Can also use assignment operator.

Exceptions

DtException

if the UTM reference point is not initialized.

virtual DtUtmCoord& DtUtmCoord::setGeodetic ( const DtGeodeticCoord &  geodetic )

virtual

Set from geodetic coordinate (convert geodetic to UTM).

Can also use assignment operator.

Exceptions

DtException

if the UTM reference point is not initialized.

void DtUtmCoord::setNorth ( DtFloat64  north )

inlinevirtual

Set/Get north component.

void DtUtmCoord::setUp ( DtFloat64  up )

inlinevirtual

Set/Get up component.

DtFloat64 DtUtmCoord::up ( ) const

inlinevirtual

Member Data Documentation

DtUtmReferencePoint* DtUtmCoord::myRefPt

protected

---

The documentation for this class was generated from the following file:

• utmCoord.h