MAK RTIspy API Documentation for HLA 1516
assistantFederationStateMsg.h
Go to the documentation of this file.
1 /*********************************************************************
2 ** Copyright (c) 2013 VT MAK
3 ** All rights reserved.
4 *********************************************************************/
5 
6 #ifndef DtAssistantFederationStateMsg_H_
7 #define DtAssistantFederationStateMsg_H_
8 
12 
13 #include <vlutil/vlString.h>
14 #include <vlutil/vlUtil.h>
15 
16 #include "assistantMsg.h"
17 #include "federationInfo.h"
18 #include "netAssistantFederationStateMsg.h"
19 
20 class DtRtiAssistantPeer;
21 class DtRtiAssistantServer;
22 class DtAssistantFederationStateMsg;
23 class DtRtiConnectionInfo;
24 
25 typedef void (*DtAssistantFederationStateCb)(const DtAssistantFederationStateMsg& inter, void* usr);
26 
31 class DT_DLL_ASSISTANT DtAssistantFederationStateMsg : public DtAssistantMsg
32 {
33 public:
34 
36  DtAssistantFederationStateMsg(DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER);
37 
38  DtAssistantFederationStateMsg(const DtNetAssistantFederationStateMsg* netRepMsg,
39  DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER);
40 
42  virtual ~DtAssistantFederationStateMsg();
43 
45  virtual DtAssistantMsg* clone(bool copy = true) const;
46 
48  virtual bool noFederations() const;
49 
51  virtual void setNoFederations(bool val);
52 
54  virtual unsigned int federationHandle() const;
55 
57  virtual void setFederationHandle( unsigned int handle );
58 
60  virtual bool isTestEnabled() const;
61 
63  virtual void setIsTestEnabled( bool enabled );
64 
66  virtual bool isRemoval() const;
67 
69  virtual void setIsRemoval( bool remove );
70 
72  virtual MAKRti::DtString federationName() const;
73 
75  virtual void setFederationName( const MAKRti::DtString& name );
76 
78  virtual MAKRti::DtString fedFileName() const;
79 
81  virtual void setFedFileName( const MAKRti::DtString& name );
82 
84  virtual void getFomModules(std::list<MAKRti::DtString>& fomModules ) const;
85 
87  virtual void setFomModules( const std::list<MAKRti::DtString>& fomModules );
88 
92  virtual void getUpdatedFederateStates( DtFederateInfoByHandleMap& federates,
93  const MAKRti::DtString& federation = MAKRti::DtString::nullString(),
94  std::set<unsigned>* notUpdated = 0 ) const;
95 
97  virtual void setFederateStates( const DtFederateInfoByHandleMap& federates );
98 
101  virtual void getConnection( DtRtiConnectionInfo& conn,
102  const MAKRti::DtInetAddr& address ) const;
103 
105  virtual void setConnection( const DtRtiConnectionInfo& conn );
106 
108  virtual void printData() const;
109 
110 public:
111 
113  static DtAssistantMsg* create(const DtNetAssistantMsgHeader* initial,
114  DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER);
115 
116  static DtAssistantMsg* create(DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER);
117 
120  static void addCallback(DtRtiAssistantServer* conn,
121  DtAssistantFederationStateCb cb, void* usr);
122  static void removeCallback(DtRtiAssistantServer* conn,
123  DtAssistantFederationStateCb cb, void* usr);
124 
127  static void addCallback(DtRtiAssistantPeer* conn,
128  DtAssistantFederationStateCb cb, void* usr);
129  static void removeCallback(DtRtiAssistantPeer* conn,
130  DtAssistantFederationStateCb cb, void* usr);
131 
132 protected:
133 
135  virtual DtNetAssistantFederationStateMsg* netAssistantFederationStateMsg();
136  virtual const DtNetAssistantFederationStateMsg* netAssistantFederationStateMsg() const;
137 
139  virtual DtAssistantMsgKind internalMsgKind();
140 
142  virtual int minSize() const;
143 
145  virtual void setAddressFamily( DtInetUtils::DtInetAddrFamily fam );
146  virtual DtInetUtils::DtInetAddrFamily addressFamily() const;
147 
149  virtual void setFederationNameSize( unsigned size );
150  virtual unsigned federationNameSize() const;
151 
153  virtual void setFedFileNameSize( unsigned size );
154  virtual unsigned fedFileNameSize() const;
155 
157  virtual void setFomModulesSize( unsigned size );
158  virtual unsigned fomModulesSize() const;
159 
161  virtual void setNumFederates( unsigned num );
162  virtual unsigned numFederates() const;
163 
165  virtual void setFederateTypesSize( unsigned size );
166  virtual unsigned federateTypesSize() const;
167 
169  virtual void setFederateNamesSize( unsigned size );
170  virtual unsigned federateNamesSize() const;
171 
173  virtual void setFederateHostNamesSize( unsigned size );
174  virtual unsigned federateHostNamesSize() const;
175 
177  virtual void setLbtsStringsSize( unsigned size );
178  virtual unsigned lbtsStringsSize() const;
179 
181  virtual void setLookAheadStringsSize( unsigned size );
182  virtual unsigned lookAheadStringsSize() const;
183 
185  virtual void setTimeStringsSize( unsigned size );
186  virtual unsigned timeStringsSize() const;
187 
189  virtual DtNetU32* federateConnIdsPtr();
190  virtual const DtNetU32* federateConnIdsPtr() const;
191 
193  virtual DtNetU32* federateHdlsPtr();
194  virtual const DtNetU32* federateHdlsPtr() const;
195 
197  virtual DtNetU32* federateAstntCompIdsPtr();
198  virtual const DtNetU32* federateAstntCompIdsPtr() const;
199 
201  virtual DtNetU128* federateHostAddrsPtr();
202  virtual const DtNetU128* federateHostAddrsPtr() const;
203 
206  virtual DtNetU32* federateWebServerAddrsPtr();
207  virtual const DtNetU32* federateWebServerAddrsPtr() const;
208 
210  virtual DtNetU16* federateWebServerPortsPtr();
211  virtual const DtNetU16* federateWebServerPortsPtr() const;
212 
215  virtual DtNetU16* federateNumInitiatedTestsPtr();
216  virtual const DtNetU16* federateNumInitiatedTestsPtr() const;
217 
220  virtual DtNetU16* federateNumTestReportsPtr();
221  virtual const DtNetU16* federateNumTestReportsPtr() const;
222 
224  virtual DtNetU8* federateTestEnablePtr();
225  virtual const DtNetU8* federateTestEnablePtr() const;
226 
229  virtual DtNetU8* federateTestInProgressPtr();
230  virtual const DtNetU8* federateTestInProgressPtr() const;
231 
234  virtual DtNetU8* federateContTestPtr();
235  virtual const DtNetU8* federateContTestPtr() const;
236 
238  virtual DtNetU8* reconnectingPtr();
239  virtual const DtNetU8* reconnectingPtr() const;
240 
242  virtual DtNetU8* disconnectedPtr();
243  virtual const DtNetU8* disconnectedPtr() const;
244 
246  virtual DtNetU8* regulatingPtr();
247  virtual const DtNetU8* regulatingPtr() const;
248 
250  virtual DtNetU8* constrainedPtr();
251  virtual const DtNetU8* constrainedPtr() const;
252 
254  virtual DtNetU8* hlaVersionsPtr();
255  virtual const DtNetU8* hlaVersionsPtr() const;
256 
258  virtual const char* federationNamePtr() const;
259  virtual char* federationNamePtr();
260 
262  virtual const char* fedFileNamePtr() const;
263  virtual char* fedFileNamePtr();
264 
266  virtual const char* fomModulesPtr() const;
267  virtual char* fomModulesPtr();
268 
270  virtual const char* federateTypesPtr() const;
271  virtual char* federateTypesPtr();
272 
274  virtual const char* federateNamesPtr() const;
275  virtual char* federateNamesPtr();
276 
278  virtual const char* federateHostNamesPtr() const;
279  virtual char* federateHostNamesPtr();
280 
282  virtual const char* lbtsStringsPtr() const;
283  virtual char* lbtsStringsPtr();
284 
286  virtual const char* lookAheadStringsPtr() const;
287  virtual char* lookAheadStringsPtr();
288 
290  virtual const char* timeStringsPtr() const;
291  virtual char* timeStringsPtr();
292 };
293 
294 #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)