QWhereaboutsCoordinate Class Reference
[QtLocationModule]

Detailed Description

The QWhereaboutsCoordinate class contains a geographical coordinate.

A QWhereaboutsCoordinate has a latitude and longitude, and optionally, an altitude.

Use type() to determine whether a coordinate is a 2D coordinate (has latitude and longitude only) or 3D coordinate (has latitude, longitude and altitude). Use distanceTo() and azimuthTo() to calculate the distance and bearing between coordinates.

See also QWhereabouts.

Member Type Documentation

enum QWhereaboutsCoordinate::CoordinateFormat

Defines the possible formatting options for toString().

See also toString().

enum QWhereaboutsCoordinate::CoordinateType

Defines the possible types for a coordinate.

Member Function Documentation

QWhereaboutsCoordinate::QWhereaboutsCoordinate ()

Constructs a coordinate. The coordinate will be invalid until setLatitude() and setLongitude() have been called.

QWhereaboutsCoordinate::QWhereaboutsCoordinate ( double latitude, double longitude )

Constructs a coordinate with the given latitude and longitude.

QWhereaboutsCoordinate::QWhereaboutsCoordinate ( double latitude, double longitude, double altitude )

Constructs a coordinate with the given latitude, longitude and altitude.

QWhereaboutsCoordinate::QWhereaboutsCoordinate ( const QWhereaboutsCoordinate & other )

Constructs a coordinate from the contents of other.

QWhereaboutsCoordinate::~QWhereaboutsCoordinate ()

Destroys the coordinate object.

double QWhereaboutsCoordinate::altitude () const

Returns the altitude (meters above sea level).

See also setAltitude().

qreal QWhereaboutsCoordinate::azimuthTo ( const QWhereaboutsCoordinate & other )

Returns the azimuth (or bearing) in degrees from this coordinate to the coordinate specified by other. Altitude is not used in the calculation.

The calculation does not take the aspects of the geoid into account.

Returns 0 if the type of this coordinate or the type of other is QWhereaboutsCoordinate::InvalidCoordinate.

qreal QWhereaboutsCoordinate::distanceTo ( const QWhereaboutsCoordinate & other )

Returns the distance (in meters) from this coordinate to the coordinate specified by other. Altitude is not used in the calculation.

This calculation returns the great-circle distance between the two coordinates, without taking the aspects of the geoid into account.

Returns 0 if the type of this coordinate or the type of other is QWhereaboutsCoordinate::InvalidCoordinate.

bool QWhereaboutsCoordinate::isNull () const

Returns true if no attributes have been set for this coordinate.

double QWhereaboutsCoordinate::latitude () const

Returns the latitude, in decimal degrees. A positive latitude indicates the Northern Hemisphere, and a negative latitude indicates the Southern Hemisphere.

See also setLatitude().

double QWhereaboutsCoordinate::longitude () const

Returns the longitude, in decimal degrees. A positive longitude indicates the Eastern Hemisphere, and a negative longitude indicates the Western Hemisphere.

See also setLongitude().

void QWhereaboutsCoordinate::setAltitude ( double altitude )

Sets the altitude (meters above sea level) to altitude.

See also altitude().

void QWhereaboutsCoordinate::setLatitude ( double latitude )

Sets the latitude (in decimal degrees) to latitude. The value should be in the WGS84 datum.

To be valid, the latitude must be between -90 to 90 inclusive.

See also latitude().

void QWhereaboutsCoordinate::setLongitude ( double longitude )

Sets the longitude (in decimal degrees) to longitude. The value should be in the WGS84 datum.

To be valid, the longitude must be between -180 to 180 inclusive.

See also longitude().

QString QWhereaboutsCoordinate::toString ( CoordinateFormat format = DegreesMinutesSecondsWithHemisphere ) const

Returns this coordinate as a string in the specified format.

For example, if this coordinate latitude-longitude coordinates of (-27.46758°, 153.027892°), these are the strings that are returned depending on format:

CoordinateType QWhereaboutsCoordinate::type () const

Returns the type of this coordinate.

QWhereaboutsCoordinate & QWhereaboutsCoordinate::operator= ( const QWhereaboutsCoordinate & other )

Assigns other to this coordinate and returns a reference to this coordinate.