MAK RTIspy API Documentation for HLA 1516
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
momWrapper1516_2025.h
Go to the documentation of this file.
1 /*********************************************************************
2 ** Copyright (c) 2024 MAK Technologies, Inc.
3 ** All rights reserved.
4 *********************************************************************/
5 
8 
9 #pragma once
10 
11 #ifdef DtMOM
12 #ifdef DtIFSPEC1516_2025
13 
14 #include "rtiMsConfig.h"
15 #include "fedAmbWrap1516_2025.h"
16 #include "momArgument.h"
17 
18 class DtFederateMgr;
19 class DtFomClassMgr;
20 class DtMomMgr;
21 class DtObjectMgr;
22 class DtMomWrapper;
23 
25 typedef DtMomWrapper* (*DtMomWrapperCreator)(DtMomMgr* momMgrPtr);
26 
27 class DT_DLL_LRC DtMomWrapper : public DtFedAmbWrapper
28 {
29 public:
30 
32 
33  static DtMomWrapper* create(DtMomMgr* momMgrPtr);
34  static void setCreator(DtMomWrapperCreator functionPtr);
36 
38  DtMomWrapper( DtMomMgr* momMgrPtr );
39 
41  virtual ~DtMomWrapper();
42 
44  virtual DtMomMgr* momMgr();
45 
47  virtual void reset();
48 
49  // Get the verbose level
50  virtual int verboseLevel() const;
51 
52  virtual DtFederateMgr* fedMgr();
53  virtual DtFomClassMgr* fomMgr();
54  virtual DtObjectMgr* objMgr();
55 
58  virtual unsigned long objectRemoveCount() const;
59 
62  virtual unsigned long objectDiscoverCount() const;
63 
65 
66 
67 
68  // 4.8
69  virtual void reportFederationExecutions (
70  rti1516_2025::FederationExecutionInformationVector const & report) override;
71 
72  // 4.10
73  virtual void reportFederationExecutionMembers(
74  std::wstring const & thefederationExecutionName,
75  rti1516_2025::FederationExecutionMemberInformationVector const & theFederationExecutionMemberInformationList) override;
76 
77  // 4.12
78  virtual void synchronizationPointRegistrationSucceeded (
79  std::wstring const & label) override;
80 
81  virtual void synchronizationPointRegistrationFailed (
82  std::wstring const & label,
83  rti1516_2025::SynchronizationPointFailureReason reason) override;
84 
85  // 4.13
86  virtual void announceSynchronizationPoint (
87  std::wstring const & label,
88  rti1516_2025::VariableLengthData const & theUserSuppliedTag) override;
89 
90  // 4.15
91  virtual void federationSynchronized (
92  std::wstring const & label,
93  rti1516_2025::FederateHandleSet const& failedToSyncSet) override;
94 
95  // 4.17
96  virtual void initiateFederateSave (
97  std::wstring const & label) override;
98 
99  virtual void initiateFederateSave (
100  std::wstring const & label,
101  rti1516_2025::LogicalTime const & theTime) override;
102 
103  // 4.20
104  virtual void federationSaved () override;
105 
106  virtual void federationNotSaved (
107  rti1516_2025::SaveFailureReason theSaveFailureReason) override;
108 
109 
110  // 4.23
111  virtual void federationSaveStatusResponse (
112  rti1516_2025::FederateHandleSaveStatusPairVector const &
113  theFederateStatusVector) override;
114 
115  // 4.25
116  virtual void requestFederationRestoreSucceeded (
117  std::wstring const & label) override;
118 
119  virtual void requestFederationRestoreFailed (
120  std::wstring const & label) override;
121 
122  // 4.26
123  virtual void federationRestoreBegun () override;
124 
125  // 4.27
126  virtual void initiateFederateRestore (
127  std::wstring const & label,
128  std::wstring const & federateName,
129  rti1516_2025::FederateHandle const & theHandle) override;
130 
131  // 4.29
132  virtual void federationRestored () override;
133 
134  virtual void federationNotRestored (
135  rti1516_2025::RestoreFailureReason theRestoreFailureReason) override;
136 
137  // 4.32
138  virtual void federationRestoreStatusResponse (
139  rti1516_2025::FederateRestoreStatusVector const & theFederateRestoreStatusVector) override;
140 
142  // Declaration Management Services //
144 
145  // 5.10
146  virtual void startRegistrationForObjectClass (
147  rti1516_2025::ObjectClassHandle const & theClass) override;
148 
149  // 5.11
150  virtual void stopRegistrationForObjectClass (
151  rti1516_2025::ObjectClassHandle const & theClass) override;
152 
153  // 5.12
154  virtual void turnInteractionsOn (
155  rti1516_2025::InteractionClassHandle const & theHandle) override;
156 
157  // 5.13
158  virtual void turnInteractionsOff (
159  rti1516_2025::InteractionClassHandle const & theHandle) override;
160 
162  // Object Management Services //
164 
165  // 6.3
166  virtual void objectInstanceNameReservationSucceeded (
167  std::wstring const & theObjectInstanceName) override;
168 
169  virtual void objectInstanceNameReservationFailed (
170  std::wstring const & theObjectInstanceName) override;
171 
172  // 6.6
173  virtual void multipleObjectInstanceNameReservationSucceeded (
174  std::set<std::wstring> const & theObjectInstanceNames) override;
175 
176  virtual void multipleObjectInstanceNameReservationFailed (
177  std::set<std::wstring> const & theObjectInstanceNames) override;
178 
179  // 6.9
180  virtual void discoverObjectInstance (
181  rti1516_2025::ObjectInstanceHandle const & theObject,
182  rti1516_2025::ObjectClassHandle const & theObjectClass,
183  std::wstring const & theObjectInstanceName,
184  rti1516_2025::FederateHandle const & producingFederate) override;
185 
186  // 6.11
187  virtual void reflectAttributeValues(
188  rti1516_2025::ObjectInstanceHandle const& theObject,
189  rti1516_2025::AttributeHandleValueMap const& theAttributeValues,
190  rti1516_2025::VariableLengthData const& theUserSuppliedTag,
191  rti1516_2025::TransportationTypeHandle const& theType,
192  rti1516_2025::FederateHandle const& theProducingFederate,
193  rti1516_2025::RegionHandleSet const* theOptionalSentRegions) override;
194 
195  virtual void reflectAttributeValues(
196  rti1516_2025::ObjectInstanceHandle const& theObject,
197  rti1516_2025::AttributeHandleValueMap const& theAttributeValues,
198  rti1516_2025::VariableLengthData const& theUserSuppliedTag,
199  rti1516_2025::TransportationTypeHandle const& theType,
200  rti1516_2025::FederateHandle const& theProducingFederate,
201  rti1516_2025::RegionHandleSet const* theOptionalSentRegions,
202  rti1516_2025::LogicalTime const& theTime,
203  rti1516_2025::OrderType theSentOrder,
204  rti1516_2025::OrderType theReceivedOrder,
205  rti1516_2025::MessageRetractionHandle const* theOptionalRetraction) override;
206 
207  // 6.13
208  virtual void receiveInteraction(
209  rti1516_2025::InteractionClassHandle const& theInteraction,
210  rti1516_2025::ParameterHandleValueMap const& theParameterValues,
211  rti1516_2025::VariableLengthData const& theUserSuppliedTag,
212  rti1516_2025::TransportationTypeHandle const& theType,
213  rti1516_2025::FederateHandle const& theProducingFederate,
214  const rti1516_2025::RegionHandleSet* theOptionalSentRegions) override;
215 
216  virtual void receiveInteraction(
217  rti1516_2025::InteractionClassHandle const& theInteraction,
218  rti1516_2025::ParameterHandleValueMap const& theParameterValues,
219  rti1516_2025::VariableLengthData const& theUserSuppliedTag,
220  rti1516_2025::TransportationTypeHandle const& theType,
221  rti1516_2025::FederateHandle const& theProducingFederate,
222  rti1516_2025::RegionHandleSet const* theOptionalSentRegions,
223  rti1516_2025::LogicalTime const& theTime,
224  rti1516_2025::OrderType theSentOrder,
225  rti1516_2025::OrderType theReceivedOrder,
226  rti1516_2025::MessageRetractionHandle const* theOptionalRetraction) override;
227 
228  // 6.13
229  virtual void receiveDirectedInteraction(
230  rti1516_2025::InteractionClassHandle const& theInteraction,
231  rti1516_2025::ObjectInstanceHandle const& theObject,
232  rti1516_2025::ParameterHandleValueMap const& theParameterValues,
233  rti1516_2025::VariableLengthData const& theUserSuppliedTag,
234  rti1516_2025::TransportationTypeHandle const& theType,
235  rti1516_2025::FederateHandle const& producingFederate) override;
236 
237  virtual void receiveDirectedInteraction(
238  rti1516_2025::InteractionClassHandle const& theInteraction,
239  rti1516_2025::ObjectInstanceHandle const& theObject,
240  rti1516_2025::ParameterHandleValueMap const& theParameterValues,
241  rti1516_2025::VariableLengthData const& theUserSuppliedTag,
242  rti1516_2025::TransportationTypeHandle const& theType,
243  rti1516_2025::FederateHandle const& theProducingFederate,
244  rti1516_2025::LogicalTime const& theTime,
245  rti1516_2025::OrderType theSentOrder,
246  rti1516_2025::OrderType theReceivedOrder,
247  rti1516_2025::MessageRetractionHandle const* theOptionalRetraction) override;
248 
249  // 6.15
250  virtual void removeObjectInstance(
251  rti1516_2025::ObjectInstanceHandle const& theObject,
252  rti1516_2025::VariableLengthData const& theUserSuppliedTag,
253  rti1516_2025::FederateHandle const& theProducingFederate) override;
254 
255  virtual void removeObjectInstance(
256  rti1516_2025::ObjectInstanceHandle const& theObject,
257  rti1516_2025::VariableLengthData const& theUserSuppliedTag,
258  rti1516_2025::FederateHandle const& theProducingFederate,
259  rti1516_2025::LogicalTime const& theTime,
260  rti1516_2025::OrderType theSentOrder,
261  rti1516_2025::OrderType theReceivedOrder,
262  rti1516_2025::MessageRetractionHandle const* theOptionalRetraction) override;
263 
264  // 6.17
265  virtual void attributesInScope (
266  rti1516_2025::ObjectInstanceHandle const & theObject,
267  rti1516_2025::AttributeHandleSet const & theAttributes) override;
268 
269  // 6.18
270  virtual void attributesOutOfScope (
271  rti1516_2025::ObjectInstanceHandle const & theObject,
272  rti1516_2025::AttributeHandleSet const & theAttributes) override;
273 
274  // 6.20
275  virtual void provideAttributeValueUpdate (
276  rti1516_2025::ObjectInstanceHandle const & theObject,
277  rti1516_2025::AttributeHandleSet const & theAttributes,
278  rti1516_2025::VariableLengthData const & theUserSuppliedTag) override;
279 
280  // 6.21
281  virtual void turnUpdatesOnForObjectInstance (
282  rti1516_2025::ObjectInstanceHandle const & theObject,
283  rti1516_2025::AttributeHandleSet const & theAttributes) override;
284 
285  virtual void turnUpdatesOnForObjectInstance (
286  rti1516_2025::ObjectInstanceHandle const & theObject,
287  rti1516_2025::AttributeHandleSet const & theAttributes,
288  std::wstring const & updateRateDesignator) override;
289 
290  // 6.22
291  virtual void turnUpdatesOffForObjectInstance (
292  rti1516_2025::ObjectInstanceHandle const & theObject,
293  rti1516_2025::AttributeHandleSet const & theAttributes) override;
294 
295  // 6.24
296  virtual void confirmAttributeTransportationTypeChange (
297  rti1516_2025::ObjectInstanceHandle const & theObject,
298  rti1516_2025::AttributeHandleSet const & theAttributes,
299  rti1516_2025::TransportationTypeHandle const & theTransportation) override;
300 
301  // 6.26
302  virtual void reportAttributeTransportationType (
303  rti1516_2025::ObjectInstanceHandle const & theObject,
304  rti1516_2025::AttributeHandle const & theAttribute,
305  rti1516_2025::TransportationTypeHandle const & theTransportation) override;
306 
307  // 6.28
308  virtual void confirmInteractionTransportationTypeChange (
309  rti1516_2025::InteractionClassHandle const & theInteraction,
310  rti1516_2025::TransportationTypeHandle const & theTransportation) override;
311 
312  // 6.30
313  virtual void reportInteractionTransportationType (
314  rti1516_2025::FederateHandle const & theFederateHandle,
315  rti1516_2025::InteractionClassHandle const & theInteraction,
316  rti1516_2025::TransportationTypeHandle const & theTransportation) override;
317 
318 
320  // Ownership Management Services //
322 
323  // 7.4
324  virtual void requestAttributeOwnershipAssumption (
325  rti1516_2025::ObjectInstanceHandle const & theObject,
326  rti1516_2025::AttributeHandleSet const & offeredAttributes,
327  rti1516_2025::VariableLengthData const & theUserSuppliedTag) override;
328 
329  // 7.5
330  virtual void requestDivestitureConfirmation (
331  rti1516_2025::ObjectInstanceHandle const & theObject,
332  rti1516_2025::AttributeHandleSet const & releasedAttributes,
333  rti1516_2025::VariableLengthData const & theUserSuppliedTag) override;
334 
335  // 7.7
336  virtual void attributeOwnershipAcquisitionNotification (
337  rti1516_2025::ObjectInstanceHandle const & theObject,
338  rti1516_2025::AttributeHandleSet const & securedAttributes,
339  rti1516_2025::VariableLengthData const & theUserSuppliedTag) override;
340 
341  // 7.10
342  virtual void attributeOwnershipUnavailable (
343  rti1516_2025::ObjectInstanceHandle const & theObject,
344  rti1516_2025::AttributeHandleSet const & theAttributes,
345  rti1516_2025::VariableLengthData const & theUserSuppliedTag) override;
346 
347  // 7.11
348  virtual void requestAttributeOwnershipRelease (
349  rti1516_2025::ObjectInstanceHandle const & theObject,
350  rti1516_2025::AttributeHandleSet const & candidateAttributes,
351  rti1516_2025::VariableLengthData const & theUserSuppliedTag) override;
352 
353  // 7.16
354  virtual void confirmAttributeOwnershipAcquisitionCancellation (
355  rti1516_2025::ObjectInstanceHandle const & theObject,
356  rti1516_2025::AttributeHandleSet const & theAttributes) override;
357 
358  // 7.18
359  virtual void informAttributeOwnership (
360  rti1516_2025::ObjectInstanceHandle const & theObject,
361  rti1516_2025::AttributeHandleSet const & theAttributeSet,
362  rti1516_2025::FederateHandle const & theOwner) override;
363 
364  virtual void attributeIsNotOwned (
365  rti1516_2025::ObjectInstanceHandle const & theObject,
366  rti1516_2025::AttributeHandleSet const & theAttributeSet) override;
367 
368  virtual void attributeIsOwnedByRTI (
369  rti1516_2025::ObjectInstanceHandle const & theObject,
370  rti1516_2025::AttributeHandleSet const & theAttributeSet) override;
371 
373  // Time Management Services //
375 
376  // 8.3
377  virtual void timeRegulationEnabled (
378  rti1516_2025::LogicalTime const & theFederateTime) override;
379 
380  // 8.6
381  virtual void timeConstrainedEnabled (
382  rti1516_2025::LogicalTime const & theFederateTime) override;
383 
384  // 8.13
385  virtual void timeAdvanceGrant (
386  rti1516_2025::LogicalTime const & theTime) override;
387 
388  // 8.22
389  virtual void requestRetraction (
390  rti1516_2025::MessageRetractionHandle const & theHandle) override;
392 
393 private:
395  DtMomWrapper( const DtMomWrapper& src );
396 
398  DtMomWrapper& operator=( const DtMomWrapper& src );
399 
400 protected:
401  DtMomMgr* myMomMgr;
402  unsigned long myDiscoverCount;
403  unsigned long myRemoveCount;
404 
405  static const DtMomArgument theDfltMomArgument;
406  static const DtMomArgument theDfltRetVal;
407  static DtMomWrapperCreator theCreator;
408 };
409 
410 #endif
411 #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
DtFomClassMgr
Definition: fomMgr.h:49
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
DtObjectMgr
The object manager class processes the object management services.
Definition: objMgr.h:81
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)