GmMFAMDataSource.hpp

#ifndef GM_TIVA_MFAM_DATA_SOURCE_HPP_
#define GM_TIVA_MFAM_DATA_SOURCE_HPP_
 
#include "GmBufferedSensor.hpp"
 
#ifndef GMMFAMDATA_HPP_
#include <GmMfamData.hpp>
#endif
 
#include <GmRingBuffer.hpp>
#include <GmManagedRingBuffer.hpp>
#include <GmChildRingBuffer.hpp>
 
// TODO RHC document the meanings of all these.
 
#define OUT_MSG_LEN              32
// todo rhc should this be 24?
 
// Error codes.
//   As with all sensors, the base success code is
//   GM_SENSOR_OK, defined in the base CSensor header.
#define MFAM_FAILED_INIT 1
#define MFAM_FAILED      2
#define MFAM_BLOCK_COUNT 100
 
 
 
namespace Geometrics
{
  class GmMfamDataSource : public GmBufferedSensor
  {
    public:
    GmMfamDataSource    (UInt8                iSubjectId,
                            GmManagedArrayRingBuffer<uint8_t,GM_SIZE_OF_APP_DATA_QUEUE> *mainEventQueue);
    int             Start                   ();
    virtual    int  CheckCalibrate          (Bool                bForceCalibrate);
    int             SetSimpleSubsampleRate  (int                 iNewRate);
    int             ResetBuffers            (Bool                bForceCalibrate);
    virtual UInt16  SystemStatus            () { return m_static_iSystemStatus; };
    virtual int     WriteToStorage          (UInt32     ui32Topic,
                                          char      *pData,
                                          UInt32     iSize,
                                          GmStorage  *psStorage,
                                          UInt32     ui32FormatId);
    virtual void    Halt                    () = 0;
    Bool            IsSuperMag              ();
    Bool            MagOneDataValid         ();
    Bool            MagTwoDataValid         ();
    Bool            PpsLocked               ();
    Bool            PpsAvailable            ();
    static int      DecodeMagStartupStatus (UInt16   iMagStatus,
                                            char *strBuffer,
                                            int   iBufferLength);
    static int      DecodeMagOperatingStatus (UInt16   iMagStatus,
                                            char *strBuffer,
                                            int   iBufferLength);
    int             MagOneStartupStatusString      (char      *strBuffer,
                                           int        iBufferLength);
    int             MagTwoStartupStatusString      (char      *strBuffer,
                                           int        iBufferLength);
    int             MagOneOperatingStatusString      (char      *strBuffer,
                                           int        iBufferLength);
    int             MagTwoOperatingStatusString      (char      *strBuffer,
                                           int        iBufferLength);
    int             LastMagOneDataValue     (float     *pfDataValue);
    int             LastMagTwoDataValue     (float     *pfDataValue);
    UInt16          MagMainMode              ();
    UInt16          CompassStatus            ();
    bool           IsInStartup               ();
    Bool           SystemHasStartedUp        ();
    Bool           SystemFailed              ();
    #if GEO_MFAM_FULL_FILTER == GEO_TRUE
    void           SaveMonitorPacket        (IndexedMfamFilteredPacketWithHeader  *pMonitorPacket, Bool bFilter);
    #else
    void           SaveMonitorPacket        (MfamSpiPacket  *pMonitorPacket, Bool bFilter);
    #endif
    static UInt16            m_static_iSystemStatus;
    uint32_t                 mQueueFillTopThreshold,
                             mQueueFillRestartThreshold;
    protected:
 
    int            RecordStatus     (MfamSpiPacket   *pmspRecord);
 
    /*****************************************************/
    /* Keep one packet with which to keep status         */
    /*   information about the MFAM system.              */
    /*****************************************************/
    #if GEO_MFAM_FULL_FILTER == GEO_TRUE
    IndexedMfamFilteredPacketWithHeader      m_mspStatusPacket;
    #else
    MfamSpiPacket            m_mspStatusPacket;
    #endif
 
    static bool              m_static_boolInitialized;
    int                      m_iSimpleSubsampleRate;
    static int               m_static_iSubsampleCount;
 
    /**********************************************************************************/
    /* Keep an array of spi packets to track current status of the system. Each       */
    /*   packet tracks one aspect of the status. This avoids mixing                   */
    /*   the information, and because MFAM cycles through different uses for the      */
    /*   system and mag status fields.                                                */
    /* These records are for updating the UI about system status, not for real-time   */
    /*   response to events.                                                          */
    /**********************************************************************************/
    #define MAG_SPI_LAST_DATA   0
    #define MAG_SPI_SYS_STAT    0
    #define MAG_SPI_ONE_STAT    0
    #define MAG_SPI_TWO_STAT    0
    #define MAG_SPI_AUX_SERIAL  0
    #define MAG_SPI_AUX_ACCEL   1
    #define MAG_SPI_AUX_GYRO    2
    #define MAG_SPI_AUX_COMPASS 3
    #define MAG_SPI_TOTAL_RECORDS 4
    #if GEO_MFAM_FULL_FILTER == GEO_TRUE
    IndexedMfamFilteredPacketWithHeader  m_amspStatusRecords [MAG_SPI_TOTAL_RECORDS];
    #else
    MfamSpiPacket            m_amspStatusRecords [MAG_SPI_TOTAL_RECORDS];
    #endif
 
 };
 
} // End of namespace
 
#endif