netStatsFedAmb1516.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2012 MaK Technologies, Inc.
** All rights reserved.
*******************************************************************************/

#ifndef netStatsFedAmb1516_h__
#define netStatsFedAmb1516_h__

#ifdef DtIFSPEC1516

#include "rtiMsConfig.h"
#include "fedAmbWrap1516.h"
#include <vlutil/vlTime.h>
#include "fedMgr.h"
#include <rtiutil/fedAmbAPITypes.h>

// Forward References
class DtNetStatsMonitor;

class DtNetStatsFedAmbWrapper : public DtFedAmbWrapper
{
public:

   DtNetStatsFedAmbWrapper(DtFederateMgr* mgr, DtTime start);

   virtual ~DtNetStatsFedAmbWrapper() 
      throw ();

   bool subscriptionsChanged();

   // Set the handle to the Network Statistics Monitor
   virtual void setTrafficMonitor( DtNetStatsMonitor* stats );

   virtual bool netStatsEnabled() const;
   virtual void setNetStatsEnabled(bool shouldEnable);

   // Initializes the high performance timer (must be paired with endTimerAndRecord)
   virtual void startTimer();

   // Records the service and the elapsed time (must be paired with startTimer)
   virtual void endTimerAndRecord(DtFedAmbAPIType fedAmbType);

protected:

   MAKRti::DtTime myStartTime;
   MAKRti::DtClock myClock;
   DtFederateMgr* myMgr;
   bool mySubscriptionsChanged;

   // Statistics Log
   DtNetStatsMonitor* myNetStats;

   // API Call Timer
   MAKRti::DtClock   myTimer;

   // Enable/Disable flag for network statistics
   bool myNetStatsEnabled;

public:
  
   //---------------------------------------------------------------
   // The federate ambassador calls
   //---------------------------------------------------------------

    // 4.7
    virtual
    void
    synchronizationPointRegistrationSucceeded(std::wstring const & label)
      throw (rti1516::FederateInternalError);

    virtual
    void
    synchronizationPointRegistrationFailed(std::wstring const & label,
                                           rti1516::SynchronizationFailureReason reason)
      throw (rti1516::FederateInternalError);

    // 4.8
    virtual
    void
    announceSynchronizationPoint(std::wstring  const & label,
                                 rti1516::VariableLengthData const & theUserSuppliedTag)
      throw (rti1516::FederateInternalError);

    // 4.10
    virtual
    void
    federationSynchronized(std::wstring const & label)
      throw (rti1516::FederateInternalError);

    // 4.12
    virtual
    void
    initiateFederateSave(std::wstring const & label)
      throw (rti1516::UnableToPerformSave,
             rti1516::FederateInternalError);

    virtual
    void
    initiateFederateSave(std::wstring const & label,
                         rti1516::LogicalTime const & theTime)
      throw (rti1516::UnableToPerformSave,
             rti1516::InvalidLogicalTime,
             rti1516::FederateInternalError);

    // 4.15
    virtual
    void
    federationSaved()
      throw (rti1516::FederateInternalError);

    virtual
    void
    federationNotSaved(rti1516::SaveFailureReason theSaveFailureReason)
      throw (rti1516::FederateInternalError);


    // 4.17
    virtual
    void
    federationSaveStatusResponse(
      rti1516::FederateHandleSaveStatusPairVector const & theFederateStatusVector)
      throw (rti1516::FederateInternalError);

    // 4.19
    virtual
    void
    requestFederationRestoreSucceeded(std::wstring const & label)
      throw (rti1516::FederateInternalError);

    virtual
    void
    requestFederationRestoreFailed(std::wstring const & label)
      throw (rti1516::FederateInternalError);

    // 4.20
    virtual
    void
    federationRestoreBegun()
      throw (rti1516::FederateInternalError);

    // 4.21
    virtual
    void
    initiateFederateRestore(std::wstring         const & label,
                            rti1516::FederateHandle handle)
      throw (rti1516::SpecifiedSaveLabelDoesNotExist,
             rti1516::CouldNotInitiateRestore,
             rti1516::FederateInternalError);

    // 4.23
    virtual
    void
    federationRestored()
      throw (rti1516::FederateInternalError);

    virtual
    void
    federationNotRestored(rti1516::RestoreFailureReason theRestoreFailureReason)
      throw (rti1516::FederateInternalError);

    // 4.25
    virtual
    void
    federationRestoreStatusResponse(
      rti1516::FederateHandleRestoreStatusPairVector  const & theFederateStatusVector)
      throw (rti1516::FederateInternalError);

