MAK RTIspy API Documentation for HLA 1.3
fedAmbCallbackQueue1516.h
Go to the documentation of this file.
1 /*********************************************************************
2 ** Copyright (c) 2007 MaK Technologies, Inc.
3 ** All rights reserved.
4 *********************************************************************/
5 /*********************************************************************
6 ** $RCSfile: fedAmbCallbackQueue1516.h,v $ $Revision: 1.5 $ $State: Exp $
7 *********************************************************************/
8 
9 #ifndef DtFedAmbCallbackQueue1516_h
10 #define DtFedAmbCallbackQueue1516_h
11 #ifdef DtIFSPEC1516
12 
15 
16 #include <queue>
17 #include <RTI/Typedefs.h>
18 #include "fedAmbWrap1516.h"
19 #include "rtiMsg.h"
20 
21 class DtFederateMgr;
22 class DtFedAmbCallback;
23 
24 typedef std::queue<DtRtiMsg*> DtFedAmbMsgQueue;
25 
29 class DT_DLL_LRC DtCallbackQueue : public DtFedAmbWrapper
30 {
31 public:
32 
34  DtCallbackQueue(DtFederateMgr* fedMgr = 0);
35 
37  virtual ~DtCallbackQueue() throw ();
38 
39 private:
41  DtCallbackQueue(DtCallbackQueue const& orig);
43  DtCallbackQueue& operator = (DtCallbackQueue const& orig);
44 
45 public:
46 
48  virtual void enableQueue();
49 
51  virtual void disableQueue();
52 
54  MAKRti::DtString const& name() const;
55 
57  virtual DtRtiMsg* popMessage();
58 
62 
64  virtual void synchronizationPointRegistrationSucceeded(std::wstring const & label)
65  throw (rti1516::FederateInternalError);
66 
67  virtual void synchronizationPointRegistrationFailed(std::wstring const & label,
68  rti1516::SynchronizationFailureReason reason)
69  throw (rti1516::FederateInternalError);
70 
72  virtual void announceSynchronizationPoint(std::wstring const & label,
73  rti1516::VariableLengthData const & theUserSuppliedTag)
74  throw (rti1516::FederateInternalError);
75 
77  virtual void federationSynchronized(std::wstring const & label)
78  throw (rti1516::FederateInternalError);
79 
81  virtual void initiateFederateSave(std::wstring const & label)
82  throw (rti1516::UnableToPerformSave,
83  rti1516::FederateInternalError);
84 
85  virtual void initiateFederateSave(std::wstring const & label,
86  rti1516::LogicalTime const & theTime)
87  throw (rti1516::UnableToPerformSave,
88  rti1516::InvalidLogicalTime,
89  rti1516::FederateInternalError);
90 
92  virtual void federationSaved()
93  throw (rti1516::FederateInternalError);
94 
95  virtual void federationNotSaved(rti1516::SaveFailureReason theSaveFailureReason)
96  throw (rti1516::FederateInternalError);
97 
99  virtual void federationSaveStatusResponse(
100  rti1516::FederateHandleSaveStatusPairVector const & theFederateStatusVector)
101  throw (rti1516::FederateInternalError);
102 
104  virtual void requestFederationRestoreSucceeded(std::wstring const & label)
105  throw (rti1516::FederateInternalError);
106 
107  virtual void requestFederationRestoreFailed(std::wstring const & label)
108  throw (rti1516::FederateInternalError);
109 
111  virtual void federationRestoreBegun()
112  throw (rti1516::FederateInternalError);
113 
115  virtual void initiateFederateRestore(std::wstring const & label,
116  rti1516::FederateHandle handle)
117  throw (rti1516::SpecifiedSaveLabelDoesNotExist,
118  rti1516::CouldNotInitiateRestore,
119  rti1516::FederateInternalError);
120 
122  virtual void federationRestored()
123  throw (rti1516::FederateInternalError);
124 
125  virtual void federationNotRestored(rti1516::RestoreFailureReason theRestoreFailureReason)
126  throw (rti1516::FederateInternalError);
127 
129  virtual void federationRestoreStatusResponse(
130  rti1516::FederateHandleRestoreStatusPairVector const & theFederateStatusVector)
131  throw (rti1516::FederateInternalError);
132 
136 
138  virtual void startRegistrationForObjectClass(rti1516::ObjectClassHandle theClass)
139  throw (rti1516::ObjectClassNotPublished,
140  rti1516::FederateInternalError);
141 
143  virtual void stopRegistrationForObjectClass(rti1516::ObjectClassHandle theClass)
144  throw (rti1516::ObjectClassNotPublished,
145  rti1516::FederateInternalError);
146 
148  virtual void turnInteractionsOn(rti1516::InteractionClassHandle theHandle)
149  throw (rti1516::InteractionClassNotPublished,
150  rti1516::FederateInternalError);
151 
153  virtual void turnInteractionsOff(rti1516::InteractionClassHandle theHandle)
154  throw (rti1516::InteractionClassNotPublished,
155  rti1516::FederateInternalError);
156 
160 
162  virtual void objectInstanceNameReservationSucceeded(std::wstring const &
163  theObjectInstanceName)
164  throw (rti1516::UnknownName,
165  rti1516::FederateInternalError);
166 
167  virtual void objectInstanceNameReservationFailed(std::wstring const &
168  theObjectInstanceName)
169  throw (rti1516::UnknownName,
170  rti1516::FederateInternalError);
171 
173  virtual void discoverObjectInstance(rti1516::ObjectInstanceHandle theObject,
174  rti1516::ObjectClassHandle theObjectClass,
175  std::wstring const & theObjectInstanceName)
176  throw (rti1516::CouldNotDiscover,
177  rti1516::ObjectClassNotKnown,
178  rti1516::FederateInternalError);
179 
181  virtual void reflectAttributeValues
182  (rti1516::ObjectInstanceHandle theObject,
183  rti1516::AttributeHandleValueMap const & theAttributeValues,
184  rti1516::VariableLengthData const & theUserSuppliedTag,
185  rti1516::OrderType sentOrder,
186  rti1516::TransportationType theType)
187  throw (rti1516::ObjectInstanceNotKnown,
188  rti1516::AttributeNotRecognized,
189  rti1516::AttributeNotSubscribed,
190  rti1516::FederateInternalError);
191 
192  virtual void reflectAttributeValues
193  (rti1516::ObjectInstanceHandle theObject,
194  rti1516::AttributeHandleValueMap const & theAttributeValues,
195  rti1516::VariableLengthData const & theUserSuppliedTag,
196  rti1516::OrderType sentOrder,
197  rti1516::TransportationType theType,
198  rti1516::RegionHandleSet const & theSentRegionHandleSet)
199  throw (rti1516::ObjectInstanceNotKnown,
200  rti1516::AttributeNotRecognized,
201  rti1516::AttributeNotSubscribed,
202  rti1516::FederateInternalError);
203 
204  virtual void reflectAttributeValues
205  (rti1516::ObjectInstanceHandle theObject,
206  rti1516::AttributeHandleValueMap const & theAttributeValues,
207  rti1516::VariableLengthData const & theUserSuppliedTag,
208  rti1516::OrderType sentOrder,
209  rti1516::TransportationType theType,
210  rti1516::LogicalTime const & theTime,
211  rti1516::OrderType receivedOrder)
212  throw (rti1516::ObjectInstanceNotKnown,
213  rti1516::AttributeNotRecognized,
214  rti1516::AttributeNotSubscribed,
215  rti1516::FederateInternalError);
216 
217  virtual void reflectAttributeValues
218  (rti1516::ObjectInstanceHandle theObject,
219  rti1516::AttributeHandleValueMap const & theAttributeValues,
220  rti1516::VariableLengthData const & theUserSuppliedTag,
221  rti1516::OrderType sentOrder,
222  rti1516::TransportationType theType,
223  rti1516::LogicalTime const & theTime,
224  rti1516::OrderType receivedOrder,
225  rti1516::RegionHandleSet const & theSentRegionHandleSet)
226  throw (rti1516::ObjectInstanceNotKnown,
227  rti1516::AttributeNotRecognized,
228  rti1516::AttributeNotSubscribed,
229  rti1516::FederateInternalError);
230 
231  virtual void reflectAttributeValues
232  (rti1516::ObjectInstanceHandle theObject,
233  rti1516::AttributeHandleValueMap const & theAttributeValues,
234  rti1516::VariableLengthData const & theUserSuppliedTag,
235  rti1516::OrderType sentOrder,
236  rti1516::TransportationType theType,
237  rti1516::LogicalTime const & theTime,
238  rti1516::OrderType receivedOrder,
239  rti1516::MessageRetractionHandle theHandle)
240  throw (rti1516::ObjectInstanceNotKnown,
241  rti1516::AttributeNotRecognized,
242  rti1516::AttributeNotSubscribed,
243  rti1516::InvalidLogicalTime,
244  rti1516::FederateInternalError);
245 
246  virtual void reflectAttributeValues
247  (rti1516::ObjectInstanceHandle theObject,
248  rti1516::AttributeHandleValueMap const & theAttributeValues,
249  rti1516::VariableLengthData const & theUserSuppliedTag,
250  rti1516::OrderType sentOrder,
251  rti1516::TransportationType theType,
252  rti1516::LogicalTime const & theTime,
253  rti1516::OrderType receivedOrder,
254  rti1516::MessageRetractionHandle theHandle,
255  rti1516::RegionHandleSet const & theSentRegionHandleSet)
256  throw (rti1516::ObjectInstanceNotKnown,
257  rti1516::AttributeNotRecognized,
258  rti1516::AttributeNotSubscribed,
259  rti1516::InvalidLogicalTime,
260  rti1516::FederateInternalError);
261 
263  virtual void receiveInteraction
264  (rti1516::InteractionClassHandle theInteraction,
265  rti1516::ParameterHandleValueMap const & theParameterValues,
266  rti1516::VariableLengthData const & theUserSuppliedTag,
267  rti1516::OrderType sentOrder,
268  rti1516::TransportationType theType)
269  throw (rti1516::InteractionClassNotRecognized,
270  rti1516::InteractionParameterNotRecognized,
271  rti1516::InteractionClassNotSubscribed,
272  rti1516::FederateInternalError);
273 
274  virtual void receiveInteraction
275  (rti1516::InteractionClassHandle theInteraction,
276  rti1516::ParameterHandleValueMap const & theParameterValues,
277  rti1516::VariableLengthData const & theUserSuppliedTag,
278  rti1516::OrderType sentOrder,
279  rti1516::TransportationType theType,
280  rti1516::RegionHandleSet const & theSentRegionHandleSet)
281  throw (rti1516::InteractionClassNotRecognized,
282  rti1516::InteractionParameterNotRecognized,
283  rti1516::InteractionClassNotSubscribed,
284  rti1516::FederateInternalError);
285 
286  virtual void receiveInteraction
287  (rti1516::InteractionClassHandle theInteraction,
288  rti1516::ParameterHandleValueMap const & theParameterValues,
289  rti1516::VariableLengthData const & theUserSuppliedTag,
290  rti1516::OrderType sentOrder,
291  rti1516::TransportationType theType,
292  rti1516::LogicalTime const & theTime,
293  rti1516::OrderType receivedOrder)
294  throw (rti1516::InteractionClassNotRecognized,
295  rti1516::InteractionParameterNotRecognized,
296  rti1516::InteractionClassNotSubscribed,
297  rti1516::FederateInternalError);
298 
299  virtual void receiveInteraction
300  (rti1516::InteractionClassHandle theInteraction,
301  rti1516::ParameterHandleValueMap const & theParameterValues,
302  rti1516::VariableLengthData const & theUserSuppliedTag,
303  rti1516::OrderType sentOrder,
304  rti1516::TransportationType theType,
305  rti1516::LogicalTime const & theTime,
306  rti1516::OrderType receivedOrder,
307  rti1516::RegionHandleSet const & theSentRegionHandleSet)
308  throw (rti1516::InteractionClassNotRecognized,
309  rti1516::InteractionParameterNotRecognized,
310  rti1516::InteractionClassNotSubscribed,
311  rti1516::FederateInternalError);
312 
313  virtual void receiveInteraction
314  (rti1516::InteractionClassHandle theInteraction,
315  rti1516::ParameterHandleValueMap const & theParameterValues,
316  rti1516::VariableLengthData const & theUserSuppliedTag,
317  rti1516::OrderType sentOrder,
318  rti1516::TransportationType theType,
319  rti1516::LogicalTime const & theTime,
320  rti1516::OrderType receivedOrder,
321  rti1516::MessageRetractionHandle theHandle)
322  throw (rti1516::InteractionClassNotRecognized,
323  rti1516::InteractionParameterNotRecognized,
324  rti1516::InteractionClassNotSubscribed,
325  rti1516::InvalidLogicalTime,
326  rti1516::FederateInternalError);
327 
328  virtual void receiveInteraction
329  (rti1516::InteractionClassHandle theInteraction,
330  rti1516::ParameterHandleValueMap const & theParameterValues,
331  rti1516::VariableLengthData const & theUserSuppliedTag,
332  rti1516::OrderType sentOrder,
333  rti1516::TransportationType theType,
334  rti1516::LogicalTime const & theTime,
335  rti1516::OrderType receivedOrder,
336  rti1516::MessageRetractionHandle theHandle,
337  rti1516::RegionHandleSet const & theSentRegionHandleSet)
338  throw (rti1516::InteractionClassNotRecognized,
339  rti1516::InteractionParameterNotRecognized,
340  rti1516::InteractionClassNotSubscribed,
341  rti1516::InvalidLogicalTime,
342  rti1516::FederateInternalError);
343 
345  virtual void removeObjectInstance(rti1516::ObjectInstanceHandle theObject,
346  rti1516::VariableLengthData const & theUserSuppliedTag,
347  rti1516::OrderType sentOrder)
348  throw (rti1516::ObjectInstanceNotKnown,
349  rti1516::FederateInternalError);
350 
351  virtual void removeObjectInstance(rti1516::ObjectInstanceHandle theObject,
352  rti1516::VariableLengthData const & theUserSuppliedTag,
353  rti1516::OrderType sentOrder,
354  rti1516::LogicalTime const & theTime,
355  rti1516::OrderType receivedOrder)
356  throw (rti1516::ObjectInstanceNotKnown,
357  rti1516::FederateInternalError);
358 
359  virtual void removeObjectInstance(rti1516::ObjectInstanceHandle theObject,
360  rti1516::VariableLengthData const & theUserSuppliedTag,
361  rti1516::OrderType sentOrder,
362  rti1516::LogicalTime const & theTime,
363  rti1516::OrderType receivedOrder,
364  rti1516::MessageRetractionHandle theHandle)
365  throw (rti1516::ObjectInstanceNotKnown,
366  rti1516::InvalidLogicalTime,
367  rti1516::FederateInternalError);
368 
370  virtual void attributesInScope
371  (rti1516::ObjectInstanceHandle theObject,
372  rti1516::AttributeHandleSet const & theAttributes)
373  throw (rti1516::ObjectInstanceNotKnown,
374  rti1516::AttributeNotRecognized,
375  rti1516::AttributeNotSubscribed,
376  rti1516::FederateInternalError);
377 
379  virtual void attributesOutOfScope
380  (rti1516::ObjectInstanceHandle theObject,
381  rti1516::AttributeHandleSet const & theAttributes)
382  throw (rti1516::ObjectInstanceNotKnown,
383  rti1516::AttributeNotRecognized,
384  rti1516::AttributeNotSubscribed,
385  rti1516::FederateInternalError);
386 
388  virtual void provideAttributeValueUpdate
389  (rti1516::ObjectInstanceHandle theObject,
390  rti1516::AttributeHandleSet const & theAttributes,
391  rti1516::VariableLengthData const & theUserSuppliedTag)
392  throw (rti1516::ObjectInstanceNotKnown,
393  rti1516::AttributeNotRecognized,
394  rti1516::AttributeNotOwned,
395  rti1516::FederateInternalError);
396 
398  virtual void turnUpdatesOnForObjectInstance
399  (rti1516::ObjectInstanceHandle theObject,
400  rti1516::AttributeHandleSet const & theAttributes)
401  throw (rti1516::ObjectInstanceNotKnown,
402  rti1516::AttributeNotRecognized,
403  rti1516::AttributeNotOwned,
404  rti1516::FederateInternalError);
405 
407  virtual void turnUpdatesOffForObjectInstance
408  (rti1516::ObjectInstanceHandle theObject,
409  rti1516::AttributeHandleSet const & theAttributes)
410  throw (rti1516::ObjectInstanceNotKnown,
411  rti1516::AttributeNotRecognized,
412  rti1516::AttributeNotOwned,
413  rti1516::FederateInternalError);
414 
418 
420  virtual void requestAttributeOwnershipAssumption
421  (rti1516::ObjectInstanceHandle theObject,
422  rti1516::AttributeHandleSet const & offeredAttributes,
423  rti1516::VariableLengthData const & theUserSuppliedTag)
424  throw (rti1516::ObjectInstanceNotKnown,
425  rti1516::AttributeNotRecognized,
426  rti1516::AttributeAlreadyOwned,
427  rti1516::AttributeNotPublished,
428  rti1516::FederateInternalError);
429 
431  virtual void requestDivestitureConfirmation
432  (rti1516::ObjectInstanceHandle theObject,
433  rti1516::AttributeHandleSet const & releasedAttributes)
434  throw (rti1516::ObjectInstanceNotKnown,
435  rti1516::AttributeNotRecognized,
436  rti1516::AttributeNotOwned,
437  rti1516::AttributeDivestitureWasNotRequested,
438  rti1516::FederateInternalError);
439 
441  virtual void attributeOwnershipAcquisitionNotification
442  (rti1516::ObjectInstanceHandle theObject,
443  rti1516::AttributeHandleSet const & securedAttributes,
444  rti1516::VariableLengthData const & theUserSuppliedTag)
445  throw (rti1516::ObjectInstanceNotKnown,
446  rti1516::AttributeNotRecognized,
447  rti1516::AttributeAcquisitionWasNotRequested,
448  rti1516::AttributeAlreadyOwned,
449  rti1516::AttributeNotPublished,
450  rti1516::FederateInternalError);
451 
453  virtual void attributeOwnershipUnavailable
454  (rti1516::ObjectInstanceHandle theObject,
455  rti1516::AttributeHandleSet const & theAttributes)
456  throw (rti1516::ObjectInstanceNotKnown,
457  rti1516::AttributeNotRecognized,
458  rti1516::AttributeAlreadyOwned,
459  rti1516::AttributeAcquisitionWasNotRequested,
460  rti1516::FederateInternalError);
461 
463  virtual void requestAttributeOwnershipRelease
464  (rti1516::ObjectInstanceHandle theObject,
465  rti1516::AttributeHandleSet const & candidateAttributes,
466  rti1516::VariableLengthData const & theUserSuppliedTag)
467  throw (rti1516::ObjectInstanceNotKnown,
468  rti1516::AttributeNotRecognized,
469  rti1516::AttributeNotOwned,
470  rti1516::FederateInternalError);
471 
473  virtual void confirmAttributeOwnershipAcquisitionCancellation
474  (rti1516::ObjectInstanceHandle theObject,
475  rti1516::AttributeHandleSet const & theAttributes)
476  throw (rti1516::ObjectInstanceNotKnown,
477  rti1516::AttributeNotRecognized,
478  rti1516::AttributeAlreadyOwned,
479  rti1516::AttributeAcquisitionWasNotCanceled,
480  rti1516::FederateInternalError);
481 
483  virtual void informAttributeOwnership(rti1516::ObjectInstanceHandle theObject,
484  rti1516::AttributeHandle theAttribute,
485  rti1516::FederateHandle theOwner)
486  throw (rti1516::ObjectInstanceNotKnown,
487  rti1516::AttributeNotRecognized,
488  rti1516::FederateInternalError);
489 
490  virtual void attributeIsNotOwned(rti1516::ObjectInstanceHandle theObject,
491  rti1516::AttributeHandle theAttribute)
492  throw (rti1516::ObjectInstanceNotKnown,
493  rti1516::AttributeNotRecognized,
494  rti1516::FederateInternalError);
495 
496  virtual void attributeIsOwnedByRTI(rti1516::ObjectInstanceHandle theObject,
497  rti1516::AttributeHandle theAttribute)
498  throw (rti1516::ObjectInstanceNotKnown,
499  rti1516::AttributeNotRecognized,
500  rti1516::FederateInternalError);
501 
505 
507  virtual void timeRegulationEnabled(rti1516::LogicalTime const & theFederateTime)
508  throw (rti1516::InvalidLogicalTime,
509  rti1516::NoRequestToEnableTimeRegulationWasPending,
510  rti1516::FederateInternalError);
511 
513  virtual void timeConstrainedEnabled(rti1516::LogicalTime const & theFederateTime)
514  throw (rti1516::InvalidLogicalTime,
515  rti1516::NoRequestToEnableTimeConstrainedWasPending,
516  rti1516::FederateInternalError);
517 
519  virtual void timeAdvanceGrant(rti1516::LogicalTime const & theTime)
520  throw (rti1516::InvalidLogicalTime,
521  rti1516::JoinedFederateIsNotInTimeAdvancingState,
522  rti1516::FederateInternalError);
523 
525  virtual void requestRetraction(rti1516::MessageRetractionHandle theHandle)
526  throw (rti1516::FederateInternalError);
527 
528 protected:
529 
531  virtual std::auto_ptr<rti1516::LogicalTime> copyTime(
532  rti1516::LogicalTime const& timeValue);
533 
534 protected:
535 
536  DtFederateMgr* myFedMgr;
537  DtFedAmbMsgQueue myFedAmbQueue;
538  bool myQueueCallback;
539  const MAKRti::DtString myName;
540 };
541 
542 #endif
543 #endif
Document ID: Generated on Tue May 7 16:26:47 EDT 2013 from SVN revision 126903
Copyright © 2005-2013 VT MÄK Inc. All Rights Reserved (www.mak.com)