yocto_gps.h File Reference

#include "yocto_api.h"
#include <cfloat>
#include <cmath>
#include <map>

Include dependency graph for yocto_gps.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
class	YGps

Macros
#define	_Y_COORDSYSTEM_ENUM
#define	_Y_ISFIXED_ENUM
#define	Y_ALTITUDE_INVALID   (YAPI_INVALID_DOUBLE)
#define	Y_COMMAND_INVALID   (YAPI_INVALID_STRING)
#define	Y_DATETIME_INVALID   (YAPI_INVALID_STRING)
#define	Y_DILUTION_INVALID   (YAPI_INVALID_DOUBLE)
#define	Y_DIRECTION_INVALID   (YAPI_INVALID_DOUBLE)
#define	Y_GROUNDSPEED_INVALID   (YAPI_INVALID_DOUBLE)
#define	Y_LATITUDE_INVALID   (YAPI_INVALID_STRING)
#define	Y_LONGITUDE_INVALID   (YAPI_INVALID_STRING)
#define	Y_SATCOUNT_INVALID   (YAPI_INVALID_LONG)
#define	Y_UNIXTIME_INVALID   (YAPI_INVALID_LONG)
#define	Y_UTCOFFSET_INVALID   (YAPI_INVALID_INT)

Typedefs
typedef void(*	YGpsValueCallback) (YGps *func, const string &functionValue)

Enumerations
enum	Y_COORDSYSTEM_enum { Y_COORDSYSTEM_GPS_DMS = 0, Y_COORDSYSTEM_GPS_DM = 1, Y_COORDSYSTEM_GPS_D = 2, Y_COORDSYSTEM_INVALID = -1 }
enum	Y_ISFIXED_enum { Y_ISFIXED_FALSE = 0, Y_ISFIXED_TRUE = 1, Y_ISFIXED_INVALID = -1 }

Functions
YGps *	yFindGps (const string &func)
YGps *	yFirstGps (void)

Macro Definition Documentation

#define _Y_COORDSYSTEM_ENUM

Definition at line 64 of file yocto_gps.h.

#define _Y_ISFIXED_ENUM

Definition at line 56 of file yocto_gps.h.

#define Y_ALTITUDE_INVALID   (YAPI_INVALID_DOUBLE)

Definition at line 76 of file yocto_gps.h.

#define Y_COMMAND_INVALID   (YAPI_INVALID_STRING)

Definition at line 82 of file yocto_gps.h.

#define Y_DATETIME_INVALID   (YAPI_INVALID_STRING)

Definition at line 80 of file yocto_gps.h.

#define Y_DILUTION_INVALID   (YAPI_INVALID_DOUBLE)

Definition at line 75 of file yocto_gps.h.

#define Y_DIRECTION_INVALID   (YAPI_INVALID_DOUBLE)

Definition at line 78 of file yocto_gps.h.

#define Y_GROUNDSPEED_INVALID   (YAPI_INVALID_DOUBLE)

Definition at line 77 of file yocto_gps.h.

#define Y_LATITUDE_INVALID   (YAPI_INVALID_STRING)

Definition at line 73 of file yocto_gps.h.

#define Y_LONGITUDE_INVALID   (YAPI_INVALID_STRING)

Definition at line 74 of file yocto_gps.h.

#define Y_SATCOUNT_INVALID   (YAPI_INVALID_LONG)

Definition at line 72 of file yocto_gps.h.

#define Y_UNIXTIME_INVALID   (YAPI_INVALID_LONG)

Definition at line 79 of file yocto_gps.h.

#define Y_UTCOFFSET_INVALID   (YAPI_INVALID_INT)

Definition at line 81 of file yocto_gps.h.

Typedef Documentation

typedef void(* YGpsValueCallback) (YGps *func, const string &functionValue)

Definition at line 54 of file yocto_gps.h.

Enumeration Type Documentation

enum Y_COORDSYSTEM_enum

Enumerator
Y_COORDSYSTEM_GPS_DMS
Y_COORDSYSTEM_GPS_DM
Y_COORDSYSTEM_GPS_D
Y_COORDSYSTEM_INVALID

Definition at line 65 of file yocto_gps.h.

enum Y_ISFIXED_enum

Enumerator
Y_ISFIXED_FALSE
Y_ISFIXED_TRUE
Y_ISFIXED_INVALID

Definition at line 57 of file yocto_gps.h.

Function Documentation

YGps* yFindGps ( const string &  func )

inline

Retrieves a GPS for a given identifier. The identifier can be specified using several formats:

• FunctionLogicalName
• ModuleSerialNumber.FunctionIdentifier
• ModuleSerialNumber.FunctionLogicalName
• ModuleLogicalName.FunctionIdentifier
• ModuleLogicalName.FunctionLogicalName

This function does not require that the GPS is online at the time it is invoked. The returned object is nevertheless valid. Use the method YGps.isOnline() to test if the GPS is indeed online at a given time. In case of ambiguity when looking for a GPS by logical name, no error is notified: the first instance found is returned. The search is performed first by hardware name, then by logical name.

If a call to this object's is_online() method returns FALSE although you are certain that the matching device is plugged, make sure that you did call registerHub() at application initialization time.

Parameters

func	: a string that uniquely characterizes the GPS

Returns

a YGps object allowing you to drive the GPS.

Definition at line 449 of file yocto_gps.h.

YGps* yFirstGps ( void  )

inline

Starts the enumeration of GPS currently accessible. Use the method YGps.nextGps() to iterate on next GPS.

Returns

a pointer to a YGps object, corresponding to the first GPS currently online, or a NULL pointer if there are none.

Definition at line 460 of file yocto_gps.h.