GmAppEvent.hpp

#ifndef GM_APP_EVENT_SENSOR_HPP_
#define GM_APP_EVENT_SENSOR_HPP_
 
#include <geotypes.hpp>
#include <GmMeta.hpp>
 
#include "GmBufferedSensor.hpp"
#include <GmRingBuffer.hpp>
#include <GmManagedRingBuffer.hpp>
#include <GmChildRingBuffer.hpp>
 
#ifndef GMMFAMDATA_HPP_
#include <GmMfamData.hpp>
#endif
 
 
//#define COUNT_APP_EVENT_BUFFERS         20
// Date size should align to 32-bit boundary.
#define MAX_APP_EVENT_DATA_SIZE             64
 
// Error codes.
//   As with all sensors, the base success code is
//   GM_SENSOR_OK, defined in the base CSensor header.
#define GM_APP_EVENT_FAILED_INIT  1
#define GM_APP_EVENT_FAILED       2
 
// =========================================================== //
// Event types.
// =========================================================== //
 
 
namespace Geometrics
{
   PACKED_PRAGMA
   typedef struct PACKED_SPEC  _AppEvent
   {
      _AppEvent (UInt32   uiEventCode,
                 UInt32   uiEventInfo,
                 UInt32   uiDataLength,
                 const char    *caData);
      _AppEvent () {};
      UInt32    m_uiEventCode; // Offset 0, size 4
      UInt32    m_uiEventInfo; // Offset 4, size 4
      UInt32    m_uiDataLength; // Offset 8, size 4
      char      m_caData[MAX_APP_EVENT_DATA_SIZE]; // Offset 12, size 64, total size 76
   } GmAppEvent ALIGN_4_SPEC ;
 
   PACKED_PRAGMA
   typedef struct PACKED_SPEC  _IndexedAppEvent
   {
   public:
      _IndexedAppEvent (uint64_t   uiIndex,
                        UInt32     uiEventCode,
                        UInt32     uiEventInfo,
                        UInt32     uiDataLength,
                        const char      *caData);
      _IndexedAppEvent () {};
      GmAppEvent    m_eEvent; // Offset 0, size 76
      uint64_t      m_uiIndex; // Offset 76, size 8, total record size 84
   } IndexedAppEvent ALIGN_4_SPEC ;
 
   PACKED_PRAGMA
   typedef struct PACKED_SPEC  _TypedAppEvent
   {
       public:
       int     m_iRecordType;  // Offset 0 - always GM_EVENT_FORMAT_BINARY_STORED
       int     m_iRecordSize;  // Offset 4 - size of this structure.
       IndexedAppEvent m_event; // Offset 8, size 84, total size 92.
    } TypedAppEvent ALIGN_4_SPEC ;
 
   PACKED_PRAGMA
   typedef struct PACKED_SPEC  _DatasetAppEvent
   {
   public:
      _DatasetAppEvent (int        iDataset,
                        uint64_t   uiIndex,
                        UInt32     uiEventCode,
                        UInt32     uiEventInfo,
                        UInt32     uiDataLength,
                        char      *caData);
      _DatasetAppEvent () {};
      int     mDataset;
      IndexedAppEvent m_event; // Offset 4, size 84, total size 88.
   } DatasetAppEvent ALIGN_4_SPEC;
 
 
   #if defined(acs) || defined (linux)
 
   /**************************************************************************/
   /* The default for GmAppEventSource is that all data is contained in the   */
   /*   event structure, i.e. no pointers to allocations.                    */
   /*   If new application event types allocation information, then either   */
   /*   this class becomes aware of it, or callers don't call DeleteNext     */
   /*   and manage the memory carefully.                                     */
   /**************************************************************************/
   class GmAppEventSource : public GmBufferedSensor
   {
      public:
      GmAppEventSource                   (UInt8                  iSubjectId,
                                         GmManagedArrayRingBuffer<uint8_t,GM_SIZE_OF_APP_DATA_QUEUE> *mainEventQueue);
      int            Initialize         ();
      void           ReadDataInternal   ();
 
      int            AddEvent           (UInt32          uiEventCode,
                                         UInt32          uiEventInfo,
                                         UInt32          uiDataLength,
                                         const char     *caData);
      int            WriteToStorage     (UInt32     ui32Topic,
                                         char      *pData,
                                         UInt32     iSize,
                                         GmStorage  *psStorage,
                                         UInt32     ui32FormatId);
 
   };
   #endif
}
 
#endif