geolocation_event_get_satellite_is_ephemeris

Indicate whether the ephemeris of the satellite at the specified index in the GEOLOCATION_INFO event has been decoded.

Synopsis:

#include <bps/geolocation.h>

BPS_API bool geolocation_event_get_satellite_is_ephemeris_decoded(bps_event_t *event,
                                                                  int satellite_index)

Since:

BlackBerry 10.0.0

Arguments:

event: The GEOLOCATION_INFO event to extract the satellite ephemeris decoded flag from.

satellite_index: The index of the satellite to extract the ephemeris decoded flag of. Must be in the range 0 to geolocation_event_get_num_satellites() - 1.

Library:

libbps (For the qcc command, use the -l bps option to link against this library)

Description:

The geolocation_event_get_satellite_is_ephemeris_decoded() function extracts whether the ephemeris of the satellite at the specified index in the GEOLOCATION_INFO event has been decoded. The ephemeris of a satellite provides precise orbit information for the satellite. A decoded ephemeris may aid in the acquisition of future fixes.

Returns:

true if the ephemeris of the satellite at the specified index has been decoded, false otherwise.