VR-Link API Documentation for HLA 1.3
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
nullFederateAmbassador1516.h
Go to the documentation of this file.
1 /*******************************************************************************
2 ** Copyright (c) 1992-2025 MAK Technologies, Inc
3 ** All rights reserved.
4 *******************************************************************************/
5 
6 
7 #if DtHLA_1516 && !DtHLA_1516_EVOLVED
8 
11 
12 #pragma once
13 #include <RTI/Exception.h>
14 #include <RTI/FederateAmbassador.h>
15 
16 #include "rtiNamespace.h"
17 #include <vlutil/vlMachineTypes.h>
18 
19 class DT_DLL_VL DtNullFederateAmbassador : public RTI::FederateAmbassador
20 {
21 public:
22  DtNullFederateAmbassador()
23  throw (RTI::FederateInternalError) {};
24 
25  virtual
26  ~DtNullFederateAmbassador()
27  throw () {};
28 
29 protected:
30 
32  DtNullFederateAmbassador( const DtNullFederateAmbassador& src );
34  DtNullFederateAmbassador& operator=( const DtNullFederateAmbassador& src );
35 
36 public:
38  virtual
39  void
40  synchronizationPointRegistrationSucceeded(std::wstring const & label)
41  throw (RTI::FederateInternalError) {}
42 
43  virtual
44  void
45  synchronizationPointRegistrationFailed(std::wstring const & label,
46  RTI::SynchronizationFailureReason reason)
47  throw (RTI::FederateInternalError) {}
48 
50  virtual
51  void
52  announceSynchronizationPoint(std::wstring const & label,
53  RTI::VariableLengthData const & theUserSuppliedTag)
54  throw (RTI::FederateInternalError) {}
55 
57  virtual
58  void
59  federationSynchronized(std::wstring const & label)
60  throw (RTI::FederateInternalError) {}
61 
63  virtual
64  void
65  initiateFederateSave(std::wstring const & label)
66  throw (RTI::UnableToPerformSave,
67  RTI::FederateInternalError) {}
68 
69  virtual
70  void
71  initiateFederateSave(std::wstring const & label,
72  RTI::LogicalTime const & theTime)
73  throw (RTI::UnableToPerformSave,
74  RTI::InvalidLogicalTime,
75  RTI::FederateInternalError) {}
76 
78  virtual
79  void
80  federationSaved()
81  throw (RTI::FederateInternalError) {}
82 
83  virtual
84  void
85  federationNotSaved(RTI::SaveFailureReason theSaveFailureReason)
86  throw (RTI::FederateInternalError) {}
87 
88 
90  virtual
91  void
92  federationSaveStatusResponse(
93  RTI::FederateHandleSaveStatusPairVector const & theFederateStatusVector)
94  throw (RTI::FederateInternalError) {}
95 
97  virtual
98  void
99  requestFederationRestoreSucceeded(std::wstring const & label)
100  throw (RTI::FederateInternalError) {}
101 
102  virtual
103  void
104  requestFederationRestoreFailed(std::wstring const & label)
105  throw (RTI::FederateInternalError) {}
106 
108  virtual
109  void
110  federationRestoreBegun()
111  throw (RTI::FederateInternalError) {}
112 
114  virtual
115  void
116  initiateFederateRestore(std::wstring const & label,
117  RTI::FederateHandle handle)
118  throw (RTI::SpecifiedSaveLabelDoesNotExist,
119  RTI::CouldNotInitiateRestore,
120  RTI::FederateInternalError) {}
121 
123  virtual
124  void
125  federationRestored()
126  throw (RTI::FederateInternalError) {}
127 
128  virtual
129  void
130  federationNotRestored(RTI::RestoreFailureReason theRestoreFailureReason)
131  throw (RTI::FederateInternalError) {}
132 
134  virtual
135  void
136  federationRestoreStatusResponse(
137  RTI::FederateHandleRestoreStatusPairVector const & theFederateStatusVector)
138  throw (RTI::FederateInternalError) {}
139 
143 
145  virtual
146  void
147  startRegistrationForObjectClass(RTI::ObjectClassHandle theClass)
148  throw (RTI::ObjectClassNotPublished,
149  RTI::FederateInternalError) {}
150 
152  virtual
153  void
154  stopRegistrationForObjectClass(RTI::ObjectClassHandle theClass)
155  throw (RTI::ObjectClassNotPublished,
156  RTI::FederateInternalError) {}
157 
159  virtual
160  void
161  turnInteractionsOn(RTI::InteractionClassHandle theHandle)
162  throw (RTI::InteractionClassNotPublished,
163  RTI::FederateInternalError) {}
164 
166  virtual
167  void
168  turnInteractionsOff(RTI::InteractionClassHandle theHandle)
169  throw (RTI::InteractionClassNotPublished,
170  RTI::FederateInternalError) {}
171 
175 
177  virtual
178  void
179  objectInstanceNameReservationSucceeded(std::wstring const &
180  theObjectInstanceName)
181  throw (RTI::UnknownName,
182  RTI::FederateInternalError) {}
183 
184  virtual
185  void
186  objectInstanceNameReservationFailed(std::wstring const &
187  theObjectInstanceName)
188  throw (RTI::UnknownName,
189  RTI::FederateInternalError) {}
190 
191 
193  virtual
194  void
195  discoverObjectInstance(RTI::ObjectInstanceHandle theObject,
196  RTI::ObjectClassHandle theObjectClass,
197  std::wstring const & theObjectInstanceName)
198  throw (RTI::CouldNotDiscover,
199  RTI::ObjectClassNotKnown,
200  RTI::FederateInternalError) {}
201 
203  virtual
204  void
205  reflectAttributeValues
206  (RTI::ObjectInstanceHandle theObject,
207  RTI::AttributeHandleValueMap const & theAttributeValues,
208  RTI::VariableLengthData const & theUserSuppliedTag,
209  RTI::OrderType sentOrder,
210  RTI::TransportationType theType)
211  throw (RTI::ObjectInstanceNotKnown,
212  RTI::AttributeNotRecognized,
213  RTI::AttributeNotSubscribed,
214  RTI::FederateInternalError) {}
215 
216  virtual
217  void
218  reflectAttributeValues
219  (RTI::ObjectInstanceHandle theObject,
220  RTI::AttributeHandleValueMap const & theAttributeValues,
221  RTI::VariableLengthData const & theUserSuppliedTag,
222  RTI::OrderType sentOrder,
223  RTI::TransportationType theType,
224  RTI::RegionHandleSet const & theSentRegionHandleSet)
225  throw (RTI::ObjectInstanceNotKnown,
226  RTI::AttributeNotRecognized,
227  RTI::AttributeNotSubscribed,
228  RTI::FederateInternalError) {}
229 
230  virtual
231  void
232  reflectAttributeValues
233  (RTI::ObjectInstanceHandle theObject,
234  RTI::AttributeHandleValueMap const & theAttributeValues,
235  RTI::VariableLengthData const & theUserSuppliedTag,
236  RTI::OrderType sentOrder,
237  RTI::TransportationType theType,
238  RTI:: LogicalTime const & theTime,
239  RTI:: OrderType receivedOrder)
240  throw (RTI::ObjectInstanceNotKnown,
241  RTI::AttributeNotRecognized,
242  RTI::AttributeNotSubscribed,
243  RTI::FederateInternalError) {}
244 
245  virtual
246  void
247  reflectAttributeValues
248  (RTI::ObjectInstanceHandle theObject,
249  RTI::AttributeHandleValueMap const & theAttributeValues,
250  RTI::VariableLengthData const & theUserSuppliedTag,
251  RTI::OrderType sentOrder,
252  RTI::TransportationType theType,
253  RTI::LogicalTime const & theTime,
254  RTI::OrderType receivedOrder,
255  RTI::RegionHandleSet const & theSentRegionHandleSet)
256  throw (RTI::ObjectInstanceNotKnown,
257  RTI::AttributeNotRecognized,
258  RTI::AttributeNotSubscribed,
259  RTI::FederateInternalError) {}
260 
261  virtual
262  void
263  reflectAttributeValues
264  (RTI::ObjectInstanceHandle theObject,
265  RTI::AttributeHandleValueMap const & theAttributeValues,
266  RTI::VariableLengthData const & theUserSuppliedTag,
267  RTI::OrderType sentOrder,
268  RTI::TransportationType theType,
269  RTI::LogicalTime const & theTime,
270  RTI::OrderType receivedOrder,
271  RTI::MessageRetractionHandle theHandle)
272  throw (RTI::ObjectInstanceNotKnown,
273  RTI::AttributeNotRecognized,
274  RTI::AttributeNotSubscribed,
275  RTI::InvalidLogicalTime,
276  RTI::FederateInternalError) {}
277 
278  virtual
279  void
280  reflectAttributeValues
281  (RTI::ObjectInstanceHandle theObject,
282  RTI::AttributeHandleValueMap const & theAttributeValues,
283  RTI::VariableLengthData const & theUserSuppliedTag,
284  RTI::OrderType sentOrder,
285  RTI::TransportationType theType,
286  RTI::LogicalTime const & theTime,
287  RTI::OrderType receivedOrder,
288  RTI::MessageRetractionHandle theHandle,
289  RTI::RegionHandleSet const & theSentRegionHandleSet)
290  throw (RTI::ObjectInstanceNotKnown,
291  RTI::AttributeNotRecognized,
292  RTI::AttributeNotSubscribed,
293  RTI::InvalidLogicalTime,
294  RTI::FederateInternalError) {}
295 
297  virtual
298  void
299  receiveInteraction
300  (RTI::InteractionClassHandle theInteraction,
301  RTI::ParameterHandleValueMap const & theParameterValues,
302  RTI::VariableLengthData const & theUserSuppliedTag,
303  RTI::OrderType sentOrder,
304  RTI::TransportationType theType)
305  throw (RTI::InteractionClassNotRecognized,
306  RTI::InteractionParameterNotRecognized,
307  RTI::InteractionClassNotSubscribed,
308  RTI::FederateInternalError) {}
309 
310  virtual
311  void
312  receiveInteraction
313  (RTI::InteractionClassHandle theInteraction,
314  RTI::ParameterHandleValueMap const & theParameterValues,
315  RTI::VariableLengthData const & theUserSuppliedTag,
316  RTI::OrderType sentOrder,
317  RTI::TransportationType theType,
318  RTI::RegionHandleSet const & theSentRegionHandleSet)
319  throw (RTI::InteractionClassNotRecognized,
320  RTI::InteractionParameterNotRecognized,
321  RTI::InteractionClassNotSubscribed,
322  RTI::FederateInternalError) {}
323 
324  virtual
325  void
326  receiveInteraction
327  (RTI::InteractionClassHandle theInteraction,
328  RTI::ParameterHandleValueMap const & theParameterValues,
329  RTI::VariableLengthData const & theUserSuppliedTag,
330  RTI::OrderType sentOrder,
331  RTI::TransportationType theType,
332  RTI::LogicalTime const & theTime,
333  RTI::OrderType receivedOrder)
334  throw (RTI::InteractionClassNotRecognized,
335  RTI::InteractionParameterNotRecognized,
336  RTI::InteractionClassNotSubscribed,
337  RTI::FederateInternalError) {}
338 
339  virtual
340  void
341  receiveInteraction
342  (RTI::InteractionClassHandle theInteraction,
343  RTI::ParameterHandleValueMap const & theParameterValues,
344  RTI::VariableLengthData const & theUserSuppliedTag,
345  RTI::OrderType sentOrder,
346  RTI::TransportationType theType,
347  RTI::LogicalTime const & theTime,
348  RTI::OrderType receivedOrder,
349  RTI::RegionHandleSet const & theSentRegionHandleSet)
350  throw (RTI::InteractionClassNotRecognized,
351  RTI::InteractionParameterNotRecognized,
352  RTI::InteractionClassNotSubscribed,
353  RTI::FederateInternalError) {}
354 
355  virtual
356  void
357  receiveInteraction
358  (RTI::InteractionClassHandle theInteraction,
359  RTI::ParameterHandleValueMap const & theParameterValues,
360  RTI::VariableLengthData const & theUserSuppliedTag,
361  RTI::OrderType sentOrder,
362  RTI::TransportationType theType,
363  RTI::LogicalTime const & theTime,
364  RTI::OrderType receivedOrder,
365  RTI::MessageRetractionHandle theHandle)
366  throw (RTI::InteractionClassNotRecognized,
367  RTI::InteractionParameterNotRecognized,
368  RTI::InteractionClassNotSubscribed,
369  RTI::InvalidLogicalTime,
370  RTI::FederateInternalError) {}
371 
372  virtual
373  void
374  receiveInteraction
375  (RTI::InteractionClassHandle theInteraction,
376  RTI::ParameterHandleValueMap const & theParameterValues,
377  RTI::VariableLengthData const & theUserSuppliedTag,
378  RTI::OrderType sentOrder,
379  RTI::TransportationType theType,
380  RTI::LogicalTime const & theTime,
381  RTI::OrderType receivedOrder,
382  RTI::MessageRetractionHandle theHandle,
383  RTI::RegionHandleSet const & theSentRegionHandleSet)
384  throw (RTI::InteractionClassNotRecognized,
385  RTI::InteractionParameterNotRecognized,
386  RTI::InteractionClassNotSubscribed,
387  RTI::InvalidLogicalTime,
388  RTI::FederateInternalError) {}
389 
391  virtual
392  void
393  removeObjectInstance(RTI::ObjectInstanceHandle theObject,
394  RTI::VariableLengthData const & theUserSuppliedTag,
395  RTI::OrderType sentOrder)
396  throw (RTI::ObjectInstanceNotKnown,
397  RTI::FederateInternalError) {}
398 
399  virtual
400  void
401  removeObjectInstance(RTI::ObjectInstanceHandle theObject,
402  RTI::VariableLengthData const & theUserSuppliedTag,
403  RTI::OrderType sentOrder,
404  RTI::LogicalTime const & theTime,
405  RTI::OrderType receivedOrder)
406  throw (RTI::ObjectInstanceNotKnown,
407  RTI::FederateInternalError) {}
408 
409  virtual
410  void
411  removeObjectInstance(RTI::ObjectInstanceHandle theObject,
412  RTI::VariableLengthData const & theUserSuppliedTag,
413  RTI::OrderType sentOrder,
414  RTI::LogicalTime const & theTime,
415  RTI::OrderType receivedOrder,
416  RTI::MessageRetractionHandle theHandle)
417  throw (RTI::ObjectInstanceNotKnown,
418  RTI::InvalidLogicalTime,
419  RTI::FederateInternalError) {}
420 
422  virtual
423  void
424  attributesInScope
425  (RTI::ObjectInstanceHandle theObject,
426  RTI::AttributeHandleSet const & theAttributes)
427  throw (RTI::ObjectInstanceNotKnown,
428  RTI::AttributeNotRecognized,
429  RTI::AttributeNotSubscribed,
430  RTI::FederateInternalError) {}
431 
433  virtual
434  void
435  attributesOutOfScope
436  (RTI::ObjectInstanceHandle theObject,
437  RTI::AttributeHandleSet const & theAttributes)
438  throw (RTI::ObjectInstanceNotKnown,
439  RTI::AttributeNotRecognized,
440  RTI::AttributeNotSubscribed,
441  RTI::FederateInternalError) {}
442 
444  virtual
445  void
446  provideAttributeValueUpdate
447  (RTI::ObjectInstanceHandle theObject,
448  RTI::AttributeHandleSet const & theAttributes,
449  RTI::VariableLengthData const & theUserSuppliedTag)
450  throw (RTI::ObjectInstanceNotKnown,
451  RTI::AttributeNotRecognized,
452  RTI::AttributeNotOwned,
453  RTI::FederateInternalError) {}
454 
456  virtual
457  void
458  turnUpdatesOnForObjectInstance
459  (RTI::ObjectInstanceHandle theObject,
460  RTI::AttributeHandleSet const & theAttributes)
461  throw (RTI::ObjectInstanceNotKnown,
462  RTI::AttributeNotRecognized,
463  RTI::AttributeNotOwned,
464  RTI::FederateInternalError) {}
465 
467  virtual
468  void
469  turnUpdatesOffForObjectInstance
470  (RTI::ObjectInstanceHandle theObject,
471  RTI::AttributeHandleSet const & theAttributes)
472  throw (RTI::ObjectInstanceNotKnown,
473  RTI::AttributeNotRecognized,
474  RTI::AttributeNotOwned,
475  RTI::FederateInternalError) {}
476 
480 
482  virtual
483  void
484  requestAttributeOwnershipAssumption
485  (RTI::ObjectInstanceHandle theObject,
486  RTI::AttributeHandleSet const & theAttributes,
487  RTI::VariableLengthData const & theUserSuppliedTag)
488  throw (RTI::ObjectInstanceNotKnown,
489  RTI::AttributeNotRecognized,
490  RTI::AttributeAlreadyOwned,
491  RTI::AttributeNotPublished,
492  RTI::FederateInternalError) {}
493 
495  virtual
496  void
497  requestDivestitureConfirmation
498  (RTI::ObjectInstanceHandle theObject,
499  RTI::AttributeHandleSet const & theAttributes)
500  throw (RTI::ObjectInstanceNotKnown,
501  RTI::AttributeNotRecognized,
502  RTI::AttributeNotOwned,
503  RTI::AttributeDivestitureWasNotRequested,
504  RTI::FederateInternalError) {}
505 
507  virtual
508  void
509  attributeOwnershipAcquisitionNotification
510  (RTI::ObjectInstanceHandle theObject,
511  RTI::AttributeHandleSet const & theAttributes,
512  RTI::VariableLengthData const & theUserSuppliedTag)
513  throw (RTI::ObjectInstanceNotKnown,
514  RTI::AttributeNotRecognized,
515  RTI::AttributeAcquisitionWasNotRequested,
516  RTI::AttributeAlreadyOwned,
517  RTI::AttributeNotPublished,
518  RTI::FederateInternalError) {}
519 
521  virtual
522  void
523  attributeOwnershipUnavailable
524  (RTI::ObjectInstanceHandle theObject,
525  RTI::AttributeHandleSet const & theAttributes)
526  throw (RTI::ObjectInstanceNotKnown,
527  RTI::AttributeNotRecognized,
528  RTI::AttributeAlreadyOwned,
529  RTI::AttributeAcquisitionWasNotRequested,
530  RTI::FederateInternalError) {}
531 
533  virtual
534  void
535  requestAttributeOwnershipRelease
536  (RTI::ObjectInstanceHandle theObject,
537  RTI::AttributeHandleSet const & theAttributes,
538  RTI::VariableLengthData const & theUserSuppliedTag)
539  throw (RTI::ObjectInstanceNotKnown,
540  RTI::AttributeNotRecognized,
541  RTI::AttributeNotOwned,
542  RTI::FederateInternalError) {}
543 
545  virtual
546  void
547  confirmAttributeOwnershipAcquisitionCancellation
548  (RTI::ObjectInstanceHandle theObject,
549  RTI::AttributeHandleSet const & theAttributes)
550  throw (RTI::ObjectInstanceNotKnown,
551  RTI::AttributeNotRecognized,
552  RTI::AttributeAlreadyOwned,
553  RTI::AttributeAcquisitionWasNotCanceled,
554  RTI::FederateInternalError) {}
555 
557  virtual
558  void
559  informAttributeOwnership(RTI::ObjectInstanceHandle theObject,
560  RTI::AttributeHandle theAttribute,
561  RTI::FederateHandle theOwner)
562  throw (RTI::ObjectInstanceNotKnown,
563  RTI::AttributeNotRecognized,
564  RTI::FederateInternalError) {}
565 
566  virtual
567  void
568  attributeIsNotOwned(RTI::ObjectInstanceHandle theObject,
569  RTI::AttributeHandle theAttribute)
570  throw (RTI::ObjectInstanceNotKnown,
571  RTI::AttributeNotRecognized,
572  RTI::FederateInternalError) {}
573 
574  virtual
575  void
576  attributeIsOwnedByRTI(RTI::ObjectInstanceHandle theObject,
577  RTI::AttributeHandle theAttribute)
578  throw (RTI::ObjectInstanceNotKnown,
579  RTI::AttributeNotRecognized,
580  RTI::FederateInternalError) {}
581 
585 
587  virtual
588  void
589  timeRegulationEnabled(RTI::LogicalTime const & theFederateTime)
590  throw (RTI::InvalidLogicalTime,
591  RTI::NoRequestToEnableTimeRegulationWasPending,
592  RTI::FederateInternalError) {}
593 
595  virtual
596  void
597  timeConstrainedEnabled(RTI::LogicalTime const & theFederateTime)
598  throw (RTI::InvalidLogicalTime,
599  RTI::NoRequestToEnableTimeConstrainedWasPending,
600  RTI::FederateInternalError) {}
601 
603  virtual
604  void
605  timeAdvanceGrant(RTI::LogicalTime const & theTime)
606  throw (RTI::InvalidLogicalTime,
607  RTI::JoinedFederateIsNotInTimeAdvancingState,
608  RTI::FederateInternalError) {}
609 
611  virtual
612  void
613  requestRetraction(RTI::MessageRetractionHandle theHandle)
614  throw (RTI::FederateInternalError) {}
615 };
616 
617 #endif
618 
619 
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)