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(DtIFSPEC1516) || defined(DtIFSPEC1516E)

#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,
#ifdef DtIFSPEC1516
      rti1516::FederateHandleRestoreStatusPairVector const & restoreStatusList,
#else
      rti1516e::FederateRestoreStatusVector const & restoreStatusList,
#endif
      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,
#ifdef DtIFSPEC1516
      rti1516::FederateHandleRestoreStatusPairVector const & restoreStatusList
#else
      rti1516e::FederateRestoreStatusVector const & restoreStatusList
#endif
      );

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

#ifdef DtIFSPEC1516
   virtual void setRestoreStatus(
      rti1516::FederateHandleRestoreStatusPairVector const & restoreStatusList,
      bool checkBufferSize=true);
   virtual rti1516::FederateHandleRestoreStatusPairVector const & restoreStatus() const;
#else
   virtual void setRestoreStatus(
      rti1516e::FederateRestoreStatusVector const & restoreStatusList,
      bool checkBufferSize=true);
   virtual rti1516e::FederateRestoreStatusVector const & restoreStatus() const;
#endif

   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();

#ifdef DtIFSPEC1516
   virtual int minSize(
      rti1516::FederateHandleRestoreStatusPairVector const * restoreStatusList=NULL) const;
#else
   virtual int minSize(
      rti1516e::FederateRestoreStatusVector const * restoreStatusList=NULL) const;
#endif

   virtual void setSizeOfStatus(unsigned long size);
   
#ifdef DtIFSPEC1516
   virtual unsigned long sizeNeededForStatus(
      rti1516::FederateHandleRestoreStatusPairVector const & restoreStatusList) const;
#else
   virtual unsigned long sizeNeededForStatus(
      rti1516e::FederateRestoreStatusVector const & restoreStatusList) const;
#endif

   virtual DtRestoreStatusMsg* self() const;

protected:

#ifdef DtIFSPEC1516
   rti1516::FederateHandleRestoreStatusPairVector* myFederateStatus;
#else
   rti1516e::FederateRestoreStatusVector* myFederateStatus;
#endif

   int myStatusFieldLength;
};


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


#endif // defined(DtIFSPEC1516) || defined(DtIFSPEC1516E)