    // Declaration Management Services //
  
    // 5.10
    virtual
    void
    startRegistrationForObjectClass(rti1516::ObjectClassHandle theClass)
      throw (rti1516::ObjectClassNotPublished,
             rti1516::FederateInternalError);

    // 5.11
    virtual
    void
    stopRegistrationForObjectClass(rti1516::ObjectClassHandle theClass)
      throw (rti1516::ObjectClassNotPublished,
             rti1516::FederateInternalError);

    // 5.12
    virtual
    void
    turnInteractionsOn(rti1516::InteractionClassHandle theHandle)
      throw (rti1516::InteractionClassNotPublished,
             rti1516::FederateInternalError);

    // 5.13
    virtual
    void
    turnInteractionsOff(rti1516::InteractionClassHandle theHandle)
      throw (rti1516::InteractionClassNotPublished,
             rti1516::FederateInternalError);

    // Object Management Services //
  
    // 6.3
    virtual
    void
    objectInstanceNameReservationSucceeded(std::wstring const &
                                           theObjectInstanceName)
      throw (rti1516::UnknownName,
             rti1516::FederateInternalError);

    virtual
    void
    objectInstanceNameReservationFailed(std::wstring const &
                                        theObjectInstanceName)
      throw (rti1516::UnknownName,
             rti1516::FederateInternalError);

  
    // 6.5
    virtual
    void
    discoverObjectInstance(rti1516::ObjectInstanceHandle theObject,
                           rti1516::ObjectClassHandle theObjectClass,
                           std::wstring const & theObjectInstanceName)
      throw (rti1516::CouldNotDiscover,
             rti1516::ObjectClassNotKnown,
             rti1516::FederateInternalError);

    // 6.7
    virtual
    void
    reflectAttributeValues
    (rti1516::ObjectInstanceHandle theObject,
     rti1516::AttributeHandleValueMap const & theAttributeValues,
     rti1516::VariableLengthData const & theUserSuppliedTag,
     rti1516::OrderType sentOrder,
     rti1516::TransportationType theType)
      throw (rti1516::ObjectInstanceNotKnown,
             rti1516::AttributeNotRecognized,
             rti1516::AttributeNotSubscribed,
             rti1516::FederateInternalError);

    virtual
    void
    reflectAttributeValues
    (rti1516::ObjectInstanceHandle theObject,
     rti1516::AttributeHandleValueMap const & theAttributeValues,
     rti1516::VariableLengthData const & theUserSuppliedTag,
     rti1516::OrderType sentOrder,
     rti1516::TransportationType theType,
     rti1516::RegionHandleSet const & theSentRegionHandleSet)
      throw (rti1516::ObjectInstanceNotKnown,
             rti1516::AttributeNotRecognized,
             rti1516::AttributeNotSubscribed,
             rti1516::FederateInternalError);

    virtual
    void
    reflectAttributeValues
    (rti1516::ObjectInstanceHandle theObject,
     rti1516::AttributeHandleValueMap const & theAttributeValues,
     rti1516::VariableLengthData const & theUserSuppliedTag,
     rti1516::OrderType sentOrder,
     rti1516::TransportationType theType,
     rti1516::LogicalTime const & theTime,
     rti1516::OrderType receivedOrder)
      throw (rti1516::ObjectInstanceNotKnown,
             rti1516::AttributeNotRecognized,
             rti1516::AttributeNotSubscribed,
             rti1516::FederateInternalError);
  
    virtual
    void
    reflectAttributeValues
    (rti1516::ObjectInstanceHandle theObject,
     rti1516::AttributeHandleValueMap const & theAttributeValues,
     rti1516::VariableLengthData const & theUserSuppliedTag,
     rti1516::OrderType sentOrder,
     rti1516::TransportationType theType,
     rti1516::LogicalTime const & theTime,
     rti1516::OrderType receivedOrder,
     rti1516::RegionHandleSet const & theSentRegionHandleSet)
      throw (rti1516::ObjectInstanceNotKnown,
             rti1516::AttributeNotRecognized,
             rti1516::AttributeNotSubscribed,
             rti1516::FederateInternalError);
  
    virtual
    void
    reflectAttributeValues
    (rti1516::ObjectInstanceHandle theObject,
     rti1516::AttributeHandleValueMap const & theAttributeValues,
     rti1516::VariableLengthData const & theUserSuppliedTag,
     rti1516::OrderType sentOrder,
     rti1516::TransportationType theType,
     rti1516::LogicalTime const & theTime,
     rti1516::OrderType receivedOrder,
     rti1516::MessageRetractionHandle theHandle)
      throw (rti1516::ObjectInstanceNotKnown,
             rti1516::AttributeNotRecognized,
             rti1516::AttributeNotSubscribed,
             rti1516::InvalidLogicalTime,
             rti1516::FederateInternalError);

