GeoDeviceLocation

#include <bb/platform/geo/GeoDeviceLocation>

To link against this class, add the following line to your .pro file: LIBS += -lbbcascadesmaps

A point in geographic space that represents the device's current latitude and longitude coordinates.

Markers

The GeoDeviceLocation class uses Markers to indicate the device's current location on the map. It has two Marker properties, one used when the device has a valid heading, the other used when the device doesn't have a valid heading. Only one marker property is displayed at a time, depending on the headingValid property.

If no markers are provided, default ones will be used. (The defaults can be restored using the reset* operations.)

Directional Device Marker

The deviceDirectionalMarker property is the Marker that is used to visually represent the device's location on a map when the direction of the device is known.

The icon for the marker is expected to point North initially, and is rotated in accordance with the device's heading. For example, if the heading is 90 degrees, then the icon is rotated a quarter turn to the right. The icon is rotated around the marker's "location coordinate" attribute (Marker::locationCoordinate()).

Directionless Device Marker

The deviceDirectionlessMarker property is the Marker that is used to visually represent the device's location on a map when the direction of the device is not known.

This marker is not rotated since it does not represent directionality.

Inheritance

bb::platform::geo::Geographic
	bb::platform::geo::GeoDeviceLocation

Properties Index

bb::platform::geo::Marker	deviceDirectionalMarker
bb::platform::geo::Marker	deviceDirectionlessMarker
double	heading [read-only]
bool	headingValid [read-only]
bb::platform::geo::Point	point [read-only]
float	pointAccuracy [read-only]
float	speed [read-only]
bool	valid [read-only]
bb::platform::geo::BoundingBox	boundingBox [read-only]
QString	description
QString	geoId
QString	id
QString	name
QString	styleFamily

Public Functions Index

	GeoDeviceLocation (QObject *parent=0)
	GeoDeviceLocation (const QString &id, QObject *parent=0)
virtual	~GeoDeviceLocation ()
bb::platform::geo::Marker	deviceDirectionalMarker () const
bb::platform::geo::Marker	deviceDirectionlessMarker () const
double	heading () const
bool	isHeadingValid () const
bool	isValid () const
bb::platform::geo::Point	point () const
float	pointAccuracy () const
Q_SLOT void	resetDeviceDirectionalMarker ()
Q_SLOT void	resetDeviceDirectionlessMarker ()
Q_SLOT void	setDeviceDirectionalMarker (const bb::platform::geo::Marker &marker)
Q_SLOT void	setDeviceDirectionlessMarker (const bb::platform::geo::Marker &marker)
float	speed () const
virtual bb::platform::geo::BoundingBox	boundingBox () const
QString	description () const
	Geographic (QObject *parent=0)
	Geographic (const QString &id, QObject *parent=0)
QString	geoId () const
QString	id () const BB_DEPRECATED
QString	name () const
Q_SLOT void	setDescription (const QString &desc)
Q_SLOT void	setGeoId (const QString &id)
Q_SLOT void	setId (const QString &id) BB_DEPRECATED
Q_SLOT void	setName (const QString &name)
Q_SLOT void	setStyleFamily (const QString &styleFamily)
QString	styleFamily () const

Protected Functions Index

Only has inherited protected functions

void	setBoundingBox (const bb::platform::geo::BoundingBox &newBox)

Signals Index

void	deviceDirectionalMarkerChanged (const bb::platform::geo::Marker &newMarker)
void	deviceDirectionlessMarkerChanged (const bb::platform::geo::Marker &newMarker)
void	headingChanged (double heading)
void	headingValidityChanged (bool headingValidity)
void	pointAccuracyChanged (float accuracy)
void	pointChanged (const bb::platform::geo::Point &point)
void	speedChanged (float speed)
void	validChanged (bool valid)
void	boundaryChanged (const bb::platform::geo::BoundingBox &box)
void	descriptionChanged (const QString &desc)
void	geoIdChanged (const QString &id)
void	idChanged (const QString &id) BB_DEPRECATED
void	nameChanged (const QString &name)
void	styleFamilyChanged (const QString &newFamily)
void	topographyChanged (const QString &id)

Properties

bb::platform::geo::Marker deviceDirectionalMarker

The marker used to represent this location when it has a valid heading.

Since:

BlackBerry 10.2.0

bb::platform::geo::Marker deviceDirectionlessMarker

The marker used to represent this device's location when the heading of the device is invalid.

See Directionless Device Marker for more information.

Since:

BlackBerry 10.2.0

double heading[read-only]

The direction the device is heading, in degrees from true North.

Since:

BlackBerry 10.2.0

bool headingValid[read-only]

The validity of the heading property.

The heading property can be invalid while the GeoDeviceLocation is valid in the case where the device is not moving.

Since:

BlackBerry 10.2.0

bb::platform::geo::Point point[read-only]

The location of the device.

Since:

BlackBerry 10.2.0

float pointAccuracy[read-only]

The accuracy of the device's location, in meters, or a value less than 0 if the location is not valid.

Since:

BlackBerry 10.2.0

float speed[read-only]

The speed the device is traveling at, in meters/second.

Since:

BlackBerry 10.2.0

bool valid[read-only]

The validity of the device's location.

The device has a valid location when it has received a location update from a location source.

Since:

BlackBerry 10.3.0

bb::platform::geo::BoundingBox boundingBox[read-only]

The axis-aligned bounding box in which this object is contained.

Since:

BlackBerry 10.0.0

QString description

The description of this object.

Since:

BlackBerry 10.0.0

QString geoId

The ID of this Geographic object.

Since:

BlackBerry 10.2.0

QString id

Deprecated

Use the geoId property instead.

QString name

The name of this object.

Since:

BlackBerry 10.0.0

QString styleFamily

The style family to be used in conjunction with this element.

Since:

BlackBerry 10.2.0

Public Functions

GeoDeviceLocation (
QObject *parent)

Creates an instance of GeoDeviceLocation.

Parameters
parent	The QObject parent of this object.

Since:

BlackBerry 10.2.0

GeoDeviceLocation (
const QString &id,
QObject *parent )

Creates an instance of GeoDeviceLocation.

Parameters
id	The identifier for this Geographic. It is up to the caller to ensure the uniqueness of Geographic IDs.
parent	The QObject parent of this object.

Since:

BlackBerry 10.2.0

virtual~GeoDeviceLocation ()

Destructor.

Since:

BlackBerry 10.2.0

bb::platform::geo::Marker deviceDirectionalMarker ()

Retrieves the marker used to indicate this location when the device's heading is valid.

See Directional Device Marker for more information.

Return:

The device's marker when the heading is valid.

Since:

BlackBerry 10.2.0

bb::platform::geo::Marker deviceDirectionlessMarker ()

Retrieves the marker used to indicate this location when the device's heading is invalid.

See Directionless Device Marker for more information.

Return:

The device's marker when the heading is invalid.

Since:

BlackBerry 10.2.0

double heading ()

Retrieves the bearing to true north from the direction of travel, in degrees.

This property is undefined if headingValid is false.

Return:

The device's bearing.

Since:

BlackBerry 10.2.0

bool isHeadingValid ()

Determines if the heading property contains valid information.

Return:

true if the heading property contains valid information, false otherwise.

Since:

BlackBerry 10.2.0

bool isValid ()

Retrieves the validity of the device's location.

Return:

true if the device's location is valid, false otherwise.

Since:

BlackBerry 10.3.0

bb::platform::geo::Point point ()

Retrieves the point.

Since:

BlackBerry 10.2.0

float pointAccuracy ()

Retrieves the accuracy of the provided latitude-longitude values, in meters.

Return:

The accuracy.

Since:

BlackBerry 10.2.0

Q_SLOT void resetDeviceDirectionalMarker ()

Resets the directional marker to the default icon.

See Directional Device Marker for more information.

Since:

BlackBerry 10.2.0

Q_SLOT void resetDeviceDirectionlessMarker ()

Resets the directionless marker to the default icon.

See Directionless Device Marker for more information.

Since:

BlackBerry 10.2.0

Q_SLOT void setDeviceDirectionalMarker (
const bb::platform::geo::Marker &marker)

Sets the marker used to indicate this location when the device's heading is valid.

See Directional Device Marker for more information.

Parameters
marker	The new marker.

Since:

BlackBerry 10.2.0

Q_SLOT void setDeviceDirectionlessMarker (
const bb::platform::geo::Marker &marker)

Sets the marker used to indicate this location when the device's heading is invalid.

See Directionless Device Marker for more information.

Parameters
marker	The new marker.

Since:

BlackBerry 10.2.0

float speed ()

Retrieves the ground speed, in meters/sec.

Return:

The ground speed.

Since:

BlackBerry 10.2.0

virtualbb::platform::geo::BoundingBox boundingBox ()

