MAK RTIspy API Documentation for HLA Evolved
 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  The IEEE hereby grants a general, royalty-free license to copy, distribute,
3  display and make derivative works from this material, for all purposes,
4  provided that any use of the material contains the following
5  attribution: "Reprinted with permission from IEEE 1516.1(TM)-2010".
6  Should you require additional information, contact the Manager, Standards
7  Intellectual Property, IEEE Standards Association (stds-ipr@ieee.org).
8 ***********************************************************************/
9 /***********************************************************************
10  IEEE 1516.1 High Level Architecture Interface Specification C++ API
11  File: RTI/NullFederateAmbassador.h
12 ***********************************************************************/
13 #if defined(_WIN32)
14 #pragma warning(disable : 4100)
15 #endif
16 
17 #ifndef RTI_NullFederateAmbassador_h
18 #define RTI_NullFederateAmbassador_h
19 
20 #include <RTI/Exception.h>
21 #include <RTI/FederateAmbassador.h>
22 
23 namespace rti1516e
24 {
25  class RTI_EXPORT NullFederateAmbassador : public FederateAmbassador
26  {
27  public:
28  NullFederateAmbassador ()
29  throw (
30  FederateInternalError) {}
31 
32  virtual ~NullFederateAmbassador ()
33  throw () {}
34 
35  // 4.4
36  virtual void connectionLost (
37  std::wstring const & faultDescription)
38  throw (
39  FederateInternalError) {}
40 
41  // 4.8
42  virtual void reportFederationExecutions (
43  FederationExecutionInformationVector const &
44  theFederationExecutionInformationList)
45  throw (
46  FederateInternalError) {}
47 
48  // 4.12
49  virtual void synchronizationPointRegistrationSucceeded (
50  std::wstring const & label)
51  throw (
52  FederateInternalError) {}
53 
54  virtual void synchronizationPointRegistrationFailed (
55  std::wstring const & label,
56  SynchronizationPointFailureReason reason)
57  throw (
58  FederateInternalError) {}
59 
60  // 4.13
61  virtual void announceSynchronizationPoint (
62  std::wstring const & label,
63  VariableLengthData const & theUserSuppliedTag)
64  throw (
65  FederateInternalError) {}
66 
67  // 4.15
68  virtual void federationSynchronized (
69  std::wstring const & label,
70  FederateHandleSet const& failedToSyncSet)
71  throw (
72  FederateInternalError) {}
73 
74  // 4.17
75  virtual void initiateFederateSave (
76  std::wstring const & label)
77  throw (
78  FederateInternalError) {}
79 
80  virtual void initiateFederateSave (
81  std::wstring const & label,
82  LogicalTime const & theTime)
83  throw (
84  FederateInternalError) {}
85 
86  // 4.20
87  virtual void federationSaved ()
88  throw (
89  FederateInternalError) {}
90 
91  virtual void federationNotSaved (
92  SaveFailureReason theSaveFailureReason)
93  throw (
94  FederateInternalError) {}
95 
96 
97  // 4.23
98  virtual void federationSaveStatusResponse (
99  FederateHandleSaveStatusPairVector const &
100  theFederateStatusVector)
101  throw (
102  FederateInternalError) {}
103 
104  // 4.25
105  virtual void requestFederationRestoreSucceeded (
106  std::wstring const & label)
107  throw (
108  FederateInternalError) {}
109 
110  virtual void requestFederationRestoreFailed (
111  std::wstring const & label)
112  throw (
113  FederateInternalError) {}
114 
115  // 4.26
116  virtual void federationRestoreBegun ()
117  throw (
118  FederateInternalError) {}
119 
120  // 4.27
121  virtual void initiateFederateRestore (
122  std::wstring const & label,
123  std::wstring const & federateName,
124  FederateHandle handle)
125  throw (
126  FederateInternalError) {}
127 
128  // 4.29
129  virtual void federationRestored ()
130  throw (
131  FederateInternalError) {}
132 
133  virtual void federationNotRestored (
134  RestoreFailureReason theRestoreFailureReason)
135  throw (
136  FederateInternalError) {}
137 
138  // 4.32
139  virtual void federationRestoreStatusResponse (
140  FederateRestoreStatusVector const &
141  theFederateRestoreStatusVector)
142  throw (
143  FederateInternalError) {}
144 
146  // Declaration Management Services //
148 
149  // 5.10
150  virtual void startRegistrationForObjectClass (
151  ObjectClassHandle theClass)
152  throw (
153  FederateInternalError) {}
154 
155  // 5.11
156  virtual void stopRegistrationForObjectClass (
157  ObjectClassHandle theClass)
158  throw (
159  FederateInternalError) {}
160 
161  // 5.12
162  virtual void turnInteractionsOn (
163  InteractionClassHandle theHandle)
164  throw (
165  FederateInternalError) {}
166 
167  // 5.13
168  virtual void turnInteractionsOff (
169  InteractionClassHandle theHandle)
170  throw (
171  FederateInternalError) {}
172 
174  // Object Management Services //
176 
177  // 6.3
178  virtual void objectInstanceNameReservationSucceeded (
179  std::wstring const & theObjectInstanceName)
180  throw (
181  FederateInternalError) {}
182 
183  virtual void objectInstanceNameReservationFailed (
184  std::wstring const & theObjectInstanceName)
185  throw (
186  FederateInternalError) {}
187 
188  // 6.6
189  virtual void multipleObjectInstanceNameReservationSucceeded (
190  std::set<std::wstring> const & theObjectInstanceNames)
191  throw (
192  FederateInternalError) {}
193 
194  virtual void multipleObjectInstanceNameReservationFailed (
195  std::set<std::wstring> const & theObjectInstanceNames)
196  throw (
197  FederateInternalError) {}
198 
199  // 6.9
200  virtual void discoverObjectInstance (
201  ObjectInstanceHandle theObject,
202  ObjectClassHandle theObjectClass,
203  std::wstring const & theObjectInstanceName)
204  throw (
205  FederateInternalError) {}
206 
207  virtual void discoverObjectInstance (
208  ObjectInstanceHandle theObject,
209  ObjectClassHandle theObjectClass,
210  std::wstring const & theObjectInstanceName,
211  FederateHandle producingFederate)
212  throw (
213  FederateInternalError) {}
214 
215  // 6.11
216  virtual void reflectAttributeValues (
217  ObjectInstanceHandle theObject,
218  AttributeHandleValueMap const & theAttributeValues,
219  VariableLengthData const & theUserSuppliedTag,
220  OrderType sentOrder,
221  TransportationType theType,
222  SupplementalReflectInfo theReflectInfo)
223  throw (
224  FederateInternalError) {}
225 
226  virtual void reflectAttributeValues (
227  ObjectInstanceHandle theObject,
228  AttributeHandleValueMap const & theAttributeValues,
229  VariableLengthData const & theUserSuppliedTag,
230  OrderType sentOrder,
231  TransportationType theType,
232  LogicalTime const & theTime,
233  OrderType receivedOrder,
234  SupplementalReflectInfo theReflectInfo)
235  throw (
236  FederateInternalError) {}
237 
238  virtual void reflectAttributeValues (
239  ObjectInstanceHandle theObject,
240  AttributeHandleValueMap const & theAttributeValues,
241  VariableLengthData const & theUserSuppliedTag,
242  OrderType sentOrder,
243  TransportationType theType,
244  LogicalTime const & theTime,
245  OrderType receivedOrder,
246  MessageRetractionHandle theHandle,
247  SupplementalReflectInfo theReflectInfo)
248  throw (
249  FederateInternalError) {}
250 
251  // 6.13
252  virtual void receiveInteraction (
253  InteractionClassHandle theInteraction,
254  ParameterHandleValueMap const & theParameterValues,
255  VariableLengthData const & theUserSuppliedTag,
256  OrderType sentOrder,
257  TransportationType theType,
258  SupplementalReceiveInfo theReceiveInfo)
259  throw (
260  FederateInternalError) {}
261 
262  virtual void receiveInteraction (
263  InteractionClassHandle theInteraction,
264  ParameterHandleValueMap const & theParameterValues,
265  VariableLengthData const & theUserSuppliedTag,
266  OrderType sentOrder,
267  TransportationType theType,
268  LogicalTime const & theTime,
269  OrderType receivedOrder,
270  SupplementalReceiveInfo theReceiveInfo)
271  throw (
272  FederateInternalError) {}
273 
274  virtual void receiveInteraction (
275  InteractionClassHandle theInteraction,
276  ParameterHandleValueMap const & theParameterValues,
277  VariableLengthData const & theUserSuppliedTag,
278  OrderType sentOrder,
279  TransportationType theType,
280  LogicalTime const & theTime,
281  OrderType receivedOrder,
282  MessageRetractionHandle theHandle,
283  SupplementalReceiveInfo theReceiveInfo)
284  throw (
285  FederateInternalError) {}
286 
287  // 6.15
288  virtual void removeObjectInstance (
289  ObjectInstanceHandle theObject,
290  VariableLengthData const & theUserSuppliedTag,
291  OrderType sentOrder,
292  SupplementalRemoveInfo theRemoveInfo)
293  throw (
294  FederateInternalError) {}
295 
296  virtual void removeObjectInstance (
297  ObjectInstanceHandle theObject,
298  VariableLengthData const & theUserSuppliedTag,
299  OrderType sentOrder,
300  LogicalTime const & theTime,
301  OrderType receivedOrder,
302  SupplementalRemoveInfo theRemoveInfo)
303  throw (
304  FederateInternalError) {}
305 
306  virtual void removeObjectInstance (
307  ObjectInstanceHandle theObject,
308  VariableLengthData const & theUserSuppliedTag,
309  OrderType sentOrder,
310  LogicalTime const & theTime,
311  OrderType receivedOrder,
312  MessageRetractionHandle theHandle,
313  SupplementalRemoveInfo theRemoveInfo)
314  throw (
315  FederateInternalError) {}
316 
317  // 6.17
318  virtual void attributesInScope (
319  ObjectInstanceHandle theObject,
320  AttributeHandleSet const & theAttributes)
321  throw (
322  FederateInternalError) {}
323 
324  // 6.18
325  virtual void attributesOutOfScope (
326  ObjectInstanceHandle theObject,
327  AttributeHandleSet const & theAttributes)
328  throw (
329  FederateInternalError) {}
330 
331  // 6.20
332  virtual void provideAttributeValueUpdate (
333  ObjectInstanceHandle theObject,
334  AttributeHandleSet const & theAttributes,
335  VariableLengthData const & theUserSuppliedTag)
336  throw (
337  FederateInternalError) {}
338 
339  // 6.21
340  virtual void turnUpdatesOnForObjectInstance (
341  ObjectInstanceHandle theObject,
342  AttributeHandleSet const & theAttributes)
343  throw (
344  FederateInternalError) {}
345 
346  virtual void turnUpdatesOnForObjectInstance (
347  ObjectInstanceHandle theObject,
348  AttributeHandleSet const & theAttributes,
349  std::wstring const & updateRateDesignator)
350  throw (
351  FederateInternalError) {}
352 
353  // 6.22
354  virtual void turnUpdatesOffForObjectInstance (
355  ObjectInstanceHandle theObject,
356  AttributeHandleSet const & theAttributes)
357  throw (
358  FederateInternalError) {}
359 
360  // 6.24
361  virtual void confirmAttributeTransportationTypeChange (
362  ObjectInstanceHandle theObject,
363  AttributeHandleSet theAttributes,
364  TransportationType theTransportation)
365  throw (
366  FederateInternalError) {}
367 
368  // 6.26
369  virtual void reportAttributeTransportationType (
370  ObjectInstanceHandle theObject,
371  AttributeHandle theAttribute,
372  TransportationType theTransportation)
373  throw (
374  FederateInternalError) {}
375 
376  // 6.28
377  virtual void confirmInteractionTransportationTypeChange (
378  InteractionClassHandle theInteraction,
379  TransportationType theTransportation)
380  throw (
381  FederateInternalError) {}
382 
383  // 6.30
384  virtual void reportInteractionTransportationType (
385  FederateHandle federateHandle,
386  InteractionClassHandle theInteraction,
387  TransportationType theTransportation)
388  throw (
389  FederateInternalError) {}
390 
391 
393  // Ownership Management Services //
395 
396  // 7.4
397  virtual void requestAttributeOwnershipAssumption (
398  ObjectInstanceHandle theObject,
399  AttributeHandleSet const & offeredAttributes,
400  VariableLengthData const & theUserSuppliedTag)
401  throw (
402  FederateInternalError) {}
403 
404  // 7.5
405  virtual void requestDivestitureConfirmation (
406  ObjectInstanceHandle theObject,
407  AttributeHandleSet const & releasedAttributes)
408  throw (
409  FederateInternalError) {}
410 
411  // 7.7
412  virtual void attributeOwnershipAcquisitionNotification (
413  ObjectInstanceHandle theObject,
414  AttributeHandleSet const & securedAttributes,
415  VariableLengthData const & theUserSuppliedTag)
416  throw (
417  FederateInternalError) {}
418 
419  // 7.10
420  virtual void attributeOwnershipUnavailable (
421  ObjectInstanceHandle theObject,
422  AttributeHandleSet const & theAttributes)
423  throw (
424  FederateInternalError) {}
425 
426  // 7.11
427  virtual void requestAttributeOwnershipRelease (
428  ObjectInstanceHandle theObject,
429  AttributeHandleSet const & candidateAttributes,
430  VariableLengthData const & theUserSuppliedTag)
431  throw (
432  FederateInternalError) {}
433 
434  // 7.16
435  virtual void confirmAttributeOwnershipAcquisitionCancellation (
436  ObjectInstanceHandle theObject,
437  AttributeHandleSet const & theAttributes)
438  throw (
439  FederateInternalError) {}
440 
441  // 7.18
442  virtual void informAttributeOwnership (
443  ObjectInstanceHandle theObject,
444  AttributeHandle theAttribute,
445  FederateHandle theOwner)
446  throw (
447  FederateInternalError) {}
448 
449  virtual void attributeIsNotOwned (
450  ObjectInstanceHandle theObject,
451  AttributeHandle theAttribute)
452  throw (
453  FederateInternalError) {}
454 
455  virtual void attributeIsOwnedByRTI (
456  ObjectInstanceHandle theObject,
457  AttributeHandle theAttribute)
458  throw (
459  FederateInternalError) {}
460 
462  // Time Management Services //
464 
465  // 8.3
466  virtual void timeRegulationEnabled (
467  LogicalTime const & theFederateTime)
468  throw (
469  FederateInternalError) {}
470 
471  // 8.6
472  virtual void timeConstrainedEnabled (
473  LogicalTime const & theFederateTime)
474  throw (
475  FederateInternalError) {}
476 
477  // 8.13
478  virtual void timeAdvanceGrant (
479  LogicalTime const & theTime)
480  throw (
481  FederateInternalError) {}
482 
483  // 8.22
484  virtual void requestRetraction (
485  MessageRetractionHandle theHandle)
486  throw (
487  FederateInternalError) {}
488  };
489 }
490 
491 #endif // RTI_NullFederateAmbassador_h
Document ID: Generated on Mon Mar 21 09:41:37 EDT 2016 from SVN revision 163228
Copyright © 2005-2015 VT MÄK Inc. All Rights Reserved (www.mak.com)