MAK RTIspy API Documentation for HLA 1516: fedAmbPrinter1516.h Source File

Go to the documentation of this file.
00001 /*********************************************************************
00002 ** Copyright (c) 2001 MaK Technologies, Inc.
00003 ** All rights reserved.
00004 *********************************************************************/
00005 /*********************************************************************
00006 ** $RCSfile: fedAmbPrinter1516.h,v $ $Revision: 1.4 $ $State: Exp $
00007 *********************************************************************/
00008 
00011 
00012 #ifndef DtFedAmbPrinter1516_h
00013 #define DtFedAmbPrinter1516_h
00014 
00015 #ifdef DtIFSPEC1516
00016 
00017 #include "rtiMsConfig.h"
00018 #include "fedAmbWrap1516.h"
00019 
00020 class DtFederateMgr;
00021 class DtFomClassMgr;
00022 class DtObjectMgr;
00023 
00024 class DT_DLL_LRC DtFedAmbPrinter : public DtFedAmbWrapper
00025 {
00026 public:
00027 
00028    DtFedAmbPrinter(DtFederateMgr* fedMgr);
00029    virtual ~DtFedAmbPrinter() throw ();
00030 
00034    
00036     virtual
00037     void
00038     synchronizationPointRegistrationSucceeded(std::wstring const & label)
00039       throw (rti1516::FederateInternalError);
00040 
00041     virtual
00042     void
00043     synchronizationPointRegistrationFailed(std::wstring const & label,
00044                                            rti1516::SynchronizationFailureReason reason)
00045       throw (rti1516::FederateInternalError);
00046 
00048     virtual
00049     void
00050     announceSynchronizationPoint(std::wstring  const & label,
00051                                  rti1516::VariableLengthData const & theUserSuppliedTag)
00052       throw (rti1516::FederateInternalError);
00053 
00055     virtual
00056     void
00057     federationSynchronized(std::wstring const & label)
00058       throw (rti1516::FederateInternalError);
00059 
00061     virtual
00062     void
00063     initiateFederateSave(std::wstring const & label)
00064       throw (rti1516::UnableToPerformSave,
00065              rti1516::FederateInternalError);
00066 
00067     virtual
00068     void
00069     initiateFederateSave(std::wstring const & label,
00070                          rti1516::LogicalTime const & theTime)
00071       throw (rti1516::UnableToPerformSave,
00072              rti1516::InvalidLogicalTime,
00073              rti1516::FederateInternalError);
00074 
00076     virtual
00077     void
00078     federationSaved()
00079       throw (rti1516::FederateInternalError);
00080 
00081     virtual
00082     void
00083     federationNotSaved(rti1516::SaveFailureReason theSaveFailureReason)
00084       throw (rti1516::FederateInternalError);
00085 
00086 
00088     virtual
00089     void
00090     federationSaveStatusResponse(
00091       rti1516::FederateHandleSaveStatusPairVector const & theFederateStatusVector)
00092       throw (rti1516::FederateInternalError);
00093 
00095     virtual
00096     void
00097     requestFederationRestoreSucceeded(std::wstring const & label)
00098       throw (rti1516::FederateInternalError);
00099 
00100     virtual
00101     void
00102     requestFederationRestoreFailed(std::wstring const & label)
00103       throw (rti1516::FederateInternalError);
00104 
00106     virtual
00107     void
00108     federationRestoreBegun()
00109       throw (rti1516::FederateInternalError);
00110 
00112     virtual
00113     void
00114     initiateFederateRestore(std::wstring         const & label,
00115                             rti1516::FederateHandle handle)
00116       throw (rti1516::SpecifiedSaveLabelDoesNotExist,
00117              rti1516::CouldNotInitiateRestore,
00118              rti1516::FederateInternalError);
00119 
00121     virtual
00122     void
00123     federationRestored()
00124       throw (rti1516::FederateInternalError);
00125 
00126     virtual
00127     void
00128     federationNotRestored(rti1516::RestoreFailureReason theRestoreFailureReason)
00129       throw (rti1516::FederateInternalError);
00130 
00132     virtual
00133     void
00134     federationRestoreStatusResponse(
00135       rti1516::FederateHandleRestoreStatusPairVector  const & theFederateStatusVector)
00136       throw (rti1516::FederateInternalError);
00137 
00141   
00143     virtual
00144     void
00145     startRegistrationForObjectClass(rti1516::ObjectClassHandle theClass)
00146       throw (rti1516::ObjectClassNotPublished,
00147              rti1516::FederateInternalError);
00148 
00150     virtual
00151     void
00152     stopRegistrationForObjectClass(rti1516::ObjectClassHandle theClass)
00153       throw (rti1516::ObjectClassNotPublished,
00154              rti1516::FederateInternalError);
00155 
00157     virtual
00158     void
00159     turnInteractionsOn(rti1516::InteractionClassHandle theHandle)
00160       throw (rti1516::InteractionClassNotPublished,
00161              rti1516::FederateInternalError);
00162 
00164     virtual
00165     void
00166     turnInteractionsOff(rti1516::InteractionClassHandle theHandle)
00167       throw (rti1516::InteractionClassNotPublished,
00168              rti1516::FederateInternalError);
00169 
00173   
00175     virtual
00176     void
00177     objectInstanceNameReservationSucceeded(std::wstring const &
00178                                            theObjectInstanceName)
00179       throw (rti1516::UnknownName,
00180              rti1516::FederateInternalError);
00181 
00182     virtual
00183     void
00184     objectInstanceNameReservationFailed(std::wstring const &
00185                                         theObjectInstanceName)
00186       throw (rti1516::UnknownName,
00187              rti1516::FederateInternalError);
00188 
00189   
00191     virtual
00192     void
00193     discoverObjectInstance(rti1516::ObjectInstanceHandle theObject,
00194                            rti1516::ObjectClassHandle theObjectClass,
00195                            std::wstring const & theObjectInstanceName)
00196       throw (rti1516::CouldNotDiscover,
00197              rti1516::ObjectClassNotKnown,
00198              rti1516::FederateInternalError);
00199 
00201     virtual
00202     void
00203     reflectAttributeValues
00204     (rti1516::ObjectInstanceHandle theObject,
00205      rti1516::AttributeHandleValueMap const & theAttributeValues,
00206      rti1516::VariableLengthData const & theUserSuppliedTag,
00207      rti1516::OrderType sentOrder,
00208      rti1516::TransportationType theType)
00209       throw (rti1516::ObjectInstanceNotKnown,
00210              rti1516::AttributeNotRecognized,
00211              rti1516::AttributeNotSubscribed,
00212              rti1516::FederateInternalError);
00213 
00214     virtual
00215     void
00216     reflectAttributeValues
00217     (rti1516::ObjectInstanceHandle theObject,
00218      rti1516::AttributeHandleValueMap const & theAttributeValues,
00219      rti1516::VariableLengthData const & theUserSuppliedTag,
00220      rti1516::OrderType sentOrder,
00221      rti1516::TransportationType theType,
00222      rti1516::RegionHandleSet const & theSentRegionHandleSet)
00223       throw (rti1516::ObjectInstanceNotKnown,
00224              rti1516::AttributeNotRecognized,
00225              rti1516::AttributeNotSubscribed,
00226              rti1516::FederateInternalError);
00227 
00228     virtual
00229     void
00230     reflectAttributeValues
00231     (rti1516::ObjectInstanceHandle theObject,
00232      rti1516::AttributeHandleValueMap const & theAttributeValues,
00233      rti1516::VariableLengthData const & theUserSuppliedTag,
00234      rti1516::OrderType sentOrder,
00235      rti1516::TransportationType theType,
00236      rti1516::LogicalTime const & theTime,
00237      rti1516::OrderType receivedOrder)
00238       throw (rti1516::ObjectInstanceNotKnown,
00239              rti1516::AttributeNotRecognized,
00240              rti1516::AttributeNotSubscribed,
00241              rti1516::FederateInternalError);
00242   
00243     virtual
00244     void
00245     reflectAttributeValues
00246     (rti1516::ObjectInstanceHandle theObject,
00247      rti1516::AttributeHandleValueMap const & theAttributeValues,
00248      rti1516::VariableLengthData const & theUserSuppliedTag,
00249      rti1516::OrderType sentOrder,
00250      rti1516::TransportationType theType,
00251      rti1516::LogicalTime const & theTime,
00252      rti1516::OrderType receivedOrder,
00253      rti1516::RegionHandleSet const & theSentRegionHandleSet)
00254       throw (rti1516::ObjectInstanceNotKnown,
00255              rti1516::AttributeNotRecognized,
00256              rti1516::AttributeNotSubscribed,
00257              rti1516::FederateInternalError);
00258   
00259     virtual
00260     void
00261     reflectAttributeValues
00262     (rti1516::ObjectInstanceHandle theObject,
00263      rti1516::AttributeHandleValueMap const & theAttributeValues,
00264      rti1516::VariableLengthData const & theUserSuppliedTag,
00265      rti1516::OrderType sentOrder,
00266      rti1516::TransportationType theType,
00267      rti1516::LogicalTime const & theTime,
00268      rti1516::OrderType receivedOrder,
00269      rti1516::MessageRetractionHandle theHandle)
00270       throw (rti1516::ObjectInstanceNotKnown,
00271              rti1516::AttributeNotRecognized,
00272              rti1516::AttributeNotSubscribed,
00273              rti1516::InvalidLogicalTime,
00274              rti1516::FederateInternalError);
00275 
00276     virtual
00277     void
00278     reflectAttributeValues
00279     (rti1516::ObjectInstanceHandle theObject,
00280      rti1516::AttributeHandleValueMap const & theAttributeValues,
00281      rti1516::VariableLengthData const & theUserSuppliedTag,
00282      rti1516::OrderType sentOrder,
00283      rti1516::TransportationType theType,
00284      rti1516::LogicalTime const & theTime,
00285      rti1516::OrderType receivedOrder,
00286      rti1516::MessageRetractionHandle theHandle,
00287      rti1516::RegionHandleSet const & theSentRegionHandleSet)
00288       throw (rti1516::ObjectInstanceNotKnown,
00289              rti1516::AttributeNotRecognized,
00290              rti1516::AttributeNotSubscribed,
00291              rti1516::InvalidLogicalTime,
00292              rti1516::FederateInternalError);
00293 
00295     virtual
00296     void
00297     receiveInteraction
00298     (rti1516::InteractionClassHandle theInteraction,
00299      rti1516::ParameterHandleValueMap const & theParameterValues,
00300      rti1516::VariableLengthData const & theUserSuppliedTag,
00301      rti1516::OrderType sentOrder,
00302      rti1516::TransportationType theType)
00303       throw (rti1516::InteractionClassNotRecognized,
00304              rti1516::InteractionParameterNotRecognized,
00305              rti1516::InteractionClassNotSubscribed,
00306              rti1516::FederateInternalError);
00307 
00308     virtual
00309     void
00310     receiveInteraction
00311     (rti1516::InteractionClassHandle theInteraction,
00312      rti1516::ParameterHandleValueMap const & theParameterValues,
00313      rti1516::VariableLengthData const & theUserSuppliedTag,
00314      rti1516::OrderType sentOrder,
00315      rti1516::TransportationType theType,
00316      rti1516::RegionHandleSet const & theSentRegionHandleSet)
00317       throw (rti1516::InteractionClassNotRecognized,
00318              rti1516::InteractionParameterNotRecognized,
00319              rti1516::InteractionClassNotSubscribed,
00320              rti1516::FederateInternalError);
00321 
00322     virtual
00323     void
00324     receiveInteraction
00325     (rti1516::InteractionClassHandle theInteraction,
00326      rti1516::ParameterHandleValueMap const & theParameterValues,
00327      rti1516::VariableLengthData const & theUserSuppliedTag,
00328      rti1516::OrderType sentOrder,
00329      rti1516::TransportationType theType,
00330      rti1516::LogicalTime const & theTime,
00331      rti1516::OrderType receivedOrder)
00332       throw (rti1516::InteractionClassNotRecognized,
00333              rti1516::InteractionParameterNotRecognized,
00334              rti1516::InteractionClassNotSubscribed,
00335              rti1516::FederateInternalError);
00336 
00337     virtual
00338     void
00339     receiveInteraction
00340     (rti1516::InteractionClassHandle theInteraction,
00341      rti1516::ParameterHandleValueMap const & theParameterValues,
00342      rti1516::VariableLengthData const & theUserSuppliedTag,
00343      rti1516::OrderType sentOrder,
00344      rti1516::TransportationType theType,
00345      rti1516::LogicalTime const & theTime,
00346      rti1516::OrderType receivedOrder,
00347      rti1516::RegionHandleSet const & theSentRegionHandleSet)
00348       throw (rti1516::InteractionClassNotRecognized,
00349              rti1516::InteractionParameterNotRecognized,
00350              rti1516::InteractionClassNotSubscribed,
00351              rti1516::FederateInternalError);
00352 
00353     virtual
00354     void
00355     receiveInteraction
00356     (rti1516::InteractionClassHandle theInteraction,
00357      rti1516::ParameterHandleValueMap const & theParameterValues,
00358      rti1516::VariableLengthData const & theUserSuppliedTag,
00359      rti1516::OrderType sentOrder,
00360      rti1516::TransportationType theType,
00361      rti1516::LogicalTime const & theTime,
00362      rti1516::OrderType receivedOrder,
00363      rti1516::MessageRetractionHandle theHandle)
00364       throw (rti1516::InteractionClassNotRecognized,
00365              rti1516::InteractionParameterNotRecognized,
00366              rti1516::InteractionClassNotSubscribed,
00367              rti1516::InvalidLogicalTime,
00368              rti1516::FederateInternalError);
00369 
00370     virtual
00371     void
00372     receiveInteraction
00373     (rti1516::InteractionClassHandle theInteraction,
00374      rti1516::ParameterHandleValueMap const & theParameterValues,
00375      rti1516::VariableLengthData const & theUserSuppliedTag,
00376      rti1516::OrderType sentOrder,
00377      rti1516::TransportationType theType,
00378      rti1516::LogicalTime const & theTime,
00379      rti1516::OrderType receivedOrder,
00380      rti1516::MessageRetractionHandle theHandle,
00381      rti1516::RegionHandleSet const & theSentRegionHandleSet)
00382       throw (rti1516::InteractionClassNotRecognized,
00383              rti1516::InteractionParameterNotRecognized,
00384              rti1516::InteractionClassNotSubscribed,
00385              rti1516::InvalidLogicalTime,
00386              rti1516::FederateInternalError);
00387 
00389     virtual
00390     void
00391     removeObjectInstance(rti1516::ObjectInstanceHandle theObject,
00392                          rti1516::VariableLengthData const & theUserSuppliedTag,
00393                          rti1516::OrderType sentOrder)
00394       throw (rti1516::ObjectInstanceNotKnown,
00395              rti1516::FederateInternalError);
00396 
00397     virtual
00398     void
00399     removeObjectInstance(rti1516::ObjectInstanceHandle theObject,
00400                          rti1516::VariableLengthData const & theUserSuppliedTag,
00401                          rti1516::OrderType sentOrder,
00402                          rti1516::LogicalTime const & theTime,
00403                          rti1516::OrderType receivedOrder)
00404       throw (rti1516::ObjectInstanceNotKnown,
00405              rti1516::FederateInternalError);
00406 
00407     virtual
00408     void
00409     removeObjectInstance(rti1516::ObjectInstanceHandle theObject,
00410                          rti1516::VariableLengthData const & theUserSuppliedTag,
00411                          rti1516::OrderType sentOrder,
00412                          rti1516::LogicalTime const & theTime,
00413                          rti1516::OrderType receivedOrder,
00414                          rti1516::MessageRetractionHandle theHandle)
00415       throw (rti1516::ObjectInstanceNotKnown,
00416              rti1516::InvalidLogicalTime,
00417              rti1516::FederateInternalError);
00418 
00420     virtual
00421     void
00422     attributesInScope
00423     (rti1516::ObjectInstanceHandle theObject,
00424      rti1516::AttributeHandleSet const & theAttributes)
00425       throw (rti1516::ObjectInstanceNotKnown,
00426              rti1516::AttributeNotRecognized,
00427              rti1516::AttributeNotSubscribed,
00428              rti1516::FederateInternalError);
00429 
00431     virtual
00432     void
00433     attributesOutOfScope
00434     (rti1516::ObjectInstanceHandle theObject,
00435      rti1516::AttributeHandleSet const & theAttributes)
00436       throw (rti1516::ObjectInstanceNotKnown,
00437              rti1516::AttributeNotRecognized,
00438              rti1516::AttributeNotSubscribed,
00439              rti1516::FederateInternalError);
00440 
00442     virtual
00443     void
00444     provideAttributeValueUpdate
00445     (rti1516::ObjectInstanceHandle theObject,
00446      rti1516::AttributeHandleSet const & theAttributes,
00447      rti1516::VariableLengthData const & theUserSuppliedTag)
00448       throw (rti1516::ObjectInstanceNotKnown,
00449              rti1516::AttributeNotRecognized,
00450              rti1516::AttributeNotOwned,
00451              rti1516::FederateInternalError);
00452 
00454     virtual
00455     void
00456     turnUpdatesOnForObjectInstance
00457     (rti1516::ObjectInstanceHandle theObject,
00458      rti1516::AttributeHandleSet const & theAttributes)
00459       throw (rti1516::ObjectInstanceNotKnown,
00460              rti1516::AttributeNotRecognized,
00461              rti1516::AttributeNotOwned,
00462              rti1516::FederateInternalError);
00463 
00465     virtual
00466     void
00467     turnUpdatesOffForObjectInstance
00468     (rti1516::ObjectInstanceHandle theObject,
00469      rti1516::AttributeHandleSet const & theAttributes)
00470       throw (rti1516::ObjectInstanceNotKnown,
00471              rti1516::AttributeNotRecognized,
00472              rti1516::AttributeNotOwned,
00473              rti1516::FederateInternalError);
00474 
00478   
00480     virtual
00481     void
00482     requestAttributeOwnershipAssumption
00483     (rti1516::ObjectInstanceHandle theObject,
00484      rti1516::AttributeHandleSet const & offeredAttributes,
00485      rti1516::VariableLengthData const & theUserSuppliedTag)
00486       throw (rti1516::ObjectInstanceNotKnown,
00487              rti1516::AttributeNotRecognized,
00488              rti1516::AttributeAlreadyOwned,
00489              rti1516::AttributeNotPublished,
00490              rti1516::FederateInternalError);
00491 
00493     virtual
00494     void
00495     requestDivestitureConfirmation
00496     (rti1516::ObjectInstanceHandle theObject,
00497      rti1516::AttributeHandleSet const & releasedAttributes)
00498       throw (rti1516::ObjectInstanceNotKnown,
00499              rti1516::AttributeNotRecognized,
00500              rti1516::AttributeNotOwned,
00501              rti1516::AttributeDivestitureWasNotRequested,
00502              rti1516::FederateInternalError);
00503 
00505     virtual
00506     void
00507     attributeOwnershipAcquisitionNotification
00508     (rti1516::ObjectInstanceHandle theObject,
00509      rti1516::AttributeHandleSet const & securedAttributes,
00510      rti1516::VariableLengthData const & theUserSuppliedTag)
00511       throw (rti1516::ObjectInstanceNotKnown,
00512              rti1516::AttributeNotRecognized,
00513              rti1516::AttributeAcquisitionWasNotRequested,
00514              rti1516::AttributeAlreadyOwned,
00515              rti1516::AttributeNotPublished,
00516              rti1516::FederateInternalError);
00517 
00519     virtual
00520     void
00521     attributeOwnershipUnavailable
00522     (rti1516::ObjectInstanceHandle theObject,
00523      rti1516::AttributeHandleSet const & theAttributes)
00524       throw (rti1516::ObjectInstanceNotKnown,
00525              rti1516::AttributeNotRecognized,
00526              rti1516::AttributeAlreadyOwned,
00527              rti1516::AttributeAcquisitionWasNotRequested,
00528              rti1516::FederateInternalError);
00529 
00531     virtual
00532     void
00533     requestAttributeOwnershipRelease
00534     (rti1516::ObjectInstanceHandle theObject,
00535      rti1516::AttributeHandleSet const & candidateAttributes,
00536      rti1516::VariableLengthData const & theUserSuppliedTag)
00537       throw (rti1516::ObjectInstanceNotKnown,
00538              rti1516::AttributeNotRecognized,
00539              rti1516::AttributeNotOwned,
00540              rti1516::FederateInternalError);
00541 
00543     virtual
00544     void
00545     confirmAttributeOwnershipAcquisitionCancellation
00546     (rti1516::ObjectInstanceHandle theObject,
00547      rti1516::AttributeHandleSet const & theAttributes)
00548       throw (rti1516::ObjectInstanceNotKnown,
00549              rti1516::AttributeNotRecognized,
00550              rti1516::AttributeAlreadyOwned,
00551              rti1516::AttributeAcquisitionWasNotCanceled,
00552              rti1516::FederateInternalError);
00553 
00555     virtual
00556     void
00557     informAttributeOwnership(rti1516::ObjectInstanceHandle theObject,
00558                              rti1516::AttributeHandle theAttribute,
00559                              rti1516::FederateHandle theOwner)
00560       throw (rti1516::ObjectInstanceNotKnown,
00561              rti1516::AttributeNotRecognized,
00562              rti1516::FederateInternalError);
00563 
00564     virtual
00565     void
00566     attributeIsNotOwned(rti1516::ObjectInstanceHandle theObject,
00567                         rti1516::AttributeHandle theAttribute)
00568       throw (rti1516::ObjectInstanceNotKnown,
00569              rti1516::AttributeNotRecognized,
00570              rti1516::FederateInternalError);
00571 
00572     virtual
00573     void
00574     attributeIsOwnedByRTI(rti1516::ObjectInstanceHandle theObject,
00575                           rti1516::AttributeHandle theAttribute)
00576       throw (rti1516::ObjectInstanceNotKnown,
00577              rti1516::AttributeNotRecognized,
00578              rti1516::FederateInternalError);
00579 
00583   
00585     virtual
00586     void
00587     timeRegulationEnabled(rti1516::LogicalTime const & theFederateTime)
00588       throw (rti1516::InvalidLogicalTime,
00589              rti1516::NoRequestToEnableTimeRegulationWasPending,
00590              rti1516::FederateInternalError);
00591 
00593     virtual
00594     void
00595     timeConstrainedEnabled(rti1516::LogicalTime const & theFederateTime)
00596       throw (rti1516::InvalidLogicalTime,
00597              rti1516::NoRequestToEnableTimeConstrainedWasPending,
00598              rti1516::FederateInternalError);
00599 
00601     virtual
00602     void
00603     timeAdvanceGrant(rti1516::LogicalTime const & theTime)
00604       throw (rti1516::InvalidLogicalTime,
00605              rti1516::JoinedFederateIsNotInTimeAdvancingState,
00606              rti1516::FederateInternalError);
00607 
00609     virtual
00610     void
00611     requestRetraction(rti1516::MessageRetractionHandle theHandle)
00612       throw (rti1516::FederateInternalError);
00613 
00614 protected:
00615 
00617    virtual DtFomClassMgr* fom();
00618    virtual DtObjectMgr* objMgr();
00619 
00620 protected:
00621    DtFederateMgr* myFedMgr;
00622 };
00623 
00624 #endif //! DtIFSPEC1516
00625 #endif //! DtFedAmbPrinter1516_h