Class GpsSatellite

Definition

Namespace:
Tizen.Location
Assembly:
Tizen.Location.dll

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

public class GpsSatellite
Inheritance
object
GpsSatellite

Constructors

View Source

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
System.ArgumentException

Thrown when an invalid argument is used.

Properties

View Source

ActiveCount

The count of active satellites.

Declaration
public int ActiveCount { get; }
Property Value
Type Description
int
Exceptions
Type Condition
System.InvalidOperationException

Thrown when the operation is invalid for the current state.
System.ArgumentException

Thrown when an invalid argument is used.
System.UnauthorizedAccessException

Thrown when the application has no privilege to use the location.
System.NotSupportedException

Thrown when the location is not supported.
View Source

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
int
Exceptions
Type Condition
System.ArgumentException

Thrown when an an invalid argument is used.
View Source

InViewCount

The count of satellites in view.

Declaration
public int InViewCount { get; }
Property Value
Type Description
int
Exceptions
Type Condition
System.InvalidOperationException

Thrown when the operation is invalid for the current state.
System.ArgumentException

Thrown when an invalid argument is used.
System.UnauthorizedAccessException

Thrown when the application has no privilege to use the location.
System.NotSupportedException

Thrown when the location is not supported.
View Source

Nmea

The NMEA data from the satellite.

Declaration
public string Nmea { get; }
Property Value
Type Description
string
Exceptions
Type Condition
System.InvalidOperationException

Thrown when the operation is invalid for the current state.
System.ArgumentException

Thrown when an invalid argument is used.
System.UnauthorizedAccessException

Thrown when the application has no privilege to use the location.
System.NotSupportedException

Thrown when the location is not supported.
View Source

Satellites

The list of satellites or last recorded satellites in view.

Declaration
public IList<SatelliteInformation> Satellites { get; }
Property Value
Type Description
System.Collections.Generic.IList<T><SatelliteInformation>
Exceptions
Type Condition
System.InvalidOperationException

Thrown when the operation is invalid for the current state.
System.ArgumentException

Thrown when an invalid argument is used.
System.UnauthorizedAccessException

Thrown when the application has no privilege to use the location.
System.NotSupportedException

Thrown when the location is not supported.

Events

View Source

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
System.EventHandler<TEventArgs><SatelliteStatusChangedEventArgs>
Exceptions
Type Condition
System.ArgumentException

Thrown when an invalid argument is used.
System.UnauthorizedAccessException

Thrown when the application has no privilege to use the location.
System.NotSupportedException

Thrown when the location is not supported.