restoreStatusMsg.h

Go to the documentation of this file.

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


#pragma once
#if !defined(DtIFSPEC13)

#include "rtiMsg.h"
#include "netFederateStatusMsg.h"
#include <vlutil/vlString.h>

enum DtRestoreStatus
{
   DtNoRestoreInProgress,
   DtFederateRestoreRequestPending,
   DtWaitingForRestoreToBegin,
   DtPreparedToRestore,
   DtRestoring,
   DtWaitingForFederationToRestore
};

class DtConnectionMgr;
class DtRestoreStatusMsg;
typedef void (*DtRestoreStatusCb)(const DtRestoreStatusMsg& inter, void* usr);

class DT_DLL_LRC DtRestoreStatusMsg : public DtRtiMsg
{
public:

   DtRestoreStatusMsg(DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER);

   DtRestoreStatusMsg(DtFederateHandle federate, DtRtiApiFederateRestoreStatusVector const & restoreStatusList,
      DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER);

   DtRestoreStatusMsg(const DtNetRestoreStatusMsg* netRep,
      DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER);

   virtual ~DtRestoreStatusMsg();

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

   virtual void set(DtFederateHandle federate, DtRtiApiFederateRestoreStatusVector const & restoreStatusList,
      bool adjustBufferSize = true);

   virtual void setRequestingFederate(DtFederateHandle federate);
   virtual DtFederateHandle requestingFederate() const;

   virtual void setRestoreStatus(DtRtiApiFederateRestoreStatusVector const & restoreStatusList, bool adjustBufferSize = true);
   virtual DtRtiApiFederateRestoreStatusVector const & restoreStatus() 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,
      DtRestoreStatusCb cb, void* usr, bool isMomCallback=false);
   static void removeCallback(DtConnectionMgr* conn,
      DtRestoreStatusCb cb, void* usr, bool isMomCallback=false);

   static const char* statusToString(DtRestoreStatus status);

protected:

   virtual DtNetRestoreStatusMsg* netRestoreStatusMsg();
   virtual const DtNetRestoreStatusMsg* netRestoreStatusMsg() const;

   virtual DtNetFederateStatus* netStatusList();
   virtual const DtNetFederateStatus* netStatusList() const;

   virtual void setNumberFederates(int count);
   virtual int numberFederates() const;

   virtual DtRtiMsgKind internalDtRtiMsgKind();

   virtual int minSize(DtRtiApiFederateRestoreStatusVector const * restoreStatusList=NULL) const;

   virtual unsigned long sizeNeededForStatus(int numberOfFederates) const;

   virtual DtRestoreStatusMsg* self() const;

protected:

   DtRtiApiFederateRestoreStatusVector* myFederateStatus;

   int myStatusFieldLength;
};


inline DtRestoreStatusMsg* DtRestoreStatusMsg::self() const
{
   return (DtRestoreStatusMsg*) this;
}


#endif // !defined(DtIFSPEC13)