Class GpsSatellite

Definition

Namespace:

Tizen.Location

Assembly:

Tizen.Location.dll

API Level:

3

This class contains the functionality for obtaining information about GPS satellites in the range and in use.

public class GpsSatellite

Inheritance

Object

GpsSatellite

Constructors

GpsSatellite(Locator)

The constructor of the GpsSatellite class.

Declaration

public GpsSatellite(Locator locator)

Parameters

Type	Name	Description
Locator	locator	The locator object initilized using GPS.

Exceptions

Type	Condition
ArgumentException	Thrown when an invalid argument is used.

API Level: 3

Properties

ActiveCount

The count of active satellites.

Declaration

public int ActiveCount { get; }

Property Value

Type	Description
Int32

Exceptions

Type	Condition
InvalidOperationException	Thrown when the operation is invalid for the current state.
ArgumentException	Thrown when an invalid argument is used.
UnauthorizedAccessException	Thrown when the application has no privilege to use the location.
NotSupportedException	Thrown when the location is not supported.

API Level: 3

Privilege Level: public

Privilege: http://tizen.org/privilege/location

Interval

The time interval between callback updates. Should be in the range of 1~120 seconds.

Declaration

public int Interval { get; set; }

Property Value

Type	Description
Int32

Exceptions

Type	Condition
ArgumentException	Thrown when an an invalid argument is used.

API Level: 3

InViewCount

The count of satellites in view.

Declaration

public int InViewCount { get; }

Property Value

Type	Description
Int32

Exceptions

Type	Condition
InvalidOperationException	Thrown when the operation is invalid for the current state.
ArgumentException	Thrown when an invalid argument is used.
UnauthorizedAccessException	Thrown when the application has no privilege to use the location.
NotSupportedException	Thrown when the location is not supported.

API Level: 3

Privilege Level: public

Privilege: http://tizen.org/privilege/location

Nmea

The NMEA data from the satellite.

Declaration

public string Nmea { get; }

Property Value

Type	Description
String

Exceptions

Type	Condition
InvalidOperationException	Thrown when the operation is invalid for the current state.
ArgumentException	Thrown when an invalid argument is used.
UnauthorizedAccessException	Thrown when the application has no privilege to use the location.
NotSupportedException	Thrown when the location is not supported.

API Level: 3

Satellites

The list of satellites or last recorded satellites in view.

Declaration

public IList<SatelliteInformation> Satellites { get; }

Property Value

Type	Description
IList<SatelliteInformation>

Exceptions

Type	Condition
InvalidOperationException	Thrown when the operation is invalid for the current state.
ArgumentException	Thrown when an invalid argument is used.
UnauthorizedAccessException	Thrown when the application has no privilege to use the location.
NotSupportedException	Thrown when the location is not supported.

API Level: 3

Privilege Level: public

Privilege: http://tizen.org/privilege/location

Events

SatelliteStatusUpdated

The SatelliteStatusUpdated event is raised whenever the satellite information is updated. The callback will be invoked periodically (every Interval seconds).

Declaration

public event EventHandler<SatelliteStatusChangedEventArgs> SatelliteStatusUpdated

Event Type

Type	Description
EventHandler<SatelliteStatusChangedEventArgs>

Exceptions

Type	Condition
ArgumentException	Thrown when an invalid argument is used.
UnauthorizedAccessException	Thrown when the application has no privilege to use the location.
NotSupportedException	Thrown when the location is not supported.

API Level: 3

Privilege Level: public

Privilege: http://tizen.org/privilege/location