Class MQLatLng

Object
   |
   +--MQObject
         |
         +--MQLatLng

class MQLatLng

extends MQObject

Contains a latitude/longitude pair.
Defined in mqcommon.js

Field Detail

lat

float lat

Value to represent the latitude

lng

float lng

Value to represent the longitude

MQLatLng

MQLatLng(<float/string> param1, <float> param2)

Constructs a new MQLatLng object.

Parameters:
param1 - OPTIONAL: Depending on the absence of param2. If param2 exists then param1 is initial latitude (float - default is 0.0) otherwise param1 is xpath (string - default is "LatLng").
param2 - OPTIONAL: initial longitude (default is 0.0).

arcDistance

double arcDistance( <MQLatLng> ll2, <MQDistanceUnits> lUnits)

Calculates the distance between two lat/lng's in miles or meters. If LUnits not provide then miles will be the default.

Parameters:
ll2 - Second lat,lng position to calculate distance to.
lUnits - Units to calculate distance

Returns:
Returns the distance in meters or miles.

Throws:
- SomeException If the ll2 parameter is not the type MQLatLng
- SomeException If the lUnits parameter exists and is not the type MQDistanceUnits

equals

Boolean equals(<MQLatLng> ll)

Determines whether or not two latlngs are equal. Two instances of MQLatLng are equal if the values of their latitude and longitude member fields, representing their position in the coordinate space, are the same.

Parameters:
ll - an MQLatLng object to be compared with this MQLatLng

Returns:
True if both the latitude and longitude values are equal.

getClassName

String getClassName()

Returns the text name of this class.

Returns:
The text name of this class.

getLatitude

float getLatitude()

Returns the latitude value.

Returns:
the latitude value.

getLongitude

float getLongitude()

Returns the longitude value.

Returns:
the longitude value.

getObjectVersion

int getObjectVersion()

Returns the version of this class.

Returns:
The version of this class.

loadXml

void loadXml(<String> strXml)

Assigns the xml that relates to this object.

Parameters:
strXml - the xml to be assigned.

saveXml

String saveXml()

Build an xml string that represents this object.

Returns:
The xml string.

setLatitude

void setLatitude(<float> fLatitude)

Sets the latitude value.

Parameters:
fLatitude - the value to set lat to

setLatLng

void setLatLng(<float> fLatitude, <float> fLongitude)

Sets the latitude and longitude values.

Parameters:
fLatitude - the value to set lat to
fLongitude - the value to set lng to

setLongitude

void setLongitude(<float> fLongitude)

Sets the longitude value.

Parameters:
fLongitude - the value to set lng to

toString

string toString()

Returns a string representation of this MQLatLng. The format is "latitude,longitude".

Returns:
a string representation of this MQLatLng.

valid

Boolean valid()

Returns a true if both the latitude and longitude values are set to a value other than the static "INVALID" value.

Returns:
True if both the latitude and longitude values are not equal to the static "INVALID".