All Classes Functions Variables Typedefs Friends Pages
Public Member Functions | List of all members
Glympse::ILocation Struct Referenceabstract

Specifies a single location point (latitude and longitude) at a given time, with optional altitude, bearing, speed, and accuracy information. More...

#include <ILocation.h>

Inheritance diagram for Glympse::ILocation:
Inheritance graph
[legend]

Public Member Functions

virtual bool hasProvider ()=0
 True if this location has a provider.
 
virtual bool hasAltitude ()=0
 True if this location has an altitude.
 
virtual bool hasBearing ()=0
 True if this location has a bearing.
 
virtual bool hasSpeed ()=0
 True if this location has a speed.
 
virtual bool hasHAccuracy ()=0
 True if this location has horizontal accuracy.
 
virtual bool hasVAccuracy ()=0
 True if this location has vertical accuracy.
 
virtual bool hasTime ()=0
 True if this location has a time.
 
virtual int32 getProvider ()=0
 Get the provider if available. More...
 
virtual float getAltitude ()=0
 Get the altitude if available, in meters above sea level. More...
 
virtual float getBearing ()=0
 Get the bearing, in degrees. More...
 
virtual float getSpeed ()=0
 Get the speed if it is available, in meters/second over ground. More...
 
virtual float getHAccuracy ()=0
 Get the estimated horizontal accuracy of this location, in meters. More...
 
virtual float getVAccuracy ()=0
 Get the estimated vertical accuracy of this location, in meters. More...
 
virtual int64 getTime ()=0
 Return the UTC time of this fix, in milliseconds since January 1, 1970.
 
virtual GLocation clone ()=0
 Creates and returns a copy of this location object.
 
virtual float distanceTo (const GLatLng &dest)=0
 Returns the approximate distance in meters between this location and the given location. More...
 
virtual float bearingTo (const GLatLng &dest)=0
 Returns the approximate initial bearing in degrees East of true North when traveling along the shortest path between this location and the given location. More...
 
- Public Member Functions inherited from Glympse::ILatLng
virtual bool hasLocation ()=0
 
virtual double getLatitude ()=0
 
virtual double getLongitude ()=0
 
virtual int32 getLatitudeE6 ()=0
 
virtual int32 getLongitudeE6 ()=0
 
- Public Member Functions inherited from Glympse::ICommon
virtual int32 retain ()=0
 Add a reference to our object in a COM-like way.
 
virtual int32 release ()=0
 Release a reference to our object in a COM-like way.
 
virtual int32 hold ()=0
 Add a reference to our object in a COM-like way.
 
virtual int32 unhold ()=0
 Release a reference to our object in a COM-like way.
 
virtual int32 hashCode ()=0
 Returns an integer hash code for this object.
 
virtual bool equals (const GCommonObj &o)=0
 Compares this instance with the specified object and indicates if they are equal. More...
 
virtual GString toString ()=0
 Returns a string containing a concise, human-readable description of this object. More...
 
virtual void attachObject (const GCommon &obj)=0
 Asociates arbitrary object with the instance.
 
virtual GCommon extractObject ()=0
 Extracts associated object or NULL if no association is established.
 

Additional Inherited Members

- Protected Member Functions inherited from Glympse::ICommon
virtual ~ICommon ()
 Destructor is protected to deny explicit object deallocation. More...
 

Detailed Description

Specifies a single location point (latitude and longitude) at a given time, with optional altitude, bearing, speed, and accuracy information.

Member Function Documentation

virtual float Glympse::ILocation::bearingTo ( const GLatLng dest)
pure virtual

Returns the approximate initial bearing in degrees East of true North when traveling along the shortest path between this location and the given location.

The shortest path is defined using the WGS84 ellipsoid. Locations that are (nearly) antipodal may produce meaningless results.

Parameters
destThe destination location.
Returns
The initial bearing in degrees.
virtual float Glympse::ILocation::distanceTo ( const GLatLng dest)
pure virtual

Returns the approximate distance in meters between this location and the given location.

Distance is defined using the WGS84 ellipsoid.

Parameters
destThe destination location.
Returns
The approximate distance in meters.
virtual float Glympse::ILocation::getAltitude ( )
pure virtual

Get the altitude if available, in meters above sea level.

If this location does not have an altitude then Float::NaN is returned.

virtual float Glympse::ILocation::getBearing ( )
pure virtual

Get the bearing, in degrees.

Bearing is the horizontal direction of travel of this device, and is not related to the device orientation. It is guaranteed to be in the range (0.0, 360.0] if the device has a bearing.

If this location does not have a bearing then Float::NaN is returned.

virtual float Glympse::ILocation::getHAccuracy ( )
pure virtual

Get the estimated horizontal accuracy of this location, in meters.

If this location does not have an accuracy then Float::NaN is returned.

virtual int32 Glympse::ILocation::getProvider ( )
pure virtual

Get the provider if available.

If this location does not have a provider then -1 is returned.

virtual float Glympse::ILocation::getSpeed ( )
pure virtual

Get the speed if it is available, in meters/second over ground.

If this location does not have a speed then Float::NaN is returned.

virtual float Glympse::ILocation::getVAccuracy ( )
pure virtual

Get the estimated vertical accuracy of this location, in meters.

If this location does not have an accuracy then Float::NaN is returned.


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