MAK RTIspy API Documentation for HLA 1.3
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
momWrapper1516e.h
Go to the documentation of this file.
1 /*********************************************************************
2 ** Copyright (c) 2010 MaK Technologies, Inc.
3 ** All rights reserved.
4 *********************************************************************/
5 /*********************************************************************
6 ** $RCSfile: momWrapper1516e.h,v $ $Revision: 1.0 $ $State: Exp $
7 *********************************************************************/
8 
11 
12 #ifndef DtMomWrapper1516e_h
13 #define DtMomWrapper1516e_h
14 #ifdef DtMOM
15 #ifdef DtIFSPEC1516E
16 
17 #include "rtiMsConfig.h"
18 #include "fedAmbWrap1516e.h"
19 #include "momArgument.h"
20 
21 class DtFederateMgr;
22 class DtFomClassMgr;
23 class DtMomMgr;
24 class DtObjectMgr;
25 
26 class DT_DLL_LRC DtMomWrapper : public DtFedAmbWrapper
27 {
28 public:
29 
31  DtMomWrapper( DtMomMgr* momMgrPtr );
32 
34  virtual ~DtMomWrapper() throw ();
35 
37  virtual DtMomMgr* momMgr();
38 
40  virtual void reset();
41 
42  // Get the verbose level
43  virtual int verboseLevel() const;
44 
45  virtual DtFederateMgr* fedMgr();
46  virtual DtFomClassMgr* fomMgr();
47  virtual DtObjectMgr* objMgr();
48 
51  virtual unsigned long objectRemoveCount() const;
52 
55  virtual unsigned long objectDiscoverCount() const;
56 
58 
59 
60 
61  // 4.8
62  virtual void reportFederationExecutions (
63  FederationExecutionInformationVector const &
64  theFederationExecutionInformationList)
65  throw (
66  FederateInternalError);
67 
68  // 4.12
69  virtual void synchronizationPointRegistrationSucceeded (
70  std::wstring const & label)
71  throw (
72  FederateInternalError);
73 
74  virtual void synchronizationPointRegistrationFailed (
75  std::wstring const & label,
76  SynchronizationPointFailureReason reason)
77  throw (
78  FederateInternalError);
79 
80  // 4.13
81  virtual void announceSynchronizationPoint (
82  std::wstring const & label,
83  VariableLengthData const & theUserSuppliedTag)
84  throw (
85  FederateInternalError);
86 
87  // 4.15
88  virtual void federationSynchronized (
89  std::wstring const & label,
90  FederateHandleSet const& failedToSyncSet)
91  throw (
92  FederateInternalError);
93 
94  // 4.17
95  virtual void initiateFederateSave (
96  std::wstring const & label)
97  throw (
98  FederateInternalError);
99 
100  virtual void initiateFederateSave (
101  std::wstring const & label,
102  LogicalTime const & theTime)
103  throw (
104  FederateInternalError);
105 
106  // 4.20
107  virtual void federationSaved ()
108  throw (
109  FederateInternalError);
110 
111  virtual void federationNotSaved (
112  SaveFailureReason theSaveFailureReason)
113  throw (
114  FederateInternalError);
115 
116 
117  // 4.23
118  virtual void federationSaveStatusResponse (
119  FederateHandleSaveStatusPairVector const &
120  theFederateStatusVector)
121  throw (
122  FederateInternalError);
123 
124  // 4.25
125  virtual void requestFederationRestoreSucceeded (
126  std::wstring const & label)
127  throw (
128  FederateInternalError);
129 
130  virtual void requestFederationRestoreFailed (
131  std::wstring const & label)
132  throw (
133  FederateInternalError);
134 
135  // 4.26
136  virtual void federationRestoreBegun ()
137  throw (
138  FederateInternalError);
139 
140  // 4.27
141  virtual void initiateFederateRestore (
142  std::wstring const & label,
143  std::wstring const & federateName,
144  FederateHandle handle)
145  throw (
146  FederateInternalError);
147 
148  // 4.29
149  virtual void federationRestored ()
150  throw (
151  FederateInternalError);
152 
153  virtual void federationNotRestored (
154  RestoreFailureReason theRestoreFailureReason)
155  throw (
156  FederateInternalError);
157 
158  // 4.32
159  virtual void federationRestoreStatusResponse (
160  FederateRestoreStatusVector const &
161  theFederateRestoreStatusVector)
162  throw (
163  FederateInternalError);
164 
166  // Declaration Management Services //
168 
169  // 5.10
170  virtual void startRegistrationForObjectClass (
171  ObjectClassHandle theClass)
172  throw (
173  FederateInternalError);
174 
175  // 5.11
176  virtual void stopRegistrationForObjectClass (
177  ObjectClassHandle theClass)
178  throw (
179  FederateInternalError);
180 
181  // 5.12
182  virtual void turnInteractionsOn (
183  InteractionClassHandle theHandle)
184  throw (
185  FederateInternalError);
186 
187  // 5.13
188  virtual void turnInteractionsOff (
189  InteractionClassHandle theHandle)
190  throw (
191  FederateInternalError);
192 
194  // Object Management Services //
196 
197  // 6.3
198  virtual void objectInstanceNameReservationSucceeded (
199  std::wstring const & theObjectInstanceName)
200  throw (
201  FederateInternalError);
202 
203  virtual void objectInstanceNameReservationFailed (
204  std::wstring const & theObjectInstanceName)
205  throw (
206  FederateInternalError);
207 
208  // 6.6
209  virtual void multipleObjectInstanceNameReservationSucceeded (
210  std::set<std::wstring> const & theObjectInstanceNames)
211  throw (
212  FederateInternalError);
213 
214  virtual void multipleObjectInstanceNameReservationFailed (
215  std::set<std::wstring> const & theObjectInstanceNames)
216  throw (
217  FederateInternalError);
218 
219  // 6.9
220  virtual void discoverObjectInstance (
221  ObjectInstanceHandle theObject,
222  ObjectClassHandle theObjectClass,
223  std::wstring const & theObjectInstanceName)
224  throw (
225  FederateInternalError);
226 
227  virtual void discoverObjectInstance (
228  ObjectInstanceHandle theObject,
229  ObjectClassHandle theObjectClass,
230  std::wstring const & theObjectInstanceName,
231  FederateHandle producingFederate)
232  throw (
233  FederateInternalError);
234 
235  // 6.11
236  virtual void reflectAttributeValues (
237  ObjectInstanceHandle theObject,
238  AttributeHandleValueMap const & theAttributeValues,
239  VariableLengthData const & theUserSuppliedTag,
240  OrderType sentOrder,
241  TransportationType theType,
242  SupplementalReflectInfo theReflectInfo)
243  throw (
244  FederateInternalError);
245 
246  virtual void reflectAttributeValues (
247  ObjectInstanceHandle theObject,
248  AttributeHandleValueMap const & theAttributeValues,
249  VariableLengthData const & theUserSuppliedTag,
250  OrderType sentOrder,
251  TransportationType theType,
252  LogicalTime const & theTime,
253  OrderType receivedOrder,
254  SupplementalReflectInfo theReflectInfo)
255  throw (
256  FederateInternalError);
257 
258  virtual void reflectAttributeValues (
259  ObjectInstanceHandle theObject,
260  AttributeHandleValueMap const & theAttributeValues,
261  VariableLengthData const & theUserSuppliedTag,
262  OrderType sentOrder,
263  TransportationType theType,
264  LogicalTime const & theTime,
265  OrderType receivedOrder,
266  MessageRetractionHandle theHandle,
267  SupplementalReflectInfo theReflectInfo)
268  throw (
269  FederateInternalError);
270 
271  // 6.13
272  virtual void receiveInteraction (
273  InteractionClassHandle theInteraction,
274  ParameterHandleValueMap const & theParameterValues,
275  VariableLengthData const & theUserSuppliedTag,
276  OrderType sentOrder,
277  TransportationType theType,
278  SupplementalReceiveInfo theReceiveInfo)
279  throw (
280  FederateInternalError);
281 
282  virtual void receiveInteraction (
283  InteractionClassHandle theInteraction,
284  ParameterHandleValueMap const & theParameterValues,
285  VariableLengthData const & theUserSuppliedTag,
286  OrderType sentOrder,
287  TransportationType theType,
288  LogicalTime const & theTime,
289  OrderType receivedOrder,
290  SupplementalReceiveInfo theReceiveInfo)
291  throw (
292  FederateInternalError);
293 
294  virtual void receiveInteraction (
295  InteractionClassHandle theInteraction,
296  ParameterHandleValueMap const & theParameterValues,
297  VariableLengthData const & theUserSuppliedTag,
298  OrderType sentOrder,
299  TransportationType theType,
300  LogicalTime const & theTime,
301  OrderType receivedOrder,
302  MessageRetractionHandle theHandle,
303  SupplementalReceiveInfo theReceiveInfo)
304  throw (
305  FederateInternalError);
306 
307  // 6.15
308  virtual void removeObjectInstance (
309  ObjectInstanceHandle theObject,
310  VariableLengthData const & theUserSuppliedTag,
311  OrderType sentOrder,
312  SupplementalRemoveInfo theRemoveInfo)
313  throw (
314  FederateInternalError);
315 
316  virtual void removeObjectInstance (
317  ObjectInstanceHandle theObject,
318  VariableLengthData const & theUserSuppliedTag,
319  OrderType sentOrder,
320  LogicalTime const & theTime,
321  OrderType receivedOrder,
322  SupplementalRemoveInfo theRemoveInfo)
323  throw (
324  FederateInternalError);
325 
326  virtual void removeObjectInstance (
327  ObjectInstanceHandle theObject,
328  VariableLengthData const & theUserSuppliedTag,
329  OrderType sentOrder,
330  LogicalTime const & theTime,
331  OrderType receivedOrder,
332  MessageRetractionHandle theHandle,
333  SupplementalRemoveInfo theRemoveInfo)
334  throw (
335  FederateInternalError);
336 
337  // 6.17
338  virtual void attributesInScope (
339  ObjectInstanceHandle theObject,
340  AttributeHandleSet const & theAttributes)
341  throw (
342  FederateInternalError);
343 
344  // 6.18
345  virtual void attributesOutOfScope (
346  ObjectInstanceHandle theObject,
347  AttributeHandleSet const & theAttributes)
348  throw (
349  FederateInternalError);
350 
351  // 6.20
352  virtual void provideAttributeValueUpdate (
353  ObjectInstanceHandle theObject,
354  AttributeHandleSet const & theAttributes,
355  VariableLengthData const & theUserSuppliedTag)
356  throw (
357  FederateInternalError);
358 
359  // 6.21
360  virtual void turnUpdatesOnForObjectInstance (
361  ObjectInstanceHandle theObject,
362  AttributeHandleSet const & theAttributes)
363  throw (
364  FederateInternalError);
365 
366  virtual void turnUpdatesOnForObjectInstance (
367  ObjectInstanceHandle theObject,
368  AttributeHandleSet const & theAttributes,
369  std::wstring const & updateRateDesignator)
370  throw (
371  FederateInternalError);
372 
373  // 6.22
374  virtual void turnUpdatesOffForObjectInstance (
375  ObjectInstanceHandle theObject,
376  AttributeHandleSet const & theAttributes)
377  throw (
378  FederateInternalError);
379 
380  // 6.24
381  virtual void confirmAttributeTransportationTypeChange (
382  ObjectInstanceHandle theObject,
383  AttributeHandleSet theAttributes,
384  TransportationType theTransportation)
385  throw (
386  FederateInternalError);
387 
388  // 6.26
389  virtual void reportAttributeTransportationType (
390  ObjectInstanceHandle theObject,
391  AttributeHandle theAttribute,
392  TransportationType theTransportation)
393  throw (
394  FederateInternalError);
395 
396  // 6.28
397  virtual void confirmInteractionTransportationTypeChange (
398  InteractionClassHandle theInteraction,
399  TransportationType theTransportation)
400  throw (
401  FederateInternalError);
402 
403  // 6.30
404  virtual void reportInteractionTransportationType (
405  FederateHandle federateHandle,
406  InteractionClassHandle theInteraction,
407  TransportationType theTransportation)
408  throw (
409  FederateInternalError);
410 
411 
413  // Ownership Management Services //
415 
416  // 7.4
417  virtual void requestAttributeOwnershipAssumption (
418  ObjectInstanceHandle theObject,
419  AttributeHandleSet const & offeredAttributes,
420  VariableLengthData const & theUserSuppliedTag)
421  throw (
422  FederateInternalError);
423 
424  // 7.5
425  virtual void requestDivestitureConfirmation (
426  ObjectInstanceHandle theObject,
427  AttributeHandleSet const & releasedAttributes)
428  throw (
429  FederateInternalError);
430 
431  // 7.7
432  virtual void attributeOwnershipAcquisitionNotification (
433  ObjectInstanceHandle theObject,
434  AttributeHandleSet const & securedAttributes,
435  VariableLengthData const & theUserSuppliedTag)
436  throw (
437  FederateInternalError);
438 
439  // 7.10
440  virtual void attributeOwnershipUnavailable (
441  ObjectInstanceHandle theObject,
442  AttributeHandleSet const & theAttributes)
443  throw (
444  FederateInternalError);
445 
446  // 7.11
447  virtual void requestAttributeOwnershipRelease (
448  ObjectInstanceHandle theObject,
449  AttributeHandleSet const & candidateAttributes,
450  VariableLengthData const & theUserSuppliedTag)
451  throw (
452  FederateInternalError);
453 
454  // 7.16
455  virtual void confirmAttributeOwnershipAcquisitionCancellation (
456  ObjectInstanceHandle theObject,
457  AttributeHandleSet const & theAttributes)
458  throw (
459  FederateInternalError);
460 
461  // 7.18
462  virtual void informAttributeOwnership (
463  ObjectInstanceHandle theObject,
464  AttributeHandle theAttribute,
465  FederateHandle theOwner)
466  throw (
467  FederateInternalError);
468 
469  virtual void attributeIsNotOwned (
470  ObjectInstanceHandle theObject,
471  AttributeHandle theAttribute)
472  throw (
473  FederateInternalError);
474 
475  virtual void attributeIsOwnedByRTI (
476  ObjectInstanceHandle theObject,
477  AttributeHandle theAttribute)
478  throw (
479  FederateInternalError);
480 
482  // Time Management Services //
484 
485  // 8.3
486  virtual void timeRegulationEnabled (
487  LogicalTime const & theFederateTime)
488  throw (
489  FederateInternalError);
490 
491  // 8.6
492  virtual void timeConstrainedEnabled (
493  LogicalTime const & theFederateTime)
494  throw (
495  FederateInternalError);
496 
497  // 8.13
498  virtual void timeAdvanceGrant (
499  LogicalTime const & theTime)
500  throw (
501  FederateInternalError);
502 
503  // 8.22
504  virtual void requestRetraction (
505  MessageRetractionHandle theHandle)
506  throw (
507  FederateInternalError);
509 
510 private:
512  DtMomWrapper( const DtMomWrapper& src );
513 
515  DtMomWrapper& operator=( const DtMomWrapper& src );
516 
517 protected:
518  DtMomMgr* myMomMgr;
519  unsigned long myDiscoverCount;
520  unsigned long myRemoveCount;
521 
522 protected:
523  static const DtMomArgument theDfltMomArgument;
524  static DtMomArgument theDfltRetVal;
525 };
526 
527 #endif
528 #endif
529 #endif
Document ID: Generated on Mon Mar 21 09:41:37 EDT 2016 from SVN revision 163228
Copyright © 2005-2015 VT MÄK Inc. All Rights Reserved (www.mak.com)