 |
MAK RTIspy API Documentation for HLA 1516
|
|
MAK RTIspy API Documentation for HLA 1516
|
00001 //File RTIambServices.hh 00002 //Included in RTI.hh 00003 00004 00005 // RTI Parameter Passing Memory Conventions 00006 // 00007 // C1 In parameter by value. 00008 // C2 Out parameter by pointer value. 00009 // C3 Function return by value. 00010 // C4 In parameter by const pointer value. Caller provides memory. 00011 // Caller may free memory or overwrite it upon completion of 00012 // the call. Callee must copy during the call anything it 00013 // wishes to save beyond completion of the call. Parameter 00014 // type must define const accessor methods. 00015 // C5 Out parameter by pointer value. Caller provides reference to object. 00016 // Callee constructs an instance on the heap (new) and returns. 00017 // The caller destroys the instance (delete) at its leisure. 00018 // C6 Function return by pointer value. Callee constructs an instance on 00019 // the heap (new) and returns a reference. The caller destroys the 00020 // instance (delete) at its leisure. 00021 // 00022 00023 typedef FederateAmbassador *FederateAmbassadorPtr; 00024 00026 // Federation Management Services // 00028 00029 // 4.2 00030 void createFederationExecution ( 00031 const char *executionName, // supplied C4 00032 const char *FED) // supplied C4 00033 throw ( 00034 FederationExecutionAlreadyExists, 00035 CouldNotOpenFED, 00036 ErrorReadingFED, 00037 ConcurrentAccessAttempted, 00038 RTIinternalError); 00039 00040 // 4.3 00041 void destroyFederationExecution ( 00042 const char *executionName) // supplied C4 00043 throw ( 00044 FederatesCurrentlyJoined, 00045 FederationExecutionDoesNotExist, 00046 ConcurrentAccessAttempted, 00047 RTIinternalError); 00048 00049 // 4.4 00050 FederateHandle // returned C3 00051 joinFederationExecution ( 00052 const char *yourName, // supplied C4 00053 const char *executionName, // supplied C4 00054 FederateAmbassadorPtr federateAmbassadorReference) // supplied C1 00055 throw ( 00056 FederateAlreadyExecutionMember, 00057 FederationExecutionDoesNotExist, 00058 CouldNotOpenFED, 00059 ErrorReadingFED, 00060 ConcurrentAccessAttempted, 00061 SaveInProgress, 00062 RestoreInProgress, 00063 RTIinternalError); 00064 00065 // 4.5 00066 void resignFederationExecution ( 00067 ResignAction theAction) // supplied C1 00068 throw ( 00069 FederateOwnsAttributes, 00070 FederateNotExecutionMember, 00071 InvalidResignAction, 00072 ConcurrentAccessAttempted, 00073 RTIinternalError); 00074 00075 // 4.6 00076 void registerFederationSynchronizationPoint ( 00077 const char *label, // supplied C4 00078 const char *theTag) // supplied C4 00079 throw ( 00080 FederateNotExecutionMember, 00081 ConcurrentAccessAttempted, 00082 SaveInProgress, 00083 RestoreInProgress, 00084 RTIinternalError); 00085 00086 void registerFederationSynchronizationPoint ( 00087 const char *label, // supplied C4 00088 const char *theTag, // supplied C4 00089 const FederateHandleSet& syncSet) // supplied C4 00090 throw ( 00091 FederateNotExecutionMember, 00092 ConcurrentAccessAttempted, 00093 SaveInProgress, 00094 RestoreInProgress, 00095 RTIinternalError); 00096 00097 // 4.9 00098 void synchronizationPointAchieved ( 00099 const char *label) // supplied C4 00100 throw ( 00101 SynchronizationPointLabelWasNotAnnounced, 00102 FederateNotExecutionMember, 00103 ConcurrentAccessAttempted, 00104 SaveInProgress, 00105 RestoreInProgress, 00106 RTIinternalError); 00107 00108 // 4.11 00109 void requestFederationSave ( 00110 const char *label, // supplied C4 00111 const FedTime& theTime) // supplied C4 00112 throw ( 00113 FederationTimeAlreadyPassed, 00114 InvalidFederationTime, 00115 FederateNotExecutionMember, 00116 ConcurrentAccessAttempted, 00117 SaveInProgress, 00118 RestoreInProgress, 00119 RTIinternalError); 00120 00121 void requestFederationSave ( 00122 const char *label) // supplied C4 00123 throw ( 00124 FederateNotExecutionMember, 00125 ConcurrentAccessAttempted, 00126 SaveInProgress, 00127 RestoreInProgress, 00128 RTIinternalError); 00129 00130 // 4.13 00131 void federateSaveBegun () 00132 throw ( 00133 SaveNotInitiated, 00134 FederateNotExecutionMember, 00135 ConcurrentAccessAttempted, 00136 RestoreInProgress, 00137 RTIinternalError); 00138 00139 // 4.14 00140 void federateSaveComplete () 00141 throw ( 00142 SaveNotInitiated, 00143 FederateNotExecutionMember, 00144 ConcurrentAccessAttempted, 00145 RestoreInProgress, 00146 RTIinternalError); 00147 00148 void federateSaveNotComplete () 00149 throw ( 00150 SaveNotInitiated, 00151 FederateNotExecutionMember, 00152 ConcurrentAccessAttempted, 00153 RestoreInProgress, 00154 RTIinternalError); 00155 00156 // 4.16 00157 void requestFederationRestore ( 00158 const char *label) // supplied C4 00159 throw ( 00160 FederateNotExecutionMember, 00161 ConcurrentAccessAttempted, 00162 SaveInProgress, 00163 RestoreInProgress, 00164 RTIinternalError); 00165 00166 // 4.20 00167 void federateRestoreComplete () 00168 throw ( 00169 RestoreNotRequested, 00170 FederateNotExecutionMember, 00171 ConcurrentAccessAttempted, 00172 SaveInProgress, 00173 RTIinternalError); 00174 00175 void federateRestoreNotComplete () 00176 throw ( 00177 RestoreNotRequested, 00178 FederateNotExecutionMember, 00179 ConcurrentAccessAttempted, 00180 SaveInProgress, 00181 RTIinternalError); 00182 00184 // Declaration Management Services // 00186 00187 // 5.2 00188 void publishObjectClass ( 00189 ObjectClassHandle theClass, // supplied C1 00190 const AttributeHandleSet& attributeList) // supplied C4 00191 throw ( 00192 ObjectClassNotDefined, 00193 AttributeNotDefined, 00194 OwnershipAcquisitionPending, 00195 FederateNotExecutionMember, 00196 ConcurrentAccessAttempted, 00197 SaveInProgress, 00198 RestoreInProgress, 00199 RTIinternalError); 00200 00201 // 5.3 00202 void unpublishObjectClass ( 00203 ObjectClassHandle theClass) // supplied C1 00204 throw ( 00205 ObjectClassNotDefined, 00206 ObjectClassNotPublished, 00207 OwnershipAcquisitionPending, 00208 FederateNotExecutionMember, 00209 ConcurrentAccessAttempted, 00210 SaveInProgress, 00211 RestoreInProgress, 00212 RTIinternalError); 00213 00214 // 5.4 00215 void publishInteractionClass ( 00216 InteractionClassHandle theInteraction) // supplied C1 00217 throw ( 00218 InteractionClassNotDefined, 00219 FederateNotExecutionMember, 00220 ConcurrentAccessAttempted, 00221 SaveInProgress, 00222 RestoreInProgress, 00223 RTIinternalError); 00224 00225 // 5.5 00226 void unpublishInteractionClass ( 00227 InteractionClassHandle theInteraction) // supplied C1 00228 throw ( 00229 InteractionClassNotDefined, 00230 InteractionClassNotPublished, 00231 FederateNotExecutionMember, 00232 ConcurrentAccessAttempted, 00233 SaveInProgress, 00234 RestoreInProgress, 00235 RTIinternalError); 00236 00237 // 5.6 00238 void subscribeObjectClassAttributes ( 00239 ObjectClassHandle theClass, // supplied C1 00240 const AttributeHandleSet& attributeList, // supplied C4 00241 Boolean active = RTI_TRUE) 00242 throw ( 00243 ObjectClassNotDefined, 00244 AttributeNotDefined, 00245 FederateNotExecutionMember, 00246 ConcurrentAccessAttempted, 00247 SaveInProgress, 00248 RestoreInProgress, 00249 RTIinternalError); 00250 00251 // 5.7 00252 void unsubscribeObjectClass ( 00253 ObjectClassHandle theClass) // supplied C1 00254 throw ( 00255 ObjectClassNotDefined, 00256 ObjectClassNotSubscribed, 00257 FederateNotExecutionMember, 00258 ConcurrentAccessAttempted, 00259 SaveInProgress, 00260 RestoreInProgress, 00261 RTIinternalError); 00262 00263 // 5.8 00264 void subscribeInteractionClass ( 00265 InteractionClassHandle theClass, // supplied C1 00266 Boolean active = RTI_TRUE) 00267 throw ( 00268 InteractionClassNotDefined, 00269 FederateNotExecutionMember, 00270 ConcurrentAccessAttempted, 00271 FederateLoggingServiceCalls, 00272 SaveInProgress, 00273 RestoreInProgress, 00274 RTIinternalError); 00275 00276 // 5.9 00277 void unsubscribeInteractionClass ( 00278 InteractionClassHandle theClass) // supplied C1 00279 throw ( 00280 InteractionClassNotDefined, 00281 InteractionClassNotSubscribed, 00282 FederateNotExecutionMember, 00283 ConcurrentAccessAttempted, 00284 SaveInProgress, 00285 RestoreInProgress, 00286 RTIinternalError); 00287 00289 // Object Management Services // 00291 00292 // 6.2 00293 ObjectHandle // returned C3 00294 registerObjectInstance ( 00295 ObjectClassHandle theClass, // supplied C1 00296 const char *theObject) // supplied C4 00297 throw ( 00298 ObjectClassNotDefined, 00299 ObjectClassNotPublished, 00300 ObjectAlreadyRegistered, 00301 FederateNotExecutionMember, 00302 ConcurrentAccessAttempted, 00303 SaveInProgress, 00304 RestoreInProgress, 00305 RTIinternalError); 00306 00307 ObjectHandle // returned C3 00308 registerObjectInstance ( 00309 ObjectClassHandle theClass) // supplied C1 00310 throw ( 00311 ObjectClassNotDefined, 00312 ObjectClassNotPublished, 00313 FederateNotExecutionMember, 00314 ConcurrentAccessAttempted, 00315 SaveInProgress, 00316 RestoreInProgress, 00317 RTIinternalError); 00318 00319 // 6.4 00320 EventRetractionHandle // returned C3 00321 updateAttributeValues ( 00322 ObjectHandle theObject, // supplied C1 00323 const AttributeHandleValuePairSet& theAttributes, // supplied C4 00324 const FedTime& theTime, // supplied C4 00325 const char *theTag) // supplied C4 00326 throw ( 00327 ObjectNotKnown, 00328 AttributeNotDefined, 00329 AttributeNotOwned, 00330 InvalidFederationTime, 00331 FederateNotExecutionMember, 00332 ConcurrentAccessAttempted, 00333 SaveInProgress, 00334 RestoreInProgress, 00335 RTIinternalError); 00336 00337 void updateAttributeValues ( 00338 ObjectHandle theObject, // supplied C1 00339 const AttributeHandleValuePairSet& theAttributes, // supplied C4 00340 const char *theTag) // supplied C4 00341 throw ( 00342 ObjectNotKnown, 00343 AttributeNotDefined, 00344 AttributeNotOwned, 00345 FederateNotExecutionMember, 00346 ConcurrentAccessAttempted, 00347 SaveInProgress, 00348 RestoreInProgress, 00349 RTIinternalError); 00350 00351 // 6.6 00352 EventRetractionHandle // returned C3 00353 sendInteraction ( 00354 InteractionClassHandle theInteraction, // supplied C1 00355 const ParameterHandleValuePairSet& theParameters, // supplied C4 00356 const FedTime& theTime, // supplied C4 00357 const char *theTag) // supplied C4 00358 throw ( 00359 InteractionClassNotDefined, 00360 InteractionClassNotPublished, 00361 InteractionParameterNotDefined, 00362 InvalidFederationTime, 00363 FederateNotExecutionMember, 00364 ConcurrentAccessAttempted, 00365 SaveInProgress, 00366 RestoreInProgress, 00367 RTIinternalError); 00368 00369 void sendInteraction ( 00370 InteractionClassHandle theInteraction, // supplied C1 00371 const ParameterHandleValuePairSet& theParameters, // supplied C4 00372 const char *theTag) // supplied C4 00373 throw ( 00374 InteractionClassNotDefined, 00375 InteractionClassNotPublished, 00376 InteractionParameterNotDefined, 00377 FederateNotExecutionMember, 00378 ConcurrentAccessAttempted, 00379 SaveInProgress, 00380 RestoreInProgress, 00381 RTIinternalError); 00382 00383 // 6.8 00384 EventRetractionHandle // returned C3 00385 deleteObjectInstance ( 00386 ObjectHandle theObject, // supplied C1 00387 const FedTime& theTime, // supplied C4 00388 const char *theTag) // supplied C4 00389 throw ( 00390 ObjectNotKnown, 00391 DeletePrivilegeNotHeld, 00392 InvalidFederationTime, 00393 FederateNotExecutionMember, 00394 ConcurrentAccessAttempted, 00395 SaveInProgress, 00396 RestoreInProgress, 00397 RTIinternalError); 00398 00399 void deleteObjectInstance ( 00400 ObjectHandle theObject, // supplied C1 00401 const char *theTag) // supplied C4 00402 throw ( 00403 ObjectNotKnown, 00404 DeletePrivilegeNotHeld, 00405 FederateNotExecutionMember, 00406 ConcurrentAccessAttempted, 00407 SaveInProgress, 00408 RestoreInProgress, 00409 RTIinternalError); 00410 00411 // 6.10 00412 void localDeleteObjectInstance ( 00413 ObjectHandle theObject) // supplied C1 00414 throw ( 00415 ObjectNotKnown, 00416 FederateOwnsAttributes, 00417 FederateNotExecutionMember, 00418 ConcurrentAccessAttempted, 00419 SaveInProgress, 00420 RestoreInProgress, 00421 RTIinternalError); 00422 00423 // 6.11 00424 void changeAttributeTransportationType ( 00425 ObjectHandle theObject, // supplied C1 00426 const AttributeHandleSet& theAttributes, // supplied C4 00427 TransportationHandle theType) // supplied C1 00428 throw ( 00429 ObjectNotKnown, 00430 AttributeNotDefined, 00431 AttributeNotOwned, 00432 InvalidTransportationHandle, 00433 FederateNotExecutionMember, 00434 ConcurrentAccessAttempted, 00435 SaveInProgress, 00436 RestoreInProgress, 00437 RTIinternalError); 00438 00439 // 6.12 00440 void changeInteractionTransportationType ( 00441 InteractionClassHandle theClass, // supplied C1 00442 TransportationHandle theType) // supplied C1 00443 throw ( 00444 InteractionClassNotDefined, 00445 InteractionClassNotPublished, 00446 InvalidTransportationHandle, 00447 FederateNotExecutionMember, 00448 ConcurrentAccessAttempted, 00449 SaveInProgress, 00450 RestoreInProgress, 00451 RTIinternalError); 00452 00453 // 6.15 00454 void requestObjectAttributeValueUpdate ( 00455 ObjectHandle theObject, // supplied C1 00456 const AttributeHandleSet& theAttributes) // supplied C4 00457 throw ( 00458 ObjectNotKnown, 00459 AttributeNotDefined, 00460 FederateNotExecutionMember, 00461 ConcurrentAccessAttempted, 00462 SaveInProgress, 00463 RestoreInProgress, 00464 RTIinternalError); 00465 00466 void requestClassAttributeValueUpdate ( 00467 ObjectClassHandle theClass, // supplied C1 00468 const AttributeHandleSet& theAttributes) // supplied C4 00469 throw ( 00470 ObjectClassNotDefined, 00471 AttributeNotDefined, 00472 FederateNotExecutionMember, 00473 ConcurrentAccessAttempted, 00474 SaveInProgress, 00475 RestoreInProgress, 00476 RTIinternalError); 00477 00479 // Ownership Management Services // 00481 00482 // 7.2 00483 void unconditionalAttributeOwnershipDivestiture ( 00484 ObjectHandle theObject, // supplied C1 00485 const AttributeHandleSet& theAttributes) // supplied C4 00486 throw ( 00487 ObjectNotKnown, 00488 AttributeNotDefined, 00489 AttributeNotOwned, 00490 FederateNotExecutionMember, 00491 ConcurrentAccessAttempted, 00492 SaveInProgress, 00493 RestoreInProgress, 00494 RTIinternalError); 00495 00496 // 7.3 00497 void negotiatedAttributeOwnershipDivestiture ( 00498 ObjectHandle theObject, // supplied C1 00499 const AttributeHandleSet& theAttributes, // supplied C4 00500 const char *theTag) // supplied C4 00501 throw ( 00502 ObjectNotKnown, 00503 AttributeNotDefined, 00504 AttributeNotOwned, 00505 AttributeAlreadyBeingDivested, 00506 FederateNotExecutionMember, 00507 ConcurrentAccessAttempted, 00508 SaveInProgress, 00509 RestoreInProgress, 00510 RTIinternalError); 00511 00512 // 7.7 00513 void attributeOwnershipAcquisition ( 00514 ObjectHandle theObject, // supplied C1 00515 const AttributeHandleSet& desiredAttributes, // supplied C4 00516 const char *theTag) // supplied C4 00517 throw ( 00518 ObjectNotKnown, 00519 ObjectClassNotPublished, 00520 AttributeNotDefined, 00521 AttributeNotPublished, 00522 FederateOwnsAttributes, 00523 FederateNotExecutionMember, 00524 ConcurrentAccessAttempted, 00525 SaveInProgress, 00526 RestoreInProgress, 00527 RTIinternalError); 00528 00529 // 7.8 00530 void attributeOwnershipAcquisitionIfAvailable ( 00531 ObjectHandle theObject, // supplied C1 00532 const AttributeHandleSet& desiredAttributes) // supplied C4 00533 throw ( 00534 ObjectNotKnown, 00535 ObjectClassNotPublished, 00536 AttributeNotDefined, 00537 AttributeNotPublished, 00538 FederateOwnsAttributes, 00539 AttributeAlreadyBeingAcquired, 00540 FederateNotExecutionMember, 00541 ConcurrentAccessAttempted, 00542 SaveInProgress, 00543 RestoreInProgress, 00544 RTIinternalError); 00545 00546 // 7.11 00547 AttributeHandleSet* // returned C6 00548 attributeOwnershipReleaseResponse ( 00549 ObjectHandle theObject, // supplied C1 00550 const AttributeHandleSet& theAttributes) // supplied C4 00551 throw ( 00552 ObjectNotKnown, 00553 AttributeNotDefined, 00554 AttributeNotOwned, 00555 FederateWasNotAskedToReleaseAttribute, 00556 FederateNotExecutionMember, 00557 ConcurrentAccessAttempted, 00558 SaveInProgress, 00559 RestoreInProgress, 00560 RTIinternalError); 00561 00562 // 7.12 00563 void cancelNegotiatedAttributeOwnershipDivestiture ( 00564 ObjectHandle theObject, // supplied C1 00565 const AttributeHandleSet& theAttributes) // supplied C4 00566 throw ( 00567 ObjectNotKnown, 00568 AttributeNotDefined, 00569 AttributeNotOwned, 00570 AttributeDivestitureWasNotRequested, 00571 FederateNotExecutionMember, 00572 ConcurrentAccessAttempted, 00573 SaveInProgress, 00574 RestoreInProgress, 00575 RTIinternalError); 00576 00577 // 7.13 00578 void cancelAttributeOwnershipAcquisition ( 00579 ObjectHandle theObject, // supplied C1 00580 const AttributeHandleSet& theAttributes) // supplied C4 00581 throw ( 00582 ObjectNotKnown, 00583 AttributeNotDefined, 00584 AttributeAlreadyOwned, 00585 AttributeAcquisitionWasNotRequested, 00586 FederateNotExecutionMember, 00587 ConcurrentAccessAttempted, 00588 SaveInProgress, 00589 RestoreInProgress, 00590 RTIinternalError); 00591 00592 // 7.15 00593 void queryAttributeOwnership ( 00594 ObjectHandle theObject, // supplied C1 00595 AttributeHandle theAttribute) // supplied C1 00596 throw ( 00597 ObjectNotKnown, 00598 AttributeNotDefined, 00599 FederateNotExecutionMember, 00600 ConcurrentAccessAttempted, 00601 SaveInProgress, 00602 RestoreInProgress, 00603 RTIinternalError); 00604 00605 // 7.17 00606 Boolean // returned C3 00607 isAttributeOwnedByFederate ( 00608 ObjectHandle theObject, // supplied C1 00609 AttributeHandle theAttribute) // supplied C1 00610 throw ( 00611 ObjectNotKnown, 00612 AttributeNotDefined, 00613 FederateNotExecutionMember, 00614 ConcurrentAccessAttempted, 00615 SaveInProgress, 00616 RestoreInProgress, 00617 RTIinternalError); 00618 00620 // Time Management Services // 00622 00623 // 8.2 00624 void enableTimeRegulation ( 00625 const FedTime& theFederateTime, // supplied C4 00626 const FedTime& theLookahead) // supplied C4 00627 throw ( 00628 TimeRegulationAlreadyEnabled, 00629 EnableTimeRegulationPending, 00630 TimeAdvanceAlreadyInProgress, 00631 InvalidFederationTime, 00632 InvalidLookahead, 00633 ConcurrentAccessAttempted, 00634 FederateNotExecutionMember, 00635 SaveInProgress, 00636 RestoreInProgress, 00637 RTIinternalError); 00638 00639 // 8.4 00640 void disableTimeRegulation () 00641 throw ( 00642 TimeRegulationWasNotEnabled, 00643 ConcurrentAccessAttempted, 00644 FederateNotExecutionMember, 00645 SaveInProgress, 00646 RestoreInProgress, 00647 RTIinternalError); 00648 00649 // 8.5 00650 void enableTimeConstrained () 00651 throw ( 00652 TimeConstrainedAlreadyEnabled, 00653 EnableTimeConstrainedPending, 00654 TimeAdvanceAlreadyInProgress, 00655 FederateNotExecutionMember, 00656 ConcurrentAccessAttempted, 00657 SaveInProgress, 00658 RestoreInProgress, 00659 RTIinternalError); 00660 00661 // 8.7 00662 void disableTimeConstrained () 00663 throw ( 00664 TimeConstrainedWasNotEnabled, 00665 FederateNotExecutionMember, 00666 ConcurrentAccessAttempted, 00667 SaveInProgress, 00668 RestoreInProgress, 00669 RTIinternalError); 00670 00671 // 8.8 00672 void timeAdvanceRequest ( 00673 const FedTime& theTime) // supplied C4 00674 throw ( 00675 InvalidFederationTime, 00676 FederationTimeAlreadyPassed, 00677 TimeAdvanceAlreadyInProgress, 00678 EnableTimeRegulationPending, 00679 EnableTimeConstrainedPending, 00680 FederateNotExecutionMember, 00681 ConcurrentAccessAttempted, 00682 SaveInProgress, 00683 RestoreInProgress, 00684 RTIinternalError); 00685 00686 // 8.9 00687 void timeAdvanceRequestAvailable ( 00688 const FedTime& theTime) // supplied C4 00689 throw ( 00690 InvalidFederationTime, 00691 FederationTimeAlreadyPassed, 00692 TimeAdvanceAlreadyInProgress, 00693 EnableTimeRegulationPending, 00694 EnableTimeConstrainedPending, 00695 FederateNotExecutionMember, 00696 ConcurrentAccessAttempted, 00697 SaveInProgress, 00698 RestoreInProgress, 00699 RTIinternalError); 00700 00701 // 8.10 00702 void nextEventRequest ( 00703 const FedTime& theTime) // supplied C4 00704 throw ( 00705 InvalidFederationTime, 00706 FederationTimeAlreadyPassed, 00707 TimeAdvanceAlreadyInProgress, 00708 EnableTimeRegulationPending, 00709 EnableTimeConstrainedPending, 00710 FederateNotExecutionMember, 00711 ConcurrentAccessAttempted, 00712 SaveInProgress, 00713 RestoreInProgress, 00714 RTIinternalError); 00715 00716 // 8.11 00717 void nextEventRequestAvailable ( 00718 const FedTime& theTime) // supplied C4 00719 throw ( 00720 InvalidFederationTime, 00721 FederationTimeAlreadyPassed, 00722 TimeAdvanceAlreadyInProgress, 00723 EnableTimeRegulationPending, 00724 EnableTimeConstrainedPending, 00725 FederateNotExecutionMember, 00726 ConcurrentAccessAttempted, 00727 SaveInProgress, 00728 RestoreInProgress, 00729 RTIinternalError); 00730 00731 // 8.12 00732 void flushQueueRequest ( 00733 const FedTime& theTime) // supplied C4 00734 throw ( 00735 InvalidFederationTime, 00736 FederationTimeAlreadyPassed, 00737 TimeAdvanceAlreadyInProgress, 00738 EnableTimeRegulationPending, 00739 EnableTimeConstrainedPending, 00740 FederateNotExecutionMember, 00741 ConcurrentAccessAttempted, 00742 SaveInProgress, 00743 RestoreInProgress, 00744 RTIinternalError); 00745 00746 // 8.14 00747 void enableAsynchronousDelivery() 00748 throw ( 00749 AsynchronousDeliveryAlreadyEnabled, 00750 FederateNotExecutionMember, 00751 ConcurrentAccessAttempted, 00752 SaveInProgress, 00753 RestoreInProgress, 00754 RTIinternalError); 00755 00756 // 8.15 00757 void disableAsynchronousDelivery() 00758 throw ( 00759 AsynchronousDeliveryAlreadyDisabled, 00760 FederateNotExecutionMember, 00761 ConcurrentAccessAttempted, 00762 SaveInProgress, 00763 RestoreInProgress, 00764 RTIinternalError); 00765 00766 // 8.16 00767 void queryLBTS ( 00768 FedTime& theTime) // returned C5 00769 throw ( 00770 FederateNotExecutionMember, 00771 ConcurrentAccessAttempted, 00772 SaveInProgress, 00773 RestoreInProgress, 00774 RTIinternalError); 00775 00776 // 8.17 00777 void queryFederateTime ( 00778 FedTime& theTime) // returned C5 00779 throw ( 00780 FederateNotExecutionMember, 00781 ConcurrentAccessAttempted, 00782 SaveInProgress, 00783 RestoreInProgress, 00784 RTIinternalError); 00785 00786 // 8.18 00787 void queryMinNextEventTime ( 00788 FedTime& theTime) // returned C5 00789 throw ( 00790 FederateNotExecutionMember, 00791 ConcurrentAccessAttempted, 00792 SaveInProgress, 00793 RestoreInProgress, 00794 RTIinternalError); 00795 00796 // 8.19 00797 void modifyLookahead ( 00798 const FedTime& theLookahead) // supplied C4 00799 throw ( 00800 InvalidLookahead, 00801 FederateNotExecutionMember, 00802 ConcurrentAccessAttempted, 00803 SaveInProgress, 00804 RestoreInProgress, 00805 RTIinternalError); 00806 00807 // 8.20 00808 void queryLookahead ( 00809 FedTime& theTime) // returned C5 00810 throw ( 00811 FederateNotExecutionMember, 00812 ConcurrentAccessAttempted, 00813 SaveInProgress, 00814 RestoreInProgress, 00815 RTIinternalError); 00816 00817 // 8.21 00818 void retract ( 00819 EventRetractionHandle theHandle) // supplied C1 00820 throw ( 00821 InvalidRetractionHandle, 00822 FederateNotExecutionMember, 00823 ConcurrentAccessAttempted, 00824 SaveInProgress, 00825 RestoreInProgress, 00826 RTIinternalError); 00827 00828 // 8.23 00829 void changeAttributeOrderType ( 00830 ObjectHandle theObject, // supplied C1 00831 const AttributeHandleSet& theAttributes, // supplied C4 00832 OrderingHandle theType) // supplied C1 00833 throw ( 00834 ObjectNotKnown, 00835 AttributeNotDefined, 00836 AttributeNotOwned, 00837 InvalidOrderingHandle, 00838 FederateNotExecutionMember, 00839 ConcurrentAccessAttempted, 00840 SaveInProgress, 00841 RestoreInProgress, 00842 RTIinternalError); 00843 00844 // 8.24 00845 void changeInteractionOrderType ( 00846 InteractionClassHandle theClass, // supplied C1 00847 OrderingHandle theType) // supplied C1 00848 throw ( 00849 InteractionClassNotDefined, 00850 InteractionClassNotPublished, 00851 InvalidOrderingHandle, 00852 FederateNotExecutionMember, 00853 ConcurrentAccessAttempted, 00854 SaveInProgress, 00855 RestoreInProgress, 00856 RTIinternalError); 00857 00859 // Data Distribution Management // 00861 00862 // 9.2 00863 Region* // returned C6 00864 createRegion ( 00865 SpaceHandle theSpace, // supplied C1 00866 ULong numberOfExtents) // supplied C1 00867 throw ( 00868 SpaceNotDefined, 00869 InvalidExtents, 00870 FederateNotExecutionMember, 00871 ConcurrentAccessAttempted, 00872 SaveInProgress, 00873 RestoreInProgress, 00874 RTIinternalError); 00875 00876 // 9.3 00877 void notifyAboutRegionModification ( 00878 Region &theRegion) // supplied C4 00879 throw ( 00880 RegionNotKnown, 00881 InvalidExtents, 00882 FederateNotExecutionMember, 00883 ConcurrentAccessAttempted, 00884 SaveInProgress, 00885 RestoreInProgress, 00886 RTIinternalError); 00887 00888 // 9.4 00889 void deleteRegion ( 00890 Region *theRegion) // supplied C1 00891 throw ( 00892 RegionNotKnown, 00893 RegionInUse, 00894 FederateNotExecutionMember, 00895 ConcurrentAccessAttempted, 00896 SaveInProgress, 00897 RestoreInProgress, 00898 RTIinternalError); 00899 00900 // 9.5 00901 ObjectHandle // returned C3 00902 registerObjectInstanceWithRegion ( 00903 ObjectClassHandle theClass, // supplied C1 00904 const char *theObject, // supplied C4 00905 AttributeHandle theAttributes[], // supplied C4 00906 Region *theRegions[], // supplied C4 00907 ULong theNumberOfHandles) // supplied C1 00908 throw ( 00909 ObjectClassNotDefined, 00910 ObjectClassNotPublished, 00911 AttributeNotDefined, 00912 AttributeNotPublished, 00913 RegionNotKnown, 00914 InvalidRegionContext, 00915 ObjectAlreadyRegistered, 00916 FederateNotExecutionMember, 00917 ConcurrentAccessAttempted, 00918 SaveInProgress, 00919 RestoreInProgress, 00920 RTIinternalError); 00921 00922 ObjectHandle // returned C3 00923 registerObjectInstanceWithRegion ( 00924 ObjectClassHandle theClass, // supplied C1 00925 AttributeHandle theAttributes[], // supplied C4 00926 Region *theRegions[], // supplied C4 00927 ULong theNumberOfHandles) // supplied C1 00928 throw ( 00929 ObjectClassNotDefined, 00930 ObjectClassNotPublished, 00931 AttributeNotDefined, 00932 AttributeNotPublished, 00933 RegionNotKnown, 00934 InvalidRegionContext, 00935 FederateNotExecutionMember, 00936 ConcurrentAccessAttempted, 00937 SaveInProgress, 00938 RestoreInProgress, 00939 RTIinternalError); 00940 00941 // 9.6 00942 void associateRegionForUpdates ( 00943 Region &theRegion, // supplied C4 00944 ObjectHandle theObject, // supplied C1 00945 const AttributeHandleSet &theAttributes) // supplied C4 00946 throw ( 00947 ObjectNotKnown, 00948 AttributeNotDefined, 00949 InvalidRegionContext, 00950 RegionNotKnown, 00951 FederateNotExecutionMember, 00952 ConcurrentAccessAttempted, 00953 SaveInProgress, 00954 RestoreInProgress, 00955 RTIinternalError); 00956 00957 // 9.7 00958 void unassociateRegionForUpdates ( 00959 Region &theRegion, // supplied C4 00960 ObjectHandle theObject) // supplied C1 00961 throw ( 00962 ObjectNotKnown, 00963 InvalidRegionContext, 00964 RegionNotKnown, 00965 FederateNotExecutionMember, 00966 ConcurrentAccessAttempted, 00967 SaveInProgress, 00968 RestoreInProgress, 00969 RTIinternalError); 00970 00971 // 9.8 00972 void subscribeObjectClassAttributesWithRegion ( 00973 ObjectClassHandle theClass, // supplied C1 00974 Region &theRegion, // supplied C4 00975 const AttributeHandleSet &attributeList, // supplied C4 00976 Boolean active = RTI_TRUE) 00977 throw ( 00978 ObjectClassNotDefined, 00979 AttributeNotDefined, 00980 RegionNotKnown, 00981 InvalidRegionContext, 00982 FederateNotExecutionMember, 00983 ConcurrentAccessAttempted, 00984 SaveInProgress, 00985 RestoreInProgress, 00986 RTIinternalError); 00987 00988 // 9.9 00989 void unsubscribeObjectClassWithRegion ( 00990 ObjectClassHandle theClass, // supplied C1 00991 Region &theRegion) // supplied C4 00992 throw ( 00993 ObjectClassNotDefined, 00994 RegionNotKnown, 00995 ObjectClassNotSubscribed, 00996 FederateNotExecutionMember, 00997 ConcurrentAccessAttempted, 00998 SaveInProgress, 00999 RestoreInProgress, 01000 RTIinternalError); 01001 01002 // 9.10 01003 void subscribeInteractionClassWithRegion ( 01004 InteractionClassHandle theClass, // supplied C1 01005 Region &theRegion, // supplied C4 01006 Boolean active = RTI_TRUE) 01007 throw ( 01008 InteractionClassNotDefined, 01009 RegionNotKnown, 01010 InvalidRegionContext, 01011 FederateLoggingServiceCalls, 01012 FederateNotExecutionMember, 01013 ConcurrentAccessAttempted, 01014 SaveInProgress, 01015 RestoreInProgress, 01016 RTIinternalError); 01017 01018 // 9.11 01019 void unsubscribeInteractionClassWithRegion ( 01020 InteractionClassHandle theClass, // supplied C1 01021 Region &theRegion) // supplied C4 01022 throw ( 01023 InteractionClassNotDefined, 01024 InteractionClassNotSubscribed, 01025 RegionNotKnown, 01026 FederateNotExecutionMember, 01027 ConcurrentAccessAttempted, 01028 SaveInProgress, 01029 RestoreInProgress, 01030 RTIinternalError); 01031 01032 // 9.12 01033 EventRetractionHandle // returned C3 01034 sendInteractionWithRegion ( 01035 InteractionClassHandle theInteraction, // supplied C1 01036 const ParameterHandleValuePairSet &theParameters, // supplied C4 01037 const FedTime& theTime, // supplied C4 01038 const char *theTag, // supplied C4 01039 const Region &theRegion) // supplied C4 01040 throw ( 01041 InteractionClassNotDefined, 01042 InteractionClassNotPublished, 01043 InteractionParameterNotDefined, 01044 InvalidFederationTime, 01045 RegionNotKnown, 01046 InvalidRegionContext, 01047 FederateNotExecutionMember, 01048 ConcurrentAccessAttempted, 01049 SaveInProgress, 01050 RestoreInProgress, 01051 RTIinternalError); 01052 01053 void sendInteractionWithRegion ( 01054 InteractionClassHandle theInteraction, // supplied C1 01055 const ParameterHandleValuePairSet &theParameters, // supplied C4 01056 const char *theTag, // supplied C4 01057 const Region &theRegion) // supplied C4 01058 throw ( 01059 InteractionClassNotDefined, 01060 InteractionClassNotPublished, 01061 InteractionParameterNotDefined, 01062 RegionNotKnown, 01063 InvalidRegionContext, 01064 FederateNotExecutionMember, 01065 ConcurrentAccessAttempted, 01066 SaveInProgress, 01067 RestoreInProgress, 01068 RTIinternalError); 01069 01070 // 9.13 01071 void requestClassAttributeValueUpdateWithRegion ( 01072 ObjectClassHandle theClass, // supplied C1 01073 const AttributeHandleSet &theAttributes, // supplied C4 01074 const Region &theRegion) // supplied C4 01075 throw ( 01076 ObjectClassNotDefined, 01077 AttributeNotDefined, 01078 RegionNotKnown, 01079 FederateNotExecutionMember, 01080 ConcurrentAccessAttempted, 01081 SaveInProgress, 01082 RestoreInProgress, 01083 RTIinternalError); 01084 01086 // RTI Support Services // 01088 01089 // 10.2 01090 ObjectClassHandle // returned C3 01091 getObjectClassHandle ( 01092 const char *theName) // supplied C4 01093 throw ( 01094 NameNotFound, 01095 FederateNotExecutionMember, 01096 ConcurrentAccessAttempted, 01097 RTIinternalError); 01098 01099 // 10.3 01100 char * // returned C6 01101 getObjectClassName ( 01102 ObjectClassHandle theHandle) // supplied C1 01103 throw ( 01104 ObjectClassNotDefined, 01105 FederateNotExecutionMember, 01106 ConcurrentAccessAttempted, 01107 RTIinternalError); 01108 01109 // 10.4 01110 AttributeHandle // returned C3 01111 getAttributeHandle ( 01112 const char *theName, // supplied C4 01113 ObjectClassHandle whichClass) // supplied C1 01114 throw ( 01115 ObjectClassNotDefined, 01116 NameNotFound, 01117 FederateNotExecutionMember, 01118 ConcurrentAccessAttempted, 01119 RTIinternalError); 01120 01121 // 10.5 01122 char * // returned C6 01123 getAttributeName ( 01124 AttributeHandle theHandle, // supplied C1 01125 ObjectClassHandle whichClass) // supplied C1 01126 throw ( 01127 ObjectClassNotDefined, 01128 AttributeNotDefined, 01129 FederateNotExecutionMember, 01130 ConcurrentAccessAttempted, 01131 RTIinternalError); 01132 01133 // 10.6 01134 InteractionClassHandle // returned C3 01135 getInteractionClassHandle ( 01136 const char *theName) // supplied C4 01137 throw ( 01138 NameNotFound, 01139 FederateNotExecutionMember, 01140 ConcurrentAccessAttempted, 01141 RTIinternalError); 01142 01143 // 10.7 01144 char * // returned C6 01145 getInteractionClassName ( 01146 InteractionClassHandle theHandle) // supplied C1 01147 throw ( 01148 InteractionClassNotDefined, 01149 FederateNotExecutionMember, 01150 ConcurrentAccessAttempted, 01151 RTIinternalError); 01152 01153 // 10.8 01154 ParameterHandle // returned C3 01155 getParameterHandle ( 01156 const char *theName, // supplied C4 01157 InteractionClassHandle whichClass) // supplied C1 01158 throw ( 01159 InteractionClassNotDefined, 01160 NameNotFound, 01161 FederateNotExecutionMember, 01162 ConcurrentAccessAttempted, 01163 RTIinternalError); 01164 01165 // 10.9 01166 char * // returned C6 01167 getParameterName ( 01168 ParameterHandle theHandle, // supplied C1 01169 InteractionClassHandle whichClass) // supplied C1 01170 throw ( 01171 InteractionClassNotDefined, 01172 InteractionParameterNotDefined, 01173 FederateNotExecutionMember, 01174 ConcurrentAccessAttempted, 01175 RTIinternalError); 01176 01177 // 10.10 01178 ObjectHandle // returned C3 01179 getObjectInstanceHandle ( 01180 const char *theName) // supplied C4 01181 throw ( 01182 ObjectNotKnown, 01183 FederateNotExecutionMember, 01184 ConcurrentAccessAttempted, 01185 RTIinternalError); 01186 01187 // 10.11 01188 char * // returned C6 01189 getObjectInstanceName ( 01190 ObjectHandle theHandle) // supplied C1 01191 throw ( 01192 ObjectNotKnown, 01193 FederateNotExecutionMember, 01194 ConcurrentAccessAttempted, 01195 RTIinternalError); 01196 01197 // 10.12 01198 SpaceHandle // returned C3 01199 getRoutingSpaceHandle ( 01200 const char *theName) // supplied C4 01201 throw ( 01202 NameNotFound, 01203 FederateNotExecutionMember, 01204 ConcurrentAccessAttempted, 01205 RTIinternalError); 01206 01207 // 10.13 01208 char * // returned C6 01209 getRoutingSpaceName ( 01210 // 01211 // This const was removed for the RTI 1.3 NG to work around a limitation of 01212 // the Sun 4.2 C++ compiler regarding template instantiation. The const 01213 // is unnecessary. 01214 // 01215 /* const */ SpaceHandle theHandle) // supplied C4 01216 throw ( 01217 SpaceNotDefined, 01218 FederateNotExecutionMember, 01219 ConcurrentAccessAttempted, 01220 RTIinternalError); 01221 01222 // 10.14 01223 DimensionHandle // returned C3 01224 getDimensionHandle ( 01225 const char *theName, // supplied C4 01226 SpaceHandle whichSpace) // supplied C1 01227 throw ( 01228 SpaceNotDefined, 01229 NameNotFound, 01230 FederateNotExecutionMember, 01231 ConcurrentAccessAttempted, 01232 RTIinternalError); 01233 01234 // 10.15 01235 char * // returned C6 01236 getDimensionName ( 01237 DimensionHandle theHandle, // supplied C1 01238 SpaceHandle whichSpace) // supplied C1 01239 throw ( 01240 SpaceNotDefined, 01241 DimensionNotDefined, 01242 FederateNotExecutionMember, 01243 ConcurrentAccessAttempted, 01244 RTIinternalError); 01245 01246 // 10.16 01247 SpaceHandle // returned C3 01248 getAttributeRoutingSpaceHandle ( 01249 AttributeHandle theHandle, // supplied C1 01250 ObjectClassHandle whichClass) // supplied C1 01251 throw ( 01252 ObjectClassNotDefined, 01253 AttributeNotDefined, 01254 FederateNotExecutionMember, 01255 ConcurrentAccessAttempted, 01256 RTIinternalError); 01257 01258 // 10.17 01259 ObjectClassHandle // returned C3 01260 getObjectClass ( 01261 ObjectHandle theObject) // supplied C1 01262 throw ( 01263 ObjectNotKnown, 01264 FederateNotExecutionMember, 01265 ConcurrentAccessAttempted, 01266 RTIinternalError); 01267 01268 // 10.18 01269 SpaceHandle // returned C3 01270 getInteractionRoutingSpaceHandle ( 01271 InteractionClassHandle theHandle) // supplied C1 01272 throw ( 01273 InteractionClassNotDefined, 01274 FederateNotExecutionMember, 01275 ConcurrentAccessAttempted, 01276 RTIinternalError); 01277 01278 // 10.19 01279 TransportationHandle // returned C3 01280 getTransportationHandle ( 01281 const char *theName) // supplied C4 01282 throw ( 01283 NameNotFound, 01284 FederateNotExecutionMember, 01285 ConcurrentAccessAttempted, 01286 RTIinternalError); 01287 01288 // 10.20 01289 char * // returned C6 01290 getTransportationName ( 01291 TransportationHandle theHandle) // supplied C1 01292 throw ( 01293 InvalidTransportationHandle, 01294 FederateNotExecutionMember, 01295 ConcurrentAccessAttempted, 01296 RTIinternalError); 01297 01298 // 10.21 01299 OrderingHandle // returned C3 01300 getOrderingHandle ( 01301 const char *theName) // supplied C4 01302 throw ( 01303 NameNotFound, 01304 FederateNotExecutionMember, 01305 ConcurrentAccessAttempted, 01306 RTIinternalError); 01307 01308 // 10.22 01309 char * // returned C6 01310 getOrderingName ( 01311 OrderingHandle theHandle) // supplied C1 01312 throw ( 01313 InvalidOrderingHandle, 01314 FederateNotExecutionMember, 01315 ConcurrentAccessAttempted, 01316 RTIinternalError); 01317 01318 // 10.23 01319 void enableClassRelevanceAdvisorySwitch() 01320 throw( 01321 FederateNotExecutionMember, 01322 ConcurrentAccessAttempted, 01323 SaveInProgress, 01324 RestoreInProgress, 01325 RTIinternalError); 01326 01327 // 10.24 01328 void disableClassRelevanceAdvisorySwitch() 01329 throw( 01330 FederateNotExecutionMember, 01331 ConcurrentAccessAttempted, 01332 SaveInProgress, 01333 RestoreInProgress, 01334 RTIinternalError); 01335 01336 // 10.25 01337 void enableAttributeRelevanceAdvisorySwitch() 01338 throw( 01339 FederateNotExecutionMember, 01340 ConcurrentAccessAttempted, 01341 SaveInProgress, 01342 RestoreInProgress, 01343 RTIinternalError); 01344 01345 // 10.26 01346 void disableAttributeRelevanceAdvisorySwitch() 01347 throw( 01348 FederateNotExecutionMember, 01349 ConcurrentAccessAttempted, 01350 SaveInProgress, 01351 RestoreInProgress, 01352 RTIinternalError); 01353 01354 // 10.27 01355 void enableAttributeScopeAdvisorySwitch() 01356 throw( 01357 FederateNotExecutionMember, 01358 ConcurrentAccessAttempted, 01359 SaveInProgress, 01360 RestoreInProgress, 01361 RTIinternalError); 01362 01363 // 10.28 01364 void disableAttributeScopeAdvisorySwitch() 01365 throw( 01366 FederateNotExecutionMember, 01367 ConcurrentAccessAttempted, 01368 SaveInProgress, 01369 RestoreInProgress, 01370 RTIinternalError); 01371 01372 // 10.29 01373 void enableInteractionRelevanceAdvisorySwitch() 01374 throw( 01375 FederateNotExecutionMember, 01376 ConcurrentAccessAttempted, 01377 SaveInProgress, 01378 RestoreInProgress, 01379 RTIinternalError); 01380 01381 // 10.30 01382 void disableInteractionRelevanceAdvisorySwitch() 01383 throw( 01384 FederateNotExecutionMember, 01385 ConcurrentAccessAttempted, 01386 SaveInProgress, 01387 RestoreInProgress, 01388 RTIinternalError); 01389 01390 // 01391 Boolean // returned C3 01392 tick () 01393 throw ( 01394 SpecifiedSaveLabelDoesNotExist, 01395 ConcurrentAccessAttempted, 01396 RTIinternalError); 01397 01398 Boolean // returned C3 01399 tick ( 01400 TickTime minimum, // supplied C1 01401 TickTime maximum) // supplied C1 01402 throw ( 01403 SpecifiedSaveLabelDoesNotExist, 01404 ConcurrentAccessAttempted, 01405 RTIinternalError); 01406 01407 RTIambassador() 01408 throw ( 01409 MemoryExhausted, 01410 RTIinternalError); 01411 01412 ~RTIambassador() 01413 throw (RTIinternalError); 01414 01415 RegionToken 01416 getRegionToken( 01417 Region *) 01418 throw( 01419 FederateNotExecutionMember, 01420 ConcurrentAccessAttempted, 01421 RegionNotKnown, 01422 RTIinternalError); 01423 01424 Region * 01425 getRegion( 01426 RegionToken) 01427 throw( 01428 FederateNotExecutionMember, 01429 ConcurrentAccessAttempted, 01430 RegionNotKnown, 01431 RTIinternalError); 01432 01433 01434