interactMsg.h

Go to the documentation of this file.

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


#pragma once

#include "rtiMsConfig.h"
#include "rtiMsg.h"
#include "netParms.h"

class DtConnectionMgr;
class DtInteractionMsg;
class DtPhvps;
class DtInteractionClassInfo;
typedef void (*DtInteractionCb)(const DtInteractionMsg& inter, void* usr);


class DT_DLL_LRC DtInteractionMsg : public DtRtiMsg
{
public:

   DtInteractionMsg(DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER);

   virtual ~DtInteractionMsg();

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

   virtual void setHandle(DtInteractionClassHandle hand) = 0;
   virtual DtInteractionClassHandle handle() const = 0;

   virtual void setObjectHandle(DtInteractionClassHandle hand) = 0;
   virtual DtObjectInstanceHandle objectHandle() const = 0;

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

   virtual void setParams(const DtPhvps& theParameters, bool adjustBufferSize = true);

   virtual void getParams(DtPhvps& params, bool useMsgMemory,
      DtInteractionClassInfo const* classInfo=NULL) const;

   virtual unsigned long numParams() const;

public:

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

protected:

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

   virtual DtNetU32* channelPtr() const=0;

   virtual char* tagPtr() = 0;

   virtual DtNetParams* netParams() = 0;

   virtual DtNetBigParams* netBigParams() = 0;

   virtual DtNetParamValue* nextNetParam(char* netParamTail) const;

   virtual DtNetBigParamValue* nextNetBigParam(char* netParamTail) const;

   virtual void fillFromNetParams(
      const DtNetParams* netRepParams,
      DtPhvps& params,
      bool useMsgMemory,
      DtInteractionClassInfo const* classInfo=NULL) const;

   virtual void fillFromNetBigParams(
      const DtNetBigParams* netRepParams,
      DtPhvps& params,
      bool useMsgMemory,
      DtInteractionClassInfo const* classInfo=NULL) const;

   virtual void fillNetParams(
      const DtPhvps& theParameters,
      DtNetParams* netRepParams);
   virtual void fillNetBigParams(
      const DtPhvps& theParameters,
      DtNetBigParams* netRepParams);

   virtual void adjustBufferForParams(const DtPhvps& params);

   virtual unsigned long sizeNeededForNetParam(unsigned long paramOffset,
      unsigned long paramSize) const;

   virtual unsigned long sizeNeededForNetParams(unsigned long paramOffset,
      const DtPhvps& params) const;

   virtual int channelFieldSize() const;

   virtual int tagFieldSize() const;

   virtual int paramAlignPaddingSize(unsigned long offset) const;

   virtual DtInteractionMsg* self() const;

protected:

   DtRtiApiTagPtr myTag;
   int myParamHdrAlignment;
   int myParamListHdrSize;
   int myParamHdrSize;
   unsigned long myMaxParamSize;

protected:
   static bool theChannelIncluded;
};


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

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