 |
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 #if DtHLA_1516_EVOLVED 00010 00013 00014 #pragma once 00015 00016 #include <RTI/Exception.h> 00017 #include <RTI/FederateAmbassador.h> 00018 00019 #include "rtiNamespace.h" 00020 #include <vlutil/vlMachineTypes.h> 00021 00022 class DT_DLL_VL DtNullFederateAmbassador : public RTI::FederateAmbassador 00023 { 00024 public: 00025 DtNullFederateAmbassador() 00026 throw (RTI::FederateInternalError) {} 00027 00028 virtual 00029 ~DtNullFederateAmbassador() 00030 throw () {} 00031 00032 protected: 00033 00035 DtNullFederateAmbassador( const DtNullFederateAmbassador& src ); 00037 DtNullFederateAmbassador& operator=( const DtNullFederateAmbassador& src ); 00038 00039 00040 00041 // 4.4 00042 virtual void connectionLost ( 00043 std::wstring const & faultDescription) 00044 throw ( 00045 RTI::FederateInternalError) {} 00046 00047 // 4.8 00048 virtual void reportFederationExecutions ( 00049 RTI::FederationExecutionInformationVector const & 00050 theFederationExecutionInformationList) 00051 throw ( 00052 RTI::FederateInternalError) {} 00053 00054 // 4.12 00055 virtual void synchronizationPointRegistrationSucceeded ( 00056 std::wstring const & label) 00057 throw ( 00058 RTI::FederateInternalError) {} 00059 00060 virtual void synchronizationPointRegistrationFailed ( 00061 std::wstring const & label, 00062 RTI::SynchronizationPointFailureReason reason) 00063 throw ( 00064 RTI::FederateInternalError) {} 00065 00066 // 4.13 00067 virtual void announceSynchronizationPoint ( 00068 std::wstring const & label, 00069 RTI::VariableLengthData const & theUserSuppliedTag) 00070 throw ( 00071 RTI::FederateInternalError) {} 00072 00073 // 4.15 00074 virtual void federationSynchronized ( 00075 std::wstring const & label, 00076 RTI::FederateHandleSet const& failedToSyncSet) 00077 throw ( 00078 RTI::FederateInternalError) {} 00079 00080 // 4.17 00081 virtual void initiateFederateSave ( 00082 std::wstring const & label) 00083 throw ( 00084 RTI::FederateInternalError) {} 00085 00086 virtual void initiateFederateSave ( 00087 std::wstring const & label, 00088 RTI::LogicalTime const & theTime) 00089 throw ( 00090 RTI::FederateInternalError) {} 00091 00092 // 4.20 00093 virtual void federationSaved () 00094 throw ( 00095 RTI::FederateInternalError) {} 00096 00097 virtual void federationNotSaved ( 00098 RTI::SaveFailureReason theSaveFailureReason) 00099 throw ( 00100 RTI::FederateInternalError) {} 00101 00102 00103 // 4.23 00104 virtual void federationSaveStatusResponse ( 00105 RTI::FederateHandleSaveStatusPairVector const & 00106 theFederateStatusVector) 00107 throw ( 00108 RTI::FederateInternalError) {} 00109 00110 // 4.25 00111 virtual void requestFederationRestoreSucceeded ( 00112 std::wstring const & label) 00113 throw ( 00114 RTI::FederateInternalError) {} 00115 00116 virtual void requestFederationRestoreFailed ( 00117 std::wstring const & label) 00118 throw ( 00119 RTI::FederateInternalError) {} 00120 00121 // 4.26 00122 virtual void federationRestoreBegun () 00123 throw ( 00124 RTI::FederateInternalError) {} 00125 00126 // 4.27 00127 virtual void initiateFederateRestore ( 00128 std::wstring const & label, 00129 std::wstring const & federateName, 00130 RTI::FederateHandle handle) 00131 throw ( 00132 RTI::FederateInternalError) {} 00133 00134 // 4.29 00135 virtual void federationRestored () 00136 throw ( 00137 RTI::FederateInternalError) {} 00138 00139 virtual void federationNotRestored ( 00140 RTI::RestoreFailureReason theRestoreFailureReason) 00141 throw ( 00142 RTI::FederateInternalError) {} 00143 00144 // 4.32 00145 virtual void federationRestoreStatusResponse ( 00146 RTI::FederateRestoreStatusVector const & 00147 theFederateRestoreStatusVector) 00148 throw ( 00149 RTI::FederateInternalError) {} 00150 00152 // Declaration Management Services // 00154 00155 // 5.10 00156 virtual void startRegistrationForObjectClass ( 00157 RTI::ObjectClassHandle theClass) 00158 throw ( 00159 RTI::FederateInternalError) {} 00160 00161 // 5.11 00162 virtual void stopRegistrationForObjectClass ( 00163 RTI::ObjectClassHandle theClass) 00164 throw ( 00165 RTI::FederateInternalError) {} 00166 00167 // 5.12 00168 virtual void turnInteractionsOn ( 00169 RTI::InteractionClassHandle theHandle) 00170 throw ( 00171 RTI::FederateInternalError) {} 00172 00173 // 5.13 00174 virtual void turnInteractionsOff ( 00175 RTI::InteractionClassHandle theHandle) 00176 throw ( 00177 RTI::FederateInternalError) {} 00178 00180 // Object Management Services // 00182 00183 // 6.3 00184 virtual void objectInstanceNameReservationSucceeded ( 00185 std::wstring const & theObjectInstanceName) 00186 throw ( 00187 RTI::FederateInternalError) {} 00188 00189 virtual void objectInstanceNameReservationFailed ( 00190 std::wstring const & theObjectInstanceName) 00191 throw ( 00192 RTI::FederateInternalError) {} 00193 00194 // 6.6 00195 virtual void multipleObjectInstanceNameReservationSucceeded ( 00196 std::set<std::wstring> const & theObjectInstanceNames) 00197 throw ( 00198 RTI::FederateInternalError) {} 00199 00200 virtual void multipleObjectInstanceNameReservationFailed ( 00201 std::set<std::wstring> const & theObjectInstanceNames) 00202 throw ( 00203 RTI::FederateInternalError) {} 00204 00205 00206 // 6.9 00207 virtual void discoverObjectInstance ( 00208 RTI::ObjectInstanceHandle theObject, 00209 RTI::ObjectClassHandle theObjectClass, 00210 std::wstring const & theObjectInstanceName) 00211 throw ( 00212 RTI::FederateInternalError) {} 00213 00214 virtual void discoverObjectInstance ( 00215 RTI::ObjectInstanceHandle theObject, 00216 RTI::ObjectClassHandle theObjectClass, 00217 std::wstring const & theObjectInstanceName, 00218 RTI::FederateHandle producingFederate) 00219 throw ( 00220 RTI::FederateInternalError) {} 00221 00222 // 6.11 00223 virtual void reflectAttributeValues ( 00224 RTI::ObjectInstanceHandle theObject, 00225 RTI::AttributeHandleValueMap const & theAttributeValues, 00226 RTI::VariableLengthData const & theUserSuppliedTag, 00227 RTI::OrderType sentOrder, 00228 RTI::TransportationType theType, 00229 RTI::SupplementalReflectInfo theReflectInfo) 00230 throw ( 00231 RTI::FederateInternalError) {} 00232 00233 virtual void reflectAttributeValues ( 00234 RTI::ObjectInstanceHandle theObject, 00235 RTI::AttributeHandleValueMap const & theAttributeValues, 00236 RTI::VariableLengthData const & theUserSuppliedTag, 00237 RTI::OrderType sentOrder, 00238 RTI::TransportationType theType, 00239 RTI::LogicalTime const & theTime, 00240 RTI::OrderType receivedOrder, 00241 RTI::SupplementalReflectInfo theReflectInfo) 00242 throw ( 00243 RTI::FederateInternalError) {} 00244 00245 virtual void reflectAttributeValues ( 00246 RTI::ObjectInstanceHandle theObject, 00247 RTI::AttributeHandleValueMap const & theAttributeValues, 00248 RTI::VariableLengthData const & theUserSuppliedTag, 00249 RTI::OrderType sentOrder, 00250 RTI::TransportationType theType, 00251 RTI::LogicalTime const & theTime, 00252 RTI::OrderType receivedOrder, 00253 RTI::MessageRetractionHandle theHandle, 00254 RTI::SupplementalReflectInfo theReflectInfo) 00255 throw ( 00256 RTI::FederateInternalError) {} 00257 00258 // 6.13 00259 virtual void receiveInteraction ( 00260 RTI::InteractionClassHandle theInteraction, 00261 RTI::ParameterHandleValueMap const & theParameterValues, 00262 RTI::VariableLengthData const & theUserSuppliedTag, 00263 RTI::OrderType sentOrder, 00264 RTI::TransportationType theType, 00265 RTI::SupplementalReceiveInfo theReceiveInfo) 00266 throw ( 00267 RTI::FederateInternalError) {} 00268 00269 virtual void receiveInteraction ( 00270 RTI::InteractionClassHandle theInteraction, 00271 RTI::ParameterHandleValueMap const & theParameterValues, 00272 RTI::VariableLengthData const & theUserSuppliedTag, 00273 RTI::OrderType sentOrder, 00274 RTI::TransportationType theType, 00275 RTI::LogicalTime const & theTime, 00276 RTI::OrderType receivedOrder, 00277 RTI::SupplementalReceiveInfo theReceiveInfo) 00278 throw ( 00279 RTI::FederateInternalError) {} 00280 00281 virtual void receiveInteraction ( 00282 RTI::InteractionClassHandle theInteraction, 00283 RTI::ParameterHandleValueMap const & theParameterValues, 00284 RTI::VariableLengthData const & theUserSuppliedTag, 00285 RTI::OrderType sentOrder, 00286 RTI::TransportationType theType, 00287 RTI::LogicalTime const & theTime, 00288 RTI::OrderType receivedOrder, 00289 RTI::MessageRetractionHandle theHandle, 00290 RTI::SupplementalReceiveInfo theReceiveInfo) 00291 throw ( 00292 RTI::FederateInternalError) {} 00293 00294 // 6.15 00295 virtual void removeObjectInstance ( 00296 RTI::ObjectInstanceHandle theObject, 00297 RTI::VariableLengthData const & theUserSuppliedTag, 00298 RTI::OrderType sentOrder, 00299 RTI::SupplementalRemoveInfo theRemoveInfo) 00300 throw ( 00301 RTI::FederateInternalError) {} 00302 00303 virtual void removeObjectInstance ( 00304 RTI::ObjectInstanceHandle theObject, 00305 RTI::VariableLengthData const & theUserSuppliedTag, 00306 RTI::OrderType sentOrder, 00307 RTI::LogicalTime const & theTime, 00308 RTI::OrderType receivedOrder, 00309 RTI::SupplementalRemoveInfo theRemoveInfo) 00310 throw ( 00311 RTI::FederateInternalError) {} 00312 00313 virtual void removeObjectInstance ( 00314 RTI::ObjectInstanceHandle theObject, 00315 RTI::VariableLengthData const & theUserSuppliedTag, 00316 RTI::OrderType sentOrder, 00317 RTI::LogicalTime const & theTime, 00318 RTI::OrderType receivedOrder, 00319 RTI::MessageRetractionHandle theHandle, 00320 RTI::SupplementalRemoveInfo theRemoveInfo) 00321 throw ( 00322 RTI::FederateInternalError) {} 00323 00324 // 6.17 00325 virtual void attributesInScope ( 00326 RTI::ObjectInstanceHandle theObject, 00327 RTI::AttributeHandleSet const & theAttributes) 00328 throw ( 00329 RTI::FederateInternalError) {} 00330 00331 // 6.18 00332 virtual void attributesOutOfScope ( 00333 RTI::ObjectInstanceHandle theObject, 00334 RTI::AttributeHandleSet const & theAttributes) 00335 throw ( 00336 RTI::FederateInternalError) {} 00337 00338 // 6.20 00339 virtual void provideAttributeValueUpdate ( 00340 RTI::ObjectInstanceHandle theObject, 00341 RTI::AttributeHandleSet const & theAttributes, 00342 RTI::VariableLengthData const & theUserSuppliedTag) 00343 throw ( 00344 RTI::FederateInternalError) {} 00345 00346 // 6.21 00347 virtual void turnUpdatesOnForObjectInstance ( 00348 RTI::ObjectInstanceHandle theObject, 00349 RTI::AttributeHandleSet const & theAttributes) 00350 throw ( 00351 RTI::FederateInternalError) {} 00352 00353 virtual void turnUpdatesOnForObjectInstance ( 00354 RTI::ObjectInstanceHandle theObject, 00355 RTI::AttributeHandleSet const & theAttributes, 00356 std::wstring const & updateRateDesignator) 00357 throw ( 00358 RTI::FederateInternalError) {} 00359 00360 // 6.22 00361 virtual void turnUpdatesOffForObjectInstance ( 00362 RTI::ObjectInstanceHandle theObject, 00363 RTI::AttributeHandleSet const & theAttributes) 00364 throw ( 00365 RTI::FederateInternalError) {} 00366 00367 // 6.24 00368 virtual void confirmAttributeTransportationTypeChange ( 00369 RTI::ObjectInstanceHandle theObject, 00370 RTI::AttributeHandleSet theAttributes, 00371 RTI::TransportationType theTransportation) 00372 throw ( 00373 RTI::FederateInternalError) {} 00374 00375 // 6.26 00376 virtual void reportAttributeTransportationType ( 00377 RTI::ObjectInstanceHandle theObject, 00378 RTI::AttributeHandle theAttribute, 00379 RTI::TransportationType theTransportation) 00380 throw ( 00381 RTI::FederateInternalError) {} 00382 00383 // 6.28 00384 virtual void confirmInteractionTransportationTypeChange ( 00385 RTI::InteractionClassHandle theInteraction, 00386 RTI::TransportationType theTransportation) 00387 throw ( 00388 RTI::FederateInternalError) {} 00389 00390 // 6.30 00391 virtual void reportInteractionTransportationType ( 00392 RTI::FederateHandle federateHandle, 00393 RTI::InteractionClassHandle theInteraction, 00394 RTI::TransportationType theTransportation) 00395 throw ( 00396 RTI::FederateInternalError) {} 00397 00398 00400 // Ownership Management Services // 00402 00403 // 7.4 00404 virtual void requestAttributeOwnershipAssumption ( 00405 RTI::ObjectInstanceHandle theObject, 00406 RTI::AttributeHandleSet const & offeredAttributes, 00407 RTI::VariableLengthData const & theUserSuppliedTag) 00408 throw ( 00409 RTI::FederateInternalError) {} 00410 00411 // 7.5 00412 virtual void requestDivestitureConfirmation ( 00413 RTI::ObjectInstanceHandle theObject, 00414 RTI::AttributeHandleSet const & releasedAttributes) 00415 throw ( 00416 RTI::FederateInternalError) {} 00417 00418 // 7.7 00419 virtual void attributeOwnershipAcquisitionNotification ( 00420 RTI::ObjectInstanceHandle theObject, 00421 RTI::AttributeHandleSet const & securedAttributes, 00422 RTI::VariableLengthData const & theUserSuppliedTag) 00423 throw ( 00424 RTI::FederateInternalError) {} 00425 00426 // 7.10 00427 virtual void attributeOwnershipUnavailable ( 00428 RTI::ObjectInstanceHandle theObject, 00429 RTI::AttributeHandleSet const & theAttributes) 00430 throw ( 00431 RTI::FederateInternalError) {} 00432 00433 // 7.11 00434 virtual void requestAttributeOwnershipRelease ( 00435 RTI::ObjectInstanceHandle theObject, 00436 RTI::AttributeHandleSet const & candidateAttributes, 00437 RTI::VariableLengthData const & theUserSuppliedTag) 00438 throw ( 00439 RTI::FederateInternalError) {} 00440 00441 // 7.16 00442 virtual void confirmAttributeOwnershipAcquisitionCancellation ( 00443 RTI::ObjectInstanceHandle theObject, 00444 RTI::AttributeHandleSet const & theAttributes) 00445 throw ( 00446 RTI::FederateInternalError) {} 00447 00448 // 7.18 00449 virtual void informAttributeOwnership ( 00450 RTI::ObjectInstanceHandle theObject, 00451 RTI::AttributeHandle theAttribute, 00452 RTI::FederateHandle theOwner) 00453 throw ( 00454 RTI::FederateInternalError) {} 00455 00456 virtual void attributeIsNotOwned ( 00457 RTI::ObjectInstanceHandle theObject, 00458 RTI::AttributeHandle theAttribute) 00459 throw ( 00460 RTI::FederateInternalError) {} 00461 00462 virtual void attributeIsOwnedByRTI ( 00463 RTI::ObjectInstanceHandle theObject, 00464 RTI::AttributeHandle theAttribute) 00465 throw ( 00466 RTI::FederateInternalError) {} 00467 00469 // Time Management Services // 00471 00472 // 8.3 00473 virtual void timeRegulationEnabled ( 00474 RTI::LogicalTime const & theFederateTime) 00475 throw ( 00476 RTI::FederateInternalError) {} 00477 00478 // 8.6 00479 virtual void timeConstrainedEnabled ( 00480 RTI::LogicalTime const & theFederateTime) 00481 throw ( 00482 RTI::FederateInternalError) {} 00483 00484 // 8.13 00485 virtual void timeAdvanceGrant ( 00486 RTI::LogicalTime const & theTime) 00487 throw ( 00488 RTI::FederateInternalError) {} 00489 00490 // 8.22 00491 virtual void requestRetraction ( 00492 RTI::MessageRetractionHandle theHandle) 00493 throw ( 00494 RTI::FederateInternalError) {} 00495 00496 }; 00497 00498 #endif 00499 #endif 00500 #endif 00501 00502 00503