GPSInterface_Serial Class Reference
Implements serial GPS interface. More...
#include <GPSInterface_Serial.h>
Inheritance diagram for GPSInterface_Serial:
Collaboration diagram for GPSInterface_Serial:
Public Member Functions | |
| GPSInterface_Serial () | |
| Constructor - zero out everything. | |
| virtual | ~GPSInterface_Serial () |
| Destructor - shut down serial code. | |
| virtual wxString | Name () |
| Returns name of this GPS module. | |
| virtual EGPSStatus | GetData (wxGPSEvent *pGPSEvent) |
| Tries to get updated data from gps unit. | |
| virtual wxString | GetLastError () |
| Returns an explanation of the last error. | |
| virtual EGPSStatus | AutoDetect (wxThread *pThread) |
| Attempt to autodetect if a GPS unit is attached to a serial port. | |
Static Public Member Functions | |
| static bool | VerifyGPSChecksum (wxString strSentence) |
| Returns if the checksum on a gps sentence is valid or not. | |
Private Attributes | |
| double | m_fLastHeading |
| Last known heading. | |
| wxDateTime | m_tLastGPSSentence |
| Time of last valid GPS sentence. | |
| wxDateTime | m_tLastGPSLock |
| Time of last GPS lock. | |
| wxDateTime | m_tLastSerialActivity |
| Time of last serial activity. | |
| char | m_szBuffer [1024] |
| Receive buffer. | |
| Point | m_ptGPS |
| GPS coordinates. | |
| double | m_fSpeed |
| Speed. | |
| double | m_fHeading |
| Heading. | |
| double | m_fMinimumSpeedForHeading |
| Minimum speed the vehicle must be going in order to update the heading. | |
| bool | m_bSeenGPGGA |
| If the GPGGA sentence has been seen. | |
| bool | m_bSeenGPRMC |
| If the GPRMC sentence has been seen. | |
| bool | m_bSeenGPVTG |
| If the GPVTG sentence has been seen. | |
| long | m_nSatellites |
| Number of satellites used for lock. | |
| wxString | m_strFixType |
| String describing lock type. | |
| SSatelliteInfo | m_arSatellitesVisible [MAX_GPS_SATELLITES] |
| Satellites visible. | |
| int | m_nSatellitesVisible |
| bool | m_bSerialInitialized |
| If serial I/O init function has been called. | |
| wxString | m_strLastError |
| Last error message. | |
| wxThread * | m_pThread |
Detailed Description
Implements serial GPS interface.
Definition at line 46 of file GPSInterface_Serial.h.
Constructor & Destructor Documentation
| GPSInterface_Serial::GPSInterface_Serial | ( | ) |
| GPSInterface_Serial::~GPSInterface_Serial | ( | ) | [virtual] |
Member Function Documentation
| wxString GPSInterface_Serial::Name | ( | ) | [virtual] |
Returns name of this GPS module.
Implements IGPSInterface.
Definition at line 97 of file GPSInterface_Serial.cpp.
| IGPSInterface::EGPSStatus GPSInterface_Serial::GetData | ( | wxGPSEvent * | pGPSEvent | ) | [virtual] |
Tries to get updated data from gps unit.
- Parameters:
-
pGPSEvent Receives updated gps data.
- Returns:
- Status - either GPSStatusError for serious error, or GPSStatusOK if data was obtained.
Implements IGPSInterface.
Definition at line 173 of file GPSInterface_Serial.cpp.
| wxString GPSInterface_Serial::GetLastError | ( | ) | [virtual] |
Returns an explanation of the last error.
Implements IGPSInterface.
Definition at line 740 of file GPSInterface_Serial.cpp.
| IGPSInterface::EGPSStatus GPSInterface_Serial::AutoDetect | ( | wxThread * | pThread | ) | [virtual] |
Attempt to autodetect if a GPS unit is attached to a serial port.
- Parameters:
-
pThread Pointer to wxThread obtain this code is running in.
- Returns:
- Status - either GPSStatusOK if a gps unit was found and a lock was detected, or GPSStatusAutoDetectionGPSDetectedButNoLock if a gps unit was found, but wasn't locked, or GPSStatusAutoDetectionNoGPSDetected for no gps units.
Implements IGPSInterface.
Definition at line 760 of file GPSInterface_Serial.cpp.
| bool GPSInterface_Serial::VerifyGPSChecksum | ( | wxString | strSentence | ) | [static] |
Returns if the checksum on a gps sentence is valid or not.
- Parameters:
-
strSentence GPS sentence. May be CR-LF terminated. Should start with $.
- Returns:
- True if checksum valid, false otherwise.
Definition at line 111 of file GPSInterface_Serial.cpp.
Member Data Documentation
double GPSInterface_Serial::m_fLastHeading [private] |
wxDateTime GPSInterface_Serial::m_tLastGPSSentence [private] |
wxDateTime GPSInterface_Serial::m_tLastGPSLock [private] |
wxDateTime GPSInterface_Serial::m_tLastSerialActivity [private] |
char GPSInterface_Serial::m_szBuffer[1024] [private] |
Point GPSInterface_Serial::m_ptGPS [private] |
double GPSInterface_Serial::m_fSpeed [private] |
double GPSInterface_Serial::m_fHeading [private] |
double GPSInterface_Serial::m_fMinimumSpeedForHeading [private] |
Minimum speed the vehicle must be going in order to update the heading.
Definition at line 89 of file GPSInterface_Serial.h.
bool GPSInterface_Serial::m_bSeenGPGGA [private] |
bool GPSInterface_Serial::m_bSeenGPRMC [private] |
bool GPSInterface_Serial::m_bSeenGPVTG [private] |
long GPSInterface_Serial::m_nSatellites [private] |
wxString GPSInterface_Serial::m_strFixType [private] |
SSatelliteInfo GPSInterface_Serial::m_arSatellitesVisible[MAX_GPS_SATELLITES] [private] |
int GPSInterface_Serial::m_nSatellitesVisible [private] |
Definition at line 108 of file GPSInterface_Serial.h.
bool GPSInterface_Serial::m_bSerialInitialized [private] |
wxString GPSInterface_Serial::m_strLastError [private] |
wxThread* GPSInterface_Serial::m_pThread [private] |
Definition at line 116 of file GPSInterface_Serial.h.
The documentation for this class was generated from the following files:
