CigiSession.h

Go to the documentation of this file.

#if !defined(_CIGI_SESSION_INCLUDED_)
#define _CIGI_SESSION_INCLUDED_

#include "CigiOutgoingMsg.h"
#include "CigiIncomingMsg.h"
#include "CigiAnimationTable.h"



//=========================================================
class CIGI_SPEC CigiSession  
{
public:

   //=========================================================
   enum SessionTypeEnum
   {
      Host,
      IG
   };

   //==> Management

   //=========================================================
   virtual ~CigiSession();



   //==> Member functions


   //+> Cigi Version

   //=========================================================
        int SetCigiVersion(const int CigiVersionIn, bool bndchk=true)
   {
      return( SetCigiVersion(CigiVersionIn, 0, bndchk));
   }

   //=========================================================
        int SetCigiVersion(const int CigiVersionIn,
                      const int CigiMinorVersionIn,
                      bool bndchk=true)
   {
      CigiVersionID tCigiVer;
      tCigiVer.CigiMajorVersion = CigiVersionIn;
      tCigiVer.CigiMinorVersion = CigiMinorVersionIn;
      return(OutMsg.SetOutgoingCigiVersion(tCigiVer,bndchk));
   }

   //=========================================================
        int SetCigiVersion(CigiVersionID CigiVersionIn,
                      bool bndchk=true)
   {
      return(OutMsg.SetOutgoingCigiVersion(CigiVersionIn,bndchk));
   }

   //=========================================================
   //    Cigi Version of an incoming message received.
        void SetMostMatureReceivedCigiVersion(CigiVersionID &Version)
   {
      OutMsg.SetMostMatureReceivedCigiVersion(Version);
   }


   //=========================================================
   CigiVersionID GetCompleteCigiVersion(void)
   {
      return(OutMsg.GetOutgoingCigiVersion());
   }


   //=========================================================
   int GetCigiVersion(void)
   {
      return(OutMsg.GetOutgoingCigiVersion().CigiMajorVersion);
   }


   //=========================================================
   int GetCigiMinorVersion(void)
   {
      return(OutMsg.GetOutgoingCigiVersion().CigiMinorVersion);
   }


   //+> Managers

   //=========================================================
   CigiOutgoingMsg & GetOutgoingMsgMgr(void) { return(OutMsg); }

   //=========================================================
   CigiIncomingMsg & GetIncomingMsgMgr(void) { return(InMsg); }

   //=========================================================
   CigiAnimationTable & GetAnimationTableMgr(void) { return(ATbl); }


   //+> Interface Timing Method

   //=========================================================
   void SetSynchronous(bool Sync) { Synchronous = Sync; }

   //=========================================================
   bool IsSynchronous(void) { return(Synchronous); }


   //+> User Packet Management

   //=========================================================
        int RegisterUserPacket(CigiBasePacket *Packet,
                          Cigi_uint8 PacketID,
                          bool HostSend, bool IGSend)
   {
      int outMsgStatus = OutMsg.RegisterUserPacket(Packet,PacketID,HostSend,IGSend);
      int inMsgStatus  =  InMsg.RegisterUserPacket(Packet,PacketID,HostSend,IGSend);
      if( outMsgStatus == CIGI_SUCCESS && inMsgStatus == CIGI_SUCCESS )
         return CIGI_SUCCESS;
      else if( outMsgStatus == CIGI_SUCCESS )
         return inMsgStatus;
      else
         return outMsgStatus;
   }


   //+> Session Type

   //=========================================================
        bool IsHost(void)
   {
      return((SessionType == Host) ? true : false);
   }

   //=========================================================
        bool IsIG(void)
   {
      return((SessionType == IG) ? true : false);
   }



protected:

   //==> Member variables

   //=========================================================
   CigiOutgoingMsg OutMsg;

   //=========================================================
   CigiIncomingMsg InMsg;

   //=========================================================
   CigiAnimationTable ATbl;

   //=========================================================
   SessionTypeEnum SessionType;

   //=========================================================
   bool Synchronous;

   //=========================================================
   const CigiVersionID MostMatureKnownCigi;


   //==> Member Functions

   //=========================================================
   CigiSession(const int NumInBuf, const int InBufLen,
               const int NumOutBuf, const int OutBufLen,
               SessionTypeEnum SessionTypeIn);


};

#endif // !defined(_CIGI_SESSION_INCLUDED_)

---