MAK RTIspy API Documentation for HLA Evolved
momObserver1516e.h
Go to the documentation of this file.
1 /*******************************************************************************
2 ** Copyright (c) 2010 MaK Technologies, Inc.
3 ** All rights reserved.
4 *******************************************************************************/
5 /*******************************************************************************
6 ** $RCSfile: momObserver1516e.h,v $ $Revision: 1.0 $ $State: Exp $
7 *******************************************************************************/
8 
11 
12 #ifndef RTI_STATE1516_H_
13 #define RTI_STATE1516_H_
14 
15 #ifdef DtMOM
16 #ifdef DtIFSPEC1516E
17 
18 #include "ambObserver1516e.h"
19 #include "momArgument.h"
20 
21 class DtMomMgr;
22 
23 class DtMomObserver : public DtRtiAmbassadorObserver
24 {
25 public:
26 
27  static const DtMomArgument theDfltMomArgument;
28  static DtMomArgument theDfltRetVal;
29 
30 public:
31  DtMomObserver( DtMomMgr* momMgrPtr );
32 
33  virtual ~DtMomObserver();
34 
36  virtual void reset();
37 
40  virtual unsigned long objectRegisterCount() const;
41 
44  virtual unsigned long objectDeleteCount() const;
45 
47 
49 
50 
51  virtual void createFederationExecution
52  (std::wstring const & federationExecutionName,
53  std::wstring const & fullPathNameToTheFDDfile,
54  std::wstring const & logicalTimeImplementationName,
55  rti1516e::Exception* except=NULL);
56 
58  virtual void destroyFederationExecution
59  (std::wstring const & federationExecutionName,
60  rti1516e::Exception* except=NULL);
61 
63  virtual void joinFederationExecution
64  (std::wstring const & federateType,
65  std::wstring const & federationExecutionName,
66  rti1516e::FederateAmbassador & federateAmbassador,
67  rti1516e::FederateHandle federateHandle,
68  rti1516e::Exception* except=NULL);
69 
71  virtual void resignFederationExecution
72  (rti1516e::ResignAction resignAction,
73  rti1516e::Exception* except=NULL);
74 
77  (std::wstring const & label,
78  rti1516e::VariableLengthData const & theUserSuppliedTag,
79  rti1516e::Exception* except=NULL);
80 
82  (std::wstring const & label,
83  rti1516e::VariableLengthData const & theUserSuppliedTag,
84  rti1516e::FederateHandleSet const & syncSet,
85  rti1516e::Exception* except=NULL);
86 
88  virtual void synchronizationPointAchieved
89  (std::wstring const & label,
90  rti1516e::Exception* except=NULL);
91 
93  virtual void requestFederationSave
94  (std::wstring const & label,
95  rti1516e::Exception* except=NULL);
96 
97  virtual void requestFederationSave
98  (std::wstring const & label,
99  rti1516e::LogicalTime const & theTime,
100  rti1516e::Exception* except=NULL);
101 
103  virtual void federateSaveBegun (
104  rti1516e::Exception* except=NULL);
105 
107  virtual void federateSaveComplete (
108  rti1516e::Exception* except=NULL);
109 
110  virtual void federateSaveNotComplete(
111  rti1516e::Exception* except=NULL);
112 
114  virtual void queryFederationSaveStatus (
115  rti1516e::Exception* except=NULL);
116 
118  virtual void requestFederationRestore
119  (std::wstring const & label,
120  rti1516e::Exception* except=NULL);
121 
123  virtual void federateRestoreComplete (
124  rti1516e::Exception* except=NULL);
125 
126  virtual void federateRestoreNotComplete (
127  rti1516e::Exception* except=NULL);
128 
130  virtual void queryFederationRestoreStatus (
131  rti1516e::Exception* except=NULL);
133 
135 
136 
138  virtual void publishObjectClassAttributes
139  (rti1516e::ObjectClassHandle theClass,
140  rti1516e::AttributeHandleSet const & attributeList,
141  rti1516e::Exception* except=NULL);
142 
144  virtual void unpublishObjectClass
145  (rti1516e::ObjectClassHandle theClass,
146  rti1516e::Exception* except=NULL);
147 
148  virtual void unpublishObjectClassAttributes
149  (rti1516e::ObjectClassHandle theClass,
150  rti1516e::AttributeHandleSet const & attributeList,
151  rti1516e::Exception* except=NULL);
152 
154  virtual void publishInteractionClass
155  (rti1516e::InteractionClassHandle theInteraction,
156  rti1516e::Exception* except=NULL);
157 
159  virtual void unpublishInteractionClass
160  (rti1516e::InteractionClassHandle theInteraction,
161  rti1516e::Exception* except=NULL);
162 
164  virtual void subscribeObjectClassAttributes
165  (rti1516e::ObjectClassHandle theClass,
166  rti1516e::AttributeHandleSet const & attributeList,
167  bool active,
168  rti1516e::Exception* except=NULL);
169 
171  virtual void unsubscribeObjectClass
172  (rti1516e::ObjectClassHandle theClass,
173  rti1516e::Exception* except=NULL);
174 
175  virtual void unsubscribeObjectClassAttributes
176  (rti1516e::ObjectClassHandle theClass,
177  rti1516e::AttributeHandleSet const & attributeList,
178  rti1516e::Exception* except=NULL);
179 
181  virtual void subscribeInteractionClass
183  bool active,
184  rti1516e::Exception* except=NULL);
185 
187  virtual void unsubscribeInteractionClass
189  rti1516e::Exception* except=NULL);
191 
193 
194 
196  virtual void reserveObjectInstanceName
197  (std::wstring const & theObjectInstanceName,
198  rti1516e::Exception* except=NULL);
199 
201  virtual void registerObjectInstance
202  (rti1516e::ObjectClassHandle theClass,
203  rti1516e::ObjectInstanceHandle objectHandle,
204  rti1516e::Exception* except=NULL);
205 
206  virtual void registerObjectInstance
207  (rti1516e::ObjectClassHandle theClass,
208  std::wstring const & theObjectInstanceName,
209  rti1516e::ObjectInstanceHandle objectHandle,
210  rti1516e::Exception* except=NULL);
211 
213  virtual void updateAttributeValues
214  (rti1516e::ObjectInstanceHandle theObject,
215  rti1516e::AttributeHandleValueMap const & theAttributeValues,
216  rti1516e::VariableLengthData const & theUserSuppliedTag,
217  rti1516e::Exception* except=NULL);
218 
219  virtual void updateAttributeValues
220  (rti1516e::ObjectInstanceHandle theObject,
221  rti1516e::AttributeHandleValueMap const & theAttributeValues,
222  rti1516e::VariableLengthData const & theUserSuppliedTag,
223  rti1516e::LogicalTime const & theTime,
224  rti1516e::MessageRetractionHandle retractHandle,
225  rti1516e::Exception* except=NULL);
226 
228  virtual void sendInteraction
229  (rti1516e::InteractionClassHandle theInteraction,
230  rti1516e::ParameterHandleValueMap const & theParameterValues,
231  rti1516e::VariableLengthData const & theUserSuppliedTag,
232  rti1516e::Exception* except=NULL);
233 
234  virtual void sendInteraction
235  (rti1516e::InteractionClassHandle theInteraction,
236  rti1516e::ParameterHandleValueMap const & theParameterValues,
237  rti1516e::VariableLengthData const & theUserSuppliedTag,
238  rti1516e::LogicalTime const & theTime,
239  rti1516e::MessageRetractionHandle retractHandle,
240  rti1516e::Exception* except=NULL);
241 
243  virtual void deleteObjectInstance
244  (rti1516e::ObjectInstanceHandle theObject,
245  rti1516e::VariableLengthData const & theUserSuppliedTag,
246  rti1516e::Exception* except=NULL);
247 
248  virtual void deleteObjectInstance
249  (rti1516e::ObjectInstanceHandle theObject,
250  rti1516e::VariableLengthData const & theUserSuppliedTag,
251  rti1516e::LogicalTime const & theTime,
252  rti1516e::MessageRetractionHandle retractHandle,
253  rti1516e::Exception* except=NULL);
254 
256  virtual void localDeleteObjectInstance
257  (rti1516e::ObjectInstanceHandle theObject,
258  rti1516e::Exception* except=NULL);
259 
262  (rti1516e::ObjectInstanceHandle theObject,
263  rti1516e::AttributeHandleSet const & theAttributes,
265  rti1516e::Exception* except=NULL);
266 
271  rti1516e::Exception* except=NULL);
272 
274  virtual void requestAttributeValueUpdate
275  (rti1516e::ObjectInstanceHandle theObject,
276  rti1516e::AttributeHandleSet const & theAttributes,
277  rti1516e::VariableLengthData const & theUserSuppliedTag,
278  rti1516e::Exception* except=NULL);
279 
280  virtual void requestAttributeValueUpdate
281  (rti1516e::ObjectClassHandle theClass,
282  rti1516e::AttributeHandleSet const & theAttributes,
283  rti1516e::VariableLengthData const & theUserSuppliedTag,
284  rti1516e::Exception* except=NULL);
286 
288 
289 
292  (rti1516e::ObjectInstanceHandle theObject,
293  rti1516e::AttributeHandleSet const & theAttributes,
294  rti1516e::Exception* except=NULL);
295 
298  (rti1516e::ObjectInstanceHandle theObject,
299  rti1516e::AttributeHandleSet const & theAttributes,
300  rti1516e::VariableLengthData const & theUserSuppliedTag,
301  rti1516e::Exception* except=NULL);
302 
304  virtual void confirmDivestiture
305  (rti1516e::ObjectInstanceHandle theObject,
306  rti1516e::AttributeHandleSet const & confirmedAttributes,
307  rti1516e::VariableLengthData const & theUserSuppliedTag,
308  rti1516e::Exception* except=NULL);
309 
311  virtual void attributeOwnershipAcquisition
312  (rti1516e::ObjectInstanceHandle theObject,
313  rti1516e::AttributeHandleSet const & desiredAttributes,
314  rti1516e::VariableLengthData const & theUserSuppliedTag,
315  rti1516e::Exception* except=NULL);
316 
319  (rti1516e::ObjectInstanceHandle theObject,
320  rti1516e::AttributeHandleSet const & desiredAttributes,
321  rti1516e::Exception* except=NULL);
322 
324  virtual void attributeOwnershipDivestitureIfWanted
325  (rti1516e::ObjectInstanceHandle theObject,
326  rti1516e::AttributeHandleSet const & theAttributes,
327  rti1516e::AttributeHandleSet & theDivestedAttributes,
328  rti1516e::Exception* except=NULL);
329 
332  (rti1516e::ObjectInstanceHandle theObject,
333  rti1516e::AttributeHandleSet const & theAttributes,
334  rti1516e::Exception* except=NULL);
335 
338  (rti1516e::ObjectInstanceHandle theObject,
339  rti1516e::AttributeHandleSet const & theAttributes,
340  rti1516e::Exception* except=NULL);
341 
343  virtual void queryAttributeOwnership
344  (rti1516e::ObjectInstanceHandle theObject,
345  rti1516e::AttributeHandle theAttribute,
346  rti1516e::Exception* except=NULL);
347 
349  virtual void isAttributeOwnedByFederate
350  (rti1516e::ObjectInstanceHandle theObject,
351  rti1516e::AttributeHandle theAttribute,
352  bool result,
353  rti1516e::Exception* except=NULL);
355 
357 
358 
360  virtual void enableTimeRegulation
361  (rti1516e::LogicalTimeInterval const & theLookahead,
362  rti1516e::Exception* except=NULL);
363 
365  virtual void disableTimeRegulation (
366  rti1516e::Exception* except=NULL);
367 
369  virtual void enableTimeConstrained (
370  rti1516e::Exception* except=NULL);
371 
373  virtual void disableTimeConstrained (
374  rti1516e::Exception* except=NULL);
375 
377  virtual void timeAdvanceRequest
378  (rti1516e::LogicalTime const & theTime,
379  rti1516e::Exception* except=NULL);
380 
382  virtual void timeAdvanceRequestAvailable
383  (rti1516e::LogicalTime const & theTime,
384  rti1516e::Exception* except=NULL);
385 
387  virtual void nextMessageRequest
388  (rti1516e::LogicalTime const & theTime,
389  rti1516e::Exception* except=NULL);
390 
392  virtual void nextMessageRequestAvailable
393  (rti1516e::LogicalTime const & theTime,
394  rti1516e::Exception* except=NULL);
395 
397  virtual void flushQueueRequest
398  (rti1516e::LogicalTime const & theTime,
399  rti1516e::Exception* except=NULL);
400 
402  virtual void enableAsynchronousDelivery (
403  rti1516e::Exception* except=NULL);
404 
406  virtual void disableAsynchronousDelivery (
407  rti1516e::Exception* except=NULL);
408 
410  virtual void queryGALT (rti1516e::LogicalTime & theTime,
411  bool result,
412  rti1516e::Exception* except=NULL);
413 
415  virtual void queryLogicalTime (rti1516e::LogicalTime & theTime,
416  rti1516e::Exception* except=NULL);
417 
419  virtual void queryLITS (rti1516e::LogicalTime & theTime,
420  bool result,
421  rti1516e::Exception* except=NULL);
422 
424  virtual void modifyLookahead
425  (rti1516e::LogicalTimeInterval const & theLookahead,
426  rti1516e::Exception* except=NULL);
427 
430  rti1516e::Exception* except=NULL);
431 
433  virtual void retract
434  (rti1516e::MessageRetractionHandle theHandle,
435  rti1516e::Exception* except=NULL);
436 
438  virtual void changeAttributeOrderType
439  (rti1516e::ObjectInstanceHandle theObject,
440  rti1516e::AttributeHandleSet const & theAttributes,
441  rti1516e::OrderType theType,
442  rti1516e::Exception* except=NULL);
443 
445  virtual void changeInteractionOrderType
447  rti1516e::OrderType theType,
448  rti1516e::Exception* except=NULL);
450 
452 
453 
455  virtual void createRegion
456  (rti1516e::DimensionHandleSet const & theDimensions,
457  rti1516e::RegionHandle handle,
458  rti1516e::Exception* except=NULL);
459 
461  virtual void commitRegionModifications
462  (rti1516e::RegionHandleSet const & theRegionHandleSet,
463  rti1516e::Exception* except=NULL);
464 
466  virtual void deleteRegion
467  (rti1516e::RegionHandle theRegion,
468  rti1516e::Exception* except=NULL);
469 
471  virtual void registerObjectInstanceWithRegions
472  (rti1516e::ObjectClassHandle theClass,
474  theAttributeHandleSetRegionHandleSetPairVector,
475  rti1516e::ObjectInstanceHandle objectHandle,
476  rti1516e::Exception* except=NULL);
477 
478  virtual void registerObjectInstanceWithRegions
479  (rti1516e::ObjectClassHandle theClass,
481  theAttributeHandleSetRegionHandleSetPairVector,
482  std::wstring const & theObjectInstanceName,
483  rti1516e::ObjectInstanceHandle objectHandle,
484  rti1516e::Exception* except=NULL);
485 
487  virtual void associateRegionsForUpdates
488  (rti1516e::ObjectInstanceHandle theObject,
490  theAttributeHandleSetRegionHandleSetPairVector,
491  rti1516e::Exception* except=NULL);
492 
494  virtual void unassociateRegionsForUpdates
495  (rti1516e::ObjectInstanceHandle theObject,
497  theAttributeHandleSetRegionHandleSetPairVector,
498  rti1516e::Exception* except=NULL);
499 
501  virtual void subscribeObjectClassAttributesWithRegions
502  (rti1516e::ObjectClassHandle theClass,
504  theAttributeHandleSetRegionHandleSetPairVector,
505  bool active,
506  rti1516e::Exception* except=NULL);
507 
509  virtual void unsubscribeObjectClassAttributesWithRegions
510  (rti1516e::ObjectClassHandle theClass,
512  theAttributeHandleSetRegionHandleSetPairVector,
513  rti1516e::Exception* except=NULL);
514 
516  virtual void subscribeInteractionClassWithRegions
518  rti1516e::RegionHandleSet const & theRegionHandleSet,
519  bool active,
520  rti1516e::Exception* except=NULL);
521 
523  virtual void unsubscribeInteractionClassWithRegions
525  rti1516e::RegionHandleSet const & theRegionHandleSet,
526  rti1516e::Exception* except=NULL);
527 
529  virtual void sendInteractionWithRegions
530  (rti1516e::InteractionClassHandle theInteraction,
531  rti1516e::ParameterHandleValueMap const & theParameterValues,
532  rti1516e::RegionHandleSet const & theRegionHandleSet,
533  rti1516e::VariableLengthData const & theUserSuppliedTag,
534  rti1516e::Exception* except=NULL);
535 
536  virtual void sendInteractionWithRegions
537  (rti1516e::InteractionClassHandle theInteraction,
538  rti1516e::ParameterHandleValueMap const & theParameterValues,
539  rti1516e::RegionHandleSet const & theRegionHandleSet,
540  rti1516e::VariableLengthData const & theUserSuppliedTag,
541  rti1516e::LogicalTime const & theTime,
542  rti1516e::MessageRetractionHandle retractHandle,
543  rti1516e::Exception* except=NULL);
544 
546  virtual void requestAttributeValueUpdateWithRegions
547  (rti1516e::ObjectClassHandle theClass,
549  rti1516e::VariableLengthData const & theUserSuppliedTag,
550  rti1516e::Exception* except=NULL);
552 
554 
555 
557  virtual void getObjectClassHandle
558  (std::wstring const & theName,
559  rti1516e::ObjectClassHandle classHandle,
560  rti1516e::Exception* except=NULL);
561 
563  virtual void getObjectClassName
564  (rti1516e::ObjectClassHandle theHandle,
565  std::wstring name,
566  rti1516e::Exception* except=NULL);
567 
569  virtual void getAttributeHandle
570  (rti1516e::ObjectClassHandle whichClass,
571  std::wstring const & theAttributeName,
573  rti1516e::Exception* except=NULL);
574 
576  virtual void getAttributeName
577  (rti1516e::ObjectClassHandle whichClass,
578  rti1516e::AttributeHandle theHandle,
579  std::wstring name,
580  rti1516e::Exception* except=NULL);
581 
583  virtual void getInteractionClassHandle
584  (std::wstring const & theName,
586  rti1516e::Exception* except=NULL);
587 
589  virtual void getInteractionClassName
591  std::wstring name,
592  rti1516e::Exception* except=NULL);
593 
595  virtual void getParameterHandle
597  std::wstring const & theName,
599  rti1516e::Exception* except=NULL);
600 
602  virtual void getParameterName
604  rti1516e::ParameterHandle theHandle,
605  std::wstring name,
606  rti1516e::Exception* except=NULL);
607 
609  virtual void getObjectInstanceHandle
610  (std::wstring const & theName,
611  rti1516e::ObjectInstanceHandle objectHandle,
612  rti1516e::Exception* except=NULL);
613 
615  virtual void getObjectInstanceName
616  (rti1516e::ObjectInstanceHandle theHandle,
617  std::wstring name,
618  rti1516e::Exception* except=NULL);
619 
621  virtual void getDimensionHandle
622  (std::wstring const & theName,
624  rti1516e::Exception* except=NULL);
625 
627  virtual void getDimensionName
628  (rti1516e::DimensionHandle theHandle,
629  std::wstring name,
630  rti1516e::Exception* except=NULL);
631 
633  virtual void getDimensionUpperBound
634  (rti1516e::DimensionHandle theHandle,
635  unsigned long upperBound,
636  rti1516e::Exception* except=NULL);
637 
639  virtual void getAvailableDimensionsForClassAttribute
640  (rti1516e::ObjectClassHandle theClass,
641  rti1516e::AttributeHandle theHandle,
643  rti1516e::Exception* except=NULL);
644 
646  virtual void getKnownObjectClassHandle
647  (rti1516e::ObjectInstanceHandle theObject,
648  rti1516e::ObjectClassHandle classHandle,
649  rti1516e::Exception* except=NULL);
650 
652  virtual void getAvailableDimensionsForInteractionClass
655  rti1516e::Exception* except=NULL);
656 
658  virtual void getTransportationType
659  (std::wstring const & transportationName,
661  rti1516e::Exception* except=NULL);
662 
664  virtual void getTransportationName
665  (rti1516e::TransportationType transportationType,
666  std::wstring name,
667  rti1516e::Exception* except=NULL);
668 
670  virtual void getOrderType
671  (std::wstring const & orderName,
672  rti1516e::OrderType type,
673  rti1516e::Exception* except=NULL);
674 
676  virtual void getOrderName
677  (rti1516e::OrderType orderType,
678  std::wstring name,
679  rti1516e::Exception* except=NULL);
680 
682  virtual void enableObjectClassRelevanceAdvisorySwitch (
683  rti1516e::Exception* except=NULL);
684 
686  virtual void disableObjectClassRelevanceAdvisorySwitch (
687  rti1516e::Exception* except=NULL);
688 
691  rti1516e::Exception* except=NULL);
692 
695  rti1516e::Exception* except=NULL);
696 
699  rti1516e::Exception* except=NULL);
700 
703  rti1516e::Exception* except=NULL);
704 
707  rti1516e::Exception* except=NULL);
708 
711  rti1516e::Exception* except=NULL);
712 
714  virtual void getDimensionHandleSet
715  (rti1516e::RegionHandle theRegionHandle,
717  rti1516e::Exception* except=NULL);
718 
720  virtual void getRangeBounds
721  (rti1516e::RegionHandle theRegionHandle,
722  rti1516e::DimensionHandle theDimensionHandle,
723  rti1516e::RangeBounds bounds,
724  rti1516e::Exception* except=NULL);
725 
727  virtual void setRangeBounds
728  (rti1516e::RegionHandle theRegionHandle,
729  rti1516e::DimensionHandle theDimensionHandle,
730  rti1516e::RangeBounds const & theRangeBounds,
731  rti1516e::Exception* except=NULL);
732 
734  virtual void normalizeFederateHandle
736  unsigned long normal,
737  rti1516e::Exception* except=NULL);
738 
740  virtual void normalizeServiceGroup
741  (rti1516e::ServiceGroup theServiceGroup,
742  unsigned long normal,
743  rti1516e::Exception* except=NULL);
744 
745 #if 0
746 
747 
748 
749  virtual void evokeCallback(double approximateMinimumTimeInSeconds,
750  bool result,
751  rti1516e::Exception* except=NULL);
752 
754  virtual void evokeMultipleCallbacks(double approximateMinimumTimeInSeconds,
755  double approximateMaximumTimeInSeconds,
756  bool result,
757  rti1516e::Exception* except=NULL);
758 #endif
759 
761  virtual void enableCallbacks (
762  rti1516e::Exception* except=NULL);
763 
765  virtual void disableCallbacks (
766  rti1516e::Exception* except=NULL);
767 
768  virtual void decodeFederateHandle(
769  rti1516e::VariableLengthData const & encodedValue,
771  rti1516e::Exception* except=NULL) const;
772 
773  virtual void decodeObjectClassHandle(
774  rti1516e::VariableLengthData const & encodedValue,
775  rti1516e::ObjectClassHandle classHandle,
776  rti1516e::Exception* except=NULL) const;
777 
778  virtual void decodeInteractionClassHandle(
779  rti1516e::VariableLengthData const & encodedValue,
781  rti1516e::Exception* except=NULL) const;
782 
783  virtual void decodeObjectInstanceHandle(
784  rti1516e::VariableLengthData const & encodedValue,
785  rti1516e::ObjectInstanceHandle objectHandle,
786  rti1516e::Exception* except=NULL) const;
787 
788  virtual void decodeAttributeHandle(
789  rti1516e::VariableLengthData const & encodedValue,
791  rti1516e::Exception* except=NULL) const;
792 
793  virtual void decodeParameterHandle(
794  rti1516e::VariableLengthData const & encodedValue,
796  rti1516e::Exception* except=NULL) const;
797 
798  virtual void decodeDimensionHandle(
799  rti1516e::VariableLengthData const & encodedValue,
801  rti1516e::Exception* except=NULL) const;
802 
803  virtual void decodeMessageRetractionHandle(
804  rti1516e::VariableLengthData const & encodedValue,
805  rti1516e::MessageRetractionHandle retractHandle,
806  rti1516e::Exception* except=NULL) const;
807 
808  virtual void decodeRegionHandle(
809  rti1516e::VariableLengthData const & encodedValue,
810  rti1516e::RegionHandle handle,
811  rti1516e::Exception* except=NULL) const;
813 
814 protected:
815 
816  DtMomMgr* myMomMgr;
817  unsigned long myRegisterCount;
818  unsigned long myDeleteCount;
819 };
820 
821 
822 #endif
823 #endif
824 #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)