CigiBaseEventNotification.h

Go to the documentation of this file.

#if !defined(_CIGI_BASE_EVENT_NOTIFICATION_INCLUDED_)
#define _CIGI_BASE_EVENT_NOTIFICATION_INCLUDED_

#include "CigiBasePacket.h"

// ====================================================================
// preprocessor definitions
// ====================================================================

#define CIGI_EVENT_NOTIFICATION_PACKET_ID_V3 116
#define CIGI_EVENT_NOTIFICATION_PACKET_SIZE_V3 16


class CigiEventNotificationV3;


class CIGI_SPEC CigiBaseEventNotification : public CigiBasePacket
{

friend class CigiEventNotificationV3;

public:

   //==> Management

   //=========================================================
   CigiBaseEventNotification();

   //=========================================================
   virtual ~CigiBaseEventNotification();


   //==> Buffer Packing/Unpacking

   //=========================================================
   virtual int Pack(CigiBasePacket * Base, Cigi_uint8 * Buff, void *Spec) const=0;

   //=========================================================
   virtual int Unpack(Cigi_uint8 * Buff, bool Swap, void *Spec) =0;

   //=========================================================
        virtual int GetCnvt(CigiVersionID &CnvtVersion,
                       CigiCnvtInfoType::Type &CnvtInfo);



   //==> Accessing Member Variable Values functions

   //+> EventID

   //=========================================================
   int SetEventID(const Cigi_uint16 EventIDIn, bool bndchk=true)
   {
      EventID = EventIDIn;
      return(CIGI_SUCCESS);
   }

   //=========================================================
   Cigi_uint16 GetEventID(void) const { return(EventID); }



   //+> EventData

   //=========================================================
   int SetEventData(const Cigi_uint32 EventDataIn, int ndx, bool bndchk=true);

   //=========================================================
   int SetEventData(const Cigi_int32 EventDataIn, int ndx, bool bndchk=true);

   //=========================================================
   int SetEventData(const float EventDataIn, int ndx, bool bndchk=true);

   //=========================================================
   Cigi_uint32 GetULEventData(int ndx);

   //=========================================================
   Cigi_int32 GetLEventData(int ndx);

   //=========================================================
   float GetFEventData(int ndx);



protected:

   //==> Member variables

   //=========================================================
   Cigi_uint16 EventID;

   //=========================================================
   union EventDataGrp {
      Cigi_uint32 ul[3];
      Cigi_int32 l[3];
      float f[3];
   } EventData;


};

#endif // #if !defined(_CIGI_BASE_EVENT_NOTIFICATION_INCLUDED_)

---