VR-Link API Documentation for HLA Evolved
Public Member Functions | Protected Attributes
DtUtmCoord Class Reference

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

+ Inheritance diagram for DtUtmCoord:
+ Collaboration diagram for DtUtmCoord:

List of all members.

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
DtUtmCoordoperator= (const DtUtmCoord &src)
 assignment operator
DtUtmCoordoperator= (const DtGeodeticCoord &geodetic)
 Assignment operator; convert geodetic to UTM.
virtual DtUtmCoordsetGeodetic (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 DtUtmCoordsetGeocentric (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.

Protected Attributes

DtUtmReferencePointmyRefPt

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

default constructor

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

constructor

Constructor; construct UTM from geodetic.

virtual DtUtmCoord::~DtUtmCoord ( ) [virtual]

destructor

copy constructor


Member Function Documentation

DtFloat64 DtUtmCoord::east ( ) const [inline, virtual]
virtual DtVector DtUtmCoord::geocentric ( ) const [virtual]

Get geocentric coordinate equivalent (convert UTM to geocentric).

Note that this is not returning a reference.

Exceptions:
DtExceptionif 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:
DtExceptionif the UTM reference point is not initialized.
virtual void DtUtmCoord::getGeocentric ( DtVector geocentric) const [virtual]

Get geocentric coordinate equivalent (convert UTM to geocentric).

Exceptions:
DtExceptionif the UTM reference point is not initialized.
virtual void DtUtmCoord::getGeodetic ( DtGeodeticCoord geodetic) const [virtual]

Get geodetic coordinate equivalent (convert UTM to geodetic).

Exceptions:
DtExceptionif 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 [inline, virtual]
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) [inline, virtual]

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:
DtExceptionif 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:
DtExceptionif the UTM reference point is not initialized.
void DtUtmCoord::setNorth ( DtFloat64  north) [inline, virtual]

Set/Get north component.

void DtUtmCoord::setUp ( DtFloat64  up) [inline, virtual]

Set/Get up component.

DtFloat64 DtUtmCoord::up ( ) const [inline, virtual]

Member Data Documentation


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

Document ID: Generated on Mon May 14 08:06:18 EDT 2012 from SVN revision 114750
Copyright © 2005-2012 VT MÄK Inc. All Rights Reserved (www.mak.com)