CigiBaseSymbolClone.h

Go to the documentation of this file.

#if !defined(_CIGI_BASE_SYMBOL_CLONE_INCLUDED_)
#define _CIGI_BASE_SYMBOL_CLONE_INCLUDED_


#include "CigiBasePacket.h"

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

#define CIGI_SYMBOL_CLONE_PACKET_ID_V3_3 33
#define CIGI_SYMBOL_CLONE_PACKET_SIZE_V3_3 8


class CigiSymbolCloneV3_3;


//=========================================================
class CIGI_SPEC CigiBaseSymbolClone :
   public CigiBasePacket
{

   friend class CigiSymbolCloneV3_3;

public:


   //=========================================================
   enum SymbolSourceGrp
   {
      SymbolSrc=0,
      SymbolTemplateSrc=1
   };



   //==> Management

   //=========================================================
   CigiBaseSymbolClone(void);

   //=========================================================
   virtual ~CigiBaseSymbolClone(void);


   //==> 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

   //+> SymbolID

   //=========================================================
   int SetSymbolID(const Cigi_uint16 SymbolIDIn, bool bndchk=true)
   {
      SymbolID = SymbolIDIn;
      return(CIGI_SUCCESS);
   }

   //=========================================================
   Cigi_uint16 GetSymbolID(void) const { return(SymbolID); }
   

   //+> SourceType

   //=========================================================
   int SetSourceType(const SymbolSourceGrp SourceTypeIn, bool bndchk=true);

   //=========================================================
   SymbolSourceGrp GetSourceType(void) const { return(SourceType); }


   //+> SourceID

   //=========================================================
   int SetSourceID(const Cigi_uint16 SourceIDIn, bool bndchk=true)
   {
      SourceID = SourceIDIn;
      return(CIGI_SUCCESS);
   }

   //=========================================================
   Cigi_uint16 GetSourceID(void) const { return(SourceID); }
   


protected:

   //==> Member variables

   //=========================================================
   Cigi_uint16 SymbolID;

   //=========================================================
   SymbolSourceGrp SourceType;

   //=========================================================
   Cigi_uint16 SourceID;


};



#endif   //  #if !defined(_CIGI_BASE_SYMBOL_CLONE_INCLUDED_)

---