MAK RTIspy API Documentation for HLA 1516
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
NullFederateAmbassador.h
Go to the documentation of this file.
1 /***********************************************************************
2  IEEE 1516.1 High Level Architecture Interface Specification C++ API
3  File: RTI/NullFederateAmbassador.h
4 ***********************************************************************/
5 
6 #ifndef RTI_NullFederateAmbassador_h
7 #define RTI_NullFederateAmbassador_h
8 
9 #include <RTI/Exception.h>
10 #include <RTI/FederateAmbassador.h>
11 
12 namespace rti1516
13 {
14  class RTI_EXPORT NullFederateAmbassador : public FederateAmbassador
15  {
16  public:
17  NullFederateAmbassador()
18  throw (FederateInternalError) {}
19 
20  virtual
21  ~NullFederateAmbassador()
22  throw () {}
23 
24  // 4.7
25  virtual
26  void
27  synchronizationPointRegistrationSucceeded(std::wstring const & label)
28  throw (FederateInternalError) {}
29 
30  virtual
31  void
32  synchronizationPointRegistrationFailed(std::wstring const & label,
33  SynchronizationFailureReason reason)
34  throw (FederateInternalError) {}
35 
36  // 4.8
37  virtual
38  void
39  announceSynchronizationPoint(std::wstring const & label,
40  VariableLengthData const & theUserSuppliedTag)
41  throw (FederateInternalError) {}
42 
43  // 4.10
44  virtual
45  void
46  federationSynchronized(std::wstring const & label)
47  throw (FederateInternalError) {}
48 
49  // 4.12
50  virtual
51  void
52  initiateFederateSave(std::wstring const & label)
53  throw (UnableToPerformSave,
54  FederateInternalError) {}
55 
56  virtual
57  void
58  initiateFederateSave(std::wstring const & label,
59  LogicalTime const & theTime)
60  throw (UnableToPerformSave,
61  InvalidLogicalTime,
62  FederateInternalError) {}
63 
64  // 4.15
65  virtual
66  void
67  federationSaved()
68  throw (FederateInternalError) {}
69 
70  virtual
71  void
72  federationNotSaved(SaveFailureReason theSaveFailureReason)
73  throw (FederateInternalError) {}
74 
75 
76  // 4.17
77  virtual
78  void
79  federationSaveStatusResponse(
80  FederateHandleSaveStatusPairVector const &
81  theFederateStatusVector)
82  throw (FederateInternalError) {}
83 
84  // 4.19
85  virtual
86  void
87  requestFederationRestoreSucceeded(std::wstring const & label)
88  throw (FederateInternalError) {}
89 
90  virtual
91  void
92  requestFederationRestoreFailed(std::wstring const & label)
93  throw (FederateInternalError) {}
94 
95  // 4.20
96  virtual
97  void
98  federationRestoreBegun()
99  throw (FederateInternalError) {}
100 
101  // 4.21
102  virtual
103  void
104  initiateFederateRestore(std::wstring const & label,
105  FederateHandle handle)
106  throw (SpecifiedSaveLabelDoesNotExist,
107  CouldNotInitiateRestore,
108  FederateInternalError) {}
109 
110  // 4.23
111  virtual
112  void
113  federationRestored()
114  throw (FederateInternalError) {}
115 
116  virtual
117  void
118  federationNotRestored(RestoreFailureReason theRestoreFailureReason)
119  throw (FederateInternalError) {}
120 
121  // 4.25
122  virtual
123  void
124  federationRestoreStatusResponse(
125  FederateHandleRestoreStatusPairVector const &
126  theFederateStatusVector)
127  throw (FederateInternalError) {}
128 
130  // Declaration Management Services //
132 
133  // 5.10
134  virtual
135  void
136  startRegistrationForObjectClass(ObjectClassHandle theClass)
137  throw (ObjectClassNotPublished,
138  FederateInternalError) {}
139 
140  // 5.11
141  virtual
142  void
143  stopRegistrationForObjectClass(ObjectClassHandle theClass)
144  throw (ObjectClassNotPublished,
145  FederateInternalError) {}
146 
147  // 5.12
148  virtual
149  void
150  turnInteractionsOn(InteractionClassHandle theHandle)
151  throw (InteractionClassNotPublished,
152  FederateInternalError) {}
153 
154  // 5.13
155  virtual
156  void
157  turnInteractionsOff(InteractionClassHandle theHandle)
158  throw (InteractionClassNotPublished,
159  FederateInternalError) {}
160 
162  // Object Management Services //
164 
165  // 6.3
166  virtual
167  void
168  objectInstanceNameReservationSucceeded(std::wstring const &
169  theObjectInstanceName)
170  throw (UnknownName,
171  FederateInternalError) {}
172 
173  virtual
174  void
175  objectInstanceNameReservationFailed(std::wstring const &
176  theObjectInstanceName)
177  throw (UnknownName,
178  FederateInternalError) {}
179 
180 
181  // 6.5
182  virtual
183  void
184  discoverObjectInstance(ObjectInstanceHandle theObject,
185  ObjectClassHandle theObjectClass,
186  std::wstring const & theObjectInstanceName)
187  throw (CouldNotDiscover,
188  ObjectClassNotKnown,
189  FederateInternalError) {}
190 
191  // 6.7
192  virtual
193  void
194  reflectAttributeValues
195  (ObjectInstanceHandle theObject,
196  AttributeHandleValueMap const & theAttributeValues,
197  VariableLengthData const & theUserSuppliedTag,
198  OrderType sentOrder,
199  TransportationType theType)
200  throw (ObjectInstanceNotKnown,
201  AttributeNotRecognized,
202  AttributeNotSubscribed,
203  FederateInternalError) {}
204 
205  virtual
206  void
207  reflectAttributeValues
208  (ObjectInstanceHandle theObject,
209  AttributeHandleValueMap const & theAttributeValues,
210  VariableLengthData const & theUserSuppliedTag,
211  OrderType sentOrder,
212  TransportationType theType,
213  RegionHandleSet const & theSentRegionHandleSet)
214  throw (ObjectInstanceNotKnown,
215  AttributeNotRecognized,
216  AttributeNotSubscribed,
217  FederateInternalError) {}
218 
219  virtual
220  void
221  reflectAttributeValues
222  (ObjectInstanceHandle theObject,
223  AttributeHandleValueMap const & theAttributeValues,
224  VariableLengthData const & theUserSuppliedTag,
225  OrderType sentOrder,
226  TransportationType theType,
227  LogicalTime const & theTime,
228  OrderType receivedOrder)
229  throw (ObjectInstanceNotKnown,
230  AttributeNotRecognized,
231  AttributeNotSubscribed,
232  FederateInternalError) {}
233 
234  virtual
235  void
236  reflectAttributeValues
237  (ObjectInstanceHandle theObject,
238  AttributeHandleValueMap const & theAttributeValues,
239  VariableLengthData const & theUserSuppliedTag,
240  OrderType sentOrder,
241  TransportationType theType,
242  LogicalTime const & theTime,
243  OrderType receivedOrder,
244  RegionHandleSet const & theSentRegionHandleSet)
245  throw (ObjectInstanceNotKnown,
246  AttributeNotRecognized,
247  AttributeNotSubscribed,
248  FederateInternalError) {}
249 
250  virtual
251  void
252  reflectAttributeValues
253  (ObjectInstanceHandle theObject,
254  AttributeHandleValueMap const & theAttributeValues,
255  VariableLengthData const & theUserSuppliedTag,
256  OrderType sentOrder,
257  TransportationType theType,
258  LogicalTime const & theTime,
259  OrderType receivedOrder,
260  MessageRetractionHandle theHandle)
261  throw (ObjectInstanceNotKnown,
262  AttributeNotRecognized,
263  AttributeNotSubscribed,
264  InvalidLogicalTime,
265  FederateInternalError) {}
266 
267  virtual
268  void
269  reflectAttributeValues
270  (ObjectInstanceHandle theObject,
271  AttributeHandleValueMap const & theAttributeValues,
272  VariableLengthData const & theUserSuppliedTag,
273  OrderType sentOrder,
274  TransportationType theType,
275  LogicalTime const & theTime,
276  OrderType receivedOrder,
277  MessageRetractionHandle theHandle,
278  RegionHandleSet const & theSentRegionHandleSet)
279  throw (ObjectInstanceNotKnown,
280  AttributeNotRecognized,
281  AttributeNotSubscribed,
282  InvalidLogicalTime,
283  FederateInternalError) {}
284 
285  // 6.9
286  virtual
287  void
288  receiveInteraction
289  (InteractionClassHandle theInteraction,
290  ParameterHandleValueMap const & theParameterValues,
291  VariableLengthData const & theUserSuppliedTag,
292  OrderType sentOrder,
293  TransportationType theType)
294  throw (InteractionClassNotRecognized,
295  InteractionParameterNotRecognized,
296  InteractionClassNotSubscribed,
297  FederateInternalError) {}
298 
299  virtual
300  void
301  receiveInteraction
302  (InteractionClassHandle theInteraction,
303  ParameterHandleValueMap const & theParameterValues,
304  VariableLengthData const & theUserSuppliedTag,
305  OrderType sentOrder,
306  TransportationType theType,
307  RegionHandleSet const & theSentRegionHandleSet)
308  throw (InteractionClassNotRecognized,
309  InteractionParameterNotRecognized,
310  InteractionClassNotSubscribed,
311  FederateInternalError) {}
312 
313  virtual
314  void
315  receiveInteraction
316  (InteractionClassHandle theInteraction,
317  ParameterHandleValueMap const & theParameterValues,
318  VariableLengthData const & theUserSuppliedTag,
319  OrderType sentOrder,
320  TransportationType theType,
321  LogicalTime const & theTime,
322  OrderType receivedOrder)
323  throw (InteractionClassNotRecognized,
324  InteractionParameterNotRecognized,
325  InteractionClassNotSubscribed,
326  FederateInternalError) {}
327 
328  virtual
329  void
330  receiveInteraction
331  (InteractionClassHandle theInteraction,
332  ParameterHandleValueMap const & theParameterValues,
333  VariableLengthData const & theUserSuppliedTag,
334  OrderType sentOrder,
335  TransportationType theType,
336  LogicalTime const & theTime,
337  OrderType receivedOrder,
338  RegionHandleSet const & theSentRegionHandleSet)
339  throw (InteractionClassNotRecognized,
340  InteractionParameterNotRecognized,
341  InteractionClassNotSubscribed,
342  FederateInternalError) {}
343 
344  virtual
345  void
346  receiveInteraction
347  (InteractionClassHandle theInteraction,
348  ParameterHandleValueMap const & theParameterValues,
349  VariableLengthData const & theUserSuppliedTag,
350  OrderType sentOrder,
351  TransportationType theType,
352  LogicalTime const & theTime,
353  OrderType receivedOrder,
354  MessageRetractionHandle theHandle)
355  throw (InteractionClassNotRecognized,
356  InteractionParameterNotRecognized,
357  InteractionClassNotSubscribed,
358  InvalidLogicalTime,
359  FederateInternalError) {}
360 
361  virtual
362  void
363  receiveInteraction
364  (InteractionClassHandle theInteraction,
365  ParameterHandleValueMap const & theParameterValues,
366  VariableLengthData const & theUserSuppliedTag,
367  OrderType sentOrder,
368  TransportationType theType,
369  LogicalTime const & theTime,
370  OrderType receivedOrder,
371  MessageRetractionHandle theHandle,
372  RegionHandleSet const & theSentRegionHandleSet)
373  throw (InteractionClassNotRecognized,
374  InteractionParameterNotRecognized,
375  InteractionClassNotSubscribed,
376  InvalidLogicalTime,
377  FederateInternalError) {}
378 
379  // 6.11
380  virtual
381  void
382  removeObjectInstance(ObjectInstanceHandle theObject,
383  VariableLengthData const & theUserSuppliedTag,
384  OrderType sentOrder)
385  throw (ObjectInstanceNotKnown,
386  FederateInternalError) {}
387 
388  virtual
389  void
390  removeObjectInstance(ObjectInstanceHandle theObject,
391  VariableLengthData const & theUserSuppliedTag,
392  OrderType sentOrder,
393  LogicalTime const & theTime,
394  OrderType receivedOrder)
395  throw (ObjectInstanceNotKnown,
396  FederateInternalError) {}
397 
398  virtual
399  void
400  removeObjectInstance(ObjectInstanceHandle theObject,
401  VariableLengthData const & theUserSuppliedTag,
402  OrderType sentOrder,
403  LogicalTime const & theTime,
404  OrderType receivedOrder,
405  MessageRetractionHandle theHandle)
406  throw (ObjectInstanceNotKnown,
407  InvalidLogicalTime,
408  FederateInternalError) {}
409 
410  // 6.15
411  virtual
412  void
413  attributesInScope
414  (ObjectInstanceHandle theObject,
415  AttributeHandleSet const & theAttributes)
416  throw (ObjectInstanceNotKnown,
417  AttributeNotRecognized,
418  AttributeNotSubscribed,
419  FederateInternalError) {}
420 
421  // 6.16
422  virtual
423  void
424  attributesOutOfScope
425  (ObjectInstanceHandle theObject,
426  AttributeHandleSet const & theAttributes)
427  throw (ObjectInstanceNotKnown,
428  AttributeNotRecognized,
429  AttributeNotSubscribed,
430  FederateInternalError) {}
431 
432  // 6.18
433  virtual
434  void
435  provideAttributeValueUpdate
436  (ObjectInstanceHandle theObject,
437  AttributeHandleSet const & theAttributes,
438  VariableLengthData const & theUserSuppliedTag)
439  throw (ObjectInstanceNotKnown,
440  AttributeNotRecognized,
441  AttributeNotOwned,
442  FederateInternalError) {}
443 
444  // 6.19
445  virtual
446  void
447  turnUpdatesOnForObjectInstance
448  (ObjectInstanceHandle theObject,
449  AttributeHandleSet const & theAttributes)
450  throw (ObjectInstanceNotKnown,
451  AttributeNotRecognized,
452  AttributeNotOwned,
453  FederateInternalError) {}
454 
455  // 6.20
456  virtual
457  void
458  turnUpdatesOffForObjectInstance
459  (ObjectInstanceHandle theObject,
460  AttributeHandleSet const & theAttributes)
461  throw (ObjectInstanceNotKnown,
462  AttributeNotRecognized,
463  AttributeNotOwned,
464  FederateInternalError) {}
465 
467  // Ownership Management Services //
469 
470  // 7.4
471  virtual
472  void
473  requestAttributeOwnershipAssumption
474  (ObjectInstanceHandle theObject,
475  AttributeHandleSet const & offeredAttributes,
476  VariableLengthData const & theUserSuppliedTag)
477  throw (ObjectInstanceNotKnown,
478  AttributeNotRecognized,
479  AttributeAlreadyOwned,
480  AttributeNotPublished,
481  FederateInternalError) {}
482 
483  // 7.5
484  virtual
485  void
486  requestDivestitureConfirmation
487  (ObjectInstanceHandle theObject,
488  AttributeHandleSet const & releasedAttributes)
489  throw (ObjectInstanceNotKnown,
490  AttributeNotRecognized,
491  AttributeNotOwned,
492  AttributeDivestitureWasNotRequested,
493  FederateInternalError) {}
494 
495  // 7.7
496  virtual
497  void
498  attributeOwnershipAcquisitionNotification
499  (ObjectInstanceHandle theObject,
500  AttributeHandleSet const & securedAttributes,
501  VariableLengthData const & theUserSuppliedTag)
502  throw (ObjectInstanceNotKnown,
503  AttributeNotRecognized,
504  AttributeAcquisitionWasNotRequested,
505  AttributeAlreadyOwned,
506  AttributeNotPublished,
507  FederateInternalError) {}
508 
509  // 7.10
510  virtual
511  void
512  attributeOwnershipUnavailable
513  (ObjectInstanceHandle theObject,
514  AttributeHandleSet const & theAttributes)
515  throw (ObjectInstanceNotKnown,
516  AttributeNotRecognized,
517  AttributeAlreadyOwned,
518  AttributeAcquisitionWasNotRequested,
519  FederateInternalError) {}
520 
521  // 7.11
522  virtual
523  void
524  requestAttributeOwnershipRelease
525  (ObjectInstanceHandle theObject,
526  AttributeHandleSet const & candidateAttributes,
527  VariableLengthData const & theUserSuppliedTag)
528  throw (ObjectInstanceNotKnown,
529  AttributeNotRecognized,
530  AttributeNotOwned,
531  FederateInternalError) {}
532 
533  // 7.15
534  virtual
535  void
536  confirmAttributeOwnershipAcquisitionCancellation
537  (ObjectInstanceHandle theObject,
538  AttributeHandleSet const & theAttributes)
539  throw (ObjectInstanceNotKnown,
540  AttributeNotRecognized,
541  AttributeAlreadyOwned,
542  AttributeAcquisitionWasNotCanceled,
543  FederateInternalError) {}
544 
545  // 7.17
546  virtual
547  void
548  informAttributeOwnership(ObjectInstanceHandle theObject,
549  AttributeHandle theAttribute,
550  FederateHandle theOwner)
551  throw (ObjectInstanceNotKnown,
552  AttributeNotRecognized,
553  FederateInternalError) {}
554 
555  virtual
556  void
557  attributeIsNotOwned(ObjectInstanceHandle theObject,
558  AttributeHandle theAttribute)
559  throw (ObjectInstanceNotKnown,
560  AttributeNotRecognized,
561  FederateInternalError) {}
562 
563  virtual
564  void
565  attributeIsOwnedByRTI(ObjectInstanceHandle theObject,
566  AttributeHandle theAttribute)
567  throw (ObjectInstanceNotKnown,
568  AttributeNotRecognized,
569  FederateInternalError) {}
570 
572  // Time Management Services //
574 
575  // 8.3
576  virtual
577  void
578  timeRegulationEnabled(LogicalTime const & theFederateTime)
579  throw (InvalidLogicalTime,
580  NoRequestToEnableTimeRegulationWasPending,
581  FederateInternalError) {}
582 
583  // 8.6
584  virtual
585  void
586  timeConstrainedEnabled(LogicalTime const & theFederateTime)
587  throw (InvalidLogicalTime,
588  NoRequestToEnableTimeConstrainedWasPending,
589  FederateInternalError) {}
590 
591  // 8.13
592  virtual
593  void
594  timeAdvanceGrant(LogicalTime const & theTime)
595  throw (InvalidLogicalTime,
596  JoinedFederateIsNotInTimeAdvancingState,
597  FederateInternalError) {}
598 
599  // 8.22
600  virtual
601  void
602  requestRetraction(MessageRetractionHandle theHandle)
603  throw (FederateInternalError) {}
604  };
605 }
606 
607 #endif // RTI_NullFederateAmbassador_h
Document ID: Generated on Mon Jul 9 10:30:41 EDT 2018 from SVN revision 190224
Copyright © 2005-2018 VT MÄK Inc. All Rights Reserved (www.mak.com)