MAK RTIspy API Documentation for HLA 1516
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
fedAmbCatch1516e.h
Go to the documentation of this file.
1 /*********************************************************************
2 ** Copyright (c) 2010 MaK Technologies, Inc.
3 ** All rights reserved.
4 *********************************************************************/
5 /*********************************************************************
6 ** $RCSfile: fedAmbCatch1516e.h,v $ $Revision: 1.0 $ $State: Exp $
7 *********************************************************************/
8 
11 
12 #ifndef DtFedAmbCatch1516e_h
13 #define DtFedAmbCatch1516e_h
14 
15 #ifdef DtIFSPEC1516E
16 
17 #include "rtiMsConfig.h"
18 #include "fedAmbWrap1516e.h"
19 
20 class DtFederateMgr;
21 
24 class DT_DLL_LRC DtFedAmbCatch : public DtFedAmbWrapper
25 {
26 public:
27 
28  DtFedAmbCatch(DtFederateMgr* fedMgr);
29  virtual ~DtFedAmbCatch() throw ();
30 
34 
35  // 4.4
36  virtual void connectionLost (
37  std::wstring const & faultDescription)
38  throw (
39  FederateInternalError);
40 
41  // 4.8
42  virtual void reportFederationExecutions (
43  FederationExecutionInformationVector const &
44  theFederationExecutionInformationList)
45  throw (
46  FederateInternalError);
47 
49  virtual
50  void
51  synchronizationPointRegistrationSucceeded(std::wstring const & label)
52  throw (rti1516e::FederateInternalError);
53 
54  virtual
55  void
56  synchronizationPointRegistrationFailed(std::wstring const & label,
57  rti1516e::SynchronizationPointFailureReason reason)
58  throw (rti1516e::FederateInternalError);
59 
61  virtual
62  void
63  announceSynchronizationPoint(std::wstring const & label,
64  rti1516e::VariableLengthData const & theUserSuppliedTag)
65  throw (rti1516e::FederateInternalError);
66 
68  virtual
69  void
70  federationSynchronized(std::wstring const & label)
71  throw (rti1516e::FederateInternalError);
72 
74  virtual
75  void
76  initiateFederateSave(std::wstring const & label)
77  throw (rti1516e::FederateInternalError);
78 
79  virtual
80  void
81  initiateFederateSave(std::wstring const & label,
82  rti1516e::LogicalTime const & theTime)
83  throw (rti1516e::FederateInternalError);
84 
86  virtual
87  void
88  federationSaved()
89  throw (rti1516e::FederateInternalError);
90 
91  virtual
92  void
93  federationNotSaved(rti1516e::SaveFailureReason theSaveFailureReason)
94  throw (rti1516e::FederateInternalError);
95 
96 
98  virtual
99  void
100  federationSaveStatusResponse(
101  rti1516e::FederateHandleSaveStatusPairVector const & theFederateStatusVector)
102  throw (rti1516e::FederateInternalError);
103 
105  virtual
106  void
107  requestFederationRestoreSucceeded(std::wstring const & label)
108  throw (rti1516e::FederateInternalError);
109 
110  virtual
111  void
112  requestFederationRestoreFailed(std::wstring const & label)
113  throw (rti1516e::FederateInternalError);
114 
116  virtual
117  void
118  federationRestoreBegun()
119  throw (rti1516e::FederateInternalError);
120 
122  virtual
123  void
124  initiateFederateRestore(std::wstring const & label,
125  rti1516e::FederateHandle handle)
126  throw (rti1516e::FederateInternalError);
127 
129  virtual
130  void
131  federationRestored()
132  throw (rti1516e::FederateInternalError);
133 
134  virtual
135  void
136  federationNotRestored(rti1516e::RestoreFailureReason theRestoreFailureReason)
137  throw (rti1516e::FederateInternalError);
138 
140  virtual
141  void
142  federationRestoreStatusResponse(
143  rti1516e::FederateRestoreStatusVector const & theFederateStatusVector)
144  throw (rti1516e::FederateInternalError);
145 
149 
151  virtual
152  void
153  startRegistrationForObjectClass(rti1516e::ObjectClassHandle theClass)
154  throw (rti1516e::FederateInternalError);
155 
157  virtual
158  void
159  stopRegistrationForObjectClass(rti1516e::ObjectClassHandle theClass)
160  throw (rti1516e::FederateInternalError);
161 
163  virtual
164  void
165  turnInteractionsOn(rti1516e::InteractionClassHandle theHandle)
166  throw (rti1516e::FederateInternalError);
167 
169  virtual
170  void
171  turnInteractionsOff(rti1516e::InteractionClassHandle theHandle)
172  throw (rti1516e::FederateInternalError);
173 
177 
179  virtual
180  void
181  objectInstanceNameReservationSucceeded(std::wstring const &
182  theObjectInstanceName)
183  throw (rti1516e::FederateInternalError);
184 
185  virtual
186  void
187  objectInstanceNameReservationFailed(std::wstring const &
188  theObjectInstanceName)
189  throw (rti1516e::FederateInternalError);
190 
191 
192  // 6.6
193  virtual void multipleObjectInstanceNameReservationSucceeded (
194  std::set<std::wstring> const & theObjectInstanceNames)
195  throw (
196  FederateInternalError);
197 
198  virtual void multipleObjectInstanceNameReservationFailed (
199  std::set<std::wstring> const & theObjectInstanceNames)
200  throw (
201  FederateInternalError);
202 
204  virtual
205  void
206  discoverObjectInstance(rti1516e::ObjectInstanceHandle theObject,
207  rti1516e::ObjectClassHandle theObjectClass,
208  std::wstring const & theObjectInstanceName)
209  throw (rti1516e::FederateInternalError);
210 
211  virtual void discoverObjectInstance (
212  rti1516e::ObjectInstanceHandle theObject,
213  rti1516e::ObjectClassHandle theObjectClass,
214  std::wstring const & theObjectInstanceName,
215  rti1516e::FederateHandle producingFederate)
216  throw (
217  FederateInternalError);
218 
220  virtual void reflectAttributeValues (
221  rti1516e::ObjectInstanceHandle theObject,
222  rti1516e::AttributeHandleValueMap const & theAttributeValues,
223  rti1516e::VariableLengthData const & theUserSuppliedTag,
224  rti1516e::OrderType sentOrder,
225  rti1516e::TransportationType theType,
226  rti1516e::SupplementalReflectInfo theReflectInfo)
227  throw (
228  FederateInternalError);
229 
230  virtual void reflectAttributeValues (
231  rti1516e::ObjectInstanceHandle theObject,
232  rti1516e::AttributeHandleValueMap const & theAttributeValues,
233  rti1516e::VariableLengthData const & theUserSuppliedTag,
234  rti1516e::OrderType sentOrder,
235  rti1516e::TransportationType theType,
236  rti1516e::LogicalTime const & theTime,
237  rti1516e::OrderType receivedOrder,
238  rti1516e::SupplementalReflectInfo theReflectInfo)
239  throw (
240  FederateInternalError);
241 
242  virtual void reflectAttributeValues (
243  rti1516e::ObjectInstanceHandle theObject,
244  rti1516e::AttributeHandleValueMap const & theAttributeValues,
245  rti1516e::VariableLengthData const & theUserSuppliedTag,
246  rti1516e::OrderType sentOrder,
247  rti1516e::TransportationType theType,
248  rti1516e::LogicalTime const & theTime,
249  rti1516e::OrderType receivedOrder,
250  rti1516e::MessageRetractionHandle theHandle,
251  rti1516e::SupplementalReflectInfo theReflectInfo)
252  throw (
253  FederateInternalError);
254 
255  // 6.13
256  virtual void receiveInteraction (
257  InteractionClassHandle theInteraction,
258  ParameterHandleValueMap const & theParameterValues,
259  VariableLengthData const & theUserSuppliedTag,
260  OrderType sentOrder,
261  TransportationType theType,
262  SupplementalReceiveInfo theReceiveInfo)
263  throw (
264  FederateInternalError);
265 
266  virtual void receiveInteraction (
267  InteractionClassHandle theInteraction,
268  ParameterHandleValueMap const & theParameterValues,
269  VariableLengthData const & theUserSuppliedTag,
270  OrderType sentOrder,
271  TransportationType theType,
272  LogicalTime const & theTime,
273  OrderType receivedOrder,
274  SupplementalReceiveInfo theReceiveInfo)
275  throw (
276  FederateInternalError);
277 
278  virtual void receiveInteraction (
279  InteractionClassHandle theInteraction,
280  ParameterHandleValueMap const & theParameterValues,
281  VariableLengthData const & theUserSuppliedTag,
282  OrderType sentOrder,
283  TransportationType theType,
284  LogicalTime const & theTime,
285  OrderType receivedOrder,
286  MessageRetractionHandle theHandle,
287  SupplementalReceiveInfo theReceiveInfo)
288  throw (
289  FederateInternalError);
290 
291 
292  // 6.15
293  virtual void removeObjectInstance (
294  ObjectInstanceHandle theObject,
295  VariableLengthData const & theUserSuppliedTag,
296  OrderType sentOrder,
297  SupplementalRemoveInfo theRemoveInfo)
298  throw (
299  FederateInternalError);
300 
301  virtual void removeObjectInstance (
302  ObjectInstanceHandle theObject,
303  VariableLengthData const & theUserSuppliedTag,
304  OrderType sentOrder,
305  LogicalTime const & theTime,
306  OrderType receivedOrder,
307  SupplementalRemoveInfo theRemoveInfo)
308  throw (
309  FederateInternalError);
310 
311  virtual void removeObjectInstance (
312  ObjectInstanceHandle theObject,
313  VariableLengthData const & theUserSuppliedTag,
314  OrderType sentOrder,
315  LogicalTime const & theTime,
316  OrderType receivedOrder,
317  MessageRetractionHandle theHandle,
318  SupplementalRemoveInfo theRemoveInfo)
319  throw (
320  FederateInternalError);
321 
323  virtual
324  void
325  attributesInScope
326  (rti1516e::ObjectInstanceHandle theObject,
327  rti1516e::AttributeHandleSet const & theAttributes)
328  throw (rti1516e::FederateInternalError);
329 
331  virtual
332  void
333  attributesOutOfScope
334  (rti1516e::ObjectInstanceHandle theObject,
335  rti1516e::AttributeHandleSet const & theAttributes)
336  throw (rti1516e::FederateInternalError);
337 
339  virtual
340  void
341  provideAttributeValueUpdate
342  (rti1516e::ObjectInstanceHandle theObject,
343  rti1516e::AttributeHandleSet const & theAttributes,
344  rti1516e::VariableLengthData const & theUserSuppliedTag)
345  throw (rti1516e::FederateInternalError);
346 
348  virtual
349  void
350  turnUpdatesOnForObjectInstance
351  (rti1516e::ObjectInstanceHandle theObject,
352  rti1516e::AttributeHandleSet const & theAttributes)
353  throw (rti1516e::FederateInternalError);
354 
355  virtual void turnUpdatesOnForObjectInstance (
356  ObjectInstanceHandle theObject,
357  AttributeHandleSet const & theAttributes,
358  std::wstring const & updateRateDesignator)
359  throw (
360  FederateInternalError);
361 
363  virtual
364  void
365  turnUpdatesOffForObjectInstance
366  (rti1516e::ObjectInstanceHandle theObject,
367  rti1516e::AttributeHandleSet const & theAttributes)
368  throw (rti1516e::FederateInternalError);
369 
370  // 6.24
371  virtual void confirmAttributeTransportationTypeChange (
372  ObjectInstanceHandle theObject,
373  AttributeHandleSet theAttributes,
374  TransportationType theTransportation)
375  throw (
376  FederateInternalError);
377 
378  // 6.26
379  virtual void reportAttributeTransportationType (
380  ObjectInstanceHandle theObject,
381  AttributeHandle theAttribute,
382  TransportationType theTransportation)
383  throw (
384  FederateInternalError);
385 
386  // 6.28
387  virtual void confirmInteractionTransportationTypeChange (
388  InteractionClassHandle theInteraction,
389  TransportationType theTransportation)
390  throw (
391  FederateInternalError);
392 
393  // 6.30
394  virtual void reportInteractionTransportationType (
395  FederateHandle federateHandle,
396  InteractionClassHandle theInteraction,
397  TransportationType theTransportation)
398  throw (
399  FederateInternalError);
400 
404 
406  virtual
407  void
408  requestAttributeOwnershipAssumption
409  (rti1516e::ObjectInstanceHandle theObject,
410  rti1516e::AttributeHandleSet const & offeredAttributes,
411  rti1516e::VariableLengthData const & theUserSuppliedTag)
412  throw (rti1516e::FederateInternalError);
413 
415  virtual
416  void
417  requestDivestitureConfirmation
418  (rti1516e::ObjectInstanceHandle theObject,
419  rti1516e::AttributeHandleSet const & releasedAttributes)
420  throw (rti1516e::FederateInternalError);
421 
423  virtual
424  void
425  attributeOwnershipAcquisitionNotification
426  (rti1516e::ObjectInstanceHandle theObject,
427  rti1516e::AttributeHandleSet const & securedAttributes,
428  rti1516e::VariableLengthData const & theUserSuppliedTag)
429  throw (rti1516e::FederateInternalError);
430 
432  virtual
433  void
434  attributeOwnershipUnavailable
435  (rti1516e::ObjectInstanceHandle theObject,
436  rti1516e::AttributeHandleSet const & theAttributes)
437  throw (rti1516e::FederateInternalError);
438 
440  virtual
441  void
442  requestAttributeOwnershipRelease
443  (rti1516e::ObjectInstanceHandle theObject,
444  rti1516e::AttributeHandleSet const & candidateAttributes,
445  rti1516e::VariableLengthData const & theUserSuppliedTag)
446  throw (rti1516e::FederateInternalError);
447 
449  virtual
450  void
451  confirmAttributeOwnershipAcquisitionCancellation
452  (rti1516e::ObjectInstanceHandle theObject,
453  rti1516e::AttributeHandleSet const & theAttributes)
454  throw (rti1516e::FederateInternalError);
455 
457  virtual
458  void
459  informAttributeOwnership(rti1516e::ObjectInstanceHandle theObject,
460  rti1516e::AttributeHandle theAttribute,
461  rti1516e::FederateHandle theOwner)
462  throw (rti1516e::FederateInternalError);
463 
464  virtual
465  void
466  attributeIsNotOwned(rti1516e::ObjectInstanceHandle theObject,
467  rti1516e::AttributeHandle theAttribute)
468  throw (rti1516e::FederateInternalError);
469 
470  virtual
471  void
472  attributeIsOwnedByRTI(rti1516e::ObjectInstanceHandle theObject,
473  rti1516e::AttributeHandle theAttribute)
474  throw (rti1516e::FederateInternalError);
475 
479 
481  virtual
482  void
483  timeRegulationEnabled(rti1516e::LogicalTime const & theFederateTime)
484  throw (rti1516e::FederateInternalError);
485 
487  virtual
488  void
489  timeConstrainedEnabled(rti1516e::LogicalTime const & theFederateTime)
490  throw (rti1516e::FederateInternalError);
491 
493  virtual
494  void
495  timeAdvanceGrant(rti1516e::LogicalTime const & theTime)
496  throw (rti1516e::FederateInternalError);
497 
499  virtual
500  void
501  requestRetraction(rti1516e::MessageRetractionHandle theHandle)
502  throw (rti1516e::FederateInternalError);
503 
504  protected:
505  DtFederateMgr* myFedMgr;
506 };
507 
508 #endif
509 #endif
rti1516::FederateHandleSaveStatusPairVector
std::vector< FederateHandleSaveStatusPair > FederateHandleSaveStatusPairVector
Definition: Typedefs.h:57
requestAttributeOwnershipRelease
virtual void requestAttributeOwnershipRelease(ObjectHandle theObject, const AttributeHandleSet &candidateAttributes, const char *theTag)=0
7.10
attributesOutOfScope
virtual void attributesOutOfScope(ObjectHandle theObject, const AttributeHandleSet &theAttributes)=0
6.14
informAttributeOwnership
virtual void informAttributeOwnership(ObjectHandle theObject, AttributeHandle theAttribute, FederateHandle theOwner)=0
7.16
initiateFederateRestore
virtual void initiateFederateRestore(const char *label, FederateHandle handle)=0
4.19
confirmAttributeOwnershipAcquisitionCancellation
virtual void confirmAttributeOwnershipAcquisitionCancellation(ObjectHandle theObject, const AttributeHandleSet &theAttributes)=0
7.14
startRegistrationForObjectClass
virtual void startRegistrationForObjectClass(ObjectClassHandle theClass)=0
! Declaration Management Services //!
requestRetraction
virtual void requestRetraction(EventRetractionHandle theHandle)=0
8.22
rti1516::OrderType
OrderType
Definition: Enums.h:13
synchronizationPointRegistrationFailed
virtual void synchronizationPointRegistrationFailed(const char *label)=0
supplied C4)
federationNotRestored
virtual void federationNotRestored()=0
attributesInScope
virtual void attributesInScope(ObjectHandle theObject, const AttributeHandleSet &theAttributes)=0
6.13
attributeOwnershipUnavailable
virtual void attributeOwnershipUnavailable(ObjectHandle theObject, const AttributeHandleSet &theAttributes)=0
7.9
receiveInteraction
virtual void receiveInteraction(InteractionClassHandle theInteraction, const ParameterHandleValuePairSet &theParameters, const FedTime &theTime, const char *theTag, EventRetractionHandle theHandle)=0
6.7
removeObjectInstance
virtual void removeObjectInstance(ObjectHandle theObject, const FedTime &theTime, const char *theTag, EventRetractionHandle theHandle)=0
6.9
synchronizationPointRegistrationSucceeded
virtual void synchronizationPointRegistrationSucceeded(const char *label)=0
RTI Parameter Passing Memory Conventions.
DtFederateMgr
Instances of DtFederateMgr process federation-level messages (such as create, destroy, join, resign, and sync points) and manages the objects responsible for handling general communication, objects, interactions, the FOM, MOM, and data distribution mmg.
Definition: fedMgr.h:88
initiateFederateSave
virtual void initiateFederateSave(const char *label)=0
4.12
timeAdvanceGrant
virtual void timeAdvanceGrant(const FedTime &theTime)=0
8.13
announceSynchronizationPoint
virtual void announceSynchronizationPoint(const char *label, const char *tag)=0
4.8
requestFederationRestoreFailed
virtual void requestFederationRestoreFailed(const char *label, const char *reason)=0
supplied C4
federationNotSaved
virtual void federationNotSaved()=0
federationSynchronized
virtual void federationSynchronized(const char *label)=0
4.10
rti1516::ParameterHandleValueMap
std::map< ParameterHandle, VariableLengthData > ParameterHandleValueMap
Definition: Typedefs.h:41
discoverObjectInstance
virtual void discoverObjectInstance(ObjectHandle theObject, ObjectClassHandle theObjectClass, const char *theObjectName)=0
! Object Management Services //!
requestFederationRestoreSucceeded
virtual void requestFederationRestoreSucceeded(const char *label)=0
4.17
rti1516::RestoreFailureReason
RestoreFailureReason
Definition: Enums.h:29
attributeOwnershipAcquisitionNotification
virtual void attributeOwnershipAcquisitionNotification(ObjectHandle theObject, const AttributeHandleSet &securedAttributes)=0
7.6
reflectAttributeValues
virtual void reflectAttributeValues(ObjectHandle theObject, const AttributeHandleValuePairSet &theAttributes, const FedTime &theTime, const char *theTag, EventRetractionHandle theHandle)=0
6.5
rti1516::AttributeHandleValueMap
std::map< AttributeHandle, VariableLengthData > AttributeHandleValueMap
Definition: Typedefs.h:36
turnInteractionsOff
virtual void turnInteractionsOff(InteractionClassHandle theHandle)=0
5.13
rti1516::AttributeHandleSet
std::set< AttributeHandle > AttributeHandleSet
Definition: Typedefs.h:27
federationRestored
virtual void federationRestored()=0
4.21
provideAttributeValueUpdate
virtual void provideAttributeValueUpdate(ObjectHandle theObject, const AttributeHandleSet &theAttributes)=0
6.16
turnUpdatesOffForObjectInstance
virtual void turnUpdatesOffForObjectInstance(ObjectHandle theObject, const AttributeHandleSet &theAttributes)=0
6.18
requestAttributeOwnershipAssumption
virtual void requestAttributeOwnershipAssumption(ObjectHandle theObject, const AttributeHandleSet &offeredAttributes, const char *theTag)=0
! Ownership Management Services //!
turnUpdatesOnForObjectInstance
virtual void turnUpdatesOnForObjectInstance(ObjectHandle theObject, const AttributeHandleSet &theAttributes)=0
6.17
stopRegistrationForObjectClass
virtual void stopRegistrationForObjectClass(ObjectClassHandle theClass)=0
5.11
attributeIsNotOwned
virtual void attributeIsNotOwned(ObjectHandle theObject, AttributeHandle theAttribute)=0
supplied C1
DT_DLL_LRC
#define DT_DLL_LRC
Definition: rtiMsConfig.h:126
federationRestoreBegun
virtual void federationRestoreBegun()=0
4.18
federationSaved
virtual void federationSaved()=0
4.15
timeConstrainedEnabled
virtual void timeConstrainedEnabled(const FedTime &theFederateTime)=0
8.6
timeRegulationEnabled
virtual void timeRegulationEnabled(const FedTime &theFederateTime)=0
! Time Management Services //!
turnInteractionsOn
virtual void turnInteractionsOn(InteractionClassHandle theHandle)=0
5.12
rti1516::TransportationType
TransportationType
Definition: Enums.h:84
rti1516::SaveFailureReason
SaveFailureReason
Definition: Enums.h:47
Document ID: Generated on Thu May 11 15:55:32 EDT 2023 from SVN revision 254743
Copyright © 2005-2020 MAK Technologies Inc. All Rights Reserved (www.mak.com)