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 | List of all members
GPSPacketProcessor Class Referenceabstract

Class for directly intercepting and processing TSIP packets. More...

#include <copernicus.h>

Public Member Functions

virtual ~GPSPacketProcessor ()
 
virtual PacketStatus gpsPacket (ReportType type, CopernicusGPS *gps)=0
 

Detailed Description

Class for directly intercepting and processing TSIP packets.

This provides a mechanism by which a client may make use of Trimble packets which are not directly monitored/implemented by this API.

Only packets not monitored by the CopernicusGPS class will be passed on to registered GPSPacketProcessors.

Constructor & Destructor Documentation

GPSPacketProcessor::~GPSPacketProcessor ( )
virtual

Member Function Documentation

virtual PacketStatus GPSPacketProcessor::gpsPacket ( ReportType  type,
CopernicusGPS gps 
)
pure virtual

Called when a new TSIP packet has arrived. The packet header (DLE byte and report ID) will have already been consumed.

This function must not leave the stream in the middle of a DLE escape sequence; that is to say an even number of DLE bytes must be consumed.

Parameters
typeType of TSIP report waiting in the serial stream.
gpsGPS module which intercepted the report.
Returns
A PacketStatus indicating the state of the stream.

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