Retrieves the axis-aligned bounding box for this Geographic.

Since:

BlackBerry 10.0.0

QString description ()

Gets the description of this Geographic.

Since:

BlackBerry 10.0.0

Geographic (
QObject *parent)

Constructor.

If no ID is supplied when constructing a Geographic entity, an ID that is guaranteed to be unique will be auto-generated.

Parameters
parent	The parent of this Geographic.

Since:

BlackBerry 10.0.0

Geographic (
const QString &id,
QObject *parent )

Constructor.

Parameters
id	The identifier for this Geographic.
parent	The parent of this Geographic.

Since:

BlackBerry 10.0.0

QString geoId ()

Gets the unique identifier for this Geographic.

If two Geographics are attribute-wise equal, they still need to have different IDs. The ID needs to be unique within a process.

Since:

BlackBerry 10.2.0

QString id ()

Deprecated

Use geoId() instead.

QString name ()

Gets the name of this Geographic.

Since:

BlackBerry 10.0.0

Q_SLOT void setDescription (
const QString &desc)

Sets the description of this Geographic.

Since:

BlackBerry 10.0.0

Q_SLOT void setGeoId (
const QString &id)

Sets the ID of this Geographic.

Since:

BlackBerry 10.2.0

Q_SLOT void setId (
const QString &id)

Deprecated

Use setGeoId() instead.

Q_SLOT void setName (
const QString &name)

Sets the name of this Geographic.

Since:

BlackBerry 10.0.0

Q_SLOT void setStyleFamily (
const QString &styleFamily)

Sets the style family for this Geographic.

Parameters
styleFamily	The new style family for this element.

Since:

BlackBerry 10.2.0

QString styleFamily ()

Gets the style family for this Geographic.

Since:

BlackBerry 10.2.0

Protected Functions

(Only has inherited protected functions)

void setBoundingBox (
const bb::platform::geo::BoundingBox &newBox)

Signals

void deviceDirectionalMarkerChanged (
const bb::platform::geo::Marker &newMarker)

Emitted when the directional marker changes.

See Directional Device Marker for more information.

Parameters
newMarker	The new marker.

Since:

BlackBerry 10.2.0

void deviceDirectionlessMarkerChanged (
const bb::platform::geo::Marker &newMarker)

Emitted when the directionless marker changes.

See Directionless Device Marker for more information.

Parameters
newMarker	The new marker.

Since:

BlackBerry 10.2.0

void headingChanged (
doubleheading)

Emitted when the device changes direction.

Parameters
heading	The new direction for the device.

Since:

BlackBerry 10.2.0

void headingValidityChanged (
boolheadingValidity)

Emitted when the heading's validity property changes.

Parameters
headingValidity	The new state of the heading's validity.

Since:

BlackBerry 10.2.0

void pointAccuracyChanged (
floataccuracy)

Emitted when the accuracy of the device's location changes.

Parameters
accuracy	The location's new accuracy.

Since:

BlackBerry 10.2.0

void pointChanged (
const bb::platform::geo::Point &point)

Emitted when the device's location has changed.

Parameters
point	The new location for the device.

Since:

BlackBerry 10.2.0

void speedChanged (
floatspeed)

Emitted when the device's speed changes.

Parameters
speed	The device's new speed.

Since:

BlackBerry 10.2.0

void validChanged (
boolvalid)

Emitted when the validity of the device's location changes.

Parameters
valid	true if the device's location has become valid, false if the device's location has become invalid.

Since:

BlackBerry 10.3.0

void boundaryChanged (
const bb::platform::geo::BoundingBox &box)

Emitted by derived classes when the bounding box has changed.

See the BoundingBox documentation.

Since:

BlackBerry 10.0.0

void descriptionChanged (
const QString &desc)

Emitted when the description of this Geographic changes.

Since:

BlackBerry 10.0.0

void geoIdChanged (
const QString &id)

Emitted when the ID of this Geographic changes.

Since:

BlackBerry 10.2.0

void idChanged (
const QString &id)

Deprecated

Use geoIdChanged() instead.

void nameChanged (
const QString &name)

Emitted when the name of this Geographic changes.

Since:

BlackBerry 10.0.0

void styleFamilyChanged (
const QString &newFamily)

Emitted when the style family attribute changes.

Since:

BlackBerry 10.2.0

void topographyChanged (
const QString &id)

Emitted when the topography of this Geographic changes.

A Geographic's topography captures the location (or geographic) properties of the element.

Parameters
id	The ID of this Geographic.

Since:

BlackBerry 10.1.0

Overview

Inheritance

Properties Index

Public Functions Index

Protected Functions Index

Signals Index

Properties

bb::platform::geo::Marker deviceDirectionalMarker

bb::platform::geo::Marker deviceDirectionlessMarker

double heading[read-only]

bool headingValid[read-only]

bb::platform::geo::Point point[read-only]

float pointAccuracy[read-only]

float speed[read-only]

bool valid[read-only]

bb::platform::geo::BoundingBox boundingBox[read-only]

QString description

QString geoId

QString id

QString name

QString styleFamily

Public Functions

GeoDeviceLocation (QObject *parent)

GeoDeviceLocation (const QString &id, QObject *parent )

virtual~GeoDeviceLocation ()

bb::platform::geo::Marker deviceDirectionalMarker ()

bb::platform::geo::Marker deviceDirectionlessMarker ()

double heading ()

bool isHeadingValid ()

bool isValid ()

bb::platform::geo::Point point ()

float pointAccuracy ()

Q_SLOT void resetDeviceDirectionalMarker ()

Q_SLOT void resetDeviceDirectionlessMarker ()

Q_SLOT void setDeviceDirectionalMarker (const bb::platform::geo::Marker &marker)

Q_SLOT void setDeviceDirectionlessMarker (const bb::platform::geo::Marker &marker)

float speed ()

virtualbb::platform::geo::BoundingBox boundingBox ()

QString description ()

Geographic (QObject *parent)

Geographic (const QString &id, QObject *parent )

QString geoId ()

QString id ()

QString name ()

Q_SLOT void setDescription (const QString &desc)

Q_SLOT void setGeoId (const QString &id)

Q_SLOT void setId (const QString &id)

Q_SLOT void setName (const QString &name)

Q_SLOT void setStyleFamily (const QString &styleFamily)

QString styleFamily ()

Protected Functions

void setBoundingBox (const bb::platform::geo::BoundingBox &newBox)

Signals

void deviceDirectionalMarkerChanged (const bb::platform::geo::Marker &newMarker)

void deviceDirectionlessMarkerChanged (const bb::platform::geo::Marker &newMarker)

void headingChanged (doubleheading)

void headingValidityChanged (boolheadingValidity)

void pointAccuracyChanged (floataccuracy)

void pointChanged (const bb::platform::geo::Point &point)

void speedChanged (floatspeed)

void validChanged (boolvalid)

void boundaryChanged (const bb::platform::geo::BoundingBox &box)

void descriptionChanged (const QString &desc)

void geoIdChanged (const QString &id)

void idChanged (const QString &id)

void nameChanged (const QString &name)

void styleFamilyChanged (const QString &newFamily)

void topographyChanged (const QString &id)

1. Choose your focus

2. Download the tools

3. Try the sample apps

4. Educate yourself

5. Start developing

GeoDeviceLocation (
QObject *parent)

GeoDeviceLocation (
const QString &id,
QObject *parent )

Q_SLOT void setDeviceDirectionalMarker (
const bb::platform::geo::Marker &marker)

Q_SLOT void setDeviceDirectionlessMarker (
const bb::platform::geo::Marker &marker)

Geographic (
QObject *parent)

Geographic (
const QString &id,
QObject *parent )

Q_SLOT void setDescription (
const QString &desc)

Q_SLOT void setGeoId (
const QString &id)

Q_SLOT void setId (
const QString &id)

Q_SLOT void setName (
const QString &name)

Q_SLOT void setStyleFamily (
const QString &styleFamily)

void setBoundingBox (
const bb::platform::geo::BoundingBox &newBox)

void deviceDirectionalMarkerChanged (
const bb::platform::geo::Marker &newMarker)

void deviceDirectionlessMarkerChanged (
const bb::platform::geo::Marker &newMarker)

void headingChanged (
doubleheading)

void headingValidityChanged (
boolheadingValidity)

void pointAccuracyChanged (
floataccuracy)

void pointChanged (
const bb::platform::geo::Point &point)

void speedChanged (
floatspeed)

void validChanged (
boolvalid)

void boundaryChanged (
const bb::platform::geo::BoundingBox &box)

void descriptionChanged (
const QString &desc)

void geoIdChanged (
const QString &id)

void idChanged (
const QString &id)

void nameChanged (
const QString &name)

void styleFamilyChanged (
const QString &newFamily)

void topographyChanged (
const QString &id)