|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjavax.microedition.location.Location
net.rim.device.api.gps.BlackBerryLocation
public class BlackBerryLocation
The BlackBerryLocation class represents the extended set of location information. This includes partial location data (satellite count and average satellite signal strengh) that is produced before a complete GPS position can be obtained, the GPS mode used to get the location, and the status of the GPS fix.
Just like a Location object, a BlackBerryLocation object may also be either 'valid' or 'invalid'. The validity can be queried using the isValid method. A valid Location object represents a location with valid coordinates. An invalid Location object doesn't have valid coordinates, but the getError() method can provide information about the reason why it was not possible to provide a valid Location. The periodic location updates to the LocationListener may return invalid Location objects if it isn't possible to determine the location.
Field Summary | ||
---|---|---|
static int |
FAILOVER_MODE_ON
Constant to indicate that the BlackBerryLocation object is produced as a result of a GPS failover. |
|
static int |
GPS_ERROR
Constant to indicate that the BlackBerryLocation object is produced as a result of a GPS error. |
|
static int |
GPS_FIX_COMPLETE
Constant to indicate that a complete GPS fix is available. |
|
static int |
GPS_FIX_PARTIAL
Constant to indicate that the GPS fix contains satellite tracking information only. |
|
static int |
GPS_FIX_UNAVAILABLE
Constant to indicate that a GPS fix is unavailable. |
|
static int |
SUBSEQUENT_MODE_ON
Constant to indicate that the BlackBerryLocation object is produced when the GPS uses a subsequent mode. |
Fields inherited from class javax.microedition.location.Location |
---|
MTA_ASSISTED, MTA_UNASSISTED, MTE_ANGLEOFARRIVAL, MTE_CELLID, MTE_SATELLITE, MTE_SHORTRANGE, MTE_TIMEDIFFERENCE, MTE_TIMEOFARRIVAL, MTY_NETWORKBASED, MTY_TERMINALBASED |
Method Summary | ||
---|---|---|
int |
getAverageSatelliteSignalQuality()
Returns the average satellite signal quality - Carrier to Noise Ratio in dB. |
|
int |
getDataSource()
This method returns the data source used to produce the GPS fix. |
|
int |
getError()
This method returns the error associated with the BlackBerryLocation object, if any. |
|
int |
getGPSMode()
Returns the mode used by the GPS system. |
|
int |
getSatelliteCount()
Returns the current number of satellite count in view. |
|
Enumeration |
getSatelliteInfo()
Returns the details of all satellites that were tracked. |
|
int |
getStatus()
This method returns the status of the BlackBerryLocation object. |
Methods inherited from class javax.microedition.location.Location |
---|
getAddressInfo, getCourse, getExtraInfo, getLocationMethod, getQualifiedCoordinates, getSpeed, getTimestamp, isValid |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final int GPS_FIX_UNAVAILABLE
public static final int GPS_FIX_PARTIAL
public static final int GPS_FIX_COMPLETE
public static final int GPS_ERROR
public static final int FAILOVER_MODE_ON
public static final int SUBSEQUENT_MODE_ON
Method Detail |
---|
public int getError()
public int getStatus()
GPS_FIX_UNAVAILABLE
GPS_FIX_PARTIAL
GPS_FIX_COMPLETE
GPS_ERROR
FAILOVER_MODE_ON
SUBSEQUENT_MODE_ON
public int getDataSource()
1 (GPSInfo.GPS_DEVICE_INTERNAL) - Internal GPS
2 (GPSInfo.GPS_DEVICE_BLUETOOTH) - Bluetooth GPS
public int getSatelliteCount()
public Enumeration getSatelliteInfo()
public int getGPSMode()
public int getAverageSatelliteSignalQuality()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Copyright 1999-2010 Research In Motion Limited. 295 Phillip Street, Waterloo, Ontario, Canada, N2L 3W8. All Rights Reserved.
Copyright 1993-2003 Sun Microsystems, Inc. 901 San Antonio Road, Palo Alto, California, 94303, U.S.A. All Rights Reserved.
Copyright 2002-2003 Nokia Corporation All Rights Reserved.
Java is a trademark of Sun Microsystems, Inc.