A location profile defines the configuration that should be applied to the location provider for one of a set of pre-defined Glympse platform states.
More...
#include <ILocationProfile.h>
|
|
virtual int32 | getProfile ()=0 |
| | Profile identifier - one of the CC::LOCATION_PROFILE_* values.
|
| |
| virtual int32 | getMode ()=0 |
| | Indicates whether the location provider should be started when the profile is applied. More...
|
| |
| virtual int32 | getSource ()=0 |
| | Specifies which source(s) should be used to query location data. More...
|
| |
| virtual double | getDistance ()=0 |
| | The minimum distance between location updates. More...
|
| |
| virtual double | getAccuracy ()=0 |
| | The desired accuracy of the location data. More...
|
| |
| virtual int32 | getFrequency ()=0 |
| | The minimum time interval between location updates. More...
|
| |
| virtual int32 | getPriority ()=0 |
| | Identifies how importants location updates are. More...
|
| |
| virtual int32 | getActivity ()=0 |
| | The type of user activity associated with the location updates. More...
|
| |
| virtual bool | isAutoPauseEnabled ()=0 |
| | A bool value indicating whether the location provider object may pause location updates. More...
|
| |
| virtual bool | isSignificantLocationChangeMonitoringEnabled ()=0 |
| | A bool value whether location provider object should enabled Significant Location Change Monitoring. More...
|
| |
| virtual bool | isEqual (const GCommon &o)=0 |
| | Compares this instance with the specified object and indicates if they are equal. More...
|
| |
|
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.
|
| |
|
| virtual | ~ICommon () |
| | Destructor is protected to deny explicit object deallocation. More...
|
| |
A location profile defines the configuration that should be applied to the location provider for one of a set of pre-defined Glympse platform states.
They are:
- Glympse is running in the background with no active outgoing tickets.
- Glympse is running in the foreground with no active outgoing tickets.
- Glympse is running (foreground or background) with at least one active outgoing ticket, but with ZERO watchers.
- Glympse is running (foreground or background) with at least one active outgoing ticket and at least one watcher.
Location profiles are intended to provide the host application with an opportunity to tune the behavior of the location provider in order to minimize battery consumption.
Profiles are created using the GLocationProfileBuilder object. Profiles are applied using ILocationManager::updateProfile().
| virtual double Glympse::ILocationProfile::getAccuracy |
( |
) | |
|
|
pure virtual |
The desired accuracy of the location data.
- Platform: iOS, BB, WinPhone
- Type: double
- Values (iOS):
- kCLLocationAccuracyBestForNavigation = -2
- kCLLocationAccuracyBest = -1
- Distance in meters [0..3000]
- Applied to (iOS): CLLocationManager.desiredAccuracy
- Values (BB):
- UNSPECIFIED (Best) = 0
- Distance in meters
- Applied to (BB): QGeoPositionInfoSource.setProperty("accuracy", float distance);
- Values (WinPhone):
- PositionAccuracy.High = ...internal mapping... = -2
- PositionAccuracy.Default = ...internal mapping... = -1
- Applied to (WinPhone): Geolocator.DesiredAccuracy
- Values (WinPhone Alternate):
- Distance in meters [0..3000]
- Applied to (WinPhone Alternate): Geolocator.DesiredAccuracyInMeters
| virtual int32 Glympse::ILocationProfile::getActivity |
( |
) | |
|
|
pure virtual |
The type of user activity associated with the location updates.
- Platform: iOS (6.0+)
- Type: int32 (CLActivityType)
- Values:
- CLActivityTypeOther = 1 (default)
- CLActivityTypeAutomotiveNavigation = 2
- CLActivityTypeFitness = 3
- CLActivityTypeOtherNavigation = 4
- Applied to: CLLocationManager.activityType
| virtual double Glympse::ILocationProfile::getDistance |
( |
) | |
|
|
pure virtual |
The minimum distance between location updates.
- Platform: iOS, Android, WinPhone
- Type: double
- Values (iOS):
- kCLDistanceFilterNone = -1
- Distance in meters
- Applied to (iOS): CLLocationManager.distanceFilter
- Values (Android):
- BEST = 0
- Distance in meters
- Applied to (Android): LocationManager.requestLocationUpdates(..., float minDistance, ...)
- Values (Fuse):
- BEST = 0
- Distance in meters Applied to (Fuse): LocationRequest.setSmallestDisplacement(float displacement)
- Values (WinPhone):
- BEST = 0
- Distance in meters
- Applied to (WinPhone): Geolocator.MovementThreshold
| virtual int32 Glympse::ILocationProfile::getFrequency |
( |
) | |
|
|
pure virtual |
The minimum time interval between location updates.
- Platform: Android, BB, WinPhone
- Type: int32
- Values (Android):
- BEST = 0
- Time in milliseconds
- Applied to (Android): LocationManager.requestLocationUpdates(..., long minTime, ...)
- Values (Fuse):
- BEST = 0
- Time in milliseconds Applied to (Fuse): LocationRequest.setInterval(long interval)
- Values (BB):
- UNSPECIFIED (Best) = 0
- Time in milliseconds
- Applied to (BB): QGeoPositionInfoSource.setUpdateInterval(int32 minTime)
- Values (WinPhone):
- BEST = 0
- Time in milliseconds
- Applied to (WinPhone): Geolocator.ReportInterval
| virtual int32 Glympse::ILocationProfile::getMode |
( |
) | |
|
|
pure virtual |
Indicates whether the location provider should be started when the profile is applied.
- Platform: iOS, Android
- Type: int32
- Values: One of the CC::LOCATION_MODE_* values.
| virtual int32 Glympse::ILocationProfile::getPriority |
( |
) | |
|
|
pure virtual |
Identifies how importants location updates are.
- Platform: Android (Fuse)
- Type: int32
- Values:
- PRIORITY_HIGH_ACCURACY = 100 (default)
- PRIORITY_BALANCED_POWER_ACCURACY = 102
- PRIORITY_NO_POWER = 105
- Applied to: LocationResult.setPriority(int priority)
| virtual int32 Glympse::ILocationProfile::getSource |
( |
) | |
|
|
pure virtual |
Specifies which source(s) should be used to query location data.
- Platform: Android, BB
- Type: int32 (bitmask)
- Values: Any combination of CC::LOCATION_SOURCE_* values.
| virtual bool Glympse::ILocationProfile::isAutoPauseEnabled |
( |
) | |
|
|
pure virtual |
A bool value indicating whether the location provider object may pause location updates.
- Platform: iOS (6.0+)
- Type: bool
- Values: true/false
- Applied to: LocationManager.pausesLocationUpdatesAutomatically
| virtual bool Glympse::ILocationProfile::isSignificantLocationChangeMonitoringEnabled |
( |
) | |
|
|
pure virtual |
A bool value whether location provider object should enabled Significant Location Change Monitoring.
- Platform: iOS (4.0+)
- Type: bool
- Values: true/false
- Applied to: LocationManager start/stopMonitoringSignificantLocationChanges()
The documentation for this struct was generated from the following file:
Public Member Functions inherited from Glympse::IComparable
1.8.4
