Copernicus  1.0
An Arduino module for the Trimble Copernicus GPS receiver
 All Classes Files Functions Variables Enumerations Enumerator Friends Macros Groups
Public Member Functions | Public Attributes | Protected Attributes | Friends | List of all members
VelFix Struct Reference

Velocity fix. More...

#include <gpstype.h>

Public Member Functions

 VelFix ()
 
const XYZ_VFixgetXYZ () const
 
const ENU_VFixgetENU () const
 

Public Attributes

ReportType type
 Format of stored velocity fix. More...
 
XYZ_VFix xyz
 
ENU_VFix enu
 

Protected Attributes

union {
   XYZ_VFix   xyz
 
   ENU_VFix   enu
 
}; 
 

Friends

class CopernicusGPS
 

Detailed Description

Velocity fix.

Depending on the reporting mode of the receiver, this structure may store a report of type RPT_FIX_VEL_XYZ, RPT_FIX_VEL_ENU, or RPT_NONE. The stored type is indicated by VelFix.type; use one of the two access methods to obtain an object storing the actual velocity data. Access methods which don't currently correspond to the store type will return NULL.

If the report type is unknown, there is not yet a valid fix and all accessors will return NULL.

For example:

const VelFix &fix = gps.GetVelocityFix();
if (fix.type == RPT_FIX_VEL_ENU) {
    ENU_VFix fixdata = fix.getENU();
    // ...
} else {
    XYZ_VFix fixdata = fix.getXYZ();
    // ...
}

Constructor & Destructor Documentation

VelFix::VelFix ( )

Member Function Documentation

const ENU_VFix * VelFix::getENU ( ) const
const XYZ_VFix * VelFix::getXYZ ( ) const

Friends And Related Function Documentation

friend class CopernicusGPS
friend

Member Data Documentation

union { ... }
ENU_VFix VelFix::enu
ReportType VelFix::type

Format of stored velocity fix.

XYZ_VFix VelFix::xyz

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