    virtual
    void
    reflectAttributeValues
    (rti1516::ObjectInstanceHandle theObject,
     rti1516::AttributeHandleValueMap const & theAttributeValues,
     rti1516::VariableLengthData const & theUserSuppliedTag,
     rti1516::OrderType sentOrder,
     rti1516::TransportationType theType,
     rti1516::LogicalTime const & theTime,
     rti1516::OrderType receivedOrder,
     rti1516::MessageRetractionHandle theHandle,
     rti1516::RegionHandleSet const & theSentRegionHandleSet)
      throw (rti1516::ObjectInstanceNotKnown,
             rti1516::AttributeNotRecognized,
             rti1516::AttributeNotSubscribed,
             rti1516::InvalidLogicalTime,
             rti1516::FederateInternalError);

    // Simple event processing ignores additional reflect parameters
    virtual void processReflectAttributeValues(rti1516::ObjectInstanceHandle theObject);

    // 6.9
    virtual
    void
    receiveInteraction
    (rti1516::InteractionClassHandle theInteraction,
     rti1516::ParameterHandleValueMap const & theParameterValues,
     rti1516::VariableLengthData const & theUserSuppliedTag,
     rti1516::OrderType sentOrder,
     rti1516::TransportationType theType)
      throw (rti1516::InteractionClassNotRecognized,
             rti1516::InteractionParameterNotRecognized,
             rti1516::InteractionClassNotSubscribed,
             rti1516::FederateInternalError);

    virtual
    void
    receiveInteraction
    (rti1516::InteractionClassHandle theInteraction,
     rti1516::ParameterHandleValueMap const & theParameterValues,
     rti1516::VariableLengthData const & theUserSuppliedTag,
     rti1516::OrderType sentOrder,
     rti1516::TransportationType theType,
     rti1516::RegionHandleSet const & theSentRegionHandleSet)
      throw (rti1516::InteractionClassNotRecognized,
             rti1516::InteractionParameterNotRecognized,
             rti1516::InteractionClassNotSubscribed,
             rti1516::FederateInternalError);

    virtual
    void
    receiveInteraction
    (rti1516::InteractionClassHandle theInteraction,
     rti1516::ParameterHandleValueMap const & theParameterValues,
     rti1516::VariableLengthData const & theUserSuppliedTag,
     rti1516::OrderType sentOrder,
     rti1516::TransportationType theType,
     rti1516::LogicalTime const & theTime,
     rti1516::OrderType receivedOrder)
      throw (rti1516::InteractionClassNotRecognized,
             rti1516::InteractionParameterNotRecognized,
             rti1516::InteractionClassNotSubscribed,
             rti1516::FederateInternalError);

    virtual
    void
    receiveInteraction
    (rti1516::InteractionClassHandle theInteraction,
     rti1516::ParameterHandleValueMap const & theParameterValues,
     rti1516::VariableLengthData const & theUserSuppliedTag,
     rti1516::OrderType sentOrder,
     rti1516::TransportationType theType,
     rti1516::LogicalTime const & theTime,
     rti1516::OrderType receivedOrder,
     rti1516::RegionHandleSet const & theSentRegionHandleSet)
      throw (rti1516::InteractionClassNotRecognized,
             rti1516::InteractionParameterNotRecognized,
             rti1516::InteractionClassNotSubscribed,
             rti1516::FederateInternalError);

    virtual
    void
    receiveInteraction
    (rti1516::InteractionClassHandle theInteraction,
     rti1516::ParameterHandleValueMap const & theParameterValues,
     rti1516::VariableLengthData const & theUserSuppliedTag,
     rti1516::OrderType sentOrder,
     rti1516::TransportationType theType,
     rti1516::LogicalTime const & theTime,
     rti1516::OrderType receivedOrder,
     rti1516::MessageRetractionHandle theHandle)
      throw (rti1516::InteractionClassNotRecognized,
             rti1516::InteractionParameterNotRecognized,
             rti1516::InteractionClassNotSubscribed,
             rti1516::InvalidLogicalTime,
             rti1516::FederateInternalError);

