updateMsg.h

Go to the documentation of this file.

/*********************************************************************
** Copyright (c) 1998 MaK Technologies, Inc.
** All rights reserved.
*********************************************************************/
/*********************************************************************
** $RCSfile: updateMsg.h,v $ $Revision: 1.25 $ $State: Exp $
*********************************************************************/


#ifndef DtUpdateMsg_H_
#define DtUpdateMsg_H_

#include "rtiMsConfig.h"
#include "rtiMsg.h"
#include "netAttrs.h"
#include "rtiObject.h"
#include "RIDparams.h"
class DtAhvps;
class DtAhvpBase;
class DtUpdateMsg;
class DtObjectClassInfo;

typedef void (*DtUpdateCb)(const DtUpdateMsg& msg, void* usr);

class DT_DLL_LRC DtUpdateMsg : public DtRtiMsg
{
public:

   DtUpdateMsg(DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER);

   virtual ~DtUpdateMsg();

   virtual void setClassHandle(DtObjectClassHandle hand) = 0;
   virtual DtObjectClassHandle classHandle() const = 0;

   virtual void setObjHandle(DtObjectInstanceHandle id) = 0;
   virtual DtObjectInstanceHandle objHandle() const = 0;

   virtual void setChannel(unsigned long handleValue);
   virtual unsigned long channel() const;

   virtual const char* objName() const;

   virtual DtRtiApiTagConstRef  tag() const;

   virtual void setAttrs(const DtAhvpBase& theAttributes, bool adjustBufferSize = true);

   virtual void getAttrs(DtAhvps& attrSetBuff,
      bool useMsgMemory,
      DtObjectClassInfo* objDesc=NULL,
      DtHandle regionSetHandle=DtDefaultRegionSetHandle, 
      DtRtiObject* obj=NULL,
      float tolerance=0.0) const;
   
   virtual unsigned long numAttrs() const;
   
public:

   static void setChannelIncluded(bool includeChannel);
   static bool channelIncluded();
   
protected:
   

   virtual void setObjName(const char* name, bool adjustBufferSize = true);

   virtual void setTag(DtRtiApiTagConstRef  tag, bool adjustBufferSize = true);

   virtual void setNameSize(int size) = 0;
   virtual int nameSize() const = 0;

   virtual void setTagSize(int size) = 0;
   virtual int tagSize() const = 0;

   virtual DtNetU32* channelPtr() const=0;

   virtual char* namePtr()=0;

   virtual char* tagPtr()=0;

   virtual DtNetAttrs* netAttrs() = 0;

   virtual DtNetBigAttrs* netBigAttrs() = 0;

   virtual DtNetAttrValue* nextNetAttr(char* netAttrTail) const;

   virtual DtNetBigAttrValue* nextNetBigAttr(char* netAttrTail) const;

   virtual void fillFromNetAttrs(
      const DtNetAttrs* netRepAttrs,
      DtAhvps& attrs,
      bool useMsgMemory,
      DtObjectClassInfo* objDesc=NULL,
      DtHandle regionSetHandle=DtDefaultRegionSetHandle,
      DtRtiObject* obj=NULL,
      float tolerance=0.0) const;

   virtual void fillFromNetBigAttrs(
      const DtNetBigAttrs* netAttrs,
      DtAhvps& attrs,
      bool useMsgMemory,
      DtObjectClassInfo* objDesc=NULL,
      DtHandle regionSetHandle=DtDefaultRegionSetHandle,
      DtRtiObject* obj=NULL,
      float tolerance=0.0) const;

   virtual void fillNetAttrs(
      const DtAhvpBase& theAttributes,
      DtNetAttrs* netRepAttrs);

   virtual void fillNetBigAttrs(
      const DtAhvpBase& attrs,
      DtNetBigAttrs* netAttrs);

   virtual void adjustBufferForAttrs(const DtAhvpBase& attrs);
   
   virtual unsigned long sizeNeededForNetAttr(unsigned long attrOffset,
      unsigned long attrSize) const;

   virtual unsigned long sizeNeededForNetAttrs(unsigned long offset, const DtAhvpBase& attrs) const;

   virtual int channelFieldSize() const;

   virtual int attributeFieldSize() const = 0;

   virtual int attrAlignPaddingSize(unsigned long offset) const;

   virtual DtUpdateMsg* self() const;

protected:
   DtRtiApiTagPtr myTag;
   int myAttrHdrAlignment;
   int myAttrListHdrSize;
   int myAttrHdrSize;
   unsigned long myMaxAttrSize;

protected:
   static bool theChannelIncluded;
};


inline DtUpdateMsg* DtUpdateMsg::self() const
{
   return const_cast<DtUpdateMsg*>( this );
}

inline bool DtUpdateMsg::channelIncluded()
{
   return theChannelIncluded;
}

#endif