MAK RTIspy API Documentation for HLA 1516
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
fedAmbCatch1516_2025.h
Go to the documentation of this file.
1 /*********************************************************************
2 ** Copyright (c) 2025 MAK Technologies
3 ** All rights reserved.
4 *********************************************************************/
5 
8 
9 #pragma once
10 
11 #ifdef DtIFSPEC1516_2025
12 
13 #include "rtiMsConfig.h"
14 #include "fedAmbWrap1516_2025.h"
15 
16 class DtFederateMgr;
17 
20 class DT_DLL_LRC DtFedAmbCatch : public DtFedAmbWrapper
21 {
22  public:
23 
24  DtFedAmbCatch(DtFederateMgr* fedMgr);
25  virtual ~DtFedAmbCatch();
26 
30 
31  // 4.4
32  virtual void connectionLost(std::wstring const & faultDescription) override;
33 
34  // 4.8
35  virtual void reportFederationExecutions(
36  rti1516_2025::FederationExecutionInformationVector const & theFederationExecutionInformationList) override;
37 
38  // 4.10
39  virtual void reportFederationExecutionMembers(
40  std::wstring const & thefederationExecutionName,
41  rti1516_2025::FederationExecutionMemberInformationVector const & theFederationExecutionMemberInformationList) override;
42 
44  virtual void synchronizationPointRegistrationSucceeded(std::wstring const & label) override;
45 
46  virtual void synchronizationPointRegistrationFailed(
47  std::wstring const & label,
48  rti1516_2025::SynchronizationPointFailureReason reason) override;
49 
51  virtual void announceSynchronizationPoint(std::wstring const & label,
52  rti1516_2025::VariableLengthData const & theUserSuppliedTag) override;
53 
55  virtual void federationSynchronized(std::wstring const& label,
56  rti1516_2025::FederateHandleSet const& failedToSyncSet) override;
57 
59  virtual void initiateFederateSave(std::wstring const & label) override;
60 
61  virtual void initiateFederateSave(std::wstring const & label, rti1516_2025::LogicalTime const & theTime) override;
62 
64  virtual void federationSaved() override;
65 
66  virtual void federationNotSaved(rti1516_2025::SaveFailureReason theSaveFailureReason) override;
67 
69  virtual void federationSaveStatusResponse(
70  rti1516_2025::FederateHandleSaveStatusPairVector const & theFederateStatusVector) override;
71 
73  virtual void requestFederationRestoreSucceeded(std::wstring const & label) override;
74 
75  virtual void requestFederationRestoreFailed(std::wstring const & label) override;
76 
78  virtual void federationRestoreBegun() override;
79 
81  virtual void initiateFederateRestore(std::wstring const & label, std::wstring const & federateName,
82  rti1516_2025::FederateHandle const & handle) override;
83 
85  virtual void federationRestored() override;
86 
87  virtual void federationNotRestored(rti1516_2025::RestoreFailureReason theRestoreFailureReason) override;
88 
90  virtual void federationRestoreStatusResponse(rti1516_2025::FederateRestoreStatusVector const & theFederateStatusVector) override;
91 
95 
97  virtual void startRegistrationForObjectClass(rti1516_2025::ObjectClassHandle const & theClass) override;
98 
100  virtual void stopRegistrationForObjectClass(rti1516_2025::ObjectClassHandle const & theClass) override;
101 
103  virtual void turnInteractionsOn(rti1516_2025::InteractionClassHandle const & theHandle) override;
104 
106  virtual void turnInteractionsOff(rti1516_2025::InteractionClassHandle const & theHandle) override;
107 
111 
113  virtual void objectInstanceNameReservationSucceeded(std::wstring const & theObjectInstanceName) override;
114 
115  virtual void objectInstanceNameReservationFailed(std::wstring const & theObjectInstanceName) override;
116 
117  // 6.6
118  virtual void multipleObjectInstanceNameReservationSucceeded(std::set<std::wstring> const & theObjectInstanceNames) override;
119 
120  virtual void multipleObjectInstanceNameReservationFailed(std::set<std::wstring> const & theObjectInstanceNames) override;
121 
123  virtual void discoverObjectInstance(
124  rti1516_2025::ObjectInstanceHandle const & theObject,
125  rti1516_2025::ObjectClassHandle const & theObjectClass,
126  std::wstring const & theObjectInstanceName,
127  rti1516_2025::FederateHandle const & producingFederate) override;
128 
129  // 6.11
130  virtual void reflectAttributeValues(
131  rti1516_2025::ObjectInstanceHandle const& theObject,
132  rti1516_2025::AttributeHandleValueMap const& theAttributeValues,
133  rti1516_2025::VariableLengthData const& theUserSuppliedTag,
134  rti1516_2025::TransportationTypeHandle const& theType,
135  rti1516_2025::FederateHandle const& theProducingFederate,
136  rti1516_2025::RegionHandleSet const* theOptionalSentRegions) override;
137 
138  virtual void reflectAttributeValues(
139  rti1516_2025::ObjectInstanceHandle const& theObject,
140  rti1516_2025::AttributeHandleValueMap const& theAttributeValues,
141  rti1516_2025::VariableLengthData const& theUserSuppliedTag,
142  rti1516_2025::TransportationTypeHandle const& theType,
143  rti1516_2025::FederateHandle const& theProducingFederate,
144  rti1516_2025::RegionHandleSet const* theOptionalSentRegions,
145  rti1516_2025::LogicalTime const& theTime,
146  rti1516_2025::OrderType theSentOrder,
147  rti1516_2025::OrderType theReceivedOrder,
148  rti1516_2025::MessageRetractionHandle const* theOptionalRetraction) override;
149 
150  // 6.13
151  virtual void receiveInteraction(
152  rti1516_2025::InteractionClassHandle const& theInteraction,
153  rti1516_2025::ParameterHandleValueMap const& theParameterValues,
154  rti1516_2025::VariableLengthData const& theUserSuppliedTag,
155  rti1516_2025::TransportationTypeHandle const& theType,
156  rti1516_2025::FederateHandle const& theProducingFederate,
157  const rti1516_2025::RegionHandleSet* theOptionalSentRegions) override;
158 
159  virtual void receiveInteraction(
160  rti1516_2025::InteractionClassHandle const& theInteraction,
161  rti1516_2025::ParameterHandleValueMap const& theParameterValues,
162  rti1516_2025::VariableLengthData const& theUserSuppliedTag,
163  rti1516_2025::TransportationTypeHandle const& theType,
164  rti1516_2025::FederateHandle const& theProducingFederate,
165  rti1516_2025::RegionHandleSet const* theOptionalSentRegions,
166  rti1516_2025::LogicalTime const& theTime,
167  rti1516_2025::OrderType theSentOrder,
168  rti1516_2025::OrderType theReceivedOrder,
169  rti1516_2025::MessageRetractionHandle const* theOptionalRetraction) override;
170 
171  // 6.13
172  virtual void receiveDirectedInteraction(
173  rti1516_2025::InteractionClassHandle const& theInteraction,
174  rti1516_2025::ObjectInstanceHandle const& theObject,
175  rti1516_2025::ParameterHandleValueMap const& theParameterValues,
176  rti1516_2025::VariableLengthData const& theUserSuppliedTag,
177  rti1516_2025::TransportationTypeHandle const& theType,
178  rti1516_2025::FederateHandle const& producingFederate) override;
179 
180  virtual void receiveDirectedInteraction(
181  rti1516_2025::InteractionClassHandle const& theInteraction,
182  rti1516_2025::ObjectInstanceHandle const& theObject,
183  rti1516_2025::ParameterHandleValueMap const& theParameterValues,
184  rti1516_2025::VariableLengthData const& theUserSuppliedTag,
185  rti1516_2025::TransportationTypeHandle const& theType,
186  rti1516_2025::FederateHandle const& theProducingFederate,
187  rti1516_2025::LogicalTime const& theTime,
188  rti1516_2025::OrderType theSentOrder,
189  rti1516_2025::OrderType theReceivedOrder,
190  rti1516_2025::MessageRetractionHandle const* theOptionalRetraction) override;
191 
192  // 6.15
193 
194  virtual void removeObjectInstance(
195  rti1516_2025::ObjectInstanceHandle const& theObject,
196  rti1516_2025::VariableLengthData const& theUserSuppliedTag,
197  rti1516_2025::FederateHandle const& theProducingFederate) override;
198 
199  virtual void removeObjectInstance(
200  rti1516_2025::ObjectInstanceHandle const& theObject,
201  rti1516_2025::VariableLengthData const& theUserSuppliedTag,
202  rti1516_2025::FederateHandle const& theProducingFederate,
203  rti1516_2025::LogicalTime const& theTime,
204  rti1516_2025::OrderType theSentOrder,
205  rti1516_2025::OrderType theReceivedOrder,
206  rti1516_2025::MessageRetractionHandle const* theOptionalRetraction) override;
207 
209  virtual void attributesInScope(
210  rti1516_2025::ObjectInstanceHandle const & theObject,
211  rti1516_2025::AttributeHandleSet const & theAttributes) override;
212 
214  virtual void attributesOutOfScope(
215  rti1516_2025::ObjectInstanceHandle const & theObject,
216  rti1516_2025::AttributeHandleSet const & theAttributes) override;
217 
219  virtual void provideAttributeValueUpdate(
220  rti1516_2025::ObjectInstanceHandle const & theObject,
221  rti1516_2025::AttributeHandleSet const & theAttributes,
222  rti1516_2025::VariableLengthData const & theUserSuppliedTag) override;
223 
225  virtual void turnUpdatesOnForObjectInstance(
226  rti1516_2025::ObjectInstanceHandle const & theObject,
227  rti1516_2025::AttributeHandleSet const & theAttributes) override;
228 
229  virtual void turnUpdatesOnForObjectInstance(
230  rti1516_2025::ObjectInstanceHandle const & theObject,
231  rti1516_2025::AttributeHandleSet const & theAttributes,
232  std::wstring const & updateRateDesignator) override;
233 
235  virtual void turnUpdatesOffForObjectInstance(
236  rti1516_2025::ObjectInstanceHandle const & theObject,
237  rti1516_2025::AttributeHandleSet const & theAttributes) override;
238 
239  // 6.24
240  virtual void confirmAttributeTransportationTypeChange(
241  rti1516_2025::ObjectInstanceHandle const & theObject,
242  rti1516_2025::AttributeHandleSet const & theAttributes,
243  rti1516_2025::TransportationTypeHandle const & theTransportation) override;
244 
245  // 6.26
246  virtual void reportAttributeTransportationType(
247  rti1516_2025::ObjectInstanceHandle const & theObject,
248  rti1516_2025::AttributeHandle const & theAttribute,
249  rti1516_2025::TransportationTypeHandle const & theTransportation) override;
250 
251  // 6.28
252  virtual void confirmInteractionTransportationTypeChange(
253  rti1516_2025::InteractionClassHandle const & theInteraction,
254  rti1516_2025::TransportationTypeHandle const & theTransportation) override;
255 
256  // 6.30
257  virtual void reportInteractionTransportationType(
258  rti1516_2025::FederateHandle const & tFederateHandle,
259  rti1516_2025::InteractionClassHandle const & theInteraction,
260  rti1516_2025::TransportationTypeHandle const & theTransportation) override;
261 
265 
267  virtual void requestAttributeOwnershipAssumption(
268  rti1516_2025::ObjectInstanceHandle const & theObject,
269  rti1516_2025::AttributeHandleSet const & offeredAttributes,
270  rti1516_2025::VariableLengthData const & theUserSuppliedTag) override;
271 
273  virtual void requestDivestitureConfirmation(
274  rti1516_2025::ObjectInstanceHandle const & theObject,
275  rti1516_2025::AttributeHandleSet const & releasedAttributes,
276  rti1516_2025::VariableLengthData const & theUserSuppliedTag) override;
277 
279  virtual void attributeOwnershipAcquisitionNotification(
280  rti1516_2025::ObjectInstanceHandle const & theObject,
281  rti1516_2025::AttributeHandleSet const & securedAttributes,
282  rti1516_2025::VariableLengthData const & theUserSuppliedTag) override;
283 
285  virtual void attributeOwnershipUnavailable(
286  rti1516_2025::ObjectInstanceHandle const & theObject,
287  rti1516_2025::AttributeHandleSet const & theAttributes,
288  rti1516_2025::VariableLengthData const & theUserSuppliedTag) override;
289 
291  virtual void requestAttributeOwnershipRelease(
292  rti1516_2025::ObjectInstanceHandle const & theObject,
293  rti1516_2025::AttributeHandleSet const & candidateAttributes,
294  rti1516_2025::VariableLengthData const & theUserSuppliedTag) override;
295 
297  virtual void confirmAttributeOwnershipAcquisitionCancellation(
298  rti1516_2025::ObjectInstanceHandle const & theObject,
299  rti1516_2025::AttributeHandleSet const & theAttributes) override;
300 
302  virtual void informAttributeOwnership(
303  rti1516_2025::ObjectInstanceHandle const & theObject,
304  rti1516_2025::AttributeHandleSet const & theAttributeSet,
305  rti1516_2025::FederateHandle const & theOwner) override;
306 
307  virtual void attributeIsNotOwned(rti1516_2025::ObjectInstanceHandle const & theObject,
308  rti1516_2025::AttributeHandleSet const & theAttributeSet) override;
309 
310  virtual void attributeIsOwnedByRTI(rti1516_2025::ObjectInstanceHandle const & theObject,
311  rti1516_2025::AttributeHandleSet const & theAttributeSet) override;
312 
316 
318  virtual void timeRegulationEnabled(rti1516_2025::LogicalTime const & theFederateTime) override;
319 
321  virtual void timeConstrainedEnabled(rti1516_2025::LogicalTime const & theFederateTime) override;
322 
324  virtual void timeAdvanceGrant(rti1516_2025::LogicalTime const & theTime) override;
325 
327  virtual void requestRetraction(rti1516_2025::MessageRetractionHandle const & theHandle) override;
328 
329  protected:
330  DtFederateMgr* myFedMgr;
331 };
332 
333 #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
rti1516_2025::fedpro::OrderType
OrderType
Definition: datatypes.pb.h:472
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
fedAmbWrap1516_2025.h
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
synchronizationPointRegistrationFailed
virtual void synchronizationPointRegistrationFailed(const char *label)=0
supplied C4)
rti1516::RegionHandleSet
std::set< RegionHandle > RegionHandleSet
Definition: Typedefs.h:31
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
rti1516_2025::fedpro::RestoreFailureReason
RestoreFailureReason
Definition: datatypes.pb.h:388
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:93
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
rti1516_2025::fedpro::SaveFailureReason
SaveFailureReason
Definition: datatypes.pb.h:359
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
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
rti1516::FederateHandleSet
std::set< FederateHandle > FederateHandleSet
Definition: Typedefs.h:29
DT_DLL_LRC
#define DT_DLL_LRC
Definition: rtiMsConfig.h:155
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_2025::fedpro::SynchronizationPointFailureReason
SynchronizationPointFailureReason
Definition: datatypes.pb.h:334
Document ID: Generated on Sun Jul 20 16:15:30 EDT 2025 from SVN revision 277985
Copyright © 2005-2025 MAK Technologies Inc. All Rights Reserved (www.mak.com)