MAK RTIspy API Documentation for HLA Evolved
ambObserver.h
Go to the documentation of this file.
1 /*********************************************************************
2 ** Copyright (c) 1998 MaK Technologies, Inc.
3 ** All rights reserved.
4 *********************************************************************/
5 /*********************************************************************
6 ** $RCSfile: ambObserver.h,v $ $Revision: 1.12 $ $State: Exp $
7 *********************************************************************/
8 
11 
12 #ifndef DtRtiAmbassadorObserver_H_
13 #define DtRtiAmbassadorObserver_H_
14 
15 #ifdef DtIFSPEC13
16 
17 #include "rtiMsConfig.h"
18 #include <vlutil/vlList.h>
19 #include <vlutil/vlString.h>
20 
21 #ifdef DtIFSPEC13DLC
22 #include "RTI13.h"
23 #define RTI rti13
24 #else
25 #include "RTI.hh"
26 #endif
27 
28 class DtRtiAmbassadorImplementor;
29 
30 class DT_DLL_LRC DtRtiAmbassadorObserver : public MAKRti::DtListedObj
31 {
32 public:
33 
34  DtRtiAmbassadorObserver() : MAKRti::DtListedObj() {}
35 
36  virtual ~DtRtiAmbassadorObserver() {}
37 
39  virtual DtRtiAmbassadorObserver* next() const;
40 
42  virtual DtRtiAmbassadorObserver* prev() const;
43 
46  virtual DtRtiAmbassadorObserver* wrapNext() const;
47 
50  virtual DtRtiAmbassadorObserver* wrapPrev() const;
51 
52  virtual void createFederationExecution (
53  const char *executionName,
54  const char *FED,
55  RTI::Exception* except = NULL) {}
56 
57  virtual void destroyFederationExecution (
58  const char *executionName,
59  RTI::Exception* except = NULL) {}
60 
61  virtual void joinFederationExecution (
62  const char *yourName,
63  const char *executionName,
64  RTI::FederateAmbassador* federateAmbassadorReference,
65  RTI::FederateHandle& handle,
66  RTI::Exception* except = NULL) {}
67 
68  virtual void resignFederationExecution (
69  RTI::ResignAction theAction,
70  RTI::Exception* except = NULL) {}
71 
72  virtual void registerFederationSynchronizationPoint (
73  const char *label,
74  const char *theTag,
75  RTI::Exception* except = NULL) {}
76 
77  virtual void registerFederationSynchronizationPoint (
78  const char *label,
79  const char *theTag,
80  const RTI::FederateHandleSet& syncSet,
81  RTI::Exception* except = NULL) {}
82 
83  virtual void synchronizationPointAchieved (
84  const char *label,
85  RTI::Exception* except = NULL) {}
86 
87  virtual void requestFederationSave (
88  const char *label,
89  const RTI::FedTime& theTime,
90  RTI::Exception* except = NULL) {}
91 
92  virtual void requestFederationSave (
93  const char *label,
94  RTI::Exception* except = NULL) {}
95 
96  virtual void federateSaveBegun (
97  RTI::Exception* except = NULL) {}
98 
99  virtual void federateSaveComplete (
100  RTI::Exception* except = NULL) {}
101 
102  virtual void federateSaveNotComplete (
103  RTI::Exception* except = NULL) {}
104 
105  virtual void requestFederationRestore (
106  const char *label,
107  RTI::Exception* except = NULL) {}
108 
109  virtual void federateRestoreComplete (
110  RTI::Exception* except = NULL) {}
111 
112  virtual void federateRestoreNotComplete (
113  RTI::Exception* except = NULL) {}
114 
115 //-----------------------------------
117 //----------------------------------
118 
119  virtual void publishObjectClass (
120  RTI::ObjectClassHandle theClass,
121  const RTI::AttributeHandleSet& attributeList,
122  RTI::Exception* except = NULL) {}
123 
124  virtual void unpublishObjectClass (
125  RTI::ObjectClassHandle theClass,
126  RTI::Exception* except = NULL) {}
127 
128  virtual void publishInteractionClass (
129  RTI::InteractionClassHandle theInteraction,
130  RTI::Exception* except = NULL) {}
131 
132  virtual void unpublishInteractionClass (
133  RTI::InteractionClassHandle theInteraction,
134  RTI::Exception* except = NULL) {}
135 
136  virtual void subscribeObjectClassAttributes (
137  RTI::ObjectClassHandle theClass,
138  const RTI::AttributeHandleSet& attributeList,
139  RTI::Boolean active = RTI::RTI_TRUE,
140  RTI::Exception* except = NULL) {}
141 
142  virtual void unsubscribeObjectClass (
143  RTI::ObjectClassHandle theClass,
144  RTI::Exception* except = NULL) {}
145 
146  virtual void subscribeInteractionClass (
147  RTI::InteractionClassHandle theClass,
148  RTI::Boolean active = RTI::RTI_TRUE,
149  RTI::Exception* except = NULL) {}
150 
151  virtual void unsubscribeInteractionClass (
152  RTI::InteractionClassHandle theClass,
153  RTI::Exception* except = NULL) {}
154 
155 //-------------------------------
157 //-------------------------------
158 
159  virtual void registerObjectInstance (
160  RTI::ObjectClassHandle theClass,
161  const char *theObject,
162  RTI::ObjectHandle& handle,
163  RTI::Exception* except = NULL) {}
164 
165  virtual void registerObjectInstance (
166  RTI::ObjectClassHandle theClass,
167  RTI::ObjectHandle& handle,
168  RTI::Exception* except = NULL) {}
169 
170  virtual void updateAttributeValues (
171  RTI::ObjectHandle theObject,
172  const RTI::AttributeHandleValuePairSet& theAttributes,
173  const RTI::FedTime& theTime,
174  const char *theTag,
175  RTI::EventRetractionHandle& handle,
176  RTI::Exception* except = NULL) {}
177 
178  virtual void updateAttributeValues (
179  RTI::ObjectHandle theObject,
180  const RTI::AttributeHandleValuePairSet& theAttributes,
181  const char *theTag,
182  RTI::Exception* except = NULL) {}
183 
184  virtual void sendInteraction (
185  RTI::InteractionClassHandle theInteraction,
186  const RTI::ParameterHandleValuePairSet& theParameters,
187  const RTI::FedTime& theTime,
188  const char *theTag,
189  RTI::EventRetractionHandle& handle,
190  RTI::Exception* except = NULL) {}
191 
192  virtual void sendInteraction (
193  RTI::InteractionClassHandle theInteraction,
194  const RTI::ParameterHandleValuePairSet& theParameters,
195  const char *theTag,
196  RTI::Exception* except = NULL) {}
197 
198  virtual void deleteObjectInstance (
199  RTI::ObjectHandle theObject,
200  const RTI::FedTime& theTime,
201  const char *theTag,
202  RTI::EventRetractionHandle& handle,
203  RTI::Exception* except = NULL) {}
204 
205  virtual void deleteObjectInstance (
206  RTI::ObjectHandle theObject,
207  const char *theTag,
208  RTI::Exception* except = NULL) {}
209 
210  virtual void localDeleteObjectInstance (
211  RTI::ObjectHandle theObject,
212  RTI::Exception* except = NULL) {}
213 
214  virtual void changeAttributeTransportationType (
215  RTI::ObjectHandle theObject,
216  const RTI::AttributeHandleSet& theAttributes,
217  RTI::TransportationHandle theType,
218  RTI::Exception* except = NULL) {}
219 
220  virtual void changeInteractionTransportationType (
221  RTI::InteractionClassHandle theClass,
222  RTI::TransportationHandle theType,
223  RTI::Exception* except = NULL) {}
224 
225  virtual void requestObjectAttributeValueUpdate (
226  RTI::ObjectHandle theObject,
227  const RTI::AttributeHandleSet& theAttributes,
228  RTI::Exception* except = NULL) {}
229 
230  virtual void requestClassAttributeValueUpdate (
231  RTI::ObjectClassHandle theClass,
232  const RTI::AttributeHandleSet& theAttributes,
233  RTI::Exception* except = NULL) {}
234 
235 //---------------------------------
237 //---------------------------------
238 
239  virtual void unconditionalAttributeOwnershipDivestiture (
240  RTI::ObjectHandle theObject,
241  const RTI::AttributeHandleSet& theAttributes,
242  RTI::Exception* except = NULL) {}
243 
244  virtual void negotiatedAttributeOwnershipDivestiture (
245  RTI::ObjectHandle theObject,
246  const RTI::AttributeHandleSet& theAttributes,
247  const char *theTag,
248  RTI::Exception* except = NULL) {}
249 
250  virtual void attributeOwnershipAcquisition (
251  RTI::ObjectHandle theObject,
252  const RTI::AttributeHandleSet& desiredAttributes,
253  const char *theTag,
254  RTI::Exception* except = NULL) {}
255 
256  virtual void attributeOwnershipAcquisitionIfAvailable (
257  RTI::ObjectHandle theObject,
258  const RTI::AttributeHandleSet& desiredAttributes,
259  RTI::Exception* except = NULL) {}
260 
261  virtual void attributeOwnershipReleaseResponse (
262  RTI::ObjectHandle theObject,
263  const RTI::AttributeHandleSet& theAttributes,
264  RTI::AttributeHandleSet* set,
265  RTI::Exception* except = NULL) {}
266 
267  virtual void cancelNegotiatedAttributeOwnershipDivestiture (
268  RTI::ObjectHandle theObject,
269  const RTI::AttributeHandleSet& theAttributes,
270  RTI::Exception* except = NULL) {}
271 
272  virtual void cancelAttributeOwnershipAcquisition (
273  RTI::ObjectHandle theObject,
274  const RTI::AttributeHandleSet& theAttributes,
275  RTI::Exception* except = NULL) {}
276 
277  virtual void queryAttributeOwnership (
278  RTI::ObjectHandle theObject,
279  RTI::AttributeHandle theAttribute,
280  RTI::Exception* except = NULL) {}
281 
282  virtual void isAttributeOwnedByFederate (
283  RTI::ObjectHandle theObject,
284  RTI::AttributeHandle theAttribute,
285  RTI::Boolean boolean,
286  RTI::Exception* except = NULL) {}
287 
288 //----------------------------
290 //----------------------------
291 
292  virtual void enableTimeRegulation (
293  const RTI::FedTime& theFederateTime,
294  const RTI::FedTime& theLookahead,
295  RTI::Exception* except = NULL) {}
296 
297  virtual void disableTimeRegulation (
298  RTI::Exception* except = NULL) {}
299 
300  virtual void enableTimeConstrained (
301  RTI::Exception* except = NULL) {}
302 
303  virtual void disableTimeConstrained (
304  RTI::Exception* except = NULL) {}
305 
306  virtual void timeAdvanceRequest (
307  const RTI::FedTime& theTime,
308  RTI::Exception* except = NULL) {}
309 
310  virtual void timeAdvanceRequestAvailable (
311  const RTI::FedTime& theTime,
312  RTI::Exception* except = NULL) {}
313 
314  virtual void nextEventRequest (
315  const RTI::FedTime& theTime,
316  RTI::Exception* except = NULL) {}
317 
318  virtual void nextEventRequestAvailable (
319  const RTI::FedTime& theTime,
320  RTI::Exception* except = NULL) {}
321 
322  virtual void flushQueueRequest (
323  const RTI::FedTime& theTime,
324  RTI::Exception* except = NULL) {}
325 
326  virtual void enableAsynchronousDelivery(
327  RTI::Exception* except = NULL) {}
328 
329  virtual void disableAsynchronousDelivery(
330  RTI::Exception* except = NULL) {}
331 
332  virtual void queryLBTS (
333  RTI::FedTime& theTime,
334  RTI::Exception* except = NULL) {}
335 
336  virtual void queryFederateTime (
337  RTI::FedTime& theTime,
338  RTI::Exception* except = NULL) {}
339 
340  virtual void queryMinNextEventTime (
341  RTI::FedTime& theTime,
342  RTI::Exception* except = NULL) {}
343 
344  virtual void modifyLookahead (
345  const RTI::FedTime& theLookahead,
346  RTI::Exception* except = NULL) {}
347 
348  virtual void queryLookahead (
349  RTI::FedTime& theTime,
350  RTI::Exception* except = NULL) {}
351 
352  virtual void retract (
353  RTI::EventRetractionHandle theHandle,
354  RTI::Exception* except = NULL) {}
355 
356  virtual void changeAttributeOrderType (
357  RTI::ObjectHandle theObject,
358  const RTI::AttributeHandleSet& theAttributes,
359  RTI::OrderingHandle theType,
360  RTI::Exception* except = NULL) {}
361 
362  virtual void changeInteractionOrderType (
363  RTI::InteractionClassHandle theClass,
364  RTI::OrderingHandle theType,
365  RTI::Exception* except = NULL) {}
366 
367 //--------------------------------
369 //--------------------------------
370 
371  virtual void createRegion (
372  RTI::SpaceHandle theSpace,
373  RTI::ULong numberOfExtents,
374  RTI::Region* region,
375  RTI::Exception* except = NULL) {}
376 
377  virtual void notifyAboutRegionModification (
378  RTI::Region &theRegion,
379  RTI::Exception* except = NULL) {}
380 
381  virtual void deleteRegion (
382  RTI::Region *theRegion,
383  RTI::Exception* except = NULL) {}
384 
385  virtual void registerObjectInstanceWithRegion (
386  RTI::ObjectClassHandle theClass,
387  const char *theObject,
388  RTI::AttributeHandle theAttributes[],
389  RTI::Region *theRegions[],
390  RTI::ULong theNumberOfHandles,
391  RTI::ObjectHandle& handle,
392  RTI::Exception* except = NULL) {}
393 
394  virtual void registerObjectInstanceWithRegion (
395  RTI::ObjectClassHandle theClass,
396  RTI::AttributeHandle theAttributes[],
397  RTI::Region *theRegions[],
398  RTI::ULong theNumberOfHandles,
399  RTI::ObjectHandle& handle,
400  RTI::Exception* except = NULL) {}
401 
402  virtual void associateRegionForUpdates (
403  RTI::Region &theRegion,
404  RTI::ObjectHandle theObject,
405  const RTI::AttributeHandleSet &theAttributes,
406  RTI::Exception* except = NULL) {}
407 
408  virtual void unassociateRegionForUpdates (
409  RTI::Region &theRegion,
410  RTI::ObjectHandle theObject,
411  RTI::Exception* except = NULL) {}
412 
413  virtual void subscribeObjectClassAttributesWithRegion (
414  RTI::ObjectClassHandle theClass,
415  RTI::Region &theRegion,
416  const RTI::AttributeHandleSet &attributeList,
417  RTI::Boolean active = RTI::RTI_TRUE,
418  RTI::Exception* except = NULL) {}
419 
420  virtual void unsubscribeObjectClassWithRegion (
421  RTI::ObjectClassHandle theClass,
422  RTI::Region &theRegion,
423  RTI::Exception* except = NULL) {}
424 
425  virtual void subscribeInteractionClassWithRegion (
426  RTI::InteractionClassHandle theClass,
427  RTI::Region &theRegion,
428  RTI::Boolean active = RTI::RTI_TRUE,
429  RTI::Exception* except = NULL) {}
430 
431  virtual void unsubscribeInteractionClassWithRegion (
432  RTI::InteractionClassHandle theClass,
433  RTI::Region &theRegion,
434  RTI::Exception* except = NULL) {}
435 
436  virtual void sendInteractionWithRegion (
437  RTI::InteractionClassHandle theInteraction,
438  const RTI::ParameterHandleValuePairSet &theParameters,
439  const RTI::FedTime& theTime,
440  const char *theTag,
441  const RTI::Region &theRegion,
442  RTI::EventRetractionHandle& handle,
443  RTI::Exception* except = NULL) {}
444 
445  virtual void sendInteractionWithRegion (
446  RTI::InteractionClassHandle theInteraction,
447  const RTI::ParameterHandleValuePairSet &theParameters,
448  const char *theTag,
449  const RTI::Region &theRegion,
450  RTI::Exception* except = NULL) {}
451 
452  virtual void requestClassAttributeValueUpdateWithRegion (
453  RTI::ObjectClassHandle theClass,
454  const RTI::AttributeHandleSet &theAttributes,
455  const RTI::Region &theRegion,
456  RTI::Exception* except = NULL) {}
457 
458 //------------------------
460 //------------------------
461 
462  virtual void getObjectClassHandle (
463  const char *theName,
464  RTI::ObjectClassHandle& handle,
465  RTI::Exception* except = NULL) {}
466 
467  virtual void getObjectClassName (
468  RTI::ObjectClassHandle theHandle,
469  char* className,
470  RTI::Exception* except = NULL) {}
471 
472  virtual void getAttributeHandle (
473  const char *theName,
474  RTI::ObjectClassHandle whichClass,
475  RTI::AttributeHandle& handle,
476  RTI::Exception* except = NULL) {}
477 
478  virtual void getAttributeName (
479  RTI::AttributeHandle theHandle,
480  RTI::ObjectClassHandle whichClass,
481  char* attributeName,
482  RTI::Exception* except = NULL) {}
483 
484  virtual void getInteractionClassHandle (
485  const char *theName,
486  RTI::InteractionClassHandle& handle,
487  RTI::Exception* except = NULL) {}
488 
489  virtual void getInteractionClassName (
490  RTI::InteractionClassHandle theHandle,
491  char* className,
492  RTI::Exception* except = NULL) {}
493 
494  virtual void getParameterHandle (
495  const char *theName,
496  RTI::InteractionClassHandle whichClass,
497  RTI::ParameterHandle& handle,
498  RTI::Exception* except = NULL) {}
499 
500  virtual void getParameterName (
501  RTI::ParameterHandle theHandle,
502  RTI::InteractionClassHandle whichClass,
503  char* paramName,
504  RTI::Exception* except = NULL) {}
505 
506  virtual void getObjectInstanceHandle (
507  const char *theName,
508  RTI::ObjectHandle& handle,
509  RTI::Exception* except = NULL) {}
510 
511  virtual void getObjectInstanceName (
512  RTI::ObjectHandle theHandle,
513  char* objectInstanceName,
514  RTI::Exception* except = NULL) {}
515 
516  virtual void getRoutingSpaceHandle (
517  const char *theName,
518  RTI::SpaceHandle& handle,
519  RTI::Exception* except = NULL) {}
520 
521  virtual void getRoutingSpaceName (
522  RTI::SpaceHandle theHandle,
523  char* spaceName,
524  RTI::Exception* except = NULL) {}
525 
526  virtual void getDimensionHandle (
527  const char *theName,
528  RTI::SpaceHandle whichSpace,
529  RTI::DimensionHandle& handle,
530  RTI::Exception* except = NULL) {}
531 
532  virtual void getDimensionName (
533  RTI::DimensionHandle theHandle,
534  RTI::SpaceHandle whichSpace,
535  char* dimensionName,
536  RTI::Exception* except = NULL) {}
537 
538  virtual void getAttributeRoutingSpaceHandle (
539  RTI::AttributeHandle theHandle,
540  RTI::ObjectClassHandle whichClass,
541  RTI::SpaceHandle& handle,
542  RTI::Exception* except = NULL) {}
543 
544  virtual void getObjectClass (
545  RTI::ObjectHandle theObject,
546  RTI::ObjectClassHandle& handle,
547  RTI::Exception* except = NULL) {}
548 
549  virtual void getInteractionRoutingSpaceHandle (
550  RTI::InteractionClassHandle theHandle,
551  RTI::SpaceHandle& handle,
552  RTI::Exception* except = NULL) {}
553 
554  virtual void getTransportationHandle (
555  const char *theName,
556  RTI::TransportationHandle& handle,
557  RTI::Exception* except = NULL) {}
558 
559  virtual void getTransportationName (
560  RTI::TransportationHandle theHandle,
561  char* transportationName,
562  RTI::Exception* except = NULL) {}
563 
564  virtual void getOrderingHandle (
565  const char *theName,
566  RTI::OrderingHandle& handle,
567  RTI::Exception* except = NULL) {}
568 
569  virtual void getOrderingName (
570  RTI::OrderingHandle theHandle,
571  char* orderingName,
572  RTI::Exception* except = NULL) {}
573 
574  virtual void enableClassRelevanceAdvisorySwitch(
575  RTI::Exception* except = NULL) {}
576 
577  virtual void disableClassRelevanceAdvisorySwitch(
578  RTI::Exception* except = NULL) {}
579 
580  virtual void enableAttributeRelevanceAdvisorySwitch(
581  RTI::Exception* except = NULL) {}
582 
583  virtual void disableAttributeRelevanceAdvisorySwitch(
584  RTI::Exception* except = NULL) {}
585 
586  virtual void enableAttributeScopeAdvisorySwitch(
587  RTI::Exception* except = NULL) {}
588 
589  virtual void disableAttributeScopeAdvisorySwitch(
590  RTI::Exception* except = NULL) {}
591 
592  virtual void enableInteractionRelevanceAdvisorySwitch(
593  RTI::Exception* except = NULL) {}
594 
595  virtual void disableInteractionRelevanceAdvisorySwitch(
596  RTI::Exception* except = NULL) {}
597 
598  virtual void tick (
599  RTI::Boolean result,
600  RTI::Exception* except = NULL) {}
601 
602  virtual void tick (
603  RTI::TickTime minimum,
604  RTI::TickTime maximum,
605  RTI::Boolean result,
606  RTI::Exception* except = NULL) {}
607 
608  virtual void getRegionToken(
609  RTI::Region *,
610  RTI::RegionToken& token,
611  RTI::Exception* except = NULL) {}
612 
613  virtual void getRegion(
614  RTI::RegionToken,
615  RTI::Region* region,
616  RTI::Exception* except = NULL) {}
617 };
618 
619 inline DtRtiAmbassadorObserver* DtRtiAmbassadorObserver::next() const
620 {
621  return (DtRtiAmbassadorObserver*) MAKRti::DtListedObj::next();
622 }
623 
624 inline DtRtiAmbassadorObserver* DtRtiAmbassadorObserver::prev() const
625 {
626  return (DtRtiAmbassadorObserver*) MAKRti::DtListedObj::prev();
627 }
628 
629 inline DtRtiAmbassadorObserver* DtRtiAmbassadorObserver::wrapNext() const
630 {
631  return (DtRtiAmbassadorObserver*) MAKRti::DtListedObj::wrapNext();
632 }
633 
634 inline DtRtiAmbassadorObserver* DtRtiAmbassadorObserver::wrapPrev() const
635 {
636  return (DtRtiAmbassadorObserver*) MAKRti::DtListedObj::wrapPrev();
637 }
638 
639 #endif
640 #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)