Tezzeret  1
Tezzeret
Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
Geometrics::CTivaGpsUartSensor Class Referenceabstract
Inheritance diagram for Geometrics::CTivaGpsUartSensor:
Inheritance graph
[legend]
Collaboration diagram for Geometrics::CTivaGpsUartSensor:
Collaboration graph
[legend]

Public Member Functions

 CTivaGpsUartSensor (UInt8 iSubject, GmManagedArrayRingBuffer< uint8_t, GM_SIZE_OF_APP_DATA_QUEUE > *mainEventQueue)
 
virtual int Initialize (int iBoardID)=0
 
virtual Void OnPreProcessUartString (char *pscString)
 
virtual int WriteToStorage (UInt32 ui32Topic, char *pData, UInt32 iSize, GmStorage *psStorage, UInt32 ui32FormatId)
 
int TimeSinceLastGga ()
 
int TimeSinceLastRmc ()
 
double LastHorizontalDilutionOfPrecision ()
 
uint8_t LastFixQuality ()
 
virtual int ConvertToCustomRecord (UInt8 *pscUartData, UInt8 *pcCustomRecordBuffer)
 
- Public Member Functions inherited from Geometrics::GmUartLineSensor
 GmUartLineSensor (UInt8 iSubject, int iLineLength, int iMaxBuffered, GmManagedArrayRingBuffer< uint8_t, GM_SIZE_OF_APP_DATA_QUEUE > *mainEventQueue)
 
 GmUartLineSensor (UInt8 iSubject, int iLineLength, int iMaxBuffered, int iCustomRecordSize, GmManagedArrayRingBuffer< uint8_t, GM_SIZE_OF_APP_DATA_QUEUE > *mainEventQueue)
 
 GmUartLineSensor (UInt8 iSubject, int iLineLength, int iMaxBuffered, int iCustomRecordSize, UInt8 *puiBuffer, UInt32 uiBufferSize, GmManagedArrayRingBuffer< uint8_t, GM_SIZE_OF_APP_DATA_QUEUE > *mainEventQueue)
 
int Start ()
 
Void UartReadLoop ()
 
int WriteData (const char *pcData, unsigned int iDataSize, UInt32 ui32Topic)
 
- Public Member Functions inherited from Geometrics::GmBufferedSensor
 GmBufferedSensor (UInt8 iSubjectId, int iRingCount, int iDataSize, GmManagedArrayRingBuffer< uint8_t, GM_SIZE_OF_APP_DATA_QUEUE > *mainEventQueue)
 Constructor for derived classes, when it's OK to allocate a local buffer dynamically. More...
 
 GmBufferedSensor (UInt8 iSubjectId, int iRingCount, int iDataSize, UInt8 *puiBuffer, UInt32 uiBufferSize, GmManagedArrayRingBuffer< uint8_t, GM_SIZE_OF_APP_DATA_QUEUE > *mainEventQueue)
 Constructor used by most derived classes on memory-constrained systems. In this case the derived class provides a buffer, usually static, so that the buffer doesn't need to be allocated dynamically. More...
 
int Start ()
 
int ResetBuffers ()
 
Bool HasData ()
 
int ReadRecord (char *pcDestination, int iSize)
 The main interface for consumers of a sensors data to get that data. It simply copies the data in the sensor's buffer into the caller's buffer. It is up to the caller to know what to do with that data, and how to free any local memory. (This function should have been name ReadNextRecord)
 
virtual int DeleteNextRecord ()
 DeleteNextRecord allows a caller to discard the next record without retrieving it. The subclasses that implement DeleteNextRecord must be able to deal with any memory that needs to be freed, or other such concerns.
 
- Public Member Functions inherited from Geometrics::GmEventSource
void SetSensorId (int iSensorId)
 
int GetSensorId ()
 
- Public Member Functions inherited from Geometrics::GmStorage
virtual int Close (int iFileIndex)
 
