VR-Link API Documentation for HLA Evolved
 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:
23  DtNullFederateAmbassador() {};
24 
25  virtual ~DtNullFederateAmbassador() noexcept {};
26 
27 protected:
28 
30  DtNullFederateAmbassador( const DtNullFederateAmbassador& src );
32  DtNullFederateAmbassador& operator=( const DtNullFederateAmbassador& src );
33 
34 
35 
37  // Federation Management Services //
39 
43  virtual void connectionLost(
44  std::wstring const & faultDescription) {}
45 
49  virtual void reportFederationExecutions(
50  FederationExecutionInformationVector const & report) {}
51 
55  virtual void reportFederationExecutionMembers(
56  std::wstring const & federationName,
57  FederationExecutionMemberInformationVector const & report) {}
58 
62  virtual void reportFederationExecutionDoesNotExist(
63  std::wstring const & federationName) {}
64 
68  virtual void federateResigned(
69  std::wstring const & reasonForResignDescription) {}
70 
74  virtual void synchronizationPointRegistrationSucceeded(
75  std::wstring const & synchronizationPointLabel) {}
76 
80  virtual void synchronizationPointRegistrationFailed(
81  std::wstring const & synchronizationPointLabel,
82  SynchronizationPointFailureReason reason) {}
83 
87  virtual void announceSynchronizationPoint(
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 
125  virtual void federationSaveStatusResponse(
126  FederateHandleSaveStatusPairVector const & response) {}
127 
131  virtual void requestFederationRestoreSucceeded(
132  std::wstring const & label) {}
133 
137  virtual void requestFederationRestoreFailed(
138  std::wstring const & label) {}
139 
143  virtual void federationRestoreBegun() {}
144 
148  virtual void initiateFederateRestore(
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 
167  virtual void federationRestoreStatusResponse(
168  FederateRestoreStatusVector const & response) {}
169 
171  // Declaration Management Services //
173 
177  virtual void startRegistrationForObjectClass(
178  ObjectClassHandle const& objectClass) {}
179 
183  virtual void stopRegistrationForObjectClass(
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 
205  virtual void objectInstanceNameReservationSucceeded(
206  std::wstring const& objectInstanceName) {}
207 
211  virtual void objectInstanceNameReservationFailed(
212  std::wstring const& objectInstanceName) {}
213 
217  virtual void multipleObjectInstanceNameReservationSucceeded(
218  std::set<std::wstring> const& objectInstanceNames) {}
219 
223  virtual void multipleObjectInstanceNameReservationFailed(
224  std::set<std::wstring> const& objectInstanceNames) {}
225 
226 
230  virtual void discoverObjectInstance(
231  ObjectInstanceHandle const& objectInstance,
232  ObjectClassHandle const& objectClass,
233  std::wstring const& objectInstanceName,
234  FederateHandle const& producingFederate) {}
235 
239  virtual void reflectAttributeValues(
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 
250  virtual void reflectAttributeValues(
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 
291  virtual void receiveDirectedInteraction(
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 
302  virtual void receiveDirectedInteraction(
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 
351  virtual void provideAttributeValueUpdate(
352  ObjectInstanceHandle const& objectInstance,
353  AttributeHandleSet const& attributes,
354  VariableLengthData const& userSuppliedTag) {}
355 
359  virtual void turnUpdatesOnForObjectInstance(
360  ObjectInstanceHandle const& objectInstance,
361  AttributeHandleSet const& attributes) {}
362 
366  virtual void turnUpdatesOnForObjectInstance(
367  ObjectInstanceHandle const& objectInstance,
368  AttributeHandleSet const& attributes,
369  std::wstring const& updateRateDesignator) {}
370 
374  virtual void turnUpdatesOffForObjectInstance(
375  ObjectInstanceHandle const& objectInstance,
376  AttributeHandleSet const& attributes) {}
377 
381  virtual void confirmAttributeTransportationTypeChange(
382  ObjectInstanceHandle const& objectInstance,
383  AttributeHandleSet const& attributes,
384  TransportationTypeHandle const& transportationType) {}
385 
389  virtual void reportAttributeTransportationType(
390  ObjectInstanceHandle const& objectInstance,
391  AttributeHandle const& attribute,
392  TransportationTypeHandle const& transportationType) {}
393 
397  virtual void confirmInteractionTransportationTypeChange(
398  InteractionClassHandle const& interactionClass,
399  TransportationTypeHandle const& transportationType) {}
400 
404  virtual void reportInteractionTransportationType(
405  FederateHandle const& federate,
406  InteractionClassHandle const& interactionClass,
407  TransportationTypeHandle const& transportationType) {}
408 
409 
411  // Ownership Management Services //
413 
417  virtual void requestAttributeOwnershipAssumption(
418  ObjectInstanceHandle const& objectInstance,
419  AttributeHandleSet const& offeredAttributes,
420  VariableLengthData const& userSuppliedTag) {}
421 
425  virtual void requestDivestitureConfirmation(
426  ObjectInstanceHandle const& objectInstance,
427  AttributeHandleSet const& releasedAttributes,
428  VariableLengthData const& userSuppliedTag) {}
429 
433  virtual void attributeOwnershipAcquisitionNotification(
434  ObjectInstanceHandle const& objectInstance,
435  AttributeHandleSet const& securedAttributes,
436  VariableLengthData const& userSuppliedTag) {}
437 
441  virtual void attributeOwnershipUnavailable(
442  ObjectInstanceHandle const& objectInstance,
443  AttributeHandleSet const& attributes,
444  VariableLengthData const& userSuppliedTag) {}
445 
449  virtual void requestAttributeOwnershipRelease(
450  ObjectInstanceHandle const& objectInstance,
451  AttributeHandleSet const& candidateAttributes,
452  VariableLengthData const& userSuppliedTag) {}
453 
457  virtual void confirmAttributeOwnershipAcquisitionCancellation(
458  ObjectInstanceHandle const& objectInstance,
459  AttributeHandleSet const& attributes) {}
460 
464  virtual void informAttributeOwnership(
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 
496  virtual void timeConstrainedEnabled(
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 
DT_DLL_VL
#define DT_DLL_VL
Definition: vlMachineTypes.h:108
LogicalTime
#define LogicalTime
Definition: hlaLogicalTime.h:18
DtNullFederateAmbassador
Definition: nullFederateAmbassador13.h:24
vlMachineTypes.h
This file contains typedefs for machine dependant types.
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)