saveStatusMsg.h

Go to the documentation of this file.

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


#ifndef DtSaveStatusMsg_H_
#define DtSaveStatusMsg_H_

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

enum DtSaveStatus
{
   DtNoSaveInProgress,
   DtInstructedToSave,
   DtSaving,
   DtWaitingForFederationToSave
};

#ifdef DtIFSPEC1516

class DtConnectionMgr;
class DtSaveStatusMsg;
typedef void (*DtSaveStatusCb)(const DtSaveStatusMsg& inter, void* usr);

class DT_DLL_LRC DtSaveStatusMsg : public DtRtiMsg
{
public:

   DtSaveStatusMsg(DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER);

   DtSaveStatusMsg(DtFederateHandle federate,
      rti1516::FederateHandleSaveStatusPairVector const & saveStatusList,
      DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER);

   DtSaveStatusMsg(const DtNetSaveStatusMsg* netRep,
      DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER);

   virtual ~DtSaveStatusMsg();

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

   virtual void set(DtFederateHandle federate,
      rti1516::FederateHandleSaveStatusPairVector const & saveStatusList);

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

   virtual void setSaveStatus(
      rti1516::FederateHandleSaveStatusPairVector const & saveStatusList,
      bool checkBufferSize=true);
   virtual rti1516::FederateHandleSaveStatusPairVector const & saveStatus() 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,
      DtSaveStatusCb cb, void* usr, bool isMomCallback=false);
   static void removeCallback(DtConnectionMgr* conn,
      DtSaveStatusCb cb, void* usr, bool isMomCallback=false);

   static const char* statusToString(DtSaveStatus status);

protected:

   virtual DtNetSaveStatusMsg* netSaveStatusMsg();
   virtual const DtNetSaveStatusMsg* netSaveStatusMsg() const;

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

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

   virtual DtRtiMsgKind internalDtRtiMsgKind();

   virtual int minSize(
      rti1516::FederateHandleSaveStatusPairVector const * saveStatusList=NULL) const;

   virtual void setSizeOfStatus(unsigned long size);
   
   virtual unsigned long sizeNeededForStatus(
      const rti1516::FederateHandleSaveStatusPairVector& status) const;

   virtual DtSaveStatusMsg* self() const;

protected:

   rti1516::FederateHandleSaveStatusPairVector* myFederateStatus;
   int myStatusFieldLength;
};


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

#elif defined(DtIFSPEC1516E)

class DtConnectionMgr;
class DtSaveStatusMsg;
typedef void (*DtSaveStatusCb)(const DtSaveStatusMsg& inter, void* usr);

class DT_DLL_LRC DtSaveStatusMsg : public DtRtiMsg
{
public:

    DtSaveStatusMsg(DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER);

    DtSaveStatusMsg(DtFederateHandle federate,
        rti1516e::FederateHandleSaveStatusPairVector const & saveStatusList,
        DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER);

    DtSaveStatusMsg(const DtNetSaveStatusMsg* netRep,
        DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER);

    virtual ~DtSaveStatusMsg();

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

    virtual void set(DtFederateHandle federate,
        rti1516e::FederateHandleSaveStatusPairVector const & saveStatusList);

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

    virtual void setSaveStatus(
        rti1516e::FederateHandleSaveStatusPairVector const & saveStatusList,
        bool checkBufferSize=true);
    virtual rti1516e::FederateHandleSaveStatusPairVector const & saveStatus() 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,
        DtSaveStatusCb cb, void* usr, bool isMomCallback=false);
    static void removeCallback(DtConnectionMgr* conn,
        DtSaveStatusCb cb, void* usr, bool isMomCallback=false);

    static const char* statusToString(DtSaveStatus status);

protected:

    virtual DtNetSaveStatusMsg* netSaveStatusMsg();
    virtual const DtNetSaveStatusMsg* netSaveStatusMsg() const;

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

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

    virtual DtRtiMsgKind internalDtRtiMsgKind();

    virtual int minSize(
        rti1516e::FederateHandleSaveStatusPairVector const * saveStatusList=NULL) const;

    virtual void setSizeOfStatus(unsigned long size);

    virtual unsigned long sizeNeededForStatus(
        const rti1516e::FederateHandleSaveStatusPairVector& status) const;

    virtual DtSaveStatusMsg* self() const;

protected:

    rti1516e::FederateHandleSaveStatusPairVector* myFederateStatus;
    int myStatusFieldLength;
};


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

#endif //! DtIFSPEC1516
#endif //! DtSaveStatusMsg_H_