virtual int EnterTransaction ()
 
virtual int LeaveTransaction ()
 
virtual int RollAndSynchFile ()
 
virtual int SelectSurveyEx (const char *strSurveyId)
 
virtual int IsDataStorage ()
 
virtual int GetLastError ()
 
virtual bool IsOpen ()
 
void SetDatasetId (const int iDataset)
 
int GetDatasetId (bool increment)
 
virtual int Shutdown ()
 

Static Public Member Functions

static double convertGpsPseudoFloat (double dPseudoFloat)
 
- Static Public Member Functions inherited from Geometrics::GmUartLineSensor
static int InitUarts (int iMaxUarts)
 
- Static Public Member Functions inherited from Geometrics::GmStorage
static int DecodeDownloadName (const char *szDownloadName, char *strSurveyId, char *strAcquisitionId, char *strFileName)
 

Public Attributes

long m_iLastGpgga
 
long m_iLastGprmc
 
uint8_t mLastFixQuality
 
double m_dLastHorizontalDilutionOfPrecision
 
uint32_t m_uiScaleTicksToSeconds
 
- Public Attributes inherited from Geometrics::GmUartLineSensor
Bool m_bPing
 
Bool m_bCustomRecord
 
UART_Handle m_uhUartHandle
 
static int m_static_iMaxUarts = 0
 
static int m_static_iNextUart = 0
 
- Public Attributes inherited from Geometrics::GmBufferedSensor
CChildRingBufferm_rbBuffer
 The local buffer into which the sensor or event source stores each of its events or measurements. When an item is committed to this buffer, it also adds an event (consisting of the sensor's subject ID) into the application main event queue. The full event or measurement remains here, until the application reads the subject ID out of the main queue and then asks this sensor object for the full information by calling ReadRecord.
 
UInt8 m_iSubjectId
 

Additional Inherited Members

- Static Public Attributes inherited from Geometrics::GmUartLineSensor
static GmUartLineSensor ** m_static_aulsUarts = NULL
 
- Static Public Attributes inherited from Geometrics::GmStorage
static int s_recordsPerFile = BLOCKS_PER_ACQUISITION_DATA_FILE
 
- Protected Member Functions inherited from Geometrics::GmUartLineSensor
void PauseRead ()
 
void UnpauseRead ()
 
- Protected Attributes inherited from Geometrics::GmUartLineSensor
Task_Handle m_thTask
 
bool m_boolInitialized
 
bool m_bReadPaused
 
int m_iLineLength
 
int m_iPrefixLength
 
int m_iCustomRecordSize
 
GeoIndexedStringWithHeaderm_pgiswhBuffer
 
int m_iIndexThisUart
 
UInt8 * m_caCustomRecordBuffer
 
- Protected Attributes inherited from Geometrics::GmEventSource
int m_iSensorId
 
- Protected Attributes inherited from Geometrics::GmStorage
bool m_bIsOpen
 
int m_iCurrentDataSetId
 
bool mIncrementDatasetId
 

Member Function Documentation

◆ WriteToStorage()

int CTivaGpsUartSensor::WriteToStorage ( UInt32  ui32Topic,
char *  pData,
UInt32  iSize,
GmStorage psStorage,
UInt32  ui32FormatId 
)
virtual

Virtual function, abstract in this class, called when a sensor should write its data to a storage or other event handler.

Parameters
ui32TopicHint to the storage (MQTT is one) about adding some topic or header information about the data. Not all storages use the hint.
pDataThe data to be written.
iSizeSize of the data to be written.
psStorageStorage or event handler to which the data will be written.
ui32FormatIdFormatting information to be used by the sensor. Within a single application, a sensor might be asked to write different formats to different storages or event handlers. Very likely the per-storage, per-mode information was stored in an instance of Geometrics::SensorStorageModeInfo.

Implements Geometrics::GmEventSource.


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