MAK RTIspy API Documentation for HLA 1516
RTIambServices.hh
Go to the documentation of this file.
1 //File RTIambServices.hh
2 //Included in RTI.hh
3 
4 
5 // RTI Parameter Passing Memory Conventions
6 //
7 // C1 In parameter by value.
8 // C2 Out parameter by pointer value.
9 // C3 Function return by value.
10 // C4 In parameter by const pointer value. Caller provides memory.
11 // Caller may free memory or overwrite it upon completion of
12 // the call. Callee must copy during the call anything it
13 // wishes to save beyond completion of the call. Parameter
14 // type must define const accessor methods.
15 // C5 Out parameter by pointer value. Caller provides reference to object.
16 // Callee constructs an instance on the heap (new) and returns.
17 // The caller destroys the instance (delete) at its leisure.
18 // C6 Function return by pointer value. Callee constructs an instance on
19 // the heap (new) and returns a reference. The caller destroys the
20 // instance (delete) at its leisure.
21 //
22 
23 typedef FederateAmbassador *FederateAmbassadorPtr;
24 
26 // Federation Management Services //
28 
29 // 4.2
30 void createFederationExecution (
31  const char *executionName, // supplied C4
32  const char *FED) // supplied C4
33 throw (
34  FederationExecutionAlreadyExists,
35  CouldNotOpenFED,
36  ErrorReadingFED,
37  ConcurrentAccessAttempted,
38  RTIinternalError);
39 
40 // 4.3
41 void destroyFederationExecution (
42  const char *executionName) // supplied C4
43 throw (
44  FederatesCurrentlyJoined,
45  FederationExecutionDoesNotExist,
46  ConcurrentAccessAttempted,
47  RTIinternalError);
48 
49 // 4.4
50 FederateHandle // returned C3
51 joinFederationExecution (
52  const char *yourName, // supplied C4
53  const char *executionName, // supplied C4
54  FederateAmbassadorPtr federateAmbassadorReference) // supplied C1
55 throw (
56  FederateAlreadyExecutionMember,
57  FederationExecutionDoesNotExist,
58  CouldNotOpenFED,
59  ErrorReadingFED,
60  ConcurrentAccessAttempted,
61  SaveInProgress,
62  RestoreInProgress,
63  RTIinternalError);
64 
65 // 4.5
66 void resignFederationExecution (
67  ResignAction theAction) // supplied C1
68 throw (
69  FederateOwnsAttributes,
70  FederateNotExecutionMember,
71  InvalidResignAction,
72  ConcurrentAccessAttempted,
73  RTIinternalError);
74 
75 // 4.6
76 void registerFederationSynchronizationPoint (
77  const char *label, // supplied C4
78  const char *theTag) // supplied C4
79 throw (
80  FederateNotExecutionMember,
81  ConcurrentAccessAttempted,
82  SaveInProgress,
83  RestoreInProgress,
84  RTIinternalError);
85 
86 void registerFederationSynchronizationPoint (
87  const char *label, // supplied C4
88  const char *theTag, // supplied C4
89  const FederateHandleSet& syncSet) // supplied C4
90 throw (
91  FederateNotExecutionMember,
92  ConcurrentAccessAttempted,
93  SaveInProgress,
94  RestoreInProgress,
95  RTIinternalError);
96 
97 // 4.9
98 void synchronizationPointAchieved (
99  const char *label) // supplied C4
100 throw (
101  SynchronizationPointLabelWasNotAnnounced,
102  FederateNotExecutionMember,
103  ConcurrentAccessAttempted,
104  SaveInProgress,
105  RestoreInProgress,
106  RTIinternalError);
107 
108 // 4.11
109 void requestFederationSave (
110  const char *label, // supplied C4
111  const FedTime& theTime) // supplied C4
112 throw (
113  FederationTimeAlreadyPassed,
114  InvalidFederationTime,
115  FederateNotExecutionMember,
116  ConcurrentAccessAttempted,
117  SaveInProgress,
118  RestoreInProgress,
119  RTIinternalError);
120 
121 void requestFederationSave (
122  const char *label) // supplied C4
123  throw (
124  FederateNotExecutionMember,
125  ConcurrentAccessAttempted,
126  SaveInProgress,
127  RestoreInProgress,
128  RTIinternalError);
129 
130 // 4.13
131 void federateSaveBegun ()
132 throw (
133  SaveNotInitiated,
134  FederateNotExecutionMember,
135  ConcurrentAccessAttempted,
136  RestoreInProgress,
137  RTIinternalError);
138 
139 // 4.14
140 void federateSaveComplete ()
141 throw (
142  SaveNotInitiated,
143  FederateNotExecutionMember,
144  ConcurrentAccessAttempted,
145  RestoreInProgress,
146  RTIinternalError);
147 
148 void federateSaveNotComplete ()
149 throw (
150  SaveNotInitiated,
151  FederateNotExecutionMember,
152  ConcurrentAccessAttempted,
153  RestoreInProgress,
154  RTIinternalError);
155 
156 // 4.16
157 void requestFederationRestore (
158  const char *label) // supplied C4
159 throw (
160  FederateNotExecutionMember,
161  ConcurrentAccessAttempted,
162  SaveInProgress,
163  RestoreInProgress,
164  RTIinternalError);
165 
166 // 4.20
167 void federateRestoreComplete ()
168  throw (
169  RestoreNotRequested,
170  FederateNotExecutionMember,
171  ConcurrentAccessAttempted,
172  SaveInProgress,
173  RTIinternalError);
174 
175 void federateRestoreNotComplete ()
176 throw (
177  RestoreNotRequested,
178  FederateNotExecutionMember,
179  ConcurrentAccessAttempted,
180  SaveInProgress,
181  RTIinternalError);
182 
184 // Declaration Management Services //
186 
187 // 5.2
188 void publishObjectClass (
189  ObjectClassHandle theClass, // supplied C1
190  const AttributeHandleSet& attributeList) // supplied C4
191 throw (
192  ObjectClassNotDefined,
193  AttributeNotDefined,
194  OwnershipAcquisitionPending,
195  FederateNotExecutionMember,
196  ConcurrentAccessAttempted,
197  SaveInProgress,
198  RestoreInProgress,
199  RTIinternalError);
200 
201 // 5.3
202 void unpublishObjectClass (
203  ObjectClassHandle theClass) // supplied C1
204 throw (
205  ObjectClassNotDefined,
206  ObjectClassNotPublished,
207  OwnershipAcquisitionPending,
208  FederateNotExecutionMember,
209  ConcurrentAccessAttempted,
210  SaveInProgress,
211  RestoreInProgress,
212  RTIinternalError);
213 
214 // 5.4
215 void publishInteractionClass (
216  InteractionClassHandle theInteraction) // supplied C1
217 throw (
218  InteractionClassNotDefined,
219  FederateNotExecutionMember,
220  ConcurrentAccessAttempted,
221  SaveInProgress,
222  RestoreInProgress,
223  RTIinternalError);
224 
225 // 5.5
226 void unpublishInteractionClass (
227  InteractionClassHandle theInteraction) // supplied C1
228 throw (
229  InteractionClassNotDefined,
230  InteractionClassNotPublished,
231  FederateNotExecutionMember,
232  ConcurrentAccessAttempted,
233  SaveInProgress,
234  RestoreInProgress,
235  RTIinternalError);
236 
237 // 5.6
238 void subscribeObjectClassAttributes (
239  ObjectClassHandle theClass, // supplied C1
240  const AttributeHandleSet& attributeList, // supplied C4
241  Boolean active = RTI_TRUE)
242 throw (
243  ObjectClassNotDefined,
244  AttributeNotDefined,
245  FederateNotExecutionMember,
246  ConcurrentAccessAttempted,
247  SaveInProgress,
248  RestoreInProgress,
249  RTIinternalError);
250 
251 // 5.7
252 void unsubscribeObjectClass (
253  ObjectClassHandle theClass) // supplied C1
254 throw (
255  ObjectClassNotDefined,
256  ObjectClassNotSubscribed,
257  FederateNotExecutionMember,
258  ConcurrentAccessAttempted,
259  SaveInProgress,
260  RestoreInProgress,
261  RTIinternalError);
262 
263 // 5.8
264 void subscribeInteractionClass (
265  InteractionClassHandle theClass, // supplied C1
266  Boolean active = RTI_TRUE)
267 throw (
268  InteractionClassNotDefined,
269  FederateNotExecutionMember,
270  ConcurrentAccessAttempted,
271  FederateLoggingServiceCalls,
272  SaveInProgress,
273  RestoreInProgress,
274  RTIinternalError);
275 
276 // 5.9
277 void unsubscribeInteractionClass (
278  InteractionClassHandle theClass) // supplied C1
279 throw (
280  InteractionClassNotDefined,
281  InteractionClassNotSubscribed,
282  FederateNotExecutionMember,
283  ConcurrentAccessAttempted,
284  SaveInProgress,
285  RestoreInProgress,
286  RTIinternalError);
287 
289 // Object Management Services //
291 
292 // 6.2
293 ObjectHandle // returned C3
294 registerObjectInstance (
295  ObjectClassHandle theClass, // supplied C1
296  const char *theObject) // supplied C4
297 throw (
298  ObjectClassNotDefined,
299  ObjectClassNotPublished,
300  ObjectAlreadyRegistered,
301  FederateNotExecutionMember,
302  ConcurrentAccessAttempted,
303  SaveInProgress,
304  RestoreInProgress,
305  RTIinternalError);
306 
307 ObjectHandle // returned C3
308 registerObjectInstance (
309  ObjectClassHandle theClass) // supplied C1
310 throw (
311  ObjectClassNotDefined,
312  ObjectClassNotPublished,
313  FederateNotExecutionMember,
314  ConcurrentAccessAttempted,
315  SaveInProgress,
316  RestoreInProgress,
317  RTIinternalError);
318 
319 // 6.4
320 EventRetractionHandle // returned C3
321 updateAttributeValues (
322  ObjectHandle theObject, // supplied C1
323  const AttributeHandleValuePairSet& theAttributes, // supplied C4
324  const FedTime& theTime, // supplied C4
325  const char *theTag) // supplied C4
326 throw (
327  ObjectNotKnown,
328  AttributeNotDefined,
329  AttributeNotOwned,
330  InvalidFederationTime,
331  FederateNotExecutionMember,
332  ConcurrentAccessAttempted,
333  SaveInProgress,
334  RestoreInProgress,
335  RTIinternalError);
336 
337 void updateAttributeValues (
338  ObjectHandle theObject, // supplied C1
339  const AttributeHandleValuePairSet& theAttributes, // supplied C4
340  const char *theTag) // supplied C4
341 throw (
342  ObjectNotKnown,
343  AttributeNotDefined,
344  AttributeNotOwned,
345  FederateNotExecutionMember,
346  ConcurrentAccessAttempted,
347  SaveInProgress,
348  RestoreInProgress,
349  RTIinternalError);
350 
351 // 6.6
352 EventRetractionHandle // returned C3
353 sendInteraction (
354  InteractionClassHandle theInteraction, // supplied C1
355  const ParameterHandleValuePairSet& theParameters, // supplied C4
356  const FedTime& theTime, // supplied C4
357  const char *theTag) // supplied C4
358 throw (
359  InteractionClassNotDefined,
360  InteractionClassNotPublished,
361  InteractionParameterNotDefined,
362  InvalidFederationTime,
363  FederateNotExecutionMember,
364  ConcurrentAccessAttempted,
365  SaveInProgress,
366  RestoreInProgress,
367  RTIinternalError);
368 
369 void sendInteraction (
370  InteractionClassHandle theInteraction, // supplied C1
371  const ParameterHandleValuePairSet& theParameters, // supplied C4
372  const char *theTag) // supplied C4
373 throw (
374  InteractionClassNotDefined,
375  InteractionClassNotPublished,
376  InteractionParameterNotDefined,
377  FederateNotExecutionMember,
378  ConcurrentAccessAttempted,
379  SaveInProgress,
380  RestoreInProgress,
381  RTIinternalError);
382 
383 // 6.8
384 EventRetractionHandle // returned C3
385 deleteObjectInstance (
386  ObjectHandle theObject, // supplied C1
387  const FedTime& theTime, // supplied C4
388  const char *theTag) // supplied C4
389 throw (
390  ObjectNotKnown,
391  DeletePrivilegeNotHeld,
392  InvalidFederationTime,
393  FederateNotExecutionMember,
394  ConcurrentAccessAttempted,
395  SaveInProgress,
396  RestoreInProgress,
397  RTIinternalError);
398 
399 void deleteObjectInstance (
400  ObjectHandle theObject, // supplied C1
401  const char *theTag) // supplied C4
402 throw (
403  ObjectNotKnown,
404  DeletePrivilegeNotHeld,
405  FederateNotExecutionMember,
406  ConcurrentAccessAttempted,
407  SaveInProgress,
408  RestoreInProgress,
409  RTIinternalError);
410 
411 // 6.10
412 void localDeleteObjectInstance (
413  ObjectHandle theObject) // supplied C1
414 throw (
415  ObjectNotKnown,
416  FederateOwnsAttributes,
417  FederateNotExecutionMember,
418  ConcurrentAccessAttempted,
419  SaveInProgress,
420  RestoreInProgress,
421  RTIinternalError);
422 
423 // 6.11
424 void changeAttributeTransportationType (
425  ObjectHandle theObject, // supplied C1
426  const AttributeHandleSet& theAttributes, // supplied C4
427  TransportationHandle theType) // supplied C1
428 throw (
429  ObjectNotKnown,
430  AttributeNotDefined,
431  AttributeNotOwned,
432  InvalidTransportationHandle,
433  FederateNotExecutionMember,
434  ConcurrentAccessAttempted,
435  SaveInProgress,
436  RestoreInProgress,
437  RTIinternalError);
438 
439 // 6.12
440 void changeInteractionTransportationType (
441  InteractionClassHandle theClass, // supplied C1
442  TransportationHandle theType) // supplied C1
443 throw (
444  InteractionClassNotDefined,
445  InteractionClassNotPublished,
446  InvalidTransportationHandle,
447  FederateNotExecutionMember,
448  ConcurrentAccessAttempted,
449  SaveInProgress,
450  RestoreInProgress,
451  RTIinternalError);
452 
453 // 6.15
454 void requestObjectAttributeValueUpdate (
455  ObjectHandle theObject, // supplied C1
456  const AttributeHandleSet& theAttributes) // supplied C4
457 throw (
458  ObjectNotKnown,
459  AttributeNotDefined,
460  FederateNotExecutionMember,
461  ConcurrentAccessAttempted,
462  SaveInProgress,
463  RestoreInProgress,
464  RTIinternalError);
465 
466 void requestClassAttributeValueUpdate (
467  ObjectClassHandle theClass, // supplied C1
468  const AttributeHandleSet& theAttributes) // supplied C4
469 throw (
470  ObjectClassNotDefined,
471  AttributeNotDefined,
472  FederateNotExecutionMember,
473  ConcurrentAccessAttempted,
474  SaveInProgress,
475  RestoreInProgress,
476  RTIinternalError);
477 
479 // Ownership Management Services //
481 
482 // 7.2
483 void unconditionalAttributeOwnershipDivestiture (
484  ObjectHandle theObject, // supplied C1
485  const AttributeHandleSet& theAttributes) // supplied C4
486 throw (
487  ObjectNotKnown,
488  AttributeNotDefined,
489  AttributeNotOwned,
490  FederateNotExecutionMember,
491  ConcurrentAccessAttempted,
492  SaveInProgress,
493  RestoreInProgress,
494  RTIinternalError);
495 
496 // 7.3
497 void negotiatedAttributeOwnershipDivestiture (
498  ObjectHandle theObject, // supplied C1
499  const AttributeHandleSet& theAttributes, // supplied C4
500  const char *theTag) // supplied C4
501 throw (
502  ObjectNotKnown,
503  AttributeNotDefined,
504  AttributeNotOwned,
505  AttributeAlreadyBeingDivested,
506  FederateNotExecutionMember,
507  ConcurrentAccessAttempted,
508  SaveInProgress,
509  RestoreInProgress,
510  RTIinternalError);
511 
512 // 7.7
513 void attributeOwnershipAcquisition (
514  ObjectHandle theObject, // supplied C1
515  const AttributeHandleSet& desiredAttributes, // supplied C4
516  const char *theTag) // supplied C4
517 throw (
518  ObjectNotKnown,
519  ObjectClassNotPublished,
520  AttributeNotDefined,
521  AttributeNotPublished,
522  FederateOwnsAttributes,
523  FederateNotExecutionMember,
524  ConcurrentAccessAttempted,
525  SaveInProgress,
526  RestoreInProgress,
527  RTIinternalError);
528 
529 // 7.8
530 void attributeOwnershipAcquisitionIfAvailable (
531  ObjectHandle theObject, // supplied C1
532  const AttributeHandleSet& desiredAttributes) // supplied C4
533 throw (
534  ObjectNotKnown,
535  ObjectClassNotPublished,
536  AttributeNotDefined,
537  AttributeNotPublished,
538  FederateOwnsAttributes,
539  AttributeAlreadyBeingAcquired,
540  FederateNotExecutionMember,
541  ConcurrentAccessAttempted,
542  SaveInProgress,
543  RestoreInProgress,
544  RTIinternalError);
545 
546 // 7.11
547 AttributeHandleSet* // returned C6
548 attributeOwnershipReleaseResponse (
549  ObjectHandle theObject, // supplied C1
550  const AttributeHandleSet& theAttributes) // supplied C4
551 throw (
552  ObjectNotKnown,
553  AttributeNotDefined,
554  AttributeNotOwned,
555  FederateWasNotAskedToReleaseAttribute,
556  FederateNotExecutionMember,
557  ConcurrentAccessAttempted,
558  SaveInProgress,
559  RestoreInProgress,
560  RTIinternalError);
561 
562 // 7.12
563 void cancelNegotiatedAttributeOwnershipDivestiture (
564  ObjectHandle theObject, // supplied C1
565  const AttributeHandleSet& theAttributes) // supplied C4
566 throw (
567  ObjectNotKnown,
568  AttributeNotDefined,
569  AttributeNotOwned,
570  AttributeDivestitureWasNotRequested,
571  FederateNotExecutionMember,
572  ConcurrentAccessAttempted,
573  SaveInProgress,
574  RestoreInProgress,
575  RTIinternalError);
576 
577 // 7.13
578 void cancelAttributeOwnershipAcquisition (
579  ObjectHandle theObject, // supplied C1
580  const AttributeHandleSet& theAttributes) // supplied C4
581 throw (
582  ObjectNotKnown,
583  AttributeNotDefined,
584  AttributeAlreadyOwned,
585  AttributeAcquisitionWasNotRequested,
586  FederateNotExecutionMember,
587  ConcurrentAccessAttempted,
588  SaveInProgress,
589  RestoreInProgress,
590  RTIinternalError);
591 
592 // 7.15
593 void queryAttributeOwnership (
594  ObjectHandle theObject, // supplied C1
595  AttributeHandle theAttribute) // supplied C1
596 throw (
597  ObjectNotKnown,
598  AttributeNotDefined,
599  FederateNotExecutionMember,
600  ConcurrentAccessAttempted,
601  SaveInProgress,
602  RestoreInProgress,
603  RTIinternalError);
604 
605 // 7.17
606 Boolean // returned C3
607 isAttributeOwnedByFederate (
608  ObjectHandle theObject, // supplied C1
609  AttributeHandle theAttribute) // supplied C1
610 throw (
611  ObjectNotKnown,
612  AttributeNotDefined,
613  FederateNotExecutionMember,
614  ConcurrentAccessAttempted,
615  SaveInProgress,
616  RestoreInProgress,
617  RTIinternalError);
618 
620 // Time Management Services //
622 
623 // 8.2
624 void enableTimeRegulation (
625  const FedTime& theFederateTime, // supplied C4
626  const FedTime& theLookahead) // supplied C4
627 throw (
628  TimeRegulationAlreadyEnabled,
629  EnableTimeRegulationPending,
630  TimeAdvanceAlreadyInProgress,
631  InvalidFederationTime,
632  InvalidLookahead,
633  ConcurrentAccessAttempted,
634  FederateNotExecutionMember,
635  SaveInProgress,
636  RestoreInProgress,
637  RTIinternalError);
638 
639 // 8.4
640 void disableTimeRegulation ()
641 throw (
642  TimeRegulationWasNotEnabled,
643  ConcurrentAccessAttempted,
644  FederateNotExecutionMember,
645  SaveInProgress,
646  RestoreInProgress,
647  RTIinternalError);
648 
649 // 8.5
650 void enableTimeConstrained ()
651 throw (
652  TimeConstrainedAlreadyEnabled,
653  EnableTimeConstrainedPending,
654  TimeAdvanceAlreadyInProgress,
655  FederateNotExecutionMember,
656  ConcurrentAccessAttempted,
657  SaveInProgress,
658  RestoreInProgress,
659  RTIinternalError);
660 
661 // 8.7
662 void disableTimeConstrained ()
663 throw (
664  TimeConstrainedWasNotEnabled,
665  FederateNotExecutionMember,
666  ConcurrentAccessAttempted,
667  SaveInProgress,
668  RestoreInProgress,
669  RTIinternalError);
670 
671 // 8.8
672 void timeAdvanceRequest (
673  const FedTime& theTime) // supplied C4
674 throw (
675  InvalidFederationTime,
676  FederationTimeAlreadyPassed,
677  TimeAdvanceAlreadyInProgress,
678  EnableTimeRegulationPending,
679  EnableTimeConstrainedPending,
680  FederateNotExecutionMember,
681  ConcurrentAccessAttempted,
682  SaveInProgress,
683  RestoreInProgress,
684  RTIinternalError);
685 
686 // 8.9
687 void timeAdvanceRequestAvailable (
688 const FedTime& theTime) // supplied C4
689  throw (
690  InvalidFederationTime,
691  FederationTimeAlreadyPassed,
692  TimeAdvanceAlreadyInProgress,
693  EnableTimeRegulationPending,
694  EnableTimeConstrainedPending,
695  FederateNotExecutionMember,
696  ConcurrentAccessAttempted,
697  SaveInProgress,
698  RestoreInProgress,
699  RTIinternalError);
700 
701 // 8.10
702 void nextEventRequest (
703  const FedTime& theTime) // supplied C4
704 throw (
705  InvalidFederationTime,
706  FederationTimeAlreadyPassed,
707  TimeAdvanceAlreadyInProgress,
708  EnableTimeRegulationPending,
709  EnableTimeConstrainedPending,
710  FederateNotExecutionMember,
711  ConcurrentAccessAttempted,
712  SaveInProgress,
713  RestoreInProgress,
714  RTIinternalError);
715 
716 // 8.11
717 void nextEventRequestAvailable (
718  const FedTime& theTime) // supplied C4
719 throw (
720  InvalidFederationTime,
721  FederationTimeAlreadyPassed,
722  TimeAdvanceAlreadyInProgress,
723  EnableTimeRegulationPending,
724  EnableTimeConstrainedPending,
725  FederateNotExecutionMember,
726  ConcurrentAccessAttempted,
727  SaveInProgress,
728  RestoreInProgress,
729  RTIinternalError);
730 
731 // 8.12
732 void flushQueueRequest (
733  const FedTime& theTime) // supplied C4
734 throw (
735  InvalidFederationTime,
736  FederationTimeAlreadyPassed,
737  TimeAdvanceAlreadyInProgress,
738  EnableTimeRegulationPending,
739  EnableTimeConstrainedPending,
740  FederateNotExecutionMember,
741  ConcurrentAccessAttempted,
742  SaveInProgress,
743  RestoreInProgress,
744  RTIinternalError);
745 
746 // 8.14
747 void enableAsynchronousDelivery()
748  throw (
749  AsynchronousDeliveryAlreadyEnabled,
750  FederateNotExecutionMember,
751  ConcurrentAccessAttempted,
752  SaveInProgress,
753  RestoreInProgress,
754  RTIinternalError);
755 
756 // 8.15
757 void disableAsynchronousDelivery()
758  throw (
759  AsynchronousDeliveryAlreadyDisabled,
760  FederateNotExecutionMember,
761  ConcurrentAccessAttempted,
762  SaveInProgress,
763  RestoreInProgress,
764  RTIinternalError);
765 
766 // 8.16
767 void queryLBTS (
768  FedTime& theTime) // returned C5
769 throw (
770  FederateNotExecutionMember,
771  ConcurrentAccessAttempted,
772  SaveInProgress,
773  RestoreInProgress,
774  RTIinternalError);
775 
776 // 8.17
777 void queryFederateTime (
778  FedTime& theTime) // returned C5
779 throw (
780  FederateNotExecutionMember,
781  ConcurrentAccessAttempted,
782  SaveInProgress,
783  RestoreInProgress,
784  RTIinternalError);
785 
786 // 8.18
787 void queryMinNextEventTime (
788  FedTime& theTime) // returned C5
789 throw (
790  FederateNotExecutionMember,
791  ConcurrentAccessAttempted,
792  SaveInProgress,
793  RestoreInProgress,
794  RTIinternalError);
795 
796 // 8.19
797 void modifyLookahead (
798  const FedTime& theLookahead) // supplied C4
799 throw (
800  InvalidLookahead,
801  FederateNotExecutionMember,
802  ConcurrentAccessAttempted,
803  SaveInProgress,
804  RestoreInProgress,
805  RTIinternalError);
806 
807 // 8.20
808 void queryLookahead (
809  FedTime& theTime) // returned C5
810 throw (
811  FederateNotExecutionMember,
812  ConcurrentAccessAttempted,
813  SaveInProgress,
814  RestoreInProgress,
815  RTIinternalError);
816 
817 // 8.21
818 void retract (
819  EventRetractionHandle theHandle) // supplied C1
820 throw (
821  InvalidRetractionHandle,
822  FederateNotExecutionMember,
823  ConcurrentAccessAttempted,
824  SaveInProgress,
825  RestoreInProgress,
826  RTIinternalError);
827 
828 // 8.23
829 void changeAttributeOrderType (
830  ObjectHandle theObject, // supplied C1
831  const AttributeHandleSet& theAttributes, // supplied C4
832  OrderingHandle theType) // supplied C1
833 throw (
834  ObjectNotKnown,
835  AttributeNotDefined,
836  AttributeNotOwned,
837  InvalidOrderingHandle,
838  FederateNotExecutionMember,
839  ConcurrentAccessAttempted,
840  SaveInProgress,
841  RestoreInProgress,
842  RTIinternalError);
843 
844 // 8.24
845 void changeInteractionOrderType (
846  InteractionClassHandle theClass, // supplied C1
847  OrderingHandle theType) // supplied C1
848 throw (
849  InteractionClassNotDefined,
850  InteractionClassNotPublished,
851  InvalidOrderingHandle,
852  FederateNotExecutionMember,
853  ConcurrentAccessAttempted,
854  SaveInProgress,
855  RestoreInProgress,
856  RTIinternalError);
857 
859 // Data Distribution Management //
861 
862 // 9.2
863 Region* // returned C6
864 createRegion (
865  SpaceHandle theSpace, // supplied C1
866  ULong numberOfExtents) // supplied C1
867 throw (
868  SpaceNotDefined,
869  InvalidExtents,
870  FederateNotExecutionMember,
871  ConcurrentAccessAttempted,
872  SaveInProgress,
873  RestoreInProgress,
874  RTIinternalError);
875 
876 // 9.3
877 void notifyAboutRegionModification (
878  Region &theRegion) // supplied C4
879 throw (
880  RegionNotKnown,
881  InvalidExtents,
882  FederateNotExecutionMember,
883  ConcurrentAccessAttempted,
884  SaveInProgress,
885  RestoreInProgress,
886  RTIinternalError);
887 
888 // 9.4
889 void deleteRegion (
890  Region *theRegion) // supplied C1
891 throw (
892  RegionNotKnown,
893  RegionInUse,
894  FederateNotExecutionMember,
895  ConcurrentAccessAttempted,
896  SaveInProgress,
897  RestoreInProgress,
898  RTIinternalError);
899 
900 // 9.5
901 ObjectHandle // returned C3
902 registerObjectInstanceWithRegion (
903  ObjectClassHandle theClass, // supplied C1
904  const char *theObject, // supplied C4
905  AttributeHandle theAttributes[], // supplied C4
906  Region *theRegions[], // supplied C4
907  ULong theNumberOfHandles) // supplied C1
908 throw (
909  ObjectClassNotDefined,
910  ObjectClassNotPublished,
911  AttributeNotDefined,
912  AttributeNotPublished,
913  RegionNotKnown,
914  InvalidRegionContext,
915  ObjectAlreadyRegistered,
916  FederateNotExecutionMember,
917  ConcurrentAccessAttempted,
918  SaveInProgress,
919  RestoreInProgress,
920  RTIinternalError);
921 
922 ObjectHandle // returned C3
923 registerObjectInstanceWithRegion (
924  ObjectClassHandle theClass, // supplied C1
925  AttributeHandle theAttributes[], // supplied C4
926  Region *theRegions[], // supplied C4
927  ULong theNumberOfHandles) // supplied C1
928 throw (
929  ObjectClassNotDefined,
930  ObjectClassNotPublished,
931  AttributeNotDefined,
932  AttributeNotPublished,
933  RegionNotKnown,
934  InvalidRegionContext,
935  FederateNotExecutionMember,
936  ConcurrentAccessAttempted,
937  SaveInProgress,
938  RestoreInProgress,
939  RTIinternalError);
940 
941 // 9.6
942 void associateRegionForUpdates (
943  Region &theRegion, // supplied C4
944  ObjectHandle theObject, // supplied C1
945  const AttributeHandleSet &theAttributes) // supplied C4
946 throw (
947  ObjectNotKnown,
948  AttributeNotDefined,
949  InvalidRegionContext,
950  RegionNotKnown,
951  FederateNotExecutionMember,
952  ConcurrentAccessAttempted,
953  SaveInProgress,
954  RestoreInProgress,
955  RTIinternalError);
956 
957 // 9.7
958 void unassociateRegionForUpdates (
959  Region &theRegion, // supplied C4
960  ObjectHandle theObject) // supplied C1
961 throw (
962  ObjectNotKnown,
963  InvalidRegionContext,
964  RegionNotKnown,
965  FederateNotExecutionMember,
966  ConcurrentAccessAttempted,
967  SaveInProgress,
968  RestoreInProgress,
969  RTIinternalError);
970 
971 // 9.8
972 void subscribeObjectClassAttributesWithRegion (
973  ObjectClassHandle theClass, // supplied C1
974  Region &theRegion, // supplied C4
975  const AttributeHandleSet &attributeList, // supplied C4
976  Boolean active = RTI_TRUE)
977 throw (
978  ObjectClassNotDefined,
979  AttributeNotDefined,
980  RegionNotKnown,
981  InvalidRegionContext,
982  FederateNotExecutionMember,
983  ConcurrentAccessAttempted,
984  SaveInProgress,
985  RestoreInProgress,
986  RTIinternalError);
987 
988 // 9.9
989 void unsubscribeObjectClassWithRegion (
990  ObjectClassHandle theClass, // supplied C1
991  Region &theRegion) // supplied C4
992 throw (
993  ObjectClassNotDefined,
994  RegionNotKnown,
995  ObjectClassNotSubscribed,
996  FederateNotExecutionMember,
997  ConcurrentAccessAttempted,
998  SaveInProgress,
999  RestoreInProgress,
1000  RTIinternalError);
1001 
1002 // 9.10
1003 void subscribeInteractionClassWithRegion (
1004  InteractionClassHandle theClass, // supplied C1
1005  Region &theRegion, // supplied C4
1006  Boolean active = RTI_TRUE)
1007 throw (
1008  InteractionClassNotDefined,
1009  RegionNotKnown,
1010  InvalidRegionContext,
1011  FederateLoggingServiceCalls,
1012  FederateNotExecutionMember,
1013  ConcurrentAccessAttempted,
1014  SaveInProgress,
1015  RestoreInProgress,
1016  RTIinternalError);
1017 
1018 // 9.11
1019 void unsubscribeInteractionClassWithRegion (
1020  InteractionClassHandle theClass, // supplied C1
1021  Region &theRegion) // supplied C4
1022 throw (
1023  InteractionClassNotDefined,
1024  InteractionClassNotSubscribed,
1025  RegionNotKnown,
1026  FederateNotExecutionMember,
1027  ConcurrentAccessAttempted,
1028  SaveInProgress,
1029  RestoreInProgress,
1030  RTIinternalError);
1031 
1032 // 9.12
1033 EventRetractionHandle // returned C3
1034 sendInteractionWithRegion (
1035  InteractionClassHandle theInteraction, // supplied C1
1036  const ParameterHandleValuePairSet &theParameters, // supplied C4
1037  const FedTime& theTime, // supplied C4
1038  const char *theTag, // supplied C4
1039  const Region &theRegion) // supplied C4
1040 throw (
1041  InteractionClassNotDefined,
1042  InteractionClassNotPublished,
1043  InteractionParameterNotDefined,
1044  InvalidFederationTime,
1045  RegionNotKnown,
1046  InvalidRegionContext,
1047  FederateNotExecutionMember,
1048  ConcurrentAccessAttempted,
1049  SaveInProgress,
1050  RestoreInProgress,
1051  RTIinternalError);
1052 
1053 void sendInteractionWithRegion (
1054  InteractionClassHandle theInteraction, // supplied C1
1055  const ParameterHandleValuePairSet &theParameters, // supplied C4
1056  const char *theTag, // supplied C4
1057  const Region &theRegion) // supplied C4
1058 throw (
1059  InteractionClassNotDefined,
1060  InteractionClassNotPublished,
1061  InteractionParameterNotDefined,
1062  RegionNotKnown,
1063  InvalidRegionContext,
1064  FederateNotExecutionMember,
1065  ConcurrentAccessAttempted,
1066  SaveInProgress,
1067  RestoreInProgress,
1068  RTIinternalError);
1069 
1070 // 9.13
1071 void requestClassAttributeValueUpdateWithRegion (
1072  ObjectClassHandle theClass, // supplied C1
1073  const AttributeHandleSet &theAttributes, // supplied C4
1074  const Region &theRegion) // supplied C4
1075 throw (
1076  ObjectClassNotDefined,
1077  AttributeNotDefined,
1078  RegionNotKnown,
1079  FederateNotExecutionMember,
1080  ConcurrentAccessAttempted,
1081  SaveInProgress,
1082  RestoreInProgress,
1083  RTIinternalError);
1084 
1086 // RTI Support Services //
1088 
1089 // 10.2
1090 ObjectClassHandle // returned C3
1091 getObjectClassHandle (
1092  const char *theName) // supplied C4
1093 throw (
1094  NameNotFound,
1095  FederateNotExecutionMember,
1096  ConcurrentAccessAttempted,
1097  RTIinternalError);
1098 
1099 // 10.3
1100 char * // returned C6
1101 getObjectClassName (
1102  ObjectClassHandle theHandle) // supplied C1
1103 throw (
1104  ObjectClassNotDefined,
1105  FederateNotExecutionMember,
1106  ConcurrentAccessAttempted,
1107  RTIinternalError);
1108 
1109 // 10.4
1110 AttributeHandle // returned C3
1111 getAttributeHandle (
1112  const char *theName, // supplied C4
1113  ObjectClassHandle whichClass) // supplied C1
1114 throw (
1115  ObjectClassNotDefined,
1116  NameNotFound,
1117  FederateNotExecutionMember,
1118  ConcurrentAccessAttempted,
1119  RTIinternalError);
1120 
1121 // 10.5
1122 char * // returned C6
1123 getAttributeName (
1124  AttributeHandle theHandle, // supplied C1
1125  ObjectClassHandle whichClass) // supplied C1
1126 throw (
1127  ObjectClassNotDefined,
1128  AttributeNotDefined,
1129  FederateNotExecutionMember,
1130  ConcurrentAccessAttempted,
1131  RTIinternalError);
1132 
1133 // 10.6
1134 InteractionClassHandle // returned C3
1135 getInteractionClassHandle (
1136  const char *theName) // supplied C4
1137 throw (
1138  NameNotFound,
1139  FederateNotExecutionMember,
1140  ConcurrentAccessAttempted,
1141  RTIinternalError);
1142 
1143 // 10.7
1144 char * // returned C6
1145 getInteractionClassName (
1146  InteractionClassHandle theHandle) // supplied C1
1147 throw (
1148  InteractionClassNotDefined,
1149  FederateNotExecutionMember,
1150  ConcurrentAccessAttempted,
1151  RTIinternalError);
1152 
1153 // 10.8
1154 ParameterHandle // returned C3
1155 getParameterHandle (
1156  const char *theName, // supplied C4
1157  InteractionClassHandle whichClass) // supplied C1
1158 throw (
1159  InteractionClassNotDefined,
1160  NameNotFound,
1161  FederateNotExecutionMember,
1162  ConcurrentAccessAttempted,
1163  RTIinternalError);
1164 
1165 // 10.9
1166 char * // returned C6
1167 getParameterName (
1168  ParameterHandle theHandle, // supplied C1
1169  InteractionClassHandle whichClass) // supplied C1
1170 throw (
1171  InteractionClassNotDefined,
1172  InteractionParameterNotDefined,
1173  FederateNotExecutionMember,
1174  ConcurrentAccessAttempted,
1175  RTIinternalError);
1176 
1177 // 10.10
1178 ObjectHandle // returned C3
1179 getObjectInstanceHandle (
1180  const char *theName) // supplied C4
1181 throw (
1182  ObjectNotKnown,
1183  FederateNotExecutionMember,
1184  ConcurrentAccessAttempted,
1185  RTIinternalError);
1186 
1187 // 10.11
1188 char * // returned C6
1189 getObjectInstanceName (
1190  ObjectHandle theHandle) // supplied C1
1191 throw (
1192  ObjectNotKnown,
1193  FederateNotExecutionMember,
1194  ConcurrentAccessAttempted,
1195  RTIinternalError);
1196 
1197 // 10.12
1198 SpaceHandle // returned C3
1199 getRoutingSpaceHandle (
1200  const char *theName) // supplied C4
1201 throw (
1202  NameNotFound,
1203  FederateNotExecutionMember,
1204  ConcurrentAccessAttempted,
1205  RTIinternalError);
1206 
1207 // 10.13
1208 char * // returned C6
1209 getRoutingSpaceName (
1210  //
1211  // This const was removed for the RTI 1.3 NG to work around a limitation of
1212  // the Sun 4.2 C++ compiler regarding template instantiation. The const
1213  // is unnecessary.
1214  //
1215  /* const */ SpaceHandle theHandle) // supplied C4
1216 throw (
1217  SpaceNotDefined,
1218  FederateNotExecutionMember,
1219  ConcurrentAccessAttempted,
1220  RTIinternalError);
1221 
1222 // 10.14
1223 DimensionHandle // returned C3
1224 getDimensionHandle (
1225  const char *theName, // supplied C4
1226  SpaceHandle whichSpace) // supplied C1
1227 throw (
1228  SpaceNotDefined,
1229  NameNotFound,
1230  FederateNotExecutionMember,
1231  ConcurrentAccessAttempted,
1232  RTIinternalError);
1233 
1234 // 10.15
1235 char * // returned C6
1236 getDimensionName (
1237  DimensionHandle theHandle, // supplied C1
1238  SpaceHandle whichSpace) // supplied C1
1239 throw (
1240  SpaceNotDefined,
1241  DimensionNotDefined,
1242  FederateNotExecutionMember,
1243  ConcurrentAccessAttempted,
1244  RTIinternalError);
1245 
1246 // 10.16
1247 SpaceHandle // returned C3
1248 getAttributeRoutingSpaceHandle (
1249  AttributeHandle theHandle, // supplied C1
1250  ObjectClassHandle whichClass) // supplied C1
1251 throw (
1252  ObjectClassNotDefined,
1253  AttributeNotDefined,
1254  FederateNotExecutionMember,
1255  ConcurrentAccessAttempted,
1256  RTIinternalError);
1257 
1258 // 10.17
1259 ObjectClassHandle // returned C3
1260 getObjectClass (
1261  ObjectHandle theObject) // supplied C1
1262 throw (
1263  ObjectNotKnown,
1264  FederateNotExecutionMember,
1265  ConcurrentAccessAttempted,
1266  RTIinternalError);
1267 
1268 // 10.18
1269 SpaceHandle // returned C3
1270 getInteractionRoutingSpaceHandle (
1271  InteractionClassHandle theHandle) // supplied C1
1272 throw (
1273  InteractionClassNotDefined,
1274  FederateNotExecutionMember,
1275  ConcurrentAccessAttempted,
1276  RTIinternalError);
1277 
1278 // 10.19
1279 TransportationHandle // returned C3
1280 getTransportationHandle (
1281  const char *theName) // supplied C4
1282 throw (
1283  NameNotFound,
1284  FederateNotExecutionMember,
1285  ConcurrentAccessAttempted,
1286  RTIinternalError);
1287 
1288 // 10.20
1289 char * // returned C6
1290 getTransportationName (
1291  TransportationHandle theHandle) // supplied C1
1292 throw (
1293  InvalidTransportationHandle,
1294  FederateNotExecutionMember,
1295  ConcurrentAccessAttempted,
1296  RTIinternalError);
1297 
1298 // 10.21
1299 OrderingHandle // returned C3
1300 getOrderingHandle (
1301  const char *theName) // supplied C4
1302 throw (
1303  NameNotFound,
1304  FederateNotExecutionMember,
1305  ConcurrentAccessAttempted,
1306  RTIinternalError);
1307 
1308 // 10.22
1309 char * // returned C6
1310 getOrderingName (
1311  OrderingHandle theHandle) // supplied C1
1312 throw (
1313  InvalidOrderingHandle,
1314  FederateNotExecutionMember,
1315  ConcurrentAccessAttempted,
1316  RTIinternalError);
1317 
1318 // 10.23
1319 void enableClassRelevanceAdvisorySwitch()
1320 throw(
1321  FederateNotExecutionMember,
1322  ConcurrentAccessAttempted,
1323  SaveInProgress,
1324  RestoreInProgress,
1325  RTIinternalError);
1326 
1327 // 10.24
1328 void disableClassRelevanceAdvisorySwitch()
1329 throw(
1330  FederateNotExecutionMember,
1331  ConcurrentAccessAttempted,
1332  SaveInProgress,
1333  RestoreInProgress,
1334  RTIinternalError);
1335 
1336 // 10.25
1337 void enableAttributeRelevanceAdvisorySwitch()
1338 throw(
1339  FederateNotExecutionMember,
1340  ConcurrentAccessAttempted,
1341  SaveInProgress,
1342  RestoreInProgress,
1343  RTIinternalError);
1344 
1345 // 10.26
1346 void disableAttributeRelevanceAdvisorySwitch()
1347 throw(
1348  FederateNotExecutionMember,
1349  ConcurrentAccessAttempted,
1350  SaveInProgress,
1351  RestoreInProgress,
1352  RTIinternalError);
1353 
1354 // 10.27
1355 void enableAttributeScopeAdvisorySwitch()
1356 throw(
1357  FederateNotExecutionMember,
1358  ConcurrentAccessAttempted,
1359  SaveInProgress,
1360  RestoreInProgress,
1361  RTIinternalError);
1362 
1363 // 10.28
1364 void disableAttributeScopeAdvisorySwitch()
1365 throw(
1366  FederateNotExecutionMember,
1367  ConcurrentAccessAttempted,
1368  SaveInProgress,
1369  RestoreInProgress,
1370  RTIinternalError);
1371 
1372 // 10.29
1373 void enableInteractionRelevanceAdvisorySwitch()
1374 throw(
1375  FederateNotExecutionMember,
1376  ConcurrentAccessAttempted,
1377  SaveInProgress,
1378  RestoreInProgress,
1379  RTIinternalError);
1380 
1381 // 10.30
1382 void disableInteractionRelevanceAdvisorySwitch()
1383 throw(
1384  FederateNotExecutionMember,
1385  ConcurrentAccessAttempted,
1386  SaveInProgress,
1387  RestoreInProgress,
1388  RTIinternalError);
1389 
1390 //
1391 Boolean // returned C3
1392 tick ()
1393 throw (
1394  SpecifiedSaveLabelDoesNotExist,
1395  ConcurrentAccessAttempted,
1396  RTIinternalError);
1397 
1398 Boolean // returned C3
1399 tick (
1400  TickTime minimum, // supplied C1
1401  TickTime maximum) // supplied C1
1402 throw (
1403  SpecifiedSaveLabelDoesNotExist,
1404  ConcurrentAccessAttempted,
1405  RTIinternalError);
1406 
1407 RTIambassador()
1408 throw (
1409  MemoryExhausted,
1410  RTIinternalError);
1411 
1412 ~RTIambassador()
1413 throw (RTIinternalError);
1414 
1415 RegionToken
1416 getRegionToken(
1417  Region *)
1418 throw(
1419  FederateNotExecutionMember,
1420  ConcurrentAccessAttempted,
1421  RegionNotKnown,
1422  RTIinternalError);
1423 
1424 Region *
1425 getRegion(
1426  RegionToken)
1427 throw(
1428  FederateNotExecutionMember,
1429  ConcurrentAccessAttempted,
1430  RegionNotKnown,
1431  RTIinternalError);
1432 
1433 
1434 
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)