VR-Link API Documentation for HLA 4
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
nullFederateAmbassador1516_4.h
Go to the documentation of this file.
1 /*******************************************************************************
2 ** Copyright (c) 1992-2010 MAK Technologies, Inc
3 ** All rights reserved.
4 *******************************************************************************/
5 
6 
7 #if DtHLA_4
8 
11 
12 #pragma once
13 
14 #include <RTI/Exception.h>
15 #include <RTI/FederateAmbassador.h>
16 
17 #include "rtiNamespace.h"
18 #include <vlutil/vlMachineTypes.h>
19 
20 class DT_DLL_VL DtNullFederateAmbassador : public RTI::FederateAmbassador
21 {
22 public:
24 
25  virtual ~DtNullFederateAmbassador() noexcept {};
26 
27 protected:
28 
32  DtNullFederateAmbassador& operator=( const DtNullFederateAmbassador& src );
33 
34 
35 
37  // Federation Management Services //
39 
43  virtual void connectionLost(
44  std::wstring const & faultDescription) {}
45 
50  FederationExecutionInformationVector const & report) {}
51 
56  std::wstring const & federationName,
57  FederationExecutionMemberInformationVector const & report) {}
58 
63  std::wstring const & federationName) {}
64 
68  virtual void federateResigned(
69  std::wstring const & reasonForResignDescription) {}
70 
75  std::wstring const & synchronizationPointLabel) {}
76 
81  std::wstring const & synchronizationPointLabel,
82  SynchronizationPointFailureReason reason) {}
83 
88  std::wstring const & synchronizationPointLabel,
89  VariableLengthData const & userSuppliedTag) {}
90 
94  virtual void federationSynchronized(
95  std::wstring const & synchronizationPointLabel,
96  FederateHandleSet const & failedToSyncSet) {}
97 
101  virtual void initiateFederateSave(
102  std::wstring const & label) {}
103 
107  virtual void initiateFederateSave(
108  std::wstring const & label,
109  LogicalTime const & time) {}
110 
114  virtual void federationSaved() {}
115 
119  virtual void federationNotSaved (
120  SaveFailureReason reason) {}
121 
126  FederateHandleSaveStatusPairVector const & response) {}
127 
132  std::wstring const & label) {}
133 
138  std::wstring const & label) {}
139 
143  virtual void federationRestoreBegun() {}
144 
149  std::wstring const & label,
150  std::wstring const & federateName,
151  FederateHandle const & postRestoreFederateHandle) {}
152 
156  virtual void federationRestored() {}
157 
161  virtual void federationNotRestored (
162  RestoreFailureReason reason) {}
163 
168  FederateRestoreStatusVector const & response) {}
169 
171  // Declaration Management Services //
173 
178  ObjectClassHandle const& objectClass) {}
179 
184  ObjectClassHandle const& objectClass) {}
185 
189  virtual void turnInteractionsOn(
190  InteractionClassHandle const& interactionClass) {}
191 
195  virtual void turnInteractionsOff(
196  InteractionClassHandle const& interactionClass) {}
197 
199  // Object Management Services //
201 
206  std::wstring const& objectInstanceName) {}
207 
212  std::wstring const& objectInstanceName) {}
213 
218  std::set<std::wstring> const& objectInstanceNames) {}
219 
224  std::set<std::wstring> const& objectInstanceNames) {}
225 
226 
231  ObjectInstanceHandle const& objectInstance,
232  ObjectClassHandle const& objectClass,
233  std::wstring const& objectInstanceName,
234  FederateHandle const& producingFederate) {}
235 
240  ObjectInstanceHandle const& objectInstance,
241  AttributeHandleValueMap const& attributeValues,
242  VariableLengthData const& userSuppliedTag,
243  TransportationTypeHandle const& transportationType,
244  FederateHandle const& producingFederate,
245  RegionHandleSet const* optionalSentRegions) {}
246 
251  ObjectInstanceHandle const& objectInstance,
252  AttributeHandleValueMap const& attributeValues,
253  VariableLengthData const& userSuppliedTag,
254  TransportationTypeHandle const& transportationType,
255  FederateHandle const& producingFederate,
256  RegionHandleSet const* optionalSentRegions,
257  LogicalTime const& time,
258  OrderType sentOrderType,
259  OrderType receivedOrderType,
260  MessageRetractionHandle const* optionalRetraction) {}
261 
265  virtual void receiveInteraction(
266  InteractionClassHandle const& interactionClass,
267  ParameterHandleValueMap const& parameterValues,
268  VariableLengthData const& userSuppliedTag,
269  TransportationTypeHandle const& transportationType,
270  FederateHandle const& producingFederate,
271  const RegionHandleSet* optionalSentRegions) {}
272 
276  virtual void receiveInteraction(
277  InteractionClassHandle const& interactionClass,
278  ParameterHandleValueMap const& parameterValues,
279  VariableLengthData const& userSuppliedTag,
280  TransportationTypeHandle const& transportationType,
281  FederateHandle const& producingFederate,
282  RegionHandleSet const* optionalSentRegions,
283  LogicalTime const& time,
284  OrderType sentOrderType,
285  OrderType receivedOrderType,
286  MessageRetractionHandle const* optionalRetraction) {}
287 
292  InteractionClassHandle const& interactionClass,
293  ObjectInstanceHandle const& objectInstance,
294  ParameterHandleValueMap const& parameterValues,
295  VariableLengthData const& userSuppliedTag,
296  TransportationTypeHandle const& transportationType,
297  FederateHandle const& producingFederate) {}
298 
303  InteractionClassHandle const& interactionClass,
304  ObjectInstanceHandle const& objectInstance,
305  ParameterHandleValueMap const& parameterValues,
306  VariableLengthData const& userSuppliedTag,
307  TransportationTypeHandle const& transportationType,
308  FederateHandle const& producingFederate,
309  LogicalTime const& time,
310  OrderType sentOrderType,
311  OrderType receivedOrderType,
312  MessageRetractionHandle const* optionalRetraction) {}
313 
317  virtual void removeObjectInstance(
318  ObjectInstanceHandle const& objectInstance,
319  VariableLengthData const& userSuppliedTag,
320  FederateHandle const& producingFederate) {}
321 
325  virtual void removeObjectInstance(
326  ObjectInstanceHandle const& objectInstance,
327  VariableLengthData const& userSuppliedTag,
328  FederateHandle const& producingFederate,
329  LogicalTime const& time,
330  OrderType sentOrderType,
331  OrderType receivedOrderType,
332  MessageRetractionHandle const* optionalRetraction) {}
333 
337  virtual void attributesInScope(
338  ObjectInstanceHandle const& objectInstance,
339  AttributeHandleSet const& attributes) {}
340 
344  virtual void attributesOutOfScope(
345  ObjectInstanceHandle const& objectInstance,
346  AttributeHandleSet const& attributes) {}
347 
352  ObjectInstanceHandle const& objectInstance,
353  AttributeHandleSet const& attributes,
354  VariableLengthData const& userSuppliedTag) {}
355 
360  ObjectInstanceHandle const& objectInstance,
361  AttributeHandleSet const& attributes) {}
362 
367  ObjectInstanceHandle const& objectInstance,
368  AttributeHandleSet const& attributes,
369  std::wstring const& updateRateDesignator) {}
370 
375  ObjectInstanceHandle const& objectInstance,
376  AttributeHandleSet const& attributes) {}
377 
382  ObjectInstanceHandle const& objectInstance,
383  AttributeHandleSet const& attributes,
384  TransportationTypeHandle const& transportationType) {}
385 
390  ObjectInstanceHandle const& objectInstance,
391  AttributeHandle const& attribute,
392  TransportationTypeHandle const& transportationType) {}
393 
398  InteractionClassHandle const& interactionClass,
399  TransportationTypeHandle const& transportationType) {}
400 
405  FederateHandle const& federate,
406  InteractionClassHandle const& interactionClass,
407  TransportationTypeHandle const& transportationType) {}
408 
409 
411  // Ownership Management Services //
413 
418  ObjectInstanceHandle const& objectInstance,
419  AttributeHandleSet const& offeredAttributes,
420  VariableLengthData const& userSuppliedTag) {}
421 
426  ObjectInstanceHandle const& objectInstance,
427  AttributeHandleSet const& releasedAttributes,
428  VariableLengthData const& userSuppliedTag) {}
429 
434  ObjectInstanceHandle const& objectInstance,
435  AttributeHandleSet const& securedAttributes,
436  VariableLengthData const& userSuppliedTag) {}
437 
442  ObjectInstanceHandle const& objectInstance,
443  AttributeHandleSet const& attributes,
444  VariableLengthData const& userSuppliedTag) {}
445 
450  ObjectInstanceHandle const& objectInstance,
451  AttributeHandleSet const& candidateAttributes,
452  VariableLengthData const& userSuppliedTag) {}
453 
458  ObjectInstanceHandle const& objectInstance,
459  AttributeHandleSet const& attributes) {}
460 
465  ObjectInstanceHandle const& objectInstance,
466  AttributeHandleSet const& attributes,
467  FederateHandle const& owner) {}
468 
472  virtual void attributeIsNotOwned(
473  ObjectInstanceHandle const& objectInstance,
474  AttributeHandleSet const& attributes) {}
475 
479  virtual void attributeIsOwnedByRTI(
480  ObjectInstanceHandle const& objectInstance,
481  AttributeHandleSet const& attributes) {}
482 
484  // Time Management Services //
486 
490  virtual void timeRegulationEnabled(
491  LogicalTime const& time) {}
492 
497  LogicalTime const& time) {}
498 
502  virtual void flushQueueGrant(
503  LogicalTime const& time, LogicalTime const& optimisticTime) {}
504 
508  virtual void timeAdvanceGrant(
509  LogicalTime const& time) {}
510 
514  virtual void requestRetraction(
515  MessageRetractionHandle const& retraction) {}
516 
517 };
518 
519 #endif
520 
521 
522 
virtual void receiveInteraction(InteractionClassHandle const &interactionClass, ParameterHandleValueMap const &parameterValues, VariableLengthData const &userSuppliedTag, TransportationTypeHandle const &transportationType, FederateHandle const &producingFederate, const RegionHandleSet *optionalSentRegions)
6.13
Definition: nullFederateAmbassador1516_4.h:265
virtual void reportFederationExecutionDoesNotExist(std::wstring const &federationName)
4.11
Definition: nullFederateAmbassador1516_4.h:62
virtual void timeConstrainedEnabled(LogicalTime const &time)
8.6
Definition: nullFederateAmbassador1516_4.h:496
virtual void federationRestoreBegun()
4.29
Definition: nullFederateAmbassador1516_4.h:143
virtual void multipleObjectInstanceNameReservationFailed(std::set< std::wstring > const &objectInstanceNames)
6.6
Definition: nullFederateAmbassador1516_4.h:223
virtual void attributeIsOwnedByRTI(ObjectInstanceHandle const &objectInstance, AttributeHandleSet const &attributes)
7.18
Definition: nullFederateAmbassador1516_4.h:479
virtual void synchronizationPointRegistrationSucceeded(std::wstring const &synchronizationPointLabel)
4.15
Definition: nullFederateAmbassador1516_4.h:74
virtual void federationSaved()
4.23
Definition: nullFederateAmbassador1516_4.h:114
virtual void federationNotRestored(RestoreFailureReason reason)
4.32
Definition: nullFederateAmbassador1516_4.h:161
virtual void turnUpdatesOnForObjectInstance(ObjectInstanceHandle const &objectInstance, AttributeHandleSet const &attributes)
6.23
Definition: nullFederateAmbassador1516_4.h:359
virtual void removeObjectInstance(ObjectInstanceHandle const &objectInstance, VariableLengthData const &userSuppliedTag, FederateHandle const &producingFederate, LogicalTime const &time, OrderType sentOrderType, OrderType receivedOrderType, MessageRetractionHandle const *optionalRetraction)
6.17
Definition: nullFederateAmbassador1516_4.h:325
virtual void objectInstanceNameReservationSucceeded(std::wstring const &objectInstanceName)
6.3
Definition: nullFederateAmbassador1516_4.h:205
#define DT_DLL_VL
Definition: vlMachineTypes.h:108
virtual void federateResigned(std::wstring const &reasonForResignDescription)
4.13
Definition: nullFederateAmbassador1516_4.h:68
virtual void multipleObjectInstanceNameReservationSucceeded(std::set< std::wstring > const &objectInstanceNames)
6.6
Definition: nullFederateAmbassador1516_4.h:217
virtual void requestAttributeOwnershipRelease(ObjectInstanceHandle const &objectInstance, AttributeHandleSet const &candidateAttributes, VariableLengthData const &userSuppliedTag)
7.11
Definition: nullFederateAmbassador1516_4.h:449
virtual void federationSynchronized(std::wstring const &synchronizationPointLabel, FederateHandleSet const &failedToSyncSet)
4.18
Definition: nullFederateAmbassador1516_4.h:94
virtual 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)
6.13
Definition: nullFederateAmbassador1516_4.h:276
virtual ~DtNullFederateAmbassador() noexcept
Definition: nullFederateAmbassador1516_4.h:25
virtual void connectionLost(std::wstring const &faultDescription)
4.4
Definition: nullFederateAmbassador1516_4.h:43
virtual void initiateFederateSave(std::wstring const &label, LogicalTime const &time)
4.20
Definition: nullFederateAmbassador1516_4.h:107
virtual void requestRetraction(MessageRetractionHandle const &retraction)
8.23
Definition: nullFederateAmbassador1516_4.h:514
virtual void attributeIsNotOwned(ObjectInstanceHandle const &objectInstance, AttributeHandleSet const &attributes)
7.18
Definition: nullFederateAmbassador1516_4.h:472
virtual void objectInstanceNameReservationFailed(std::wstring const &objectInstanceName)
6.3
Definition: nullFederateAmbassador1516_4.h:211
virtual void removeObjectInstance(ObjectInstanceHandle const &objectInstance, VariableLengthData const &userSuppliedTag, FederateHandle const &producingFederate)
6.17
Definition: nullFederateAmbassador1516_4.h:317
virtual void requestAttributeOwnershipAssumption(ObjectInstanceHandle const &objectInstance, AttributeHandleSet const &offeredAttributes, VariableLengthData const &userSuppliedTag)
7.4
Definition: nullFederateAmbassador1516_4.h:417
virtual void reportAttributeTransportationType(ObjectInstanceHandle const &objectInstance, AttributeHandle const &attribute, TransportationTypeHandle const &transportationType)
6.29
Definition: nullFederateAmbassador1516_4.h:389
virtual 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)
6.11
Definition: nullFederateAmbassador1516_4.h:250
virtual void reportFederationExecutionMembers(std::wstring const &federationName, FederationExecutionMemberInformationVector const &report)
4.10
Definition: nullFederateAmbassador1516_4.h:55
virtual void attributesInScope(ObjectInstanceHandle const &objectInstance, AttributeHandleSet const &attributes)
6.19
Definition: nullFederateAmbassador1516_4.h:337
virtual void initiateFederateSave(std::wstring const &label)
4.20
Definition: nullFederateAmbassador1516_4.h:101
virtual void initiateFederateRestore(std::wstring const &label, std::wstring const &federateName, FederateHandle const &postRestoreFederateHandle)
4.30
Definition: nullFederateAmbassador1516_4.h:148
virtual void informAttributeOwnership(ObjectInstanceHandle const &objectInstance, AttributeHandleSet const &attributes, FederateHandle const &owner)
7.18
Definition: nullFederateAmbassador1516_4.h:464
virtual void confirmAttributeOwnershipAcquisitionCancellation(ObjectInstanceHandle const &objectInstance, AttributeHandleSet const &attributes)
7.16
Definition: nullFederateAmbassador1516_4.h:457
virtual void reflectAttributeValues(ObjectInstanceHandle const &objectInstance, AttributeHandleValueMap const &attributeValues, VariableLengthData const &userSuppliedTag, TransportationTypeHandle const &transportationType, FederateHandle const &producingFederate, RegionHandleSet const *optionalSentRegions)
6.11
Definition: nullFederateAmbassador1516_4.h:239
virtual void attributesOutOfScope(ObjectInstanceHandle const &objectInstance, AttributeHandleSet const &attributes)
6.20
Definition: nullFederateAmbassador1516_4.h:344
virtual void confirmAttributeTransportationTypeChange(ObjectInstanceHandle const &objectInstance, AttributeHandleSet const &attributes, TransportationTypeHandle const &transportationType)
6.26
Definition: nullFederateAmbassador1516_4.h:381
virtual void federationRestored()
4.32
Definition: nullFederateAmbassador1516_4.h:156
#define LogicalTime
Definition: hlaLogicalTime.h:18
virtual void confirmInteractionTransportationTypeChange(InteractionClassHandle const &interactionClass, TransportationTypeHandle const &transportationType)
6.31
Definition: nullFederateAmbassador1516_4.h:397
virtual void federationNotSaved(SaveFailureReason reason)
4.23
Definition: nullFederateAmbassador1516_4.h:119
virtual void turnInteractionsOff(InteractionClassHandle const &interactionClass)
5.17
Definition: nullFederateAmbassador1516_4.h:195
virtual void federationSaveStatusResponse(FederateHandleSaveStatusPairVector const &response)
4.26
Definition: nullFederateAmbassador1516_4.h:125
virtual void receiveDirectedInteraction(InteractionClassHandle const &interactionClass, ObjectInstanceHandle const &objectInstance, ParameterHandleValueMap const &parameterValues, VariableLengthData const &userSuppliedTag, TransportationTypeHandle const &transportationType, FederateHandle const &producingFederate)
6.15
Definition: nullFederateAmbassador1516_4.h:291
virtual void timeRegulationEnabled(LogicalTime const &time)
8.3
Definition: nullFederateAmbassador1516_4.h:490
DtNullFederateAmbassador()
Definition: nullFederateAmbassador1516_4.h:23
virtual void announceSynchronizationPoint(std::wstring const &synchronizationPointLabel, VariableLengthData const &userSuppliedTag)
4.16
Definition: nullFederateAmbassador1516_4.h:87
virtual void requestFederationRestoreSucceeded(std::wstring const &label)
4.28
Definition: nullFederateAmbassador1516_4.h:131
virtual void synchronizationPointRegistrationFailed(std::wstring const &synchronizationPointLabel, SynchronizationPointFailureReason reason)
4.15
Definition: nullFederateAmbassador1516_4.h:80
virtual void discoverObjectInstance(ObjectInstanceHandle const &objectInstance, ObjectClassHandle const &objectClass, std::wstring const &objectInstanceName, FederateHandle const &producingFederate)
6.9
Definition: nullFederateAmbassador1516_4.h:230
virtual void reportFederationExecutions(FederationExecutionInformationVector const &report)
4.8
Definition: nullFederateAmbassador1516_4.h:49
virtual void attributeOwnershipAcquisitionNotification(ObjectInstanceHandle const &objectInstance, AttributeHandleSet const &securedAttributes, VariableLengthData const &userSuppliedTag)
7.7
Definition: nullFederateAmbassador1516_4.h:433
virtual void stopRegistrationForObjectClass(ObjectClassHandle const &objectClass)
5.15
Definition: nullFederateAmbassador1516_4.h:183
virtual void startRegistrationForObjectClass(ObjectClassHandle const &objectClass)
5.14
Definition: nullFederateAmbassador1516_4.h:177
virtual void requestFederationRestoreFailed(std::wstring const &label)
4.28
Definition: nullFederateAmbassador1516_4.h:137
virtual void turnUpdatesOffForObjectInstance(ObjectInstanceHandle const &objectInstance, AttributeHandleSet const &attributes)
6.24
Definition: nullFederateAmbassador1516_4.h:374
virtual void requestDivestitureConfirmation(ObjectInstanceHandle const &objectInstance, AttributeHandleSet const &releasedAttributes, VariableLengthData const &userSuppliedTag)
7.5
Definition: nullFederateAmbassador1516_4.h:425
virtual void federationRestoreStatusResponse(FederateRestoreStatusVector const &response)
4.35
Definition: nullFederateAmbassador1516_4.h:167
Definition: nullFederateAmbassador13.h:24
virtual void turnInteractionsOn(InteractionClassHandle const &interactionClass)
5.16
Definition: nullFederateAmbassador1516_4.h:189
virtual void attributeOwnershipUnavailable(ObjectInstanceHandle const &objectInstance, AttributeHandleSet const &attributes, VariableLengthData const &userSuppliedTag)
7.10
Definition: nullFederateAmbassador1516_4.h:441
virtual void timeAdvanceGrant(LogicalTime const &time)
8.14
Definition: nullFederateAmbassador1516_4.h:508
virtual void reportInteractionTransportationType(FederateHandle const &federate, InteractionClassHandle const &interactionClass, TransportationTypeHandle const &transportationType)
6.33
Definition: nullFederateAmbassador1516_4.h:404
This file contains typedefs for machine dependant types.
virtual void provideAttributeValueUpdate(ObjectInstanceHandle const &objectInstance, AttributeHandleSet const &attributes, VariableLengthData const &userSuppliedTag)
6.22
Definition: nullFederateAmbassador1516_4.h:351
virtual void turnUpdatesOnForObjectInstance(ObjectInstanceHandle const &objectInstance, AttributeHandleSet const &attributes, std::wstring const &updateRateDesignator)
6.23
Definition: nullFederateAmbassador1516_4.h:366
virtual 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)
6.15
Definition: nullFederateAmbassador1516_4.h:302
virtual void flushQueueGrant(LogicalTime const &time, LogicalTime const &optimisticTime)
8.13
Definition: nullFederateAmbassador1516_4.h:502

Document ID: Generated on Thu Oct 16 00:12:25 EDT 2025 from SVN revision 280738
Copyright © 1992-2025 MAK Technologies. All Rights Reserved (www.mak.com)