Defines callbacks required by GlTools class. More...
#include <gltoolsapi.h>
Public Member Functions | |
virtual | ~GlToolsCallbacks () |
Define virtual destructor. | |
virtual int | OnNmeaOpen (const plain_char *pcName)=0 |
Request to Create/Open the NMEA output/request writer. | |
virtual void | OnNmeaClose (int writer)=0 |
Request to close the NMEA output/request writer. | |
virtual void | OnNmeaWrite (int writer, const plain_char *pcNmea, short sBuffSize)=0 |
Request to write NMEA to the output. | |
virtual void | OnNmeaCustom (int writer, const GL_FIX_STATUS &fixStatus)=0 |
Gives opportunity to generate a custom NMEA message per position fix. | |
virtual int | OnPutPendingEvent (GlToolsCbOnPendingEvent cb)=0 |
Request to call cb() function during the next event processing cycle. | |
virtual short | OnGetSyncInTime (GL_TIME *pstGlTime, UTC_TIME *pstUtcTime)=0 |
Query the status of the sync in time. | |
virtual unsigned long | OnRandomSleep (unsigned long) |
Sleep for random number of seconds. | |
virtual void | OnNmeaFactTest (int, const GL_FACT_TEST_STATUS *) |
Deprecated function. |
Defines callbacks required by GlTools class.
virtual short gltools::GlToolsCallbacks::OnGetSyncInTime | ( | GL_TIME * | pstGlTime, |
UTC_TIME * | pstUtcTime | ||
) | [pure virtual] |
Query the status of the sync in time.
pstGlTime | [out] GL time |
pstUtcTime | [out] UTC time |
virtual void gltools::GlToolsCallbacks::OnNmeaClose | ( | int | writer | ) | [pure virtual] |
Request to close the NMEA output/request writer.
writer | Handle to request writer implementation obtained from call to GpsHalNmeaOpen(). |
virtual void gltools::GlToolsCallbacks::OnNmeaCustom | ( | int | writer, |
const GL_FIX_STATUS & | fixStatus | ||
) | [pure virtual] |
Gives opportunity to generate a custom NMEA message per position fix.
writer | Id of NMEA writer implementation obtained from call to GpsHalNmeaOpen(). |
fixStatus | reference to structure with detailed position fix information, see GL_FIX_STATUS. |
virtual int gltools::GlToolsCallbacks::OnNmeaOpen | ( | const plain_char * | pcName | ) | [pure virtual] |
Request to Create/Open the NMEA output/request writer.
pcName | One of the request types defined here. |
virtual void gltools::GlToolsCallbacks::OnNmeaWrite | ( | int | writer, |
const plain_char * | pcNmea, | ||
short | sBuffSize | ||
) | [pure virtual] |
Request to write NMEA to the output.
writer | Id of writer implementation obtained from call to GpsHalNmeaOpen(). |
pcNmea | Storage location of properly formatted, valid NMEA sentence |
sBuffSize | length of NMEA sentence |
virtual int gltools::GlToolsCallbacks::OnPutPendingEvent | ( | GlToolsCbOnPendingEvent | cb | ) | [pure virtual] |
Request to call cb() function during the next event processing cycle.
Return | 0 on success |
virtual unsigned long gltools::GlToolsCallbacks::OnRandomSleep | ( | unsigned long | ) | [inline, virtual] |
Sleep for random number of seconds.
maxSec | Maximum number of seconds to sleep. |
Return | number of seconds spent in sleep or ~0ul RANDOM_SLEEP_NOT_SUPPORTED if RandomSleep() feature is not available. |