syncPointMsg.h

Go to the documentation of this file.

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


#ifndef DtSyncPointMsg_H_
#define DtSyncPointMsg_H_

#include "rtiMsg.h"
#include <vlutil/vlUtil.h>
#include "netSyncMsg.h"

class DtConnectionMgr;
class DtSyncPointMsg;
class DtFederateHandleSet;

typedef void (*DtSyncPointCb)(const DtSyncPointMsg& msg, void* usr);

enum DtSyncMsgType
{
   DtRegister,
   DtAchieved,
   DtAchievedUnsuccessfully,
   DtSynchronized,
   DtAnnouncePt,
   DtSyncPointRegSucceeded,
   DtSyncPointRegFailed
};

enum DtSyncPointStatus
{
   DtSyncStatusSucceeded,
   DtSyncStatusFailLabelNotUnique,
   DtSyncStatusFailMemberNotJoined,
   DtSyncStatusFailResignDuringSync,
   DtSyncStatusFailRtiInternal,
   DtSyncStatusFailTimeNotHonored
};

class DT_DLL_LRC DtSyncPointMsg : public DtRtiMsg
{
public:

   DtSyncPointMsg(DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER);

   DtSyncPointMsg(
      DtSyncMsgType kind,
      DtFederateHandle id,
      DtSyncPointStatus statusValue,
      char const * name,
      DtRtiApiTagConstPtr tag,
      const DtFederateHandleSet* set = NULL,
      const DtFederateHandleSet* unsuccessfulSet = NULL,
      DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER);

   DtSyncPointMsg(const DtNetSyncMsg* netRepMsg,
      DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER);

   virtual ~DtSyncPointMsg();

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

   virtual void set(
      DtSyncMsgType kind,
      DtFederateHandle id,
      DtSyncPointStatus statusValue,
      char const * name,
      DtRtiApiTagConstPtr tag,
      DtFederateHandleSet const* set = NULL,
      DtFederateHandleSet const* unsuccessfulSet = NULL);

   virtual void setSyncMsgKind(DtSyncMsgType kind);
   virtual DtSyncMsgType syncMsgKind() const;

   virtual void setFederateId(DtFederateHandle id);
   virtual DtFederateHandle federateId() const;

   virtual void setSyncPointStatus(DtSyncPointStatus statusValue);
   virtual DtSyncPointStatus syncPointStatus() const;

   virtual void setSyncPointName(char const * name);
   virtual char const * syncPointName() const;

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

   virtual void setFederates(const DtFederateHandleSet* set);

   virtual DtFederateHandleSet const * federates() const;

   virtual void getFederates(DtFederateHandleSet* set) const;

   virtual int numFederates() const;

   virtual void getUnsuccessfulFederates(DtFederateHandleSet* set) const;

   virtual void setUnsuccessfulFederates(const DtFederateHandleSet* set);

   virtual DtFederateHandleSet const * unsuccessfulFederates() const;

   virtual int numUnsuccessfulFederates() 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,
      DtSyncPointCb cb, void *usr);
   static void removeCallback(DtConnectionMgr *conn,
      DtSyncPointCb cb, void *usr);

protected:

   virtual DtNetSyncMsg* netSyncMsg();
   virtual const DtNetSyncMsg* netSyncMsg() const;

   virtual DtNetU32* handleArray();
   virtual DtNetU32* unsuccessfulHandleArray();
   virtual char* tagPtr();
   virtual char* namePtr();

   virtual int handleArraySize() const;
   virtual int unsuccessfulHandleArraySize() const;
   virtual int tagFieldSize() const;
   virtual int nameFieldSize() const;

   virtual DtRtiMsgKind internalDtRtiMsgKind();

   virtual int minSize() const;

   DtSyncPointMsg* self() const;

protected:

   MAKRti::DtString myName;
   DtFederateHandleSet* mySet;
   DtFederateHandleSet* myUnsuccessfulSet;
   DtRtiApiTagPtr myTag;
};

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

#endif