 |
VR-Link API Documentation for HLA 1.3
|
|
VR-Link API Documentation for HLA 1.3
|
00001 /******************************************************************************* 00002 ** Copyright (c) 1992-2010 VT MAK 00003 ** All rights reserved. 00004 *******************************************************************************/ 00005 00006 00007 #if DtHLA 00008 #if DtHLA_1516 00009 #ifndef DtHLA_1516_EVOLVED 00010 00013 00014 #pragma once 00015 #include <RTI/Exception.h> 00016 #include <RTI/FederateAmbassador.h> 00017 00018 #include "rtiNamespace.h" 00019 #include <vlutil/vlMachineTypes.h> 00020 00021 class DT_DLL_VL DtNullFederateAmbassador : public RTI::FederateAmbassador 00022 { 00023 public: 00024 DtNullFederateAmbassador() 00025 throw (RTI::FederateInternalError) {}; 00026 00027 virtual 00028 ~DtNullFederateAmbassador() 00029 throw () {}; 00030 00031 protected: 00032 00034 DtNullFederateAmbassador( const DtNullFederateAmbassador& src ); 00036 DtNullFederateAmbassador& operator=( const DtNullFederateAmbassador& src ); 00037 00038 public: 00040 virtual 00041 void 00042 synchronizationPointRegistrationSucceeded(std::wstring const & label) 00043 throw (RTI::FederateInternalError) {} 00044 00045 virtual 00046 void 00047 synchronizationPointRegistrationFailed(std::wstring const & label, 00048 RTI::SynchronizationFailureReason reason) 00049 throw (RTI::FederateInternalError) {} 00050 00052 virtual 00053 void 00054 announceSynchronizationPoint(std::wstring const & label, 00055 RTI::VariableLengthData const & theUserSuppliedTag) 00056 throw (RTI::FederateInternalError) {} 00057 00059 virtual 00060 void 00061 federationSynchronized(std::wstring const & label) 00062 throw (RTI::FederateInternalError) {} 00063 00065 virtual 00066 void 00067 initiateFederateSave(std::wstring const & label) 00068 throw (RTI::UnableToPerformSave, 00069 RTI::FederateInternalError) {} 00070 00071 virtual 00072 void 00073 initiateFederateSave(std::wstring const & label, 00074 RTI::LogicalTime const & theTime) 00075 throw (RTI::UnableToPerformSave, 00076 RTI::InvalidLogicalTime, 00077 RTI::FederateInternalError) {} 00078 00080 virtual 00081 void 00082 federationSaved() 00083 throw (RTI::FederateInternalError) {} 00084 00085 virtual 00086 void 00087 federationNotSaved(RTI::SaveFailureReason theSaveFailureReason) 00088 throw (RTI::FederateInternalError) {} 00089 00090 00092 virtual 00093 void 00094 federationSaveStatusResponse( 00095 RTI::FederateHandleSaveStatusPairVector const & theFederateStatusVector) 00096 throw (RTI::FederateInternalError) {} 00097 00099 virtual 00100 void 00101 requestFederationRestoreSucceeded(std::wstring const & label) 00102 throw (RTI::FederateInternalError) {} 00103 00104 virtual 00105 void 00106 requestFederationRestoreFailed(std::wstring const & label) 00107 throw (RTI::FederateInternalError) {} 00108 00110 virtual 00111 void 00112 federationRestoreBegun() 00113 throw (RTI::FederateInternalError) {} 00114 00116 virtual 00117 void 00118 initiateFederateRestore(std::wstring const & label, 00119 RTI::FederateHandle handle) 00120 throw (RTI::SpecifiedSaveLabelDoesNotExist, 00121 RTI::CouldNotInitiateRestore, 00122 RTI::FederateInternalError) {} 00123 00125 virtual 00126 void 00127 federationRestored() 00128 throw (RTI::FederateInternalError) {} 00129 00130 virtual 00131 void 00132 federationNotRestored(RTI::RestoreFailureReason theRestoreFailureReason) 00133 throw (RTI::FederateInternalError) {} 00134 00136 virtual 00137 void 00138 federationRestoreStatusResponse( 00139 RTI::FederateHandleRestoreStatusPairVector const & theFederateStatusVector) 00140 throw (RTI::FederateInternalError) {} 00141 00145 00147 virtual 00148 void 00149 startRegistrationForObjectClass(RTI::ObjectClassHandle theClass) 00150 throw (RTI::ObjectClassNotPublished, 00151 RTI::FederateInternalError) {} 00152 00154 virtual 00155 void 00156 stopRegistrationForObjectClass(RTI::ObjectClassHandle theClass) 00157 throw (RTI::ObjectClassNotPublished, 00158 RTI::FederateInternalError) {} 00159 00161 virtual 00162 void 00163 turnInteractionsOn(RTI::InteractionClassHandle theHandle) 00164 throw (RTI::InteractionClassNotPublished, 00165 RTI::FederateInternalError) {} 00166 00168 virtual 00169 void 00170 turnInteractionsOff(RTI::InteractionClassHandle theHandle) 00171 throw (RTI::InteractionClassNotPublished, 00172 RTI::FederateInternalError) {} 00173 00177 00179 virtual 00180 void 00181 objectInstanceNameReservationSucceeded(std::wstring const & 00182 theObjectInstanceName) 00183 throw (RTI::UnknownName, 00184 RTI::FederateInternalError) {} 00185 00186 virtual 00187 void 00188 objectInstanceNameReservationFailed(std::wstring const & 00189 theObjectInstanceName) 00190 throw (RTI::UnknownName, 00191 RTI::FederateInternalError) {} 00192 00193 00195 virtual 00196 void 00197 discoverObjectInstance(RTI::ObjectInstanceHandle theObject, 00198 RTI::ObjectClassHandle theObjectClass, 00199 std::wstring const & theObjectInstanceName) 00200 throw (RTI::CouldNotDiscover, 00201 RTI::ObjectClassNotKnown, 00202 RTI::FederateInternalError) {} 00203 00205 virtual 00206 void 00207 reflectAttributeValues 00208 (RTI::ObjectInstanceHandle theObject, 00209 RTI::AttributeHandleValueMap const & theAttributeValues, 00210 RTI::VariableLengthData const & theUserSuppliedTag, 00211 RTI::OrderType sentOrder, 00212 RTI::TransportationType theType) 00213 throw (RTI::ObjectInstanceNotKnown, 00214 RTI::AttributeNotRecognized, 00215 RTI::AttributeNotSubscribed, 00216 RTI::FederateInternalError) {} 00217 00218 virtual 00219 void 00220 reflectAttributeValues 00221 (RTI::ObjectInstanceHandle theObject, 00222 RTI::AttributeHandleValueMap const & theAttributeValues, 00223 RTI::VariableLengthData const & theUserSuppliedTag, 00224 RTI::OrderType sentOrder, 00225 RTI::TransportationType theType, 00226 RTI::RegionHandleSet const & theSentRegionHandleSet) 00227 throw (RTI::ObjectInstanceNotKnown, 00228 RTI::AttributeNotRecognized, 00229 RTI::AttributeNotSubscribed, 00230 RTI::FederateInternalError) {} 00231 00232 virtual 00233 void 00234 reflectAttributeValues 00235 (RTI::ObjectInstanceHandle theObject, 00236 RTI::AttributeHandleValueMap const & theAttributeValues, 00237 RTI::VariableLengthData const & theUserSuppliedTag, 00238 RTI::OrderType sentOrder, 00239 RTI::TransportationType theType, 00240 RTI:: LogicalTime const & theTime, 00241 RTI:: OrderType receivedOrder) 00242 throw (RTI::ObjectInstanceNotKnown, 00243 RTI::AttributeNotRecognized, 00244 RTI::AttributeNotSubscribed, 00245 RTI::FederateInternalError) {} 00246 00247 virtual 00248 void 00249 reflectAttributeValues 00250 (RTI::ObjectInstanceHandle theObject, 00251 RTI::AttributeHandleValueMap const & theAttributeValues, 00252 RTI::VariableLengthData const & theUserSuppliedTag, 00253 RTI::OrderType sentOrder, 00254 RTI::TransportationType theType, 00255 RTI::LogicalTime const & theTime, 00256 RTI::OrderType receivedOrder, 00257 RTI::RegionHandleSet const & theSentRegionHandleSet) 00258 throw (RTI::ObjectInstanceNotKnown, 00259 RTI::AttributeNotRecognized, 00260 RTI::AttributeNotSubscribed, 00261 RTI::FederateInternalError) {} 00262 00263 virtual 00264 void 00265 reflectAttributeValues 00266 (RTI::ObjectInstanceHandle theObject, 00267 RTI::AttributeHandleValueMap const & theAttributeValues, 00268 RTI::VariableLengthData const & theUserSuppliedTag, 00269 RTI::OrderType sentOrder, 00270 RTI::TransportationType theType, 00271 RTI::LogicalTime const & theTime, 00272 RTI::OrderType receivedOrder, 00273 RTI::MessageRetractionHandle theHandle) 00274 throw (RTI::ObjectInstanceNotKnown, 00275 RTI::AttributeNotRecognized, 00276 RTI::AttributeNotSubscribed, 00277 RTI::InvalidLogicalTime, 00278 RTI::FederateInternalError) {} 00279 00280 virtual 00281 void 00282 reflectAttributeValues 00283 (RTI::ObjectInstanceHandle theObject, 00284 RTI::AttributeHandleValueMap const & theAttributeValues, 00285 RTI::VariableLengthData const & theUserSuppliedTag, 00286 RTI::OrderType sentOrder, 00287 RTI::TransportationType theType, 00288 RTI::LogicalTime const & theTime, 00289 RTI::OrderType receivedOrder, 00290 RTI::MessageRetractionHandle theHandle, 00291 RTI::RegionHandleSet const & theSentRegionHandleSet) 00292 throw (RTI::ObjectInstanceNotKnown, 00293 RTI::AttributeNotRecognized, 00294 RTI::AttributeNotSubscribed, 00295 RTI::InvalidLogicalTime, 00296 RTI::FederateInternalError) {} 00297 00299 virtual 00300 void 00301 receiveInteraction 00302 (RTI::InteractionClassHandle theInteraction, 00303 RTI::ParameterHandleValueMap const & theParameterValues, 00304 RTI::VariableLengthData const & theUserSuppliedTag, 00305 RTI::OrderType sentOrder, 00306 RTI::TransportationType theType) 00307 throw (RTI::InteractionClassNotRecognized, 00308 RTI::InteractionParameterNotRecognized, 00309 RTI::InteractionClassNotSubscribed, 00310 RTI::FederateInternalError) {} 00311 00312 virtual 00313 void 00314 receiveInteraction 00315 (RTI::InteractionClassHandle theInteraction, 00316 RTI::ParameterHandleValueMap const & theParameterValues, 00317 RTI::VariableLengthData const & theUserSuppliedTag, 00318 RTI::OrderType sentOrder, 00319 RTI::TransportationType theType, 00320 RTI::RegionHandleSet const & theSentRegionHandleSet) 00321 throw (RTI::InteractionClassNotRecognized, 00322 RTI::InteractionParameterNotRecognized, 00323 RTI::InteractionClassNotSubscribed, 00324 RTI::FederateInternalError) {} 00325 00326 virtual 00327 void 00328 receiveInteraction 00329 (RTI::InteractionClassHandle theInteraction, 00330 RTI::ParameterHandleValueMap const & theParameterValues, 00331 RTI::VariableLengthData const & theUserSuppliedTag, 00332 RTI::OrderType sentOrder, 00333 RTI::TransportationType theType, 00334 RTI::LogicalTime const & theTime, 00335 RTI::OrderType receivedOrder) 00336 throw (RTI::InteractionClassNotRecognized, 00337 RTI::InteractionParameterNotRecognized, 00338 RTI::InteractionClassNotSubscribed, 00339 RTI::FederateInternalError) {} 00340 00341 virtual 00342 void 00343 receiveInteraction 00344 (RTI::InteractionClassHandle theInteraction, 00345 RTI::ParameterHandleValueMap const & theParameterValues, 00346 RTI::VariableLengthData const & theUserSuppliedTag, 00347 RTI::OrderType sentOrder, 00348 RTI::TransportationType theType, 00349 RTI::LogicalTime const & theTime, 00350 RTI::OrderType receivedOrder, 00351 RTI::RegionHandleSet const & theSentRegionHandleSet) 00352 throw (RTI::InteractionClassNotRecognized, 00353 RTI::InteractionParameterNotRecognized, 00354 RTI::InteractionClassNotSubscribed, 00355 RTI::FederateInternalError) {} 00356 00357 virtual 00358 void 00359 receiveInteraction 00360 (RTI::InteractionClassHandle theInteraction, 00361 RTI::ParameterHandleValueMap const & theParameterValues, 00362 RTI::VariableLengthData const & theUserSuppliedTag, 00363 RTI::OrderType sentOrder, 00364 RTI::TransportationType theType, 00365 RTI::LogicalTime const & theTime, 00366 RTI::OrderType receivedOrder, 00367 RTI::MessageRetractionHandle theHandle) 00368 throw (RTI::InteractionClassNotRecognized, 00369 RTI::InteractionParameterNotRecognized, 00370 RTI::InteractionClassNotSubscribed, 00371 RTI::InvalidLogicalTime, 00372 RTI::FederateInternalError) {} 00373 00374 virtual 00375 void 00376 receiveInteraction 00377 (RTI::InteractionClassHandle theInteraction, 00378 RTI::ParameterHandleValueMap const & theParameterValues, 00379 RTI::VariableLengthData const & theUserSuppliedTag, 00380 RTI::OrderType sentOrder, 00381 RTI::TransportationType theType, 00382 RTI::LogicalTime const & theTime, 00383 RTI::OrderType receivedOrder, 00384 RTI::MessageRetractionHandle theHandle, 00385 RTI::RegionHandleSet const & theSentRegionHandleSet) 00386 throw (RTI::InteractionClassNotRecognized, 00387 RTI::InteractionParameterNotRecognized, 00388 RTI::InteractionClassNotSubscribed, 00389 RTI::InvalidLogicalTime, 00390 RTI::FederateInternalError) {} 00391 00393 virtual 00394 void 00395 removeObjectInstance(RTI::ObjectInstanceHandle theObject, 00396 RTI::VariableLengthData const & theUserSuppliedTag, 00397 RTI::OrderType sentOrder) 00398 throw (RTI::ObjectInstanceNotKnown, 00399 RTI::FederateInternalError) {} 00400 00401 virtual 00402 void 00403 removeObjectInstance(RTI::ObjectInstanceHandle theObject, 00404 RTI::VariableLengthData const & theUserSuppliedTag, 00405 RTI::OrderType sentOrder, 00406 RTI::LogicalTime const & theTime, 00407 RTI::OrderType receivedOrder) 00408 throw (RTI::ObjectInstanceNotKnown, 00409 RTI::FederateInternalError) {} 00410 00411 virtual 00412 void 00413 removeObjectInstance(RTI::ObjectInstanceHandle theObject, 00414 RTI::VariableLengthData const & theUserSuppliedTag, 00415 RTI::OrderType sentOrder, 00416 RTI::LogicalTime const & theTime, 00417 RTI::OrderType receivedOrder, 00418 RTI::MessageRetractionHandle theHandle) 00419 throw (RTI::ObjectInstanceNotKnown, 00420 RTI::InvalidLogicalTime, 00421 RTI::FederateInternalError) {} 00422 00424 virtual 00425 void 00426 attributesInScope 00427 (RTI::ObjectInstanceHandle theObject, 00428 RTI::AttributeHandleSet const & theAttributes) 00429 throw (RTI::ObjectInstanceNotKnown, 00430 RTI::AttributeNotRecognized, 00431 RTI::AttributeNotSubscribed, 00432 RTI::FederateInternalError) {} 00433 00435 virtual 00436 void 00437 attributesOutOfScope 00438 (RTI::ObjectInstanceHandle theObject, 00439 RTI::AttributeHandleSet const & theAttributes) 00440 throw (RTI::ObjectInstanceNotKnown, 00441 RTI::AttributeNotRecognized, 00442 RTI::AttributeNotSubscribed, 00443 RTI::FederateInternalError) {} 00444 00446 virtual 00447 void 00448 provideAttributeValueUpdate 00449 (RTI::ObjectInstanceHandle theObject, 00450 RTI::AttributeHandleSet const & theAttributes, 00451 RTI::VariableLengthData const & theUserSuppliedTag) 00452 throw (RTI::ObjectInstanceNotKnown, 00453 RTI::AttributeNotRecognized, 00454 RTI::AttributeNotOwned, 00455 RTI::FederateInternalError) {} 00456 00458 virtual 00459 void 00460 turnUpdatesOnForObjectInstance 00461 (RTI::ObjectInstanceHandle theObject, 00462 RTI::AttributeHandleSet const & theAttributes) 00463 throw (RTI::ObjectInstanceNotKnown, 00464 RTI::AttributeNotRecognized, 00465 RTI::AttributeNotOwned, 00466 RTI::FederateInternalError) {} 00467 00469 virtual 00470 void 00471 turnUpdatesOffForObjectInstance 00472 (RTI::ObjectInstanceHandle theObject, 00473 RTI::AttributeHandleSet const & theAttributes) 00474 throw (RTI::ObjectInstanceNotKnown, 00475 RTI::AttributeNotRecognized, 00476 RTI::AttributeNotOwned, 00477 RTI::FederateInternalError) {} 00478 00482 00484 virtual 00485 void 00486 requestAttributeOwnershipAssumption 00487 (RTI::ObjectInstanceHandle theObject, 00488 RTI::AttributeHandleSet const & theAttributes, 00489 RTI::VariableLengthData const & theUserSuppliedTag) 00490 throw (RTI::ObjectInstanceNotKnown, 00491 RTI::AttributeNotRecognized, 00492 RTI::AttributeAlreadyOwned, 00493 RTI::AttributeNotPublished, 00494 RTI::FederateInternalError) {} 00495 00497 virtual 00498 void 00499 requestDivestitureConfirmation 00500 (RTI::ObjectInstanceHandle theObject, 00501 RTI::AttributeHandleSet const & theAttributes) 00502 throw (RTI::ObjectInstanceNotKnown, 00503 RTI::AttributeNotRecognized, 00504 RTI::AttributeNotOwned, 00505 RTI::AttributeDivestitureWasNotRequested, 00506 RTI::FederateInternalError) {} 00507 00509 virtual 00510 void 00511 attributeOwnershipAcquisitionNotification 00512 (RTI::ObjectInstanceHandle theObject, 00513 RTI::AttributeHandleSet const & theAttributes, 00514 RTI::VariableLengthData const & theUserSuppliedTag) 00515 throw (RTI::ObjectInstanceNotKnown, 00516 RTI::AttributeNotRecognized, 00517 RTI::AttributeAcquisitionWasNotRequested, 00518 RTI::AttributeAlreadyOwned, 00519 RTI::AttributeNotPublished, 00520 RTI::FederateInternalError) {} 00521 00523 virtual 00524 void 00525 attributeOwnershipUnavailable 00526 (RTI::ObjectInstanceHandle theObject, 00527 RTI::AttributeHandleSet const & theAttributes) 00528 throw (RTI::ObjectInstanceNotKnown, 00529 RTI::AttributeNotRecognized, 00530 RTI::AttributeAlreadyOwned, 00531 RTI::AttributeAcquisitionWasNotRequested, 00532 RTI::FederateInternalError) {} 00533 00535 virtual 00536 void 00537 requestAttributeOwnershipRelease 00538 (RTI::ObjectInstanceHandle theObject, 00539 RTI::AttributeHandleSet const & theAttributes, 00540 RTI::VariableLengthData const & theUserSuppliedTag) 00541 throw (RTI::ObjectInstanceNotKnown, 00542 RTI::AttributeNotRecognized, 00543 RTI::AttributeNotOwned, 00544 RTI::FederateInternalError) {} 00545 00547 virtual 00548 void 00549 confirmAttributeOwnershipAcquisitionCancellation 00550 (RTI::ObjectInstanceHandle theObject, 00551 RTI::AttributeHandleSet const & theAttributes) 00552 throw (RTI::ObjectInstanceNotKnown, 00553 RTI::AttributeNotRecognized, 00554 RTI::AttributeAlreadyOwned, 00555 RTI::AttributeAcquisitionWasNotCanceled, 00556 RTI::FederateInternalError) {} 00557 00559 virtual 00560 void 00561 informAttributeOwnership(RTI::ObjectInstanceHandle theObject, 00562 RTI::AttributeHandle theAttribute, 00563 RTI::FederateHandle theOwner) 00564 throw (RTI::ObjectInstanceNotKnown, 00565 RTI::AttributeNotRecognized, 00566 RTI::FederateInternalError) {} 00567 00568 virtual 00569 void 00570 attributeIsNotOwned(RTI::ObjectInstanceHandle theObject, 00571 RTI::AttributeHandle theAttribute) 00572 throw (RTI::ObjectInstanceNotKnown, 00573 RTI::AttributeNotRecognized, 00574 RTI::FederateInternalError) {} 00575 00576 virtual 00577 void 00578 attributeIsOwnedByRTI(RTI::ObjectInstanceHandle theObject, 00579 RTI::AttributeHandle theAttribute) 00580 throw (RTI::ObjectInstanceNotKnown, 00581 RTI::AttributeNotRecognized, 00582 RTI::FederateInternalError) {} 00583 00587 00589 virtual 00590 void 00591 timeRegulationEnabled(RTI::LogicalTime const & theFederateTime) 00592 throw (RTI::InvalidLogicalTime, 00593 RTI::NoRequestToEnableTimeRegulationWasPending, 00594 RTI::FederateInternalError) {} 00595 00597 virtual 00598 void 00599 timeConstrainedEnabled(RTI::LogicalTime const & theFederateTime) 00600 throw (RTI::InvalidLogicalTime, 00601 RTI::NoRequestToEnableTimeConstrainedWasPending, 00602 RTI::FederateInternalError) {} 00603 00605 virtual 00606 void 00607 timeAdvanceGrant(RTI::LogicalTime const & theTime) 00608 throw (RTI::InvalidLogicalTime, 00609 RTI::JoinedFederateIsNotInTimeAdvancingState, 00610 RTI::FederateInternalError) {} 00611 00613 virtual 00614 void 00615 requestRetraction(RTI::MessageRetractionHandle theHandle) 00616 throw (RTI::FederateInternalError) {} 00617 }; 00618 00619 #endif 00620 #endif 00621 #endif 00622 00623