Main Page | Namespace List | Class Hierarchy | Class List | Class Members

MQClientInterface::LatLngCollection Class Reference

Inheritance diagram for MQClientInterface::LatLngCollection:

MQClientInterface::MQObjectCollection MQClientInterface::MQObject List of all members.

Public Member Functions

 LatLngCollection ()
override void Init ()
virtual LatLng GetAt (int index)
virtual void AddLatLng (double lat, double lng)
virtual double ArcDistance ()
virtual double ArcDistance (DistanceUnits units)
virtual void Generalize (double dDeviance)
bool GetBoundingRect (LatLng upperLeft, LatLng lowerRight)
bool ExpandBoundingRect (LatLng upperLeft, LatLng lowerRight)

Properties

override System.String ClassName
override int ClassID

Detailed Description

Contains a collection of LatLng objects.

See also:
LatLng

DistanceUnits


Constructor & Destructor Documentation

MQClientInterface::LatLngCollection::LatLngCollection  )  [inline]
 

Default constructor.


Member Function Documentation

virtual void MQClientInterface::LatLngCollection::AddLatLng double  lat,
double  lng
[inline, virtual]
 

Creates a new LatLng object from the two inputs, and adds it to the collection.

Parameters:
lat Latitude
lng Longitude

virtual double MQClientInterface::LatLngCollection::ArcDistance DistanceUnits  units  )  [inline, virtual]
 

Calculates the actual distance in miles of a line, by from the lat/longs that are part of this collection.

Parameters:
units Units object

virtual double MQClientInterface::LatLngCollection::ArcDistance  )  [inline, virtual]
 

Calculates the actual distance in miles of a line, by from the lat/longs that are part of this collection. (default units: Miles)

bool MQClientInterface::LatLngCollection::ExpandBoundingRect LatLng  upperLeft,
LatLng  lowerRight
[inline]
 

Expands the lat/lng bounding rectangle (upper left and lower right corners of the rectangle) of all points in this LatLngCollection If the LatLngCollection is empty, the vertices are unchanged.

Parameters:
upperLeft A LatLng object identifying the upper left corner of the rectangle. This value will not be modified if this LatLngCollection is empty.
lowerRight A LatLng object identifying the lower right corner of the rectangle. This value will not be modified if this LatLngCollection is empty.
Returns:
true if lowerRight and/or upperLeft have been changed, false otherwise.

virtual void MQClientInterface::LatLngCollection::Generalize double  dDeviance  )  [inline, virtual]
 

Reduce the points in the lat/lng collection. All points that deviate from a straight line by less than dDeviance are eliminated.

Parameters:
dDeviance Deviance

virtual LatLng MQClientInterface::LatLngCollection::GetAt int  index  )  [inline, virtual]
 

Returns the nth item in the collection.

Parameters:
index Index of item within this collection which is to be returned.
Returns:
LatLong object that is the nth element of this LatLngCollection.

bool MQClientInterface::LatLngCollection::GetBoundingRect LatLng  upperLeft,
LatLng  lowerRight
[inline]
 

Returns the lat/lng bounding rectangle (upper left and lower right corners of the rectangle) of all points in this LatLngCollection. If this LatLngCollection is empty, the vertices are unchanged.

Parameters:
upperLeft A LatLng object identifying the upper left corner of the rectangle. This value will not be modified if this LatLngCollection is empty.
lowerRight A LatLng object identifying the lower right corner of the rectangle. This value will not be modified if this LatLngCollection is empty.
Returns:
true if lowerRight and/or upperLeft have been changed.

override void MQClientInterface::LatLngCollection::Init  )  [inline, virtual]
 

Initialize.

Reimplemented from MQClientInterface::MQObjectCollection.


Property Documentation

override int MQClientInterface::LatLngCollection::ClassID [get]
 

Class ID property

Reimplemented from MQClientInterface::MQObject.

override System.String MQClientInterface::LatLngCollection::ClassName [get]
 

Class Name property

Reimplemented from MQClientInterface::MQObject.


The documentation for this class was generated from the following file:
Generated on Wed Oct 10 22:12:32 2007 for MapQuest Advantage .NET(C#) API Reference by  doxygen 1.4.1