Container to hold the data values. More...
#include <TinyGPS++.h>
Public Member Functions | |
| TinyGPSLocation | getLocation () const |
| Get the location (latitude and longitude) | |
| TinyGPSDate | getDate () const |
| Get the date (year, month, day of month) | |
| TinyGPSTime | getTime () const |
| Get the time (hour, minute, second, centisecond) | |
| TinyGPSSpeed | getSpeed () const |
| Get the speed. | |
| TinyGPSCourse | getCourse () const |
| Get the course. | |
| TinyGPSAltitude | getAltitude () const |
| Get the altitude. | |
| TinyGPSAltitude | getGeoidSeparation () const |
| Get the Geo ID separation. More... | |
| TinyGPSInteger | getSatellites () const |
| Get the number of satellites. | |
| TinyGPSDecimal | getHDOP () const |
| Get the HDOP. More... | |
| void | copyDataTo (TinyGPSData &other) const |
| Copy the data in this object to another object, atomically. More... | |
Data Fields | |
| TinyGPSLocation | location |
| Location (latitude and longitude) More... | |
| TinyGPSDate | date |
| Get the date (year, month, day of month) More... | |
| TinyGPSTime | time |
| Get the time (hour, minute, second, centisecond) More... | |
| TinyGPSSpeed | speed |
| Get the speed. More... | |
| TinyGPSCourse | course |
| Get the course (direction of travel) More... | |
| TinyGPSAltitude | altitude |
| While this field is public, you should instead use getAltitude(). In multi-threaded mode, accessing this field directly is not safe, but for backward compatibility this field remains public. | |
| TinyGPSAltitude | geoidSeparation |
| Get the Geo ID separation. More... | |
| TinyGPSInteger | satellites |
| Get the number of satellites. More... | |
| TinyGPSDecimal | hdop |
| Get the HDOP. More... | |
Detailed Description
Container to hold the data values.
The TinyGPSPlus object has this as a public superclass so you can still access the location field, for example. However, it also means you can copy all of the values to a local variable if you want to.
Also, it's used internally so a temporary copy can be updated while parsing the GPS data. If the checksum is valid, then the data will be copied into the TinyGPSPlus superclass TinyGPSData. This is necessary to avoid reading half-written values or blocking for long periods of time when supporting multi-threaded mode.
For best thread safety, you should avoid using fields like location directly and instead should use methods like getLocation() to make a copy of the location data. This will assure that your data is valid and does not change while you are reading it.
Member Function Documentation
◆ copyDataTo()
|
inline |
Copy the data in this object to another object, atomically.
This is different than operator= because it uses a SINGLE_THREADED_BLOCK.
◆ getGeoidSeparation()
|
inline |
Get the Geo ID separation.
Geoid separation is difference between ellipsoid and mean sea level (in meters)
◆ getHDOP()
|
inline |
Get the HDOP.
HDOP: Acronym for horizontal dilution of precision. A measure of the geometric quality of a GPS satellite configuration in the sky. HDOP is a factor in determining the relative accuracy of a horizontal position. The smaller the DOP number, the better the geometry.
Field Documentation
◆ course
| TinyGPSCourse TinyGPSData::course |
Get the course (direction of travel)
While this field is public, you should instead use getCourse(). In multi-threaded mode, accessing this field directly is not safe, but for backward compatibility this field remains public.
◆ date
| TinyGPSDate TinyGPSData::date |
Get the date (year, month, day of month)
While this field is public, you should instead use getDate(). In multi-threaded mode, accessing this field directly is not safe, but for backward compatibility this field remains public.
◆ geoidSeparation
| TinyGPSAltitude TinyGPSData::geoidSeparation |
Get the Geo ID separation.
While this field is public, you should instead use getGeoidSeparation(). In multi-threaded mode, accessing this field directly is not safe, but for backward compatibility this field remains public.
◆ hdop
| TinyGPSDecimal TinyGPSData::hdop |
Get the HDOP.
While this field is public, you should instead use getHDOP(). In multi-threaded mode, accessing this field directly is not safe, but for backward compatibility this field remains public.
◆ location
| TinyGPSLocation TinyGPSData::location |
Location (latitude and longitude)
While this field is public, you should instead use getLocation(). In multi-threaded mode, accessing this field directly is not safe, but for backward compatibility this field remains public.
◆ satellites
| TinyGPSInteger TinyGPSData::satellites |
Get the number of satellites.
While this field is public, you should instead use getSatellites(). In multi-threaded mode, accessing this field directly is not safe, but for backward compatibility this field remains public.
◆ speed
| TinyGPSSpeed TinyGPSData::speed |
Get the speed.
While this field is public, you should instead use getSpeed(). In multi-threaded mode, accessing this field directly is not safe, but for backward compatibility this field remains public.
◆ time
| TinyGPSTime TinyGPSData::time |
Get the time (hour, minute, second, centisecond)
While this field is public, you should instead use getTime(). In multi-threaded mode, accessing this field directly is not safe, but for backward compatibility this field remains public.
The documentation for this class was generated from the following file:
- src/TinyGPS++.h
