Qt Mobility Reference Documentation

QGeoPositionInfo Class Reference

The QGeoPositionInfo class contains information gathered on a global position, direction and velocity at a particular point in time. More...

 #include <QGeoPositionInfo>

Public Types

enum Attribute { Direction, GroundSpeed, VerticalSpeed, MagneticVariation, HorizontalAccuracy, VerticalAccuracy }

Public Functions

QGeoPositionInfo ()
QGeoPositionInfo ( const QGeoCoordinate & coordinate, const QDateTime & timestamp )
QGeoPositionInfo ( const QGeoPositionInfo & other )
~QGeoPositionInfo ()
qreal attribute ( Attribute attribute ) const
QGeoCoordinate coordinate () const
bool hasAttribute ( Attribute attribute ) const
bool isValid () const
void removeAttribute ( Attribute attribute )
void setAttribute ( Attribute attribute, qreal value )
void setCoordinate ( const QGeoCoordinate & coordinate )
void setTimestamp ( const QDateTime & timestamp )
QDateTime timestamp () const
bool operator!= ( const QGeoPositionInfo & other ) const
QGeoPositionInfo & operator= ( const QGeoPositionInfo & other )
bool operator== ( const QGeoPositionInfo & other ) const

Related Non-Members

QDataStream & operator<< ( QDataStream & stream, const QGeoPositionInfo & info )
QDataStream & operator>> ( QDataStream & stream, QGeoPositionInfo & info )

Detailed Description

The QGeoPositionInfo class contains information gathered on a global position, direction and velocity at a particular point in time.

A QGeoPositionInfo contains, at a minimum, a geographical coordinate and a timestamp. It may also have heading and speed measurements as well as estimates of the accuracy of the provided data.

See also QGeoPositionInfoSource.


Member Type Documentation

enum QGeoPositionInfo::Attribute

Defines the attributes for positional information.

ConstantValueDescription
QGeoPositionInfo::Direction0The bearing to true north from the direction of travel, in degrees.
QGeoPositionInfo::GroundSpeed1The ground speed, in metres/sec.
QGeoPositionInfo::VerticalSpeed2The vertical speed, in metres/sec.
QGeoPositionInfo::MagneticVariation3The angle between the horizontal component of the magnetic field and true north, in degrees. Also known as magnetic declination. A positive value indicates a clockwise direction from true north and a negative value indicates a counter-clockwise direction.
QGeoPositionInfo::HorizontalAccuracy4The accuracy of the provided latitude-longitude value, in metres.
QGeoPositionInfo::VerticalAccuracy5The accuracy of the provided altitude value, in metres.

Member Function Documentation

QGeoPositionInfo::QGeoPositionInfo ()

Creates an invalid QGeoPositionInfo object.

See also isValid().

QGeoPositionInfo::QGeoPositionInfo ( const QGeoCoordinate & coordinate, const QDateTime & timestamp )

Creates a QGeoPositionInfo for the given coordinate and timestamp.

QGeoPositionInfo::QGeoPositionInfo ( const QGeoPositionInfo & other )

Creates a QGeoPositionInfo with the values of other.

QGeoPositionInfo::~QGeoPositionInfo ()

Destroys a QGeoPositionInfo object.

qreal QGeoPositionInfo::attribute ( Attribute attribute ) const

Returns the value of the specified attribute as a qreal value.

Returns -1 if the value has not been set, although this may also be a legitimate value for some attributes.

The function hasAttribute() should be used to determine whether or not a value has been set for an attribute.

See also hasAttribute() and setAttribute().

QGeoCoordinate QGeoPositionInfo::coordinate () const

Returns the coordinate for this position.

Returns an invalid coordinate if no coordinate has been set.

See also setCoordinate().

bool QGeoPositionInfo::hasAttribute ( Attribute attribute ) const

Returns true if the specified attribute is present for this QGeoPositionInfo object.

bool QGeoPositionInfo::isValid () const

Returns true if the timestamp() and coordinate() values are both valid.

See also QGeoCoordinate::isValid() and QDateTime::isValid().

void QGeoPositionInfo::removeAttribute ( Attribute attribute )

Removes the specified attribute and its value.

void QGeoPositionInfo::setAttribute ( Attribute attribute, qreal value )

Sets the value for attribute to value.

See also attribute().

void QGeoPositionInfo::setCoordinate ( const QGeoCoordinate & coordinate )

Sets the coordinate for this position to coordinate.

See also coordinate().

void QGeoPositionInfo::setTimestamp ( const QDateTime & timestamp )

Sets the date and time at which this position was reported to timestamp.

The timestamp must be in UTC time.

See also timestamp().

QDateTime QGeoPositionInfo::timestamp () const

Returns the date and time at which this position was reported, in UTC time.

Returns an invalid QDateTime if no date/time value has been set.

See also setTimestamp().

bool QGeoPositionInfo::operator!= ( const QGeoPositionInfo & other ) const

Returns true if any of this object's values are not the same as those of other.

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

Assigns the values from other to this QGeoPositionInfo.

bool QGeoPositionInfo::operator== ( const QGeoPositionInfo & other ) const

Returns true if all of this object's values are the same as those of other.


Related Non-Members

QDataStream & operator<< ( QDataStream & stream, const QGeoPositionInfo & info )

Writes the given info to the specified stream.

See also Format of the QDataStream Operators.

QDataStream & operator>> ( QDataStream & stream, QGeoPositionInfo & info )

Reads a coordinate from the specified stream into the given info.

See also Format of the QDataStream Operators.

X

Thank you for giving your feedback.

Make sure it is related to this specific page. For more general bugs and requests, please use the Qt Bug Tracker.