CigiBaseSymbolTextDef.h

Go to the documentation of this file.

#if !defined(_CIGI_BASE_SYMBOL_TEXT_DEF_INCLUDED_)
#define _CIGI_BASE_SYMBOL_TEXT_DEF_INCLUDED_


#include "CigiBaseVariableSizePckt.h"

#include <string>

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

#define CIGI_SYMBOL_TEXT_DEFINITION_PACKET_ID_V3_3 30
#define CIGI_SYMBOL_TEXT_DEFINITION_PACKET_SIZE_V3_3 12


class CigiSymbolTextDefV3_3;


//=========================================================
class CIGI_SPEC CigiBaseSymbolTextDef :
   public CigiBaseVariableSizePckt
{

   friend class CigiSymbolTextDefV3_3;

public:


   //=========================================================
   enum AlignmentGrp
   {
      TopLeft=0,
      TopCenter=1,
      TopRight=2,
      CenterLeft=3,
      Center=4,
      CenterRight=5,
      BottomLeft=6,
      BottomCenter=7,
      BottomRight=8,
   };

   //=========================================================
   enum OrientationGrp
   {
      LeftToRight=0,
      TopToBottom=1,
      RightToLeft=2,
      BottomToTop=3,
   };


   //==> Management

   //=========================================================
   CigiBaseSymbolTextDef(void);

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

   //=========================================================
   CigiBaseSymbolTextDef(const CigiBaseSymbolTextDef &BaseIn);

   //=========================================================
   CigiBaseSymbolTextDef & operator=(const CigiBaseSymbolTextDef &BaseIn);


   //==> 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 GetTruePacketSize(CigiBaseVariableSizePckt &refPacket)
   { return(PacketSize + refPacket.GetVariableDataSize()); }

   //=========================================================
        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); }
   

   //+> Alignment

   //=========================================================
   int SetAlignment(const AlignmentGrp AlignmentIn, bool bndchk=true);

   //=========================================================
   AlignmentGrp GetAlignment(void) const { return(Alignment); }


   //+> Orientation

   //=========================================================
   int SetOrientation(const OrientationGrp OrientationIn, bool bndchk=true);

   //=========================================================
   OrientationGrp GetOrientation(void) const { return(Orientation); }


   //+> FontID

   //=========================================================
   int SetFontID(const Cigi_uint8 FontIDIn, bool bndchk=true)
   {
      FontID = FontIDIn;
      return(CIGI_SUCCESS);
   }

   //=========================================================
   Cigi_uint8 GetFontID(void) const { return(FontID); }


   //+> FontSize

   //=========================================================
   int SetFontSize(const float FontSizeIn, bool bndchk=true);

   //=========================================================
   float GetFontSize(void) const { return(FontSize); }


   //+> Text

   //=========================================================
   int SetText(const std::string &TextIn, bool bndchk=true);

   //=========================================================
   int GetTextSize(void) const { return(VariableDataSize); }

   //=========================================================
   const std::string & GetText(void) { return(Text); }



protected:

   //==> Member variables

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

   //=========================================================
   AlignmentGrp Alignment;

   //=========================================================
   OrientationGrp Orientation;

   //=========================================================
   Cigi_uint8 FontID;

   //=========================================================
   float FontSize;

   //=========================================================
   std::string Text;

   //=========================================================
   static const int MaxCharCnt = 235;

};



#endif   //  #if !defined(_CIGI_BASE_SYMBOL_TEXT_DEF_INCLUDED_)

---