MAK RTIspy API Documentation for HLA 4
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
NullFederateAmbassador.h
Go to the documentation of this file.
1 #pragma once
2 /***********************************************************************
3  The IEEE hereby grants a general, royalty-free license to copy, distribute,
4  display and make derivative works from this material, for all purposes,
5  provided that any use of the material contains the following
6  attribution: "Reprinted with permission from IEEE 1516.1(TM)-2025".
7  Should you require additional information, contact the Manager, Standards
8  Intellectual Property, IEEE Standards Association (stds-ipr@ieee.org).
9 ***********************************************************************/
10 
11 #if defined(_WIN32)
12 #pragma warning(disable : 4100)
13 #endif
14 
15 #include <RTI/Exception.h>
16 #include <RTI/FederateAmbassador.h>
17 
18 namespace rti1516_2025
19 {
21  {
22  public:
24  = default;
25 
27  noexcept override = default;
28 
32  std::wstring const & faultDescription) override
33  {}
34 
38  FederationExecutionInformationVector const & report) override
39  {}
40 
44  std::wstring const & federationName,
45  FederationExecutionMemberInformationVector const & report) override
46  {}
47 
51  std::wstring const & federationName) override
52  {}
53 
57  std::wstring const & reasonForResignDescription) override
58  {}
59 
63  std::wstring const & synchronizationPointLabel) override
64  {}
65 
69  std::wstring const & synchronizationPointLabel,
70  SynchronizationPointFailureReason reason) override
71  {}
72 
76  std::wstring const & synchronizationPointLabel,
77  VariableLengthData const & userSuppliedTag) override
78  {}
79 
83  std::wstring const & synchronizationPointLabel,
84  FederateHandleSet const & failedToSyncSet) override
85  {}
86 
90  std::wstring const & label) override
91  {}
92 
96  std::wstring const & label,
97  LogicalTime const & time) override
98  {}
99 
102  void federationSaved () override
103  {}
104 
108  SaveFailureReason reason) override
109  {}
110 
111 
115  FederateHandleSaveStatusPairVector const & response) override
116  {}
117 
121  std::wstring const & label) override
122  {}
123 
127  std::wstring const & label) override
128  {}
129 
132  void federationRestoreBegun () override
133  {}
134 
138  std::wstring const & label,
139  std::wstring const & federateName,
140  FederateHandle const & postRestoreFederateHandle) override
141  {}
142 
145  void federationRestored () override
146  {}
147 
151  RestoreFailureReason reason) override
152  {}
153 
157  FederateRestoreStatusVector const & response) override
158  {}
159 
163  ObjectClassHandle const & objectClass) override
164  {}
165 
169  ObjectClassHandle const & objectClass) override
170  {}
171 
175  InteractionClassHandle const & interactionClass) override
176  {}
177 
181  InteractionClassHandle const & interactionClass) override
182  {}
183 
187  std::wstring const & objectInstanceName) override
188  {}
189 
193  std::wstring const & objectInstanceName) override
194  {}
195 
199  std::set<std::wstring> const & objectInstanceNames) override
200  {}
201 
205  std::set<std::wstring> const & objectInstanceNames) override
206  {}
207 
211  ObjectInstanceHandle const & objectInstance,
212  ObjectClassHandle const & objectClass,
213  std::wstring const & objectInstanceName,
214  FederateHandle const & producingFederate) override
215  {}
216 
220  ObjectInstanceHandle const & objectInstance,
221  AttributeHandleValueMap const & attributeValues,
222  VariableLengthData const & userSuppliedTag,
223  TransportationTypeHandle const & transportationType,
224  FederateHandle const & producingFederate,
225  RegionHandleSet const * optionalSentRegions) override
226  {}
227 
231  ObjectInstanceHandle const & objectInstance,
232  AttributeHandleValueMap const & attributeValues,
233  VariableLengthData const & userSuppliedTag,
234  TransportationTypeHandle const & transportationType,
235  FederateHandle const & producingFederate,
236  RegionHandleSet const * optionalSentRegions,
237  LogicalTime const & time,
238  OrderType sentOrderType,
239  OrderType receivedOrderType,
240  MessageRetractionHandle const * optionalRetraction) override
241  {
243  objectInstance, attributeValues, userSuppliedTag, transportationType, producingFederate,
244  optionalSentRegions);
245  }
246 
250  InteractionClassHandle const & interactionClass,
251  ParameterHandleValueMap const & parameterValues,
252  VariableLengthData const & userSuppliedTag,
253  TransportationTypeHandle const & transportationType,
254  FederateHandle const & producingFederate,
255  const RegionHandleSet * optionalSentRegions) override
256  {}
257 
261  InteractionClassHandle const & interactionClass,
262  ParameterHandleValueMap const & parameterValues,
263  VariableLengthData const & userSuppliedTag,
264  TransportationTypeHandle const & transportationType,
265  FederateHandle const & producingFederate,
266  RegionHandleSet const * optionalSentRegions,
267  LogicalTime const & time,
268  OrderType sentOrderType,
269  OrderType receivedOrderType,
270  MessageRetractionHandle const * optionalRetraction) override
271  {
272  receiveInteraction(interactionClass, parameterValues, userSuppliedTag, transportationType, producingFederate,
273  optionalSentRegions);
274  }
275 
279  InteractionClassHandle const & interactionClass,
280  ObjectInstanceHandle const & objectInstance,
281  ParameterHandleValueMap const & parameterValues,
282  VariableLengthData const & userSuppliedTag,
283  TransportationTypeHandle const & transportationType,
284  FederateHandle const & producingFederate) override
285  {}
286 
290  InteractionClassHandle const & interactionClass,
291  ObjectInstanceHandle const & objectInstance,
292  ParameterHandleValueMap const & parameterValues,
293  VariableLengthData const & userSuppliedTag,
294  TransportationTypeHandle const & transportationType,
295  FederateHandle const & producingFederate,
296  LogicalTime const & time,
297  OrderType sentOrderType,
298  OrderType receivedOrderType,
299  MessageRetractionHandle const * optionalRetraction) override
300  {
301  receiveDirectedInteraction(interactionClass, objectInstance, parameterValues, userSuppliedTag, transportationType,
302  producingFederate);
303  }
304 
308  ObjectInstanceHandle const & objectInstance,
309  VariableLengthData const & userSuppliedTag,
310  FederateHandle const & producingFederate) override
311  {}
312 
316  ObjectInstanceHandle const & objectInstance,
317  VariableLengthData const & userSuppliedTag,
318  FederateHandle const & producingFederate,
319  LogicalTime const & time,
320  OrderType sentOrderType,
321  OrderType receivedOrderType,
322  MessageRetractionHandle const * optionalRetraction) override
323  {
324  removeObjectInstance(objectInstance, userSuppliedTag, producingFederate);
325  }
326 
330  ObjectInstanceHandle const & objectInstance,
331  AttributeHandleSet const & attributes) override
332  {}
333 
337  ObjectInstanceHandle const & objectInstance,
338  AttributeHandleSet const & attributes) override
339  {}
340 
344  ObjectInstanceHandle const & objectInstance,
345  AttributeHandleSet const & attributes,
346  VariableLengthData const & userSuppliedTag) override
347  {}
348 
352  ObjectInstanceHandle const & objectInstance,
353  AttributeHandleSet const & attributes) override
354  {}
355 
359  ObjectInstanceHandle const & objectInstance,
360  AttributeHandleSet const & attributes,
361  std::wstring const & updateRateDesignator) override
362  {}
363 
367  ObjectInstanceHandle const & objectInstance,
368  AttributeHandleSet const & attributes) override
369  {}
370 
374  ObjectInstanceHandle const & objectInstance,
375  AttributeHandleSet const & attributes,
376  TransportationTypeHandle const & transportationType) override
377  {}
378 
382  ObjectInstanceHandle const & objectInstance,
383  AttributeHandle const & attribute,
384  TransportationTypeHandle const & transportationType) override
385  {}
386 
390  InteractionClassHandle const & interactionClass,
391  TransportationTypeHandle const & transportationType) override
392  {}
393 
397  FederateHandle const & federate,
398  InteractionClassHandle const & interactionClass,
399  TransportationTypeHandle const & transportationType) override
400  {}
401 
402 
406  ObjectInstanceHandle const & objectInstance,
407  AttributeHandleSet const & offeredAttributes,
408  VariableLengthData const & userSuppliedTag) override
409  {}
410 
414  ObjectInstanceHandle const & objectInstance,
415  AttributeHandleSet const & releasedAttributes,
416  VariableLengthData const & userSuppliedTag) override
417  {}
418 
422  ObjectInstanceHandle const & objectInstance,
423  AttributeHandleSet const & securedAttributes,
424  VariableLengthData const & userSuppliedTag) override
425  {}
426 
430  ObjectInstanceHandle const & objectInstance,
431  AttributeHandleSet const & attributes,
432  VariableLengthData const & userSuppliedTag) override
433  {}
434 
438  ObjectInstanceHandle const & objectInstance,
439  AttributeHandleSet const & candidateAttributes,
440  VariableLengthData const & userSuppliedTag) override
441  {}
442 
446  ObjectInstanceHandle const & objectInstance,
447  AttributeHandleSet const & attributes) override
448  {}
449 
453  ObjectInstanceHandle const & objectInstance,
454  AttributeHandleSet const & attributes,
455  FederateHandle const & owner) override
456  {}
457 
461  ObjectInstanceHandle const & objectInstance,
462  AttributeHandleSet const & attributes) override
463  {}
464 
468  ObjectInstanceHandle const & objectInstance,
469  AttributeHandleSet const & attributes) override
470  {}
471 
475  LogicalTime const & time) override
476  {}
477 
481  LogicalTime const & time) override
482  {}
483 
487  LogicalTime const & time, LogicalTime const & optimisticTime) override
488  {}
489 
493  LogicalTime const & time) override
494  {}
495 
499  MessageRetractionHandle const & retraction) override
500  {}
501  };
502 }
503 
504 
Definition: LogicalTime.h:30
void requestAttributeOwnershipRelease(ObjectInstanceHandle const &objectInstance, AttributeHandleSet const &candidateAttributes, VariableLengthData const &userSuppliedTag) override
Definition: NullFederateAmbassador.h:437
std::set< AttributeHandle > AttributeHandleSet
Definition: Typedefs.h:29
void receiveDirectedInteraction(InteractionClassHandle const &interactionClass, ObjectInstanceHandle const &objectInstance, ParameterHandleValueMap const &parameterValues, VariableLengthData const &userSuppliedTag, TransportationTypeHandle const &transportationType, FederateHandle const &producingFederate, LogicalTime const &time, OrderType sentOrderType, OrderType receivedOrderType, MessageRetractionHandle const *optionalRetraction) override
Definition: NullFederateAmbassador.h:289
void confirmAttributeTransportationTypeChange(ObjectInstanceHandle const &objectInstance, AttributeHandleSet const &attributes, TransportationTypeHandle const &transportationType) override
Definition: NullFederateAmbassador.h:373
#define RTI_EXPORT
Definition: SpecificConfig.h:45
void reportFederationExecutionMembers(std::wstring const &federationName, FederationExecutionMemberInformationVector const &report) override
Definition: NullFederateAmbassador.h:43
std::vector< FederationExecutionInformation > FederationExecutionInformationVector
Definition: Typedefs.h:112
void receiveInteraction(InteractionClassHandle const &interactionClass, ParameterHandleValueMap const &parameterValues, VariableLengthData const &userSuppliedTag, TransportationTypeHandle const &transportationType, FederateHandle const &producingFederate, RegionHandleSet const *optionalSentRegions, LogicalTime const &time, OrderType sentOrderType, OrderType receivedOrderType, MessageRetractionHandle const *optionalRetraction) override
Definition: NullFederateAmbassador.h:260
void requestFederationRestoreSucceeded(std::wstring const &label) override
Definition: NullFederateAmbassador.h:120
std::vector< FederateRestoreStatus > FederateRestoreStatusVector
Definition: Typedefs.h:95
OrderType
Definition: Enums.h:28
void provideAttributeValueUpdate(ObjectInstanceHandle const &objectInstance, AttributeHandleSet const &attributes, VariableLengthData const &userSuppliedTag) override
Definition: NullFederateAmbassador.h:343
void turnInteractionsOff(InteractionClassHandle const &interactionClass) override
Definition: NullFederateAmbassador.h:180
void federationRestored() override
Definition: NullFederateAmbassador.h:145
void receiveInteraction(InteractionClassHandle const &interactionClass, ParameterHandleValueMap const &parameterValues, VariableLengthData const &userSuppliedTag, TransportationTypeHandle const &transportationType, FederateHandle const &producingFederate, const RegionHandleSet *optionalSentRegions) override
Definition: NullFederateAmbassador.h:249
void federationNotSaved(SaveFailureReason reason) override
Definition: NullFederateAmbassador.h:107
void timeRegulationEnabled(LogicalTime const &time) override
Definition: NullFederateAmbassador.h:474
void federationRestoreStatusResponse(FederateRestoreStatusVector const &response) override
Definition: NullFederateAmbassador.h:156
void federateResigned(std::wstring const &reasonForResignDescription) override
Definition: NullFederateAmbassador.h:56
SynchronizationPointFailureReason
Definition: Enums.h:92
void requestDivestitureConfirmation(ObjectInstanceHandle const &objectInstance, AttributeHandleSet const &releasedAttributes, VariableLengthData const &userSuppliedTag) override
Definition: NullFederateAmbassador.h:413
void synchronizationPointRegistrationSucceeded(std::wstring const &synchronizationPointLabel) override
Definition: NullFederateAmbassador.h:62
void initiateFederateRestore(std::wstring const &label, std::wstring const &federateName, FederateHandle const &postRestoreFederateHandle) override
Definition: NullFederateAmbassador.h:137
SaveFailureReason
Definition: Enums.h:63
void objectInstanceNameReservationSucceeded(std::wstring const &objectInstanceName) override
Definition: NullFederateAmbassador.h:186
void initiateFederateSave(std::wstring const &label) override
Definition: NullFederateAmbassador.h:89
void discoverObjectInstance(ObjectInstanceHandle const &objectInstance, ObjectClassHandle const &objectClass, std::wstring const &objectInstanceName, FederateHandle const &producingFederate) override
Definition: NullFederateAmbassador.h:210
void attributeIsOwnedByRTI(ObjectInstanceHandle const &objectInstance, AttributeHandleSet const &attributes) override
Definition: NullFederateAmbassador.h:467
void reflectAttributeValues(ObjectInstanceHandle const &objectInstance, AttributeHandleValueMap const &attributeValues, VariableLengthData const &userSuppliedTag, TransportationTypeHandle const &transportationType, FederateHandle const &producingFederate, RegionHandleSet const *optionalSentRegions) override
Definition: NullFederateAmbassador.h:219
void attributeOwnershipAcquisitionNotification(ObjectInstanceHandle const &objectInstance, AttributeHandleSet const &securedAttributes, VariableLengthData const &userSuppliedTag) override
Definition: NullFederateAmbassador.h:421
void removeObjectInstance(ObjectInstanceHandle const &objectInstance, VariableLengthData const &userSuppliedTag, FederateHandle const &producingFederate, LogicalTime const &time, OrderType sentOrderType, OrderType receivedOrderType, MessageRetractionHandle const *optionalRetraction) override
Definition: NullFederateAmbassador.h:315
void reportFederationExecutions(FederationExecutionInformationVector const &report) override
Definition: NullFederateAmbassador.h:37
void reportInteractionTransportationType(FederateHandle const &federate, InteractionClassHandle const &interactionClass, TransportationTypeHandle const &transportationType) override
Definition: NullFederateAmbassador.h:396
virtual void receiveInteraction(InteractionClassHandle theInteraction, const ParameterHandleValuePairSet &theParameters, const FedTime &theTime, const char *theTag, EventRetractionHandle theHandle)=0
6.7
virtual void removeObjectInstance(ObjectHandle theObject, const FedTime &theTime, const char *theTag, EventRetractionHandle theHandle)=0
6.9
void flushQueueGrant(LogicalTime const &time, LogicalTime const &optimisticTime) override
Definition: NullFederateAmbassador.h:486
std::vector< FederationExecutionMemberInformation > FederationExecutionMemberInformationVector
Definition: Typedefs.h:129
void attributeOwnershipUnavailable(ObjectInstanceHandle const &objectInstance, AttributeHandleSet const &attributes, VariableLengthData const &userSuppliedTag) override
Definition: NullFederateAmbassador.h:429
void requestRetraction(MessageRetractionHandle const &retraction) override
Definition: NullFederateAmbassador.h:498
void federationSaveStatusResponse(FederateHandleSaveStatusPairVector const &response) override
Definition: NullFederateAmbassador.h:114
void informAttributeOwnership(ObjectInstanceHandle const &objectInstance, AttributeHandleSet const &attributes, FederateHandle const &owner) override
Definition: NullFederateAmbassador.h:452
void attributesOutOfScope(ObjectInstanceHandle const &objectInstance, AttributeHandleSet const &attributes) override
Definition: NullFederateAmbassador.h:336
void turnUpdatesOnForObjectInstance(ObjectInstanceHandle const &objectInstance, AttributeHandleSet const &attributes) override
Definition: NullFederateAmbassador.h:351
void timeConstrainedEnabled(LogicalTime const &time) override
Definition: NullFederateAmbassador.h:480
void stopRegistrationForObjectClass(ObjectClassHandle const &objectClass) override
Definition: NullFederateAmbassador.h:168
void federationSynchronized(std::wstring const &synchronizationPointLabel, FederateHandleSet const &failedToSyncSet) override
Definition: NullFederateAmbassador.h:82
void timeAdvanceGrant(LogicalTime const &time) override
Definition: NullFederateAmbassador.h:492
void turnUpdatesOnForObjectInstance(ObjectInstanceHandle const &objectInstance, AttributeHandleSet const &attributes, std::wstring const &updateRateDesignator) override
Definition: NullFederateAmbassador.h:358
void connectionLost(std::wstring const &faultDescription) override
Definition: NullFederateAmbassador.h:31
void attributesInScope(ObjectInstanceHandle const &objectInstance, AttributeHandleSet const &attributes) override
Definition: NullFederateAmbassador.h:329
virtual void reflectAttributeValues(ObjectHandle theObject, const AttributeHandleValuePairSet &theAttributes, const FedTime &theTime, const char *theTag, EventRetractionHandle theHandle)=0
6.5
An abstract base class which must be implemented, and used by a federate.
Definition: FederateAmbassador.h:26
void reflectAttributeValues(ObjectInstanceHandle const &objectInstance, AttributeHandleValueMap const &attributeValues, VariableLengthData const &userSuppliedTag, TransportationTypeHandle const &transportationType, FederateHandle const &producingFederate, RegionHandleSet const *optionalSentRegions, LogicalTime const &time, OrderType sentOrderType, OrderType receivedOrderType, MessageRetractionHandle const *optionalRetraction) override
Definition: NullFederateAmbassador.h:230
void requestFederationRestoreFailed(std::wstring const &label) override
Definition: NullFederateAmbassador.h:126
std::map< AttributeHandle, VariableLengthData > AttributeHandleValueMap
Definition: Typedefs.h:39
void objectInstanceNameReservationFailed(std::wstring const &objectInstanceName) override
Definition: NullFederateAmbassador.h:192
Definition: NullFederateAmbassador.h:20
void synchronizationPointRegistrationFailed(std::wstring const &synchronizationPointLabel, SynchronizationPointFailureReason reason) override
Definition: NullFederateAmbassador.h:68
void announceSynchronizationPoint(std::wstring const &synchronizationPointLabel, VariableLengthData const &userSuppliedTag) override
Definition: NullFederateAmbassador.h:75
void turnUpdatesOffForObjectInstance(ObjectInstanceHandle const &objectInstance, AttributeHandleSet const &attributes) override
Definition: NullFederateAmbassador.h:366
void requestAttributeOwnershipAssumption(ObjectInstanceHandle const &objectInstance, AttributeHandleSet const &offeredAttributes, VariableLengthData const &userSuppliedTag) override
Definition: NullFederateAmbassador.h:405
void reportFederationExecutionDoesNotExist(std::wstring const &federationName) override
Definition: NullFederateAmbassador.h:50
std::vector< FederateHandleSaveStatusPair > FederateHandleSaveStatusPairVector
Definition: Typedefs.h:60
void multipleObjectInstanceNameReservationFailed(std::set< std::wstring > const &objectInstanceNames) override
Definition: NullFederateAmbassador.h:204
void federationRestoreBegun() override
Definition: NullFederateAmbassador.h:132
void attributeIsNotOwned(ObjectInstanceHandle const &objectInstance, AttributeHandleSet const &attributes) override
Definition: NullFederateAmbassador.h:460
void startRegistrationForObjectClass(ObjectClassHandle const &objectClass) override
Definition: NullFederateAmbassador.h:162
Definition: VariableLengthData.h:28
void reportAttributeTransportationType(ObjectInstanceHandle const &objectInstance, AttributeHandle const &attribute, TransportationTypeHandle const &transportationType) override
Definition: NullFederateAmbassador.h:381
void federationNotRestored(RestoreFailureReason reason) override
Definition: NullFederateAmbassador.h:150
RestoreFailureReason
Definition: Enums.h:44
void confirmAttributeOwnershipAcquisitionCancellation(ObjectInstanceHandle const &objectInstance, AttributeHandleSet const &attributes) override
Definition: NullFederateAmbassador.h:445
void receiveDirectedInteraction(InteractionClassHandle const &interactionClass, ObjectInstanceHandle const &objectInstance, ParameterHandleValueMap const &parameterValues, VariableLengthData const &userSuppliedTag, TransportationTypeHandle const &transportationType, FederateHandle const &producingFederate) override
Definition: NullFederateAmbassador.h:278
void confirmInteractionTransportationTypeChange(InteractionClassHandle const &interactionClass, TransportationTypeHandle const &transportationType) override
Definition: NullFederateAmbassador.h:389
std::map< ParameterHandle, VariableLengthData > ParameterHandleValueMap
Definition: Typedefs.h:44
void federationSaved() override
Definition: NullFederateAmbassador.h:102
void initiateFederateSave(std::wstring const &label, LogicalTime const &time) override
Definition: NullFederateAmbassador.h:95
his file contains the rti1516_2025::FederateAmbassador class.
void multipleObjectInstanceNameReservationSucceeded(std::set< std::wstring > const &objectInstanceNames) override
Definition: NullFederateAmbassador.h:198
std::set< FederateHandle > FederateHandleSet
Definition: Typedefs.h:32
void turnInteractionsOn(InteractionClassHandle const &interactionClass) override
Definition: NullFederateAmbassador.h:174
std::set< RegionHandle > RegionHandleSet
Definition: Typedefs.h:34
void removeObjectInstance(ObjectInstanceHandle const &objectInstance, VariableLengthData const &userSuppliedTag, FederateHandle const &producingFederate) override
Definition: NullFederateAmbassador.h:307

Document ID: Generated on Wed Jul 8 16:20:32 EDT 2026 from SVN revision 291616
Copyright © 2005-2025 MAK Technologies Inc. All Rights Reserved (www.mak.com)