    virtual
    void
    receiveInteraction
    (rti1516::InteractionClassHandle theInteraction,
     rti1516::ParameterHandleValueMap const & theParameterValues,
     rti1516::VariableLengthData const & theUserSuppliedTag,
     rti1516::OrderType sentOrder,
     rti1516::TransportationType theType,
     rti1516::LogicalTime const & theTime,
     rti1516::OrderType receivedOrder,
     rti1516::MessageRetractionHandle theHandle,
     rti1516::RegionHandleSet const & theSentRegionHandleSet)
      throw (rti1516::InteractionClassNotRecognized,
             rti1516::InteractionParameterNotRecognized,
             rti1516::InteractionClassNotSubscribed,
             rti1516::InvalidLogicalTime,
             rti1516::FederateInternalError);

    // Simple event processing ignores additional receive parameters
    virtual void processReceiveInteraction(rti1516::InteractionClassHandle theInteraction);

    // 6.11
    virtual
    void
    removeObjectInstance(rti1516::ObjectInstanceHandle theObject,
                         rti1516::VariableLengthData const & theUserSuppliedTag,
                         rti1516::OrderType sentOrder)
      throw (rti1516::ObjectInstanceNotKnown,
             rti1516::FederateInternalError);

    virtual
    void
    removeObjectInstance(rti1516::ObjectInstanceHandle theObject,
                         rti1516::VariableLengthData const & theUserSuppliedTag,
                         rti1516::OrderType sentOrder,
                         rti1516::LogicalTime const & theTime,
                         rti1516::OrderType receivedOrder)
      throw (rti1516::ObjectInstanceNotKnown,
             rti1516::FederateInternalError);

    virtual
    void
    removeObjectInstance(rti1516::ObjectInstanceHandle theObject,
                         rti1516::VariableLengthData const & theUserSuppliedTag,
                         rti1516::OrderType sentOrder,
                         rti1516::LogicalTime const & theTime,
                         rti1516::OrderType receivedOrder,
                         rti1516::MessageRetractionHandle theHandle)
      throw (rti1516::ObjectInstanceNotKnown,
             rti1516::InvalidLogicalTime,
             rti1516::FederateInternalError);

    // Simple event processing ignores additional remove parameters
    virtual void processRemoveObjectInstance(rti1516::ObjectInstanceHandle theObject);

    // 6.15
    virtual
    void
    attributesInScope
    (rti1516::ObjectInstanceHandle theObject,
     rti1516::AttributeHandleSet const & theAttributes)
      throw (rti1516::ObjectInstanceNotKnown,
             rti1516::AttributeNotRecognized,
             rti1516::AttributeNotSubscribed,
             rti1516::FederateInternalError);

    // 6.16
    virtual
    void
    attributesOutOfScope
    (rti1516::ObjectInstanceHandle theObject,
     rti1516::AttributeHandleSet const & theAttributes)
      throw (rti1516::ObjectInstanceNotKnown,
             rti1516::AttributeNotRecognized,
             rti1516::AttributeNotSubscribed,
             rti1516::FederateInternalError);

    // 6.18
    virtual
    void
    provideAttributeValueUpdate
    (rti1516::ObjectInstanceHandle theObject,
     rti1516::AttributeHandleSet const & theAttributes,
     rti1516::VariableLengthData const & theUserSuppliedTag)
      throw (rti1516::ObjectInstanceNotKnown,
             rti1516::AttributeNotRecognized,
             rti1516::AttributeNotOwned,
             rti1516::FederateInternalError);

    // 6.19
    virtual
    void
    turnUpdatesOnForObjectInstance
    (rti1516::ObjectInstanceHandle theObject,
     rti1516::AttributeHandleSet const & theAttributes)
      throw (rti1516::ObjectInstanceNotKnown,
             rti1516::AttributeNotRecognized,
             rti1516::AttributeNotOwned,
             rti1516::FederateInternalError);

    // 6.20
    virtual
    void
    turnUpdatesOffForObjectInstance
    (rti1516::ObjectInstanceHandle theObject,
     rti1516::AttributeHandleSet const & theAttributes)
      throw (rti1516::ObjectInstanceNotKnown,
             rti1516::AttributeNotRecognized,
             rti1516::AttributeNotOwned,
             rti1516::FederateInternalError);

    // Ownership Management Services //
  
    // 7.4
    virtual
    void
    requestAttributeOwnershipAssumption
    (rti1516::ObjectInstanceHandle theObject,
     rti1516::AttributeHandleSet const & offeredAttributes,
     rti1516::VariableLengthData const & theUserSuppliedTag)
      throw (rti1516::ObjectInstanceNotKnown,
             rti1516::AttributeNotRecognized,
             rti1516::AttributeAlreadyOwned,
             rti1516::AttributeNotPublished,
             rti1516::FederateInternalError);

