UtmPoint Class Reference

Stores a Universal Transverse Mercator (UTM) coordinate. More...

#include <GeoPoint.h>

List of all members.

Public Member Functions
	UtmPoint (LatLonPoint latLon)
	UtmPoint (double dEasting, double dNorthing, int iZone, char hemisphere)
	~UtmPoint ()
LocationType	getCoordinates () const
LatLonPoint	getLatLonCoordinates () const
double	getEasting () const
double	getNorthing () const
int	getZone () const
const char	getHemisphere () const
std::string	getText () const
std::string	getEastingText () const
std::string	getNorthingText () const
std::string	getZoneText () const

---

Detailed Description

Stores a Universal Transverse Mercator (UTM) coordinate.

This class stores a UTM coordinate and provides common text formatting when retrieving the value. In addition to the text formatting, the raw easting, northing, zone, and hemisphere values can also be retrieved.

Definition at line 320 of file GeoPoint.h.

---

Constructor & Destructor Documentation

UtmPoint::UtmPoint

(

LatLonPoint

latLon

)

Creates a UTM point based on a given latitude/longitude point.

This constructor automatically converts a latitude/longitude coordinate pair into a UTM coordinate.

Parameters:

latLon

The latitude/longitude coordinate to convert to a UTM point.

UtmPoint::UtmPoint	(	double	dEasting,
		double	dNorthing,
		int	iZone,
		char	hemisphere
	)

Creates a UTM point based on initial easting, northing, zone, and hemisphere values.

Parameters:

	dEasting	The easting value.
	dNorthing	The northing value.
	iZone	The integer zone value.
	hemisphere	The hemisphere, as a character, which should be either 'N' or 'S'.

UtmPoint::~UtmPoint

(

)

Destroys the UTM point.

---

Member Function Documentation

LocationType UtmPoint::getCoordinates

(

)

const

Retrieves the easting and northing values.

Returns:

The easting and northing values in a LocationType. The easting value is stored in the LocationType x-coordinate, and the northing value is stored in the y-coordinate.

See also:

getEasting(), getNorthing(), getText()

LatLonPoint UtmPoint::getLatLonCoordinates

(

)

const

Converts the UTM point to a latitude/longitude point.

Returns:

The UTM point converted to a latitude/longitude coordinate. The latitude value is stored in the LocationType x-coordinate, and the longitude value is stored in the y-coordinate.

See also:

LatLonPoint, getCoordinates()

double UtmPoint::getEasting

(

)

const

Returns the easting value.

Returns:

The easting value of the UTM point.

See also:

getNorthing()

double UtmPoint::getNorthing

(

)

const

Returns the northing value.

Returns:

The northing value of the UTM point.

See also:

getEasting()

int UtmPoint::getZone

(

)

const

Returns the zone value.

Returns:

The zone value of the UTM point as an integer.

const char UtmPoint::getHemisphere

(

)

const

Returns the hemisphere value.

Returns:

The hemisphere value of the UTM point as a character. Will be either 'N' or 'S'.

std::string UtmPoint::getText

(

)

const

Returns UTM point in a formatted string.

Returns:

A string representing the UTM point in the following format: easting text + " " + zone text + ", " + northing text + " " + hemisphere.

See also:

getEastingText(), getNorthingText(), getZoneText(), getHemisphere()

std::string UtmPoint::getEastingText

(

)

const

Returns the easting value as a formatted string.

Returns:

A string representing the easting value of the UTM point in the following format used by sprintf(): "E%.0f".

See also:

getText()

std::string UtmPoint::getNorthingText

(

)

const

Returns the northing value as a formatted string.

Returns:

A string representing the northing value of the UTM point in the following format used by sprintf(): "N%.0f".

See also:

getText()

std::string UtmPoint::getZoneText

(

)

const

Returns the zone value as a formatted string.

Returns:

A string representing the zone value of the UTM point in the following format used by sprintf(): "Zone %d".

See also:

getText()