GpsInterface Struct Reference

Represents the standard GPS interface. More...

#include <gps.h>


Data Fields

int(* init )(GpsCallbacks *callbacks)
 Opens the interface and provides the callback routines to the implemenation of this interface.
int(* start )(void)
 Starts navigating.
int(* stop )(void)
 Stops navigating.
void(* set_fix_frequency )(int frequency)
 Sets requested frequency of fixes in seconds.
void(* cleanup )(void)
 Closes the interface.
int(* inject_time )(GpsUtcTime time, int64_t timeReference, int uncertainty)
 Injects the current time.
void(* delete_aiding_data )(GpsAidingData flags)
 Specifies that the next call to start will not use the information defined in the flags.
int(* set_position_mode )(GpsPositionMode mode, int fix_frequency)
 fix_frequency represents the time between fixes in seconds.
const void *(* get_extension )(const char *name)
 Get a pointer to extension information.

Detailed Description

Represents the standard GPS interface.

Definition at line 183 of file gps.h.


Field Documentation

int(* GpsInterface::init)(GpsCallbacks *callbacks)

Opens the interface and provides the callback routines to the implemenation of this interface.

int(* GpsInterface::start)(void)

Starts navigating.

int(* GpsInterface::stop)(void)

Stops navigating.

void(* GpsInterface::set_fix_frequency)(int frequency)

Sets requested frequency of fixes in seconds.

void(* GpsInterface::cleanup)(void)

Closes the interface.

int(* GpsInterface::inject_time)(GpsUtcTime time, int64_t timeReference, int uncertainty)

Injects the current time.

Specifies that the next call to start will not use the information defined in the flags.

GPS_DELETE_ALL is passed for a cold start.

int(* GpsInterface::set_position_mode)(GpsPositionMode mode, int fix_frequency)

fix_frequency represents the time between fixes in seconds.

Set fix_frequency to zero for a single-shot fix.

const void*(* GpsInterface::get_extension)(const char *name)

Get a pointer to extension information.


The documentation for this struct was generated from the following file: