ownerMsg.h

Go to the documentation of this file.

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


#ifndef DtOwnershipMsg_H_
#define DtOwnershipMsg_H_

#include <rtiMsConfig.h>
#include <rtiMsg.h>
#include <netOwnerMsg.h>
#include <attrHandSet.h>

class DtConnectionMgr;
class DtOwnershipMsg;
typedef void (*DtOwnershipCb)(const DtOwnershipMsg& msg, void* usr);

enum DtOwnerMsgKind
{
   DtAcquire,
   DtAcquireIfAvail,
   DtCancelAcquire,
   DtCancelNegotiatedDivest,
   DtNegotiatedDivest,
   DtQueryOwner,
   DtUncondDivest,
   DtNotOwned,
   DtOwnedByRti,
   DtNotifyAcquire,
   DtOwnershipUnavail,
   DtConfirmCancelAcquire,
   DtInformOwner,
   DtGiveToLRC,
   DtResetOwner,
   DtMomTransfer,
   DtQueryAttrTransportType
};

class DT_DLL_LRC DtOwnershipMsg : public DtRtiMsg
{
public:

   DtOwnershipMsg(DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER);

   DtOwnershipMsg(
      DtOwnerMsgKind kind,
      DtObjectInstanceHandle objHand, 
      const DtAttributeHandleSet& attrs,
      DtFederateHandle targetFed = 0,
      DtRtiApiTagConstRef theTag=theDefaultTag,
      DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER);

   DtOwnershipMsg(
      DtOwnerMsgKind kind,
      DtObjectInstanceHandle objHand, 
      const DtAttributeHandle attr,
      DtFederateHandle targetFed = 0,
      DtRtiApiTagConstRef theTag=theDefaultTag,
      DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER);

   DtOwnershipMsg(const DtNetOwnershipMsg* netRepMsg,
      DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER);

   virtual ~DtOwnershipMsg();

   virtual DtRtiMsg* clone(bool copy = true) const; 

   virtual void set(
      DtOwnerMsgKind kind,
      DtObjectInstanceHandle objHand, 
      const DtAttributeHandleSet& attrs,
      DtFederateHandle targetFed = 0,
      DtRtiApiTagConstRef theTag = theDefaultTag);

   virtual void set (
      DtOwnerMsgKind kind,
      DtObjectInstanceHandle objHand, 
      const DtAttributeHandle attr,
      DtFederateHandle targetFed = 0,
      DtRtiApiTagConstRef theTag = theDefaultTag);

   virtual void setOwnerMsgKind(DtOwnerMsgKind kind);
   virtual DtOwnerMsgKind ownerMsgKind() const;

   virtual void setObjectHandle(DtObjectInstanceHandle handle);
   virtual DtObjectInstanceHandle objectHandle() const;

   virtual void setObjectName(char const * name);
   virtual char const * objectName() const;

   virtual void setClassHandle(DtObjectClassHandle handle);
   virtual DtObjectClassHandle classHandle() const;

   virtual void setTag(DtRtiApiTagConstRef tag);
   virtual DtRtiApiTagConstRef tag() const;

   virtual void setRecipientFederate(DtFederateHandle hand);
   virtual DtFederateHandle recipientFederate() const;

   virtual void setAttrHandles(const DtAttributeHandleSet& attrs);
   virtual const DtAttributeHandleSet& attrHandles() const;

   virtual const char* ownershipKindToString() const;

   virtual void printData(DtLogicalTimeFactory* logicalTimeFactory) const;

public:

   static const char* ownershipKindToString(DtOwnerMsgKind kind);


   static DtRtiMsg* create(const DtNetMsgHeader* initial, 
      DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER);    

   static DtRtiMsg* create(DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER);

   static void addCallback(DtConnectionMgr *conn, DtOwnershipCb cb, void *usr);
   static void removeCallback(DtConnectionMgr *conn, DtOwnershipCb cb, void *usr);
   
protected:

   virtual char* namePtr();

   virtual int nameFieldSize() const;

   virtual char* tagPtr();

   virtual int tagFieldSize() const;

   virtual DtNetOwnershipMsg* netOwnershipMsg();
   virtual const DtNetOwnershipMsg* netOwnershipMsg() const;

   virtual DtRtiMsgKind internalDtRtiMsgKind();

   virtual int minSize() const;

   virtual DtOwnershipMsg* self() const;

protected:

   mutable int myDirty;   
   DtAttributeHandleSet* myAttrs;
   DtRtiApiTagPtr myTag;
};


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

#endif