Location

java.lang.Object
- ohos.location.Location

```
public class Location
extends Object
```
Represents a data class that provides information about geographic locations.
Information about the geographic location includes the latitude, longitude, moving speed, moving direction, and timestamp.

从以下版本开始:

1

另请参阅:

Sequenceable

SystemCapability

SystemCapability.Location#LOCATION

构造器概要

构造器
构造器	说明
`Location(double latitude, double longitude)`	Creates a new `Location` object based on the specified longitude and latitude.
`Location(Location location)`	Creates a new `Location` object based on an original object.

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法	说明
`static float`	`calculateBearing(double startLatitude, double startLongitude, double endLatitude, double endLongitude)`	Estimates the azimuth between two longitude and latitude coordinates.
`static float`	`calculateDistance(double startLatitude, double startLongitude, double endLatitude, double endLongitude)`	Estimates the linear distance between two longitude and latitude coordinates, in unit of meters.
`float`	`getAccuracy()`	Obtains the predicted horizontal accuracy of the device at the current location, in unit of meters.
`PacMap`	`getAdditions()`	Obtains extended information about a `Location` object.
`double`	`getAltitude()`	Obtains the altitude of the current location.
`double`	`getDirection()`	Obtains the moving direction of the device at the current location, in unit of degrees.
`double`	`getLatitude()`	Obtains the latitude of the device at the current location, in unit of degrees.
`double`	`getLongitude()`	Obtains the longitude of the device at the current location, in unit of degrees.
`float`	`getSpeed()`	Obtains the estimated moving speed of the device at the current location, in unit of meters/second.
`long`	`getTimeSinceBoot()`	Obtains the actual time when the location is obtained, in unit of nanoseconds.
`long`	`getTimeStamp()`	Obtains the actual timestamp when the location is obtained, in unit of milliseconds.
`boolean`	`marshalling(Parcel out)`	Marshalls a `Location` object into a parcel.
`void`	`setAccuracy(float value)`	Sets the horizontal accuracy of the device at the current location, in unit of meters.
`void`	`setAdditions(PacMap additions)`	Sets extended information about a `Location` object.
`void`	`setAltitude(double value)`	Sets the altitude, in unit of meters.
`void`	`setDirection(double value)`	Sets the moving direction of the device at the current location, in unit of degrees.
`void`	`setLatitude(double value)`	Sets the latitude, in unit of degrees.
`void`	`setLongitude(double value)`	Sets the longitude, in unit of degrees.
`void`	`setSpeed(float value)`	Sets the moving speed, in unit of meters/second.
`void`	`setTimeSinceBoot(long value)`	Sets the actual time when the location is obtained, in unit of nanoseconds.
`void`	`setTimeStamp(long value)`	Sets the actual timestamp when the location is obtained, in unit of milliseconds.
`String`	`toString()`	Returns a string representation of this `Location` object.
`boolean`	`unmarshalling(Parcel in)`	Unmarshalls a `Location` object and updates its data.

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- 构造器详细资料
  - Location
```
public Location(Location location)
         throws IllegalArgumentException
```
    Creates a new Location object based on an original object.
    
    参数:
    
    location - Specifies the original Location object. The value cannot be null.
    
    抛出:
    
    IllegalArgumentException - Throws this exception if the value of the Location object is null.
    
    从以下版本开始:
    
    1
  - Location
```
public Location(double latitude,
                double longitude)
         throws IllegalArgumentException
```
    Creates a new Location object based on the specified longitude and latitude.
    Except the longitude and latitude, use default value 0 for remaining data fields, including the accuracy, altitude, moving speed, moving direction, and timestamp.
    
    参数:
    
    latitude - Specifies the latitude. The value range is [-90,90], in unit of degrees.
    
    longitude - Specifies the longitude. The value range is [-180,180], in unit of degrees.
    
    抛出:
    
    IllegalArgumentException - Throws this exception if the latitude is not within the range [-90, 90].
    
    IllegalArgumentException - Throws this exception if the longitude is not within the range [-180,180].
    
    从以下版本开始:
    
    1
- 方法详细资料
  - calculateBearing
```
public static float calculateBearing(double startLatitude,
                                     double startLongitude,
                                     double endLatitude,
                                     double endLongitude)
                              throws IllegalArgumentException
```
    Estimates the azimuth between two longitude and latitude coordinates.
    
    参数:
    
    startLatitude - Indicates the latitude of the start position. The value range is [-90,90].
    
    startLongitude - Indicates the longitude of the start position. The value range is [-180,180].
    
    endLatitude - Indicates the latitude of the end position. The value range is [-90,90].
    
    endLongitude - Indicates the longitude of the end position. The value range is [-180,180].
    
    返回:
    
    Returns the estimated azimuth between two longitude and latitude coordinates.
    
    抛出:
    
    IllegalArgumentException - Throws this exception if the latitude is out of range [-90,90] or the longitude is out of range [-180,180].
    
    从以下版本开始:
    
    5
  - calculateDistance
