MAK RTIspy API Documentation for HLA 1.3: momWrapper1516e.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: momWrapper1516e.h,v $ $Revision: 1.0 $ $State: Exp $
00007 *********************************************************************/
00008 
00011 
00012 #ifndef DtMomWrapper1516e_h
00013 #define DtMomWrapper1516e_h
00014 #ifdef DtMOM
00015 #ifdef DtIFSPEC1516E
00016 
00017 #include "rtiMsConfig.h"
00018 #include "fedAmbWrap1516e.h"
00019 #include "momArgument.h"
00020 
00021 class DtMomMgr;
00022 
00023 class DT_DLL_LRC DtMomWrapper : public DtFedAmbWrapper
00024 {
00025 public:
00026 
00028     DtMomWrapper( DtMomMgr* momMgrPtr );
00029 
00031     virtual ~DtMomWrapper() throw ();
00032 
00034     virtual DtMomMgr* momMgr();
00035 
00037     virtual void reset();
00038 
00041     virtual unsigned long objectRemoveCount() const;
00042 
00045     virtual unsigned long objectDiscoverCount() const;
00046 
00048 
00049 
00051     virtual
00052         void
00053         synchronizationPointRegistrationSucceeded(std::wstring const & label)
00054         throw (rti1516e::FederateInternalError);
00055 
00056     virtual
00057         void
00058         synchronizationPointRegistrationFailed(std::wstring const & label,
00059         rti1516e::SynchronizationPointFailureReason reason)
00060         throw (rti1516e::FederateInternalError);
00061 
00063     virtual
00064         void
00065         announceSynchronizationPoint(std::wstring  const & label,
00066         rti1516e::VariableLengthData const & theUserSuppliedTag)
00067         throw (rti1516e::FederateInternalError);
00068 
00070     virtual
00071         void
00072         federationSynchronized(std::wstring const & label)
00073         throw (rti1516e::FederateInternalError);
00074 
00076     virtual
00077         void
00078         initiateFederateSave(std::wstring const & label)
00079         throw (rti1516e::FederateInternalError);
00080 
00081     virtual
00082         void
00083         initiateFederateSave(std::wstring const & label,
00084         rti1516e::LogicalTime const & theTime)
00085         throw (rti1516e::FederateInternalError);
00086 
00088     virtual
00089         void
00090         federationSaved()
00091         throw (rti1516e::FederateInternalError);
00092 
00093     virtual
00094         void
00095         federationNotSaved(rti1516e::SaveFailureReason theSaveFailureReason)
00096         throw (rti1516e::FederateInternalError);
00097 
00098 
00100     virtual
00101         void
00102         federationSaveStatusResponse(
00103         rti1516e::FederateHandleSaveStatusPairVector const & theFederateStatusVector)
00104         throw (rti1516e::FederateInternalError);
00105 
00107     virtual
00108         void
00109         requestFederationRestoreSucceeded(std::wstring const & label)
00110         throw (rti1516e::FederateInternalError);
00111 
00112     virtual
00113         void
00114         requestFederationRestoreFailed(std::wstring const & label)
00115         throw (rti1516e::FederateInternalError);
00116 
00118     virtual
00119         void
00120         federationRestoreBegun()
00121         throw (rti1516e::FederateInternalError);
00122 
00124     virtual
00125         void
00126         initiateFederateRestore(std::wstring         const & label,
00127         rti1516e::FederateHandle handle)
00128         throw (rti1516e::FederateInternalError);
00129 
00131     virtual
00132         void
00133         federationRestored()
00134         throw (rti1516e::FederateInternalError);
00135 
00136     virtual
00137         void
00138         federationNotRestored(rti1516e::RestoreFailureReason theRestoreFailureReason)
00139         throw (rti1516e::FederateInternalError);
00140 
00142     virtual
00143         void
00144         federationRestoreStatusResponse(
00145         rti1516e::FederateRestoreStatusVector  const & theFederateStatusVector)
00146         throw (rti1516e::FederateInternalError);
00148 
00150 
00151 
00153     virtual
00154         void
00155         startRegistrationForObjectClass(rti1516e::ObjectClassHandle theClass)
00156         throw (rti1516e::FederateInternalError);
00157 
00159     virtual
00160         void
00161         stopRegistrationForObjectClass(rti1516e::ObjectClassHandle theClass)
00162         throw (rti1516e::FederateInternalError);
00163 
00165     virtual
00166         void
00167         turnInteractionsOn(rti1516e::InteractionClassHandle theHandle)
00168         throw (rti1516e::FederateInternalError);
00169 
00171     virtual
00172         void
00173         turnInteractionsOff(rti1516e::InteractionClassHandle theHandle)
00174         throw (rti1516e::FederateInternalError);
00176 
00178 
00179 
00181     virtual
00182         void
00183         objectInstanceNameReservationSucceeded(std::wstring const &
00184         theObjectInstanceName)
00185         throw (rti1516e::FederateInternalError);
00186 
00187     virtual
00188         void
00189         objectInstanceNameReservationFailed(std::wstring const &
00190         theObjectInstanceName)
00191         throw (rti1516e::FederateInternalError);
00192 
00193 
00195     virtual
00196         void
00197         discoverObjectInstance(rti1516e::ObjectInstanceHandle theObject,
00198         rti1516e::ObjectClassHandle theObjectClass,
00199         std::wstring const & theObjectInstanceName)
00200         throw (rti1516e::FederateInternalError);
00201 
00203     virtual
00204         void
00205         reflectAttributeValues
00206         (rti1516e::ObjectInstanceHandle theObject,
00207         rti1516e::AttributeHandleValueMap const & theAttributeValues,
00208         rti1516e::VariableLengthData const & theUserSuppliedTag,
00209         rti1516e::OrderType sentOrder,
00210         rti1516e::TransportationType theType)
00211         throw (rti1516e::FederateInternalError);
00212 
00213     virtual
00214         void
00215         reflectAttributeValues
00216         (rti1516e::ObjectInstanceHandle theObject,
00217         rti1516e::AttributeHandleValueMap const & theAttributeValues,
00218         rti1516e::VariableLengthData const & theUserSuppliedTag,
00219         rti1516e::OrderType sentOrder,
00220         rti1516e::TransportationType theType,
00221         rti1516e::RegionHandleSet const & theSentRegionHandleSet)
00222         throw (rti1516e::FederateInternalError);
00223 
00224     virtual
00225         void
00226         reflectAttributeValues
00227         (rti1516e::ObjectInstanceHandle theObject,
00228         rti1516e::AttributeHandleValueMap const & theAttributeValues,
00229         rti1516e::VariableLengthData const & theUserSuppliedTag,
00230         rti1516e::OrderType sentOrder,
00231         rti1516e::TransportationType theType,
00232         rti1516e::LogicalTime const & theTime,
00233         rti1516e::OrderType receivedOrder)
00234         throw (rti1516e::FederateInternalError);
00235 
00236     virtual
00237         void
00238         reflectAttributeValues
00239         (rti1516e::ObjectInstanceHandle theObject,
00240         rti1516e::AttributeHandleValueMap const & theAttributeValues,
00241         rti1516e::VariableLengthData const & theUserSuppliedTag,
00242         rti1516e::OrderType sentOrder,
00243         rti1516e::TransportationType theType,
00244         rti1516e::LogicalTime const & theTime,
00245         rti1516e::OrderType receivedOrder,
00246         rti1516e::RegionHandleSet const & theSentRegionHandleSet)
00247         throw (rti1516e::FederateInternalError);
00248 
00249     virtual
00250         void
00251         reflectAttributeValues
00252         (rti1516e::ObjectInstanceHandle theObject,
00253         rti1516e::AttributeHandleValueMap const & theAttributeValues,
00254         rti1516e::VariableLengthData const & theUserSuppliedTag,
00255         rti1516e::OrderType sentOrder,
00256         rti1516e::TransportationType theType,
00257         rti1516e::LogicalTime const & theTime,
00258         rti1516e::OrderType receivedOrder,
00259         rti1516e::MessageRetractionHandle theHandle)
00260         throw (rti1516e::FederateInternalError);
00261 
00262     virtual
00263         void
00264         reflectAttributeValues
00265         (rti1516e::ObjectInstanceHandle theObject,
00266         rti1516e::AttributeHandleValueMap const & theAttributeValues,
00267         rti1516e::VariableLengthData const & theUserSuppliedTag,
00268         rti1516e::OrderType sentOrder,
00269         rti1516e::TransportationType theType,
00270         rti1516e::LogicalTime const & theTime,
00271         rti1516e::OrderType receivedOrder,
00272         rti1516e::MessageRetractionHandle theHandle,
00273         rti1516e::RegionHandleSet const & theSentRegionHandleSet)
00274         throw (rti1516e::FederateInternalError);
00275 
00277     virtual
00278         void
00279         receiveInteraction
00280         (rti1516e::InteractionClassHandle theInteraction,
00281         rti1516e::ParameterHandleValueMap const & theParameterValues,
00282         rti1516e::VariableLengthData const & theUserSuppliedTag,
00283         rti1516e::OrderType sentOrder,
00284         rti1516e::TransportationType theType)
00285         throw (rti1516e::FederateInternalError);
00286 
00287     virtual
00288         void
00289         receiveInteraction
00290         (rti1516e::InteractionClassHandle theInteraction,
00291         rti1516e::ParameterHandleValueMap const & theParameterValues,
00292         rti1516e::VariableLengthData const & theUserSuppliedTag,
00293         rti1516e::OrderType sentOrder,
00294         rti1516e::TransportationType theType,
00295         rti1516e::RegionHandleSet const & theSentRegionHandleSet)
00296         throw (rti1516e::FederateInternalError);
00297 
00298     virtual
00299         void
00300         receiveInteraction
00301         (rti1516e::InteractionClassHandle theInteraction,
00302         rti1516e::ParameterHandleValueMap const & theParameterValues,
00303         rti1516e::VariableLengthData const & theUserSuppliedTag,
00304         rti1516e::OrderType sentOrder,
00305         rti1516e::TransportationType theType,
00306         rti1516e::LogicalTime const & theTime,
00307         rti1516e::OrderType receivedOrder)
00308         throw (rti1516e::FederateInternalError);
00309 
00310     virtual
00311         void
00312         receiveInteraction
00313         (rti1516e::InteractionClassHandle theInteraction,
00314         rti1516e::ParameterHandleValueMap const & theParameterValues,
00315         rti1516e::VariableLengthData const & theUserSuppliedTag,
00316         rti1516e::OrderType sentOrder,
00317         rti1516e::TransportationType theType,
00318         rti1516e::LogicalTime const & theTime,
00319         rti1516e::OrderType receivedOrder,
00320         rti1516e::RegionHandleSet const & theSentRegionHandleSet)
00321         throw (rti1516e::FederateInternalError);
00322 
00323     virtual
00324         void
00325         receiveInteraction
00326         (rti1516e::InteractionClassHandle theInteraction,
00327         rti1516e::ParameterHandleValueMap const & theParameterValues,
00328         rti1516e::VariableLengthData const & theUserSuppliedTag,
00329         rti1516e::OrderType sentOrder,
00330         rti1516e::TransportationType theType,
00331         rti1516e::LogicalTime const & theTime,
00332         rti1516e::OrderType receivedOrder,
00333         rti1516e::MessageRetractionHandle theHandle)
00334         throw (rti1516e::FederateInternalError);
00335 
00336     virtual
00337         void
00338         receiveInteraction
00339         (rti1516e::InteractionClassHandle theInteraction,
00340         rti1516e::ParameterHandleValueMap const & theParameterValues,
00341         rti1516e::VariableLengthData const & theUserSuppliedTag,
00342         rti1516e::OrderType sentOrder,
00343         rti1516e::TransportationType theType,
00344         rti1516e::LogicalTime const & theTime,
00345         rti1516e::OrderType receivedOrder,
00346         rti1516e::MessageRetractionHandle theHandle,
00347         rti1516e::RegionHandleSet const & theSentRegionHandleSet)
00348         throw (rti1516e::FederateInternalError);
00349 
00351     virtual
00352         void
00353         removeObjectInstance(rti1516e::ObjectInstanceHandle theObject,
00354         rti1516e::VariableLengthData const & theUserSuppliedTag,
00355         rti1516e::OrderType sentOrder)
00356         throw (rti1516e::FederateInternalError);
00357 
00358     virtual
00359         void
00360         removeObjectInstance(rti1516e::ObjectInstanceHandle theObject,
00361         rti1516e::VariableLengthData const & theUserSuppliedTag,
00362         rti1516e::OrderType sentOrder,
00363         rti1516e::LogicalTime const & theTime,
00364         rti1516e::OrderType receivedOrder)
00365         throw (rti1516e::FederateInternalError);
00366 
00367     virtual
00368         void
00369         removeObjectInstance(rti1516e::ObjectInstanceHandle theObject,
00370         rti1516e::VariableLengthData const & theUserSuppliedTag,
00371         rti1516e::OrderType sentOrder,
00372         rti1516e::LogicalTime const & theTime,
00373         rti1516e::OrderType receivedOrder,
00374         rti1516e::MessageRetractionHandle theHandle)
00375         throw (rti1516e::FederateInternalError);
00376 
00378     virtual
00379         void
00380         attributesInScope
00381         (rti1516e::ObjectInstanceHandle theObject,
00382         rti1516e::AttributeHandleSet const & theAttributes)
00383         throw (rti1516e::FederateInternalError);
00384 
00386     virtual
00387         void
00388         attributesOutOfScope
00389         (rti1516e::ObjectInstanceHandle theObject,
00390         rti1516e::AttributeHandleSet const & theAttributes)
00391         throw (rti1516e::FederateInternalError);
00392 
00394     virtual
00395         void
00396         provideAttributeValueUpdate
00397         (rti1516e::ObjectInstanceHandle theObject,
00398         rti1516e::AttributeHandleSet const & theAttributes,
00399         rti1516e::VariableLengthData const & theUserSuppliedTag)
00400         throw (rti1516e::FederateInternalError);
00401 
00403     virtual
00404         void
00405         turnUpdatesOnForObjectInstance
00406         (rti1516e::ObjectInstanceHandle theObject,
00407         rti1516e::AttributeHandleSet const & theAttributes)
00408         throw (rti1516e::FederateInternalError);
00409 
00411     virtual
00412         void
00413         turnUpdatesOffForObjectInstance
00414         (rti1516e::ObjectInstanceHandle theObject,
00415         rti1516e::AttributeHandleSet const & theAttributes)
00416         throw (rti1516e::FederateInternalError);
00418 
00420 
00421 
00423     virtual
00424         void
00425         requestAttributeOwnershipAssumption
00426         (rti1516e::ObjectInstanceHandle theObject,
00427         rti1516e::AttributeHandleSet const & offeredAttributes,
00428         rti1516e::VariableLengthData const & theUserSuppliedTag)
00429         throw (rti1516e::FederateInternalError);
00430 
00432     virtual
00433         void
00434         requestDivestitureConfirmation
00435         (rti1516e::ObjectInstanceHandle theObject,
00436         rti1516e::AttributeHandleSet const & releasedAttributes)
00437         throw (rti1516e::FederateInternalError);
00438 
00440     virtual
00441         void
00442         attributeOwnershipAcquisitionNotification
00443         (rti1516e::ObjectInstanceHandle theObject,
00444         rti1516e::AttributeHandleSet const & securedAttributes,
00445         rti1516e::VariableLengthData const & theUserSuppliedTag)
00446         throw (rti1516e::FederateInternalError);
00447 
00449     virtual
00450         void
00451         attributeOwnershipUnavailable
00452         (rti1516e::ObjectInstanceHandle theObject,
00453         rti1516e::AttributeHandleSet const & theAttributes)
00454         throw (rti1516e::FederateInternalError);
00455 
00457     virtual
00458         void
00459         requestAttributeOwnershipRelease
00460         (rti1516e::ObjectInstanceHandle theObject,
00461         rti1516e::AttributeHandleSet const & candidateAttributes,
00462         rti1516e::VariableLengthData const & theUserSuppliedTag)
00463         throw (rti1516e::FederateInternalError);
00464 
00466     virtual
00467         void
00468         confirmAttributeOwnershipAcquisitionCancellation
00469         (rti1516e::ObjectInstanceHandle theObject,
00470         rti1516e::AttributeHandleSet const & theAttributes)
00471         throw (rti1516e::FederateInternalError);
00472 
00474     virtual
00475         void
00476         informAttributeOwnership(rti1516e::ObjectInstanceHandle theObject,
00477         rti1516e::AttributeHandle theAttribute,
00478         rti1516e::FederateHandle theOwner)
00479         throw (rti1516e::FederateInternalError);
00480 
00481     virtual
00482         void
00483         attributeIsNotOwned(rti1516e::ObjectInstanceHandle theObject,
00484         rti1516e::AttributeHandle theAttribute)
00485         throw (rti1516e::FederateInternalError);
00486 
00487     virtual
00488         void
00489         attributeIsOwnedByRTI(rti1516e::ObjectInstanceHandle theObject,
00490         rti1516e::AttributeHandle theAttribute)
00491         throw (rti1516e::FederateInternalError);
00492 
00496 
00498     virtual
00499         void
00500         timeRegulationEnabled(rti1516e::LogicalTime const & theFederateTime)
00501         throw (rti1516e::FederateInternalError);
00502 
00504     virtual
00505         void
00506         timeConstrainedEnabled(rti1516e::LogicalTime const & theFederateTime)
00507         throw (rti1516e::FederateInternalError);
00508 
00510     virtual
00511         void
00512         timeAdvanceGrant(rti1516e::LogicalTime const & theTime)
00513         throw (rti1516e::FederateInternalError);
00514 
00516     virtual
00517         void
00518         requestRetraction(rti1516e::MessageRetractionHandle theHandle)
00519         throw (rti1516e::FederateInternalError);
00521 
00522 private:
00524     DtMomWrapper( const DtMomWrapper& src );
00525 
00527     DtMomWrapper& operator=( const DtMomWrapper& src );
00528 
00529 protected:
00530     DtMomMgr* myMomMgr;
00531     unsigned long myDiscoverCount;
00532     unsigned long myRemoveCount;
00533 
00534 protected:
00535     static const DtMomArgument theDfltMomArgument;
00536     static DtMomArgument theDfltRetVal;
00537 };
00538 
00539 #endif //! DtIFSPEC1516
00540 #endif //! DtMOM
00541 #endif //! DtMomWrapper1516_h