    // 7.5
    virtual
    void
    requestDivestitureConfirmation
    (rti1516::ObjectInstanceHandle theObject,
     rti1516::AttributeHandleSet const & releasedAttributes)
      throw (rti1516::ObjectInstanceNotKnown,
             rti1516::AttributeNotRecognized,
             rti1516::AttributeNotOwned,
             rti1516::AttributeDivestitureWasNotRequested,
             rti1516::FederateInternalError);

    // 7.7
    virtual
    void
    attributeOwnershipAcquisitionNotification
    (rti1516::ObjectInstanceHandle theObject,
     rti1516::AttributeHandleSet const & securedAttributes,
     rti1516::VariableLengthData const & theUserSuppliedTag)
      throw (rti1516::ObjectInstanceNotKnown,
             rti1516::AttributeNotRecognized,
             rti1516::AttributeAcquisitionWasNotRequested,
             rti1516::AttributeAlreadyOwned,
             rti1516::AttributeNotPublished,
             rti1516::FederateInternalError);

    // 7.10
    virtual
    void
    attributeOwnershipUnavailable
    (rti1516::ObjectInstanceHandle theObject,
     rti1516::AttributeHandleSet const & theAttributes)
      throw (rti1516::ObjectInstanceNotKnown,
             rti1516::AttributeNotRecognized,
             rti1516::AttributeAlreadyOwned,
             rti1516::AttributeAcquisitionWasNotRequested,
             rti1516::FederateInternalError);

    // 7.11
    virtual
    void
    requestAttributeOwnershipRelease
    (rti1516::ObjectInstanceHandle theObject,
     rti1516::AttributeHandleSet const & candidateAttributes,
     rti1516::VariableLengthData const & theUserSuppliedTag)
      throw (rti1516::ObjectInstanceNotKnown,
             rti1516::AttributeNotRecognized,
             rti1516::AttributeNotOwned,
             rti1516::FederateInternalError);

    // 7.15
    virtual
    void
    confirmAttributeOwnershipAcquisitionCancellation
    (rti1516::ObjectInstanceHandle theObject,
     rti1516::AttributeHandleSet const & theAttributes)
      throw (rti1516::ObjectInstanceNotKnown,
             rti1516::AttributeNotRecognized,
             rti1516::AttributeAlreadyOwned,
             rti1516::AttributeAcquisitionWasNotCanceled,
             rti1516::FederateInternalError);

    // 7.17
    virtual
    void
    informAttributeOwnership(rti1516::ObjectInstanceHandle theObject,
                             rti1516::AttributeHandle theAttribute,
                             rti1516::FederateHandle theOwner)
      throw (rti1516::ObjectInstanceNotKnown,
             rti1516::AttributeNotRecognized,
             rti1516::FederateInternalError);

    virtual
    void
    attributeIsNotOwned(rti1516::ObjectInstanceHandle theObject,
                        rti1516::AttributeHandle theAttribute)
      throw (rti1516::ObjectInstanceNotKnown,
             rti1516::AttributeNotRecognized,
             rti1516::FederateInternalError);

    virtual
    void
    attributeIsOwnedByRTI(rti1516::ObjectInstanceHandle theObject,
                          rti1516::AttributeHandle theAttribute)
      throw (rti1516::ObjectInstanceNotKnown,
             rti1516::AttributeNotRecognized,
             rti1516::FederateInternalError);

    // Time Management Services //
  
    // 8.3
    virtual
    void
    timeRegulationEnabled(rti1516::LogicalTime const & theFederateTime)
      throw (rti1516::InvalidLogicalTime,
             rti1516::NoRequestToEnableTimeRegulationWasPending,
             rti1516::FederateInternalError);

    // 8.6
    virtual
    void
    timeConstrainedEnabled(rti1516::LogicalTime const & theFederateTime)
      throw (rti1516::InvalidLogicalTime,
             rti1516::NoRequestToEnableTimeConstrainedWasPending,
             rti1516::FederateInternalError);

    // 8.13
    virtual
    void
    timeAdvanceGrant(rti1516::LogicalTime const & theTime)
      throw (rti1516::InvalidLogicalTime,
             rti1516::JoinedFederateIsNotInTimeAdvancingState,
             rti1516::FederateInternalError);

    // 8.22
    virtual
    void
    requestRetraction(rti1516::MessageRetractionHandle theHandle)
      throw (rti1516::FederateInternalError);

   private:
      static const DtString theUnknownName;

};

#endif // DtIFSPEC1516
#endif // netStatsFedAmb1516_h__