diGuyCustomPdu.h

Go to the documentation of this file.

/*********************************************************************
** Copyright (c) 1992-2010 VT MAK
** All rights reserved.
*********************************************************************/

#ifndef bdiCustomPdu_H_
#define bdiCustomPdu_H_

#if DtDIS

#include <vl/dStateMsg.h>
#include <vl/dExerciseConn.h>
#include <vlpi/entityIdentifier.h>


typedef struct DtNetDIGuyCustomPdu
{
   DtNetPduHeader        DtHeader;
   DtNetU16              DtDIGuyMessageVersion;
   DtNetU16              DtDIGuyMessageId;
   DtNetEntityIdentifier DtEntityId;
   DtNetU8               DtDataSize;
   DtNetU8               DtData[1]; 
} DtNetDIGuyCustomPdu;

enum DtDIGuyCustomPduMsgId
{
   DtDIGuyMsgIdEscapeReserved = 0,
   DtDIGuyMsgIdSetCharType = 1,
   DtDIGuyMsgIdSetCharAppearance = 2,
   DtDIGuyMsgIdSetCharAction = 3,
   DtDIGuyMsgIdSetCharVisible = 4
};

class DtDIGuyCustomPdu;

typedef void (*DtDIGuyCustomPduCb)(DtDIGuyCustomPdu* pdu, void* usr);

class DT_DLL_VL DtDIGuyCustomPdu : public DtStateMsg
{
public:
   enum { PduStaticSize = 23 };

public:
   DtDIGuyCustomPdu(DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER);

   DtDIGuyCustomPdu(const DtNetDIGuyCustomPdu* initial,
      DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER);

   virtual ~DtDIGuyCustomPdu();

   DtDIGuyCustomPdu(const DtDIGuyCustomPdu& other);

   DtDIGuyCustomPdu& operator=(const DtDIGuyCustomPdu& other);

   //{@
   virtual DtNetDIGuyCustomPdu* netDIGuyCustomPdu();
   virtual const DtNetDIGuyCustomPdu* netDIGuyCustomPdu() const;

   // MJI - I think this should always be 7, according to the SDK
   // User's Guide.  Going to set it to 7 by default for now, and
   // this probably shouldn't be changed.
   //{@
   virtual void setMessageVersion(int version);
   virtual int messageVersion() const;

   //{@
   virtual void setMessageId(DtDIGuyCustomPduMsgId msgId);
   virtual DtDIGuyCustomPduMsgId messageId() const;

   //{@
   virtual void setEntityId(const DtEntityIdentifier& entId);
   virtual DtEntityIdentifier entityId() const;

   //{@
   virtual void setDataSize(unsigned int size);
   virtual unsigned int dataSize() const;

   virtual void addShort(short value);

   virtual void addLong(long value);  
   
   virtual void addFloat(float value);
 
   virtual void addString(const DtString& str);
  
   //{@
   virtual bool pullShort(short& value, unsigned int& byteoffset) const;
   virtual bool pullLong(long& value, unsigned int& byteoffset) const;
   virtual bool pullFloat(float& value, unsigned int& byteoffset) const;
   virtual bool pullString(DtString& value, unsigned int& byteoffset) const;

   //{@
   virtual void getData(unsigned char* buff) const;
   virtual void* data();
   void setData(unsigned char* data, int numBytes);

   virtual void printData() const;

   virtual void printDataToStream(std::ostream& stream) const;


public:
   static DtPdu* create(const DtNetPacket* initial,
      DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER);

   static void addCallback(DtExerciseConn* conn, DtDIGuyCustomPduCb cb, 
      void* usr);
   
   static void removeCallback(DtExerciseConn* conn, DtDIGuyCustomPduCb cb, 
      void* usr);

   static void setCustomPduKind(DtPduKind pduKind);
   static DtPduKind customPduKind();

protected:
   virtual DtPduKind internalGetPduKind() const;

protected:
   static DtPduKind theCustomPduKind;
};


#endif
#endif