```
public static float calculateDistance(double startLatitude,
                                      double startLongitude,
                                      double endLatitude,
                                      double endLongitude)
                               throws IllegalArgumentException
```
    Estimates the linear distance between two longitude and latitude coordinates, in unit of meters.
    
    参数:
    
    startLatitude - Specifies the latitude of the start point. The value range is [-90,90], in unit of degrees.
    
    startLongitude - Specifies the longitude of the start point. The value range is [-180180], in unit of degrees.
    
    endLatitude - Specifies the latitude of the end point. The value range is [-90,90], in unit of degrees.
    
    endLongitude - Specifies the longitude of the end point. The value range is [-180,180], in unit of degrees.
    
    返回:
    
    Returns the distance between two longitude and latitude coordinates.
    
    抛出:
    
    IllegalArgumentException - Throws this exception if the latitude is not within the range [-90,90].
    
    IllegalArgumentException - Throws this exception if the longitude is not within the range [-180,180].
    
    从以下版本开始:
    
    1
  - getAdditions
```
public PacMap getAdditions()
```
    Obtains extended information about a Location object.
    The extended information is stored in PacMap.
    
    返回:
    
    Returns extended information about a Location object. The value is null if no valid data exists.
    
    从以下版本开始:
    
    1
    
    另请参阅:
    
    PacMap
  - setAdditions
```
public void setAdditions(PacMap additions)
```
    Sets extended information about a Location object.
    
    参数:
    
    additions - Specifies the PacMap object for storing extended information.
    
    从以下版本开始:
    
    1
    
    另请参阅:
    
    PacMap
  - getDirection
```
public double getDirection()
```
    Obtains the moving direction of the device at the current location, in unit of degrees.
    The moving direction indicates the azimuth for horizontal movement of the device at the current position.
    
    返回:
    
    Returns the azimuth for horizontal movement of the device at the current location. The value range is [0.0,360.0). The default value 0.0 indicates no valid azimuth data.
    
    从以下版本开始:
    
    1
  - setDirection
```
public void setDirection(double value)
                  throws IllegalArgumentException
```
    Sets the moving direction of the device at the current location, in unit of degrees.
    The moving direction indicates the azimuth for horizontal movement of the device at the current position.
    
    参数:
    
    value - Specifies the azimuth for horizontal movement of the device. The value range is [0.0,360.0).
    
    抛出:
    
    IllegalArgumentException - Throws this exception if the azimuth for horizontal movement is not within the range [0.0,360.0).
    
    从以下版本开始:
    
    1
  - setTimeSinceBoot
```
public void setTimeSinceBoot(long value)
```
    Sets the actual time when the location is obtained, in unit of nanoseconds.
    The time is a relative value compared with the time when the device is switched on.
    
    参数:
    
    value - Specifies the time when the location is obtained. The value must be greater than 0.0. The default value 0.0 indicates no valid time data.
    
    从以下版本开始:
    
    1
  - getTimeSinceBoot
```
public long getTimeSinceBoot()
```
    Obtains the actual time when the location is obtained, in unit of nanoseconds.
    The time obtained using Locator indicates the difference between the time when the Location object is generated and the time when the device is switched on.
    
    返回:
    
    Returns the difference between the time when the Location object is generated and the time when the device is switched on. The value must be greater than or equal to 0. The default value 0 indicates that no valid time data.
    
    从以下版本开始:
    
    1
  - getLatitude
```
public double getLatitude()
```
    Obtains the latitude of the device at the current location, in unit of degrees.
    The latitude obtained using Locator is based on the WGS 84 reference ellipsoid.
    
    返回:
    
    Returns the latitude of the device. The value range is [-90.0,90.0]. The default value 0.0 indicates no valid latitude data.
    
    从以下版本开始:
    
    1
  - setLatitude
```
public void setLatitude(double value)
                 throws IllegalArgumentException
```
    Sets the latitude, in unit of degrees.
    
    参数:
    
    value - Specifies the latitude. The value range is [-90.0,90.0].
    
    抛出:
    
    IllegalArgumentException - Throws this exception if the latitude is not within the range [-90.0,90.0].
    
    从以下版本开始:
    
    1
  - getLongitude
```
public double getLongitude()
```
    Obtains the longitude of the device at the current location, in unit of degrees.
    The longitude obtained using Locator is based on the WGS 84 reference ellipsoid.
    
    返回:
    
    Returns the longitude of the device. The value range is [-180.0,180.0]. The default value 0.0 indicates no valid longitude data.
    
    从以下版本开始:
    
    1
  - setLongitude
```
public void setLongitude(double value)
                  throws IllegalArgumentException
```
    Sets the longitude, in unit of degrees.
    
    参数:
    
    value - Specifies the longitude. The value range is [-180.0, 180.0].
    
    抛出:
    
    IllegalArgumentException - Throws this exception if the latitude is not within the range [-180.0, 180.0].
    
    从以下版本开始:
    
    1
  - getAltitude
```
public double getAltitude()
```
    Obtains the altitude of the current location.
    
    返回:
    
    Returns the altitude.
  - setAltitude
```
public void setAltitude(double value)
```
    Sets the altitude, in unit of meters.
    
    参数:
    
    value - Specifies the altitude.
    
    从以下版本开始:
    
    1
  - getAccuracy
```
public float getAccuracy()
```
    Obtains the predicted horizontal accuracy of the device at the current location, in unit of meters.
    Assume that the predicted horizontal accuracy is equal to a radius of 68% probability. If you draw a circle with this radius centering at the latitude and longitude coordinate of the device, there will be a 68% probability that the actual location is within the circle.
    
    返回:
    
    Returns the estimated horizontal accuracy. The value must be greater than or equal to 0.0. The default value 0.0 indicates no valid accuracy data.
    
    从以下版本开始:
    
    1
  - setAccuracy
```
public void setAccuracy(float value)
```
    Sets the horizontal accuracy of the device at the current location, in unit of meters.
    Assume that the predicted horizontal accuracy is equal to a radius of 68% probability. If you draw a circle with this radius centering at the latitude and longitude coordinate of the device, there will be a 68% probability that the actual location is within the circle.
    
    参数:
    
    value - Specifies the horizontal accuracy. The value must be greater than or equal to 0.0. The default value 0.0 indicates no valid accuracy data.
    
    从以下版本开始:
    
    1
  - getSpeed
```
public float getSpeed()
```
    Obtains the estimated moving speed of the device at the current location, in unit of meters/second.
    The moving speed is estimated with the ground as the reference.
    
    返回:
    
    Returns the moving speed of the device at the current location. The value is greater than 0.0. The default value 0.0 indicates that no moving speed data is available for the current location or that the device is static.
    
    从以下版本开始:
    
    1
  - setSpeed
```
public void setSpeed(float value)
```
    Sets the moving speed, in unit of meters/second.
    
    参数:
    
    value - Specifies the moving speed of the device. The value must be greater than or equal to 0.0. The default value 0.0 indicates no valid moving speed data.
    
    从以下版本开始:
    
    1
  - getTimeStamp
```
public long getTimeStamp()
```
    Obtains the actual timestamp when the location is obtained, in unit of milliseconds.
    The timestamp obtained using Locator indicates the Unix time (a relative time since January 1, 1970) when the Location object is generated.
    
    返回:
    
    Returns the timestamp when the location is obtained. The value must be greater than or equal to 0. The default value 0 indicates that no valid timestamp.
    
    从以下版本开始:
    
    1
  - setTimeStamp
```
public void setTimeStamp(long value)
```
    Sets the actual timestamp when the location is obtained, in unit of milliseconds.
    The timestamp is a relative time since January 1, 1970.
    
    参数:
    
    value - Specifies the timestamp when the location is obtained. The value must be greater than 0.0. The default value 0.0 indicates no valid timestamp.
    
    从以下版本开始:
    
    1
  - unmarshalling
```
public boolean unmarshalling(Parcel in)
```
    Unmarshalls a Location object and updates its data.
    Unmarshalling of Location objects is implemented using Sequenceable.
    
    参数:
    
    in - Specifies the Parcel object for unmarshalling a GeoAddress object. The value must not be null.
    
    返回:
    
    Returns true if unmarshaling is successful; returns false otherwise.
    
    从以下版本开始:
    
    1
    
    另请参阅:
    
    Parcel, Sequenceable
  - marshalling
```
public boolean marshalling(Parcel out)
```
    Marshalls a Location object into a parcel.
    Marshalling of Location objects is implemented using Sequenceable.
    
    参数:
    
    out - Specifies the Parcel object for marshalling a Location object. The value cannot be null.
    
    返回:
    
    Returns true if marshaling is successful; returns false otherwise.
    
    从以下版本开始:
    
    1
    
    另请参阅:
    
    Parcel, Sequenceable
  - toString
```
public String toString()
```
    Returns a string representation of this Location object.
    
    覆盖:
    
    toString 在类中 Object
    
    返回:
    
    Returns a string representation.
    
    从以下版本开始:
    
    5

类 Location

构造器概要

方法概要

从类继承的方法 java.lang.Object

构造器详细资料

Location

Location

方法详细资料

calculateBearing

calculateDistance

getAdditions

setAdditions

getDirection

setDirection

setTimeSinceBoot

getTimeSinceBoot

getLatitude

setLatitude

getLongitude

setLongitude

getAltitude

setAltitude

getAccuracy

setAccuracy

getSpeed

setSpeed

getTimeStamp

setTimeStamp

unmarshalling

marshalling

toString