MAK RTIspy API Documentation for HLA 1.3
assistantSyncPtUpdateMsg.h
Go to the documentation of this file.
1 /*********************************************************************
2 ** Copyright (c) 2008 MaK Technologies, Inc.
3 ** All rights reserved.
4 *********************************************************************/
5 /*********************************************************************
6 ** $RCSfile: assistantSyncPtUpdateMsg.h,v $ $Revision: 1.2 $ $State: Exp $
7 *********************************************************************/
8 
9 #ifndef DtAssistantSyncPtUpdateMsg_H_
10 #define DtAssistantSyncPtUpdateMsg_H_
11 
15 
16 #include <vlutil/vlString.h>
17 #include <vlutil/vlUtil.h>
18 
19 #include "assistantMsg.h"
20 #include "federationInfo.h"
21 #include "netAssistantSyncPtUpdateMsg.h"
22 
23 class DtRtiAssistantServer;
24 class DtRtiAssistantPeer;
25 class DtAssistantSyncPtUpdateMsg;
26 
27 typedef void (*DtAssistantSyncPtUpdateCb)(const DtAssistantSyncPtUpdateMsg& inter, void* usr);
28 
33 class DT_DLL_ASSISTANT DtAssistantSyncPtUpdateMsg : public DtAssistantMsg
34 {
35 public:
36 
38  DtAssistantSyncPtUpdateMsg(DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER);
39 
40  DtAssistantSyncPtUpdateMsg(const DtNetAssistantSyncPtUpdateMsg* netRepMsg,
41  DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER);
42 
44  virtual ~DtAssistantSyncPtUpdateMsg();
45 
47  virtual DtAssistantMsg* clone(bool copy = true) const;
48 
50  virtual bool isRemoval() const;
51 
53  virtual void setIsRemoval( bool remove );
54 
56  virtual void getPendingAndAchieved( DtPendingAchievedPair& pendAchieve ) const;
57 
59  virtual void setPendingAndAchieved( const DtPendingAchievedPair& pendAchieve );
60 
62  virtual MAKRti::DtString federationName() const;
63 
65  virtual void setFederationName( const MAKRti::DtString& name );
66 
68  virtual MAKRti::DtString syncPtName() const;
69 
71  virtual void setSyncPtName( const MAKRti::DtString& name );
72 
74  virtual void printData() const;
75 
76 public:
77 
79  static DtAssistantMsg* create(const DtNetAssistantMsgHeader* initial,
80  DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER);
81 
82  static DtAssistantMsg* create(DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER);
83 
86  static void addCallback(DtRtiAssistantServer* conn,
87  DtAssistantSyncPtUpdateCb cb, void* usr);
88  static void removeCallback(DtRtiAssistantServer* conn,
89  DtAssistantSyncPtUpdateCb cb, void* usr);
90 
93  static void addCallback(DtRtiAssistantPeer* conn,
94  DtAssistantSyncPtUpdateCb cb, void* usr);
95  static void removeCallback(DtRtiAssistantPeer* conn,
96  DtAssistantSyncPtUpdateCb cb, void* usr);
97 
98 protected:
99 
101  virtual DtNetAssistantSyncPtUpdateMsg* netAssistantSyncPtUpdateMsg();
102  virtual const DtNetAssistantSyncPtUpdateMsg* netAssistantSyncPtUpdateMsg() const;
103 
105  virtual DtAssistantMsgKind internalMsgKind();
106 
108  virtual int minSize() const;
109 
111  virtual void setNumPending( unsigned num );
112  virtual unsigned numPending() const;
113 
115  virtual const DtNetU32* pendingPtr() const;
116  virtual DtNetU32* pendingPtr();
117 
119  virtual void setNumAchieved( unsigned num );
120  virtual unsigned numAchieved() const;
121 
123  virtual const DtNetU32* achievedPtr() const;
124  virtual DtNetU32* achievedPtr();
125 
127  virtual void setFederationNameSize( unsigned size );
128  virtual unsigned federationNameSize() const;
129 
131  virtual const char* federationNamePtr() const;
132  virtual char* federationNamePtr();
133 
135  virtual void setSyncPtNameSize( unsigned size );
136  virtual unsigned syncPtNameSize() const;
137 
139  virtual const char* syncPtNamePtr() const;
140  virtual char* syncPtNamePtr();
141 
142 };
143 
144 #endif
Document ID: Generated on Fri Mar 14 19:08:55 EDT 2014 from SVN revision 137085
Copyright © 2005-2014 VT MÄK Inc. All Rights Reserved (www.mak.com)