resBegMsg.h

Go to the documentation of this file.

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


#ifndef DtRestoreBegunMsg_H_
#define DtRestoreBegunMsg_H_

#include "rtiMsg.h"
#include "netSavRespMsg.h"

class DtConnectionMgr;
class DtRestoreBegunMsg;
typedef void (*DtRestoreBegunCb)(const DtRestoreBegunMsg& inter, void* usr);

enum DtResponseFlag
{
   DtResponseSuccess,
   DtResponseFail
};

class DT_DLL_LRC DtRestoreBegunMsg : public DtRtiMsg
{
public:

   DtRestoreBegunMsg(DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER);

   DtRestoreBegunMsg(DtFederateHandle requestingFederateVal,
      const char* labelVal,
      DtResponseFlag flag,
      DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER);

   DtRestoreBegunMsg(const DtNetSaveResponseMsg* netRepMsg,
      DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER);

   virtual ~DtRestoreBegunMsg();

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

   virtual void set(DtFederateHandle requestingFederateVal, const char* theLabel, DtResponseFlag flag,
      bool adjustBufferSize = true);

   void setRequestingFederate(DtFederateHandle requestingFederateVal);
   DtFederateHandle requestingFederate() const;

   virtual void setLabel(const char* label, bool adjustBufferSize = true);

   virtual const char* label() const;

   void setResponseFlag(DtResponseFlag flag);
   DtResponseFlag responseFlag() const;

   virtual void printData(DtLogicalTimeFactory* logicalTimeFactory) const;

public:

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

   static DtRtiMsg* create(DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER);

   static void addCallback(DtConnectionMgr* conn,
      DtRestoreBegunCb cb, void* usr);
   static void removeCallback(DtConnectionMgr* conn,
      DtRestoreBegunCb cb, void* usr);

protected:

   virtual DtNetSaveResponseMsg* netRestoreBegunMsg();
   virtual const DtNetSaveResponseMsg* netRestoreBegunMsg() const;

   virtual DtRtiMsgKind internalDtRtiMsgKind();

   virtual char* labelPtr();

   virtual void setLabelSize(int size);
   virtual int labelSize() const;

   virtual int minSize(const char* theLabel=NULL) const;

   virtual DtRestoreBegunMsg* self() const;

};


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

#endif