MAK RTIspy API Documentation for HLA Evolved: fedAmbCatch1516e.h Source File

Go to the documentation of this file.
00001 /*********************************************************************
00002 ** Copyright (c) 2010 MaK Technologies, Inc.
00003 ** All rights reserved.
00004 *********************************************************************/
00005 /*********************************************************************
00006 ** $RCSfile: fedAmbCatch1516e.h,v $ $Revision: 1.0 $ $State: Exp $
00007 *********************************************************************/
00008 
00011 
00012 #ifndef DtFedAmbCatch1516e_h
00013 #define DtFedAmbCatch1516e_h
00014 
00015 #ifdef DtIFSPEC1516E
00016 
00017 #include "rtiMsConfig.h"
00018 #include "fedAmbWrap1516e.h"
00019 
00020 class DtFederateMgr;
00021 
00024 class DT_DLL_LRC DtFedAmbCatch : public DtFedAmbWrapper
00025 {
00026 public:
00027 
00028     DtFedAmbCatch(DtFederateMgr* fedMgr);
00029     virtual ~DtFedAmbCatch() throw ();
00030 
00034 
00035     // 4.4
00036     virtual void connectionLost (
00037         std::wstring const & faultDescription)
00038         throw (
00039         FederateInternalError);
00040 
00041     // 4.8
00042     virtual void reportFederationExecutions (
00043         FederationExecutionInformationVector const &
00044         theFederationExecutionInformationList)
00045         throw (
00046         FederateInternalError);
00047 
00049     virtual
00050         void
00051         synchronizationPointRegistrationSucceeded(std::wstring const & label)
00052         throw (rti1516e::FederateInternalError);
00053 
00054     virtual
00055         void
00056         synchronizationPointRegistrationFailed(std::wstring const & label,
00057         rti1516e::SynchronizationPointFailureReason reason)
00058         throw (rti1516e::FederateInternalError);
00059 
00061     virtual
00062         void
00063         announceSynchronizationPoint(std::wstring  const & label,
00064         rti1516e::VariableLengthData const & theUserSuppliedTag)
00065         throw (rti1516e::FederateInternalError);
00066 
00068     virtual
00069         void
00070         federationSynchronized(std::wstring const & label)
00071         throw (rti1516e::FederateInternalError);
00072 
00074     virtual
00075         void
00076         initiateFederateSave(std::wstring const & label)
00077         throw (rti1516e::FederateInternalError);
00078 
00079     virtual
00080         void
00081         initiateFederateSave(std::wstring const & label,
00082         rti1516e::LogicalTime const & theTime)
00083         throw (rti1516e::FederateInternalError);
00084 
00086     virtual
00087         void
00088         federationSaved()
00089         throw (rti1516e::FederateInternalError);
00090 
00091     virtual
00092         void
00093         federationNotSaved(rti1516e::SaveFailureReason theSaveFailureReason)
00094         throw (rti1516e::FederateInternalError);
00095 
00096 
00098     virtual
00099         void
00100         federationSaveStatusResponse(
00101         rti1516e::FederateHandleSaveStatusPairVector const & theFederateStatusVector)
00102         throw (rti1516e::FederateInternalError);
00103 
00105     virtual
00106         void
00107         requestFederationRestoreSucceeded(std::wstring const & label)
00108         throw (rti1516e::FederateInternalError);
00109 
00110     virtual
00111         void
00112         requestFederationRestoreFailed(std::wstring const & label)
00113         throw (rti1516e::FederateInternalError);
00114 
00116     virtual
00117         void
00118         federationRestoreBegun()
00119         throw (rti1516e::FederateInternalError);
00120 
00122     virtual
00123         void
00124         initiateFederateRestore(std::wstring         const & label,
00125         rti1516e::FederateHandle handle)
00126         throw (rti1516e::FederateInternalError);
00127 
00129     virtual
00130         void
00131         federationRestored()
00132         throw (rti1516e::FederateInternalError);
00133 
00134     virtual
00135         void
00136         federationNotRestored(rti1516e::RestoreFailureReason theRestoreFailureReason)
00137         throw (rti1516e::FederateInternalError);
00138 
00140     virtual
00141         void
00142         federationRestoreStatusResponse(
00143         rti1516e::FederateRestoreStatusVector  const & theFederateStatusVector)
00144         throw (rti1516e::FederateInternalError);
00145 
00149 
00151     virtual
00152         void
00153         startRegistrationForObjectClass(rti1516e::ObjectClassHandle theClass)
00154         throw (rti1516e::FederateInternalError);
00155 
00157     virtual
00158         void
00159         stopRegistrationForObjectClass(rti1516e::ObjectClassHandle theClass)
00160         throw (rti1516e::FederateInternalError);
00161 
00163     virtual
00164         void
00165         turnInteractionsOn(rti1516e::InteractionClassHandle theHandle)
00166         throw (rti1516e::FederateInternalError);
00167 
00169     virtual
00170         void
00171         turnInteractionsOff(rti1516e::InteractionClassHandle theHandle)
00172         throw (rti1516e::FederateInternalError);
00173 
00177 
00179     virtual
00180         void
00181         objectInstanceNameReservationSucceeded(std::wstring const &
00182         theObjectInstanceName)
00183         throw (rti1516e::FederateInternalError);
00184 
00185     virtual
00186         void
00187         objectInstanceNameReservationFailed(std::wstring const &
00188         theObjectInstanceName)
00189         throw (rti1516e::FederateInternalError);
00190 
00191 
00192     // 6.6
00193     virtual void multipleObjectInstanceNameReservationSucceeded (
00194         std::set<std::wstring> const & theObjectInstanceNames)
00195         throw (
00196         FederateInternalError);
00197 
00198     virtual void multipleObjectInstanceNameReservationFailed (
00199         std::set<std::wstring> const & theObjectInstanceNames)
00200         throw (
00201         FederateInternalError);
00202 
00204     virtual
00205         void
00206         discoverObjectInstance(rti1516e::ObjectInstanceHandle theObject,
00207         rti1516e::ObjectClassHandle theObjectClass,
00208         std::wstring const & theObjectInstanceName)
00209         throw (rti1516e::FederateInternalError);
00210    
00211     virtual void discoverObjectInstance (
00212         rti1516e::ObjectInstanceHandle theObject,
00213         rti1516e::ObjectClassHandle theObjectClass,
00214         std::wstring const & theObjectInstanceName,
00215         rti1516e::FederateHandle producingFederate)
00216         throw (
00217         FederateInternalError);
00218 
00220     virtual void reflectAttributeValues (
00221         rti1516e::ObjectInstanceHandle theObject,
00222         rti1516e::AttributeHandleValueMap const & theAttributeValues,
00223         rti1516e::VariableLengthData const & theUserSuppliedTag,
00224         rti1516e::OrderType sentOrder,
00225         rti1516e::TransportationType theType,
00226         rti1516e::SupplementalReflectInfo theReflectInfo)
00227         throw (
00228         FederateInternalError);
00229 
00230     virtual void reflectAttributeValues (
00231         rti1516e::ObjectInstanceHandle theObject,
00232         rti1516e::AttributeHandleValueMap const & theAttributeValues,
00233         rti1516e::VariableLengthData const & theUserSuppliedTag,
00234         rti1516e::OrderType sentOrder,
00235         rti1516e::TransportationType theType,
00236         rti1516e::LogicalTime const & theTime,
00237         rti1516e::OrderType receivedOrder,
00238         rti1516e::SupplementalReflectInfo theReflectInfo)
00239         throw (
00240         FederateInternalError);
00241 
00242     virtual void reflectAttributeValues (
00243         rti1516e::ObjectInstanceHandle theObject,
00244         rti1516e::AttributeHandleValueMap const & theAttributeValues,
00245         rti1516e::VariableLengthData const & theUserSuppliedTag,
00246         rti1516e::OrderType sentOrder,
00247         rti1516e::TransportationType theType,
00248         rti1516e::LogicalTime const & theTime,
00249         rti1516e::OrderType receivedOrder,
00250         rti1516e::MessageRetractionHandle theHandle,
00251         rti1516e::SupplementalReflectInfo theReflectInfo)
00252         throw (
00253         FederateInternalError);
00254 
00255     // 6.13
00256     virtual void receiveInteraction (
00257         InteractionClassHandle theInteraction,
00258         ParameterHandleValueMap const & theParameterValues,
00259         VariableLengthData const & theUserSuppliedTag,
00260         OrderType sentOrder,
00261         TransportationType theType,
00262         SupplementalReceiveInfo theReceiveInfo)
00263         throw (
00264         FederateInternalError);
00265 
00266     virtual void receiveInteraction (
00267         InteractionClassHandle theInteraction,
00268         ParameterHandleValueMap const & theParameterValues,
00269         VariableLengthData const & theUserSuppliedTag,
00270         OrderType sentOrder,
00271         TransportationType theType,
00272         LogicalTime const & theTime,
00273         OrderType receivedOrder,
00274         SupplementalReceiveInfo theReceiveInfo)
00275         throw (
00276         FederateInternalError);
00277 
00278     virtual void receiveInteraction (
00279         InteractionClassHandle theInteraction,
00280         ParameterHandleValueMap const & theParameterValues,
00281         VariableLengthData const & theUserSuppliedTag,
00282         OrderType sentOrder,
00283         TransportationType theType,
00284         LogicalTime const & theTime,
00285         OrderType receivedOrder,
00286         MessageRetractionHandle theHandle,
00287         SupplementalReceiveInfo theReceiveInfo)
00288         throw (
00289         FederateInternalError);
00290 
00291 
00292     // 6.15
00293     virtual void removeObjectInstance (
00294         ObjectInstanceHandle theObject,
00295         VariableLengthData const & theUserSuppliedTag,
00296         OrderType sentOrder,
00297         SupplementalRemoveInfo theRemoveInfo)
00298         throw (
00299         FederateInternalError);
00300 
00301     virtual void removeObjectInstance (
00302         ObjectInstanceHandle theObject,
00303         VariableLengthData const & theUserSuppliedTag,
00304         OrderType sentOrder,
00305         LogicalTime const & theTime,
00306         OrderType receivedOrder,
00307         SupplementalRemoveInfo theRemoveInfo)
00308         throw (
00309         FederateInternalError);
00310 
00311     virtual void removeObjectInstance (
00312         ObjectInstanceHandle theObject,
00313         VariableLengthData const & theUserSuppliedTag,
00314         OrderType sentOrder,
00315         LogicalTime const & theTime,
00316         OrderType receivedOrder,
00317         MessageRetractionHandle theHandle,
00318         SupplementalRemoveInfo theRemoveInfo)
00319         throw (
00320         FederateInternalError);
00321 
00323     virtual
00324         void
00325         attributesInScope
00326         (rti1516e::ObjectInstanceHandle theObject,
00327         rti1516e::AttributeHandleSet const & theAttributes)
00328         throw (rti1516e::FederateInternalError);
00329 
00331     virtual
00332         void
00333         attributesOutOfScope
00334         (rti1516e::ObjectInstanceHandle theObject,
00335         rti1516e::AttributeHandleSet const & theAttributes)
00336         throw (rti1516e::FederateInternalError);
00337 
00339     virtual
00340         void
00341         provideAttributeValueUpdate
00342         (rti1516e::ObjectInstanceHandle theObject,
00343         rti1516e::AttributeHandleSet const & theAttributes,
00344         rti1516e::VariableLengthData const & theUserSuppliedTag)
00345         throw (rti1516e::FederateInternalError);
00346 
00348     virtual
00349         void
00350         turnUpdatesOnForObjectInstance
00351         (rti1516e::ObjectInstanceHandle theObject,
00352         rti1516e::AttributeHandleSet const & theAttributes)
00353         throw (rti1516e::FederateInternalError);
00354 
00355     virtual void turnUpdatesOnForObjectInstance (
00356         ObjectInstanceHandle theObject,
00357         AttributeHandleSet const & theAttributes,
00358         std::wstring const & updateRateDesignator)
00359         throw (
00360         FederateInternalError);
00361 
00363     virtual
00364         void
00365         turnUpdatesOffForObjectInstance
00366         (rti1516e::ObjectInstanceHandle theObject,
00367         rti1516e::AttributeHandleSet const & theAttributes)
00368         throw (rti1516e::FederateInternalError);
00369 
00370     // 6.24
00371     virtual void confirmAttributeTransportationTypeChange (
00372         ObjectInstanceHandle theObject,
00373         AttributeHandleSet theAttributes,
00374         TransportationType theTransportation)
00375         throw (
00376         FederateInternalError);
00377 
00378     // 6.26
00379     virtual void reportAttributeTransportationType (
00380         ObjectInstanceHandle theObject,
00381         AttributeHandle theAttribute,
00382         TransportationType theTransportation)
00383         throw (
00384         FederateInternalError);
00385 
00386     // 6.28
00387     virtual void confirmInteractionTransportationTypeChange (
00388         InteractionClassHandle theInteraction,
00389         TransportationType theTransportation)
00390         throw (
00391         FederateInternalError);
00392 
00393     // 6.30
00394     virtual void reportInteractionTransportationType (
00395         FederateHandle federateHandle,
00396         InteractionClassHandle theInteraction,
00397         TransportationType  theTransportation)
00398         throw (
00399         FederateInternalError);
00400 
00404 
00406     virtual
00407         void
00408         requestAttributeOwnershipAssumption
00409         (rti1516e::ObjectInstanceHandle theObject,
00410         rti1516e::AttributeHandleSet const & offeredAttributes,
00411         rti1516e::VariableLengthData const & theUserSuppliedTag)
00412         throw (rti1516e::FederateInternalError);
00413 
00415     virtual
00416         void
00417         requestDivestitureConfirmation
00418         (rti1516e::ObjectInstanceHandle theObject,
00419         rti1516e::AttributeHandleSet const & releasedAttributes)
00420         throw (rti1516e::FederateInternalError);
00421 
00423     virtual
00424         void
00425         attributeOwnershipAcquisitionNotification
00426         (rti1516e::ObjectInstanceHandle theObject,
00427         rti1516e::AttributeHandleSet const & securedAttributes,
00428         rti1516e::VariableLengthData const & theUserSuppliedTag)
00429         throw (rti1516e::FederateInternalError);
00430 
00432     virtual
00433         void
00434         attributeOwnershipUnavailable
00435         (rti1516e::ObjectInstanceHandle theObject,
00436         rti1516e::AttributeHandleSet const & theAttributes)
00437         throw (rti1516e::FederateInternalError);
00438 
00440     virtual
00441         void
00442         requestAttributeOwnershipRelease
00443         (rti1516e::ObjectInstanceHandle theObject,
00444         rti1516e::AttributeHandleSet const & candidateAttributes,
00445         rti1516e::VariableLengthData const & theUserSuppliedTag)
00446         throw (rti1516e::FederateInternalError);
00447 
00449     virtual
00450         void
00451         confirmAttributeOwnershipAcquisitionCancellation
00452         (rti1516e::ObjectInstanceHandle theObject,
00453         rti1516e::AttributeHandleSet const & theAttributes)
00454         throw (rti1516e::FederateInternalError);
00455 
00457     virtual
00458         void
00459         informAttributeOwnership(rti1516e::ObjectInstanceHandle theObject,
00460         rti1516e::AttributeHandle theAttribute,
00461         rti1516e::FederateHandle theOwner)
00462         throw (rti1516e::FederateInternalError);
00463 
00464     virtual
00465         void
00466         attributeIsNotOwned(rti1516e::ObjectInstanceHandle theObject,
00467         rti1516e::AttributeHandle theAttribute)
00468         throw (rti1516e::FederateInternalError);
00469 
00470     virtual
00471         void
00472         attributeIsOwnedByRTI(rti1516e::ObjectInstanceHandle theObject,
00473         rti1516e::AttributeHandle theAttribute)
00474         throw (rti1516e::FederateInternalError);
00475 
00479 
00481     virtual
00482         void
00483         timeRegulationEnabled(rti1516e::LogicalTime const & theFederateTime)
00484         throw (rti1516e::FederateInternalError);
00485 
00487     virtual
00488         void
00489         timeConstrainedEnabled(rti1516e::LogicalTime const & theFederateTime)
00490         throw (rti1516e::FederateInternalError);
00491 
00493     virtual
00494         void
00495         timeAdvanceGrant(rti1516e::LogicalTime const & theTime)
00496         throw (rti1516e::FederateInternalError);
00497 
00499     virtual
00500         void
00501         requestRetraction(rti1516e::MessageRetractionHandle theHandle)
00502         throw (rti1516e::FederateInternalError);
00503 
00504 };
00505 
00506 #endif //! DtIFSPEC1516
00507 #endif //! DtFedAmbCatch1516_h