netStatsFedAmb1516e.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2012 MaK Technologies, Inc.
** All rights reserved.
*******************************************************************************/
#ifndef netStatsFedAmb1516e_h__
#define netStatsFedAmb1516e_h__

#ifdef DtIFSPEC1516E

#include "rtiMsConfig.h"
#include "fedAmbWrap1516e.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 Traffic 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:
    // 4.4
    virtual void connectionLost (
        std::wstring const & faultDescription)
        throw (
        FederateInternalError);

    // 4.8
    virtual void reportFederationExecutions (
        FederationExecutionInformationVector const &
        theFederationExecutionInformationList)
        throw (
        FederateInternalError);

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

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

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

    // 4.15
    virtual void federationSynchronized (
        std::wstring const & label,
        FederateHandleSet const& failedToSyncSet)
        throw (
        FederateInternalError);

    // 4.17
    virtual void initiateFederateSave (
        std::wstring const & label)
        throw (
        FederateInternalError);

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

    // 4.20
    virtual void federationSaved ()
        throw (
        FederateInternalError);

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


    // 4.23
    virtual void federationSaveStatusResponse (
        FederateHandleSaveStatusPairVector const &
        theFederateStatusVector)
        throw (
        FederateInternalError);

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

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

    // 4.26
    virtual void federationRestoreBegun ()
        throw (
        FederateInternalError);

    // 4.27
    virtual void initiateFederateRestore (
        std::wstring const & label,
        std::wstring const & federateName,
        FederateHandle handle)
        throw (
        FederateInternalError);

    // 4.29
    virtual void federationRestored ()
        throw (
        FederateInternalError);

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

    // 4.32
    virtual void federationRestoreStatusResponse (
        FederateRestoreStatusVector const &
        theFederateRestoreStatusVector)
        throw (
        FederateInternalError);

    // Declaration Management Services //

    // 5.10
    virtual void startRegistrationForObjectClass (
        ObjectClassHandle theClass)
        throw (
        FederateInternalError);

    // 5.11
    virtual void stopRegistrationForObjectClass (
        ObjectClassHandle theClass)
        throw (
        FederateInternalError);

    // 5.12
    virtual void turnInteractionsOn (
        InteractionClassHandle theHandle)
        throw (
        FederateInternalError);

    // 5.13
    virtual void turnInteractionsOff (
        InteractionClassHandle theHandle)
        throw (
        FederateInternalError);

    // Object Management Services //

    // 6.3
    virtual void objectInstanceNameReservationSucceeded (
        std::wstring const & theObjectInstanceName)
        throw (
        FederateInternalError);

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

    // 6.6
    virtual void multipleObjectInstanceNameReservationSucceeded (
        std::set<std::wstring> const & theObjectInstanceNames)
        throw (
        FederateInternalError);

    virtual void multipleObjectInstanceNameReservationFailed (
        std::set<std::wstring> const & theObjectInstanceNames)
        throw (
        FederateInternalError);

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

    virtual void discoverObjectInstance (
        ObjectInstanceHandle theObject,
        ObjectClassHandle theObjectClass,
        std::wstring const & theObjectInstanceName,
        FederateHandle producingFederate)
        throw (
        FederateInternalError);

    // 6.11
    virtual void reflectAttributeValues (
        ObjectInstanceHandle theObject,
        AttributeHandleValueMap const & theAttributeValues,
        VariableLengthData const & theUserSuppliedTag,
        OrderType sentOrder,
        TransportationType theType,
        SupplementalReflectInfo theReflectInfo)
        throw (
        FederateInternalError);

    virtual void reflectAttributeValues (
        ObjectInstanceHandle theObject,
        AttributeHandleValueMap const & theAttributeValues,
        VariableLengthData const & theUserSuppliedTag,
        OrderType sentOrder,
        TransportationType theType,
        LogicalTime const & theTime,
        OrderType receivedOrder,
        SupplementalReflectInfo theReflectInfo)
        throw (
        FederateInternalError);

    virtual void reflectAttributeValues (
        ObjectInstanceHandle theObject,
        AttributeHandleValueMap const & theAttributeValues,
        VariableLengthData const & theUserSuppliedTag,
        OrderType sentOrder,
        TransportationType theType,
        LogicalTime const & theTime,
        OrderType receivedOrder,
        MessageRetractionHandle theHandle,
        SupplementalReflectInfo theReflectInfo)
        throw (
        FederateInternalError);

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

    // 6.13
    virtual void receiveInteraction (
        InteractionClassHandle theInteraction,
        ParameterHandleValueMap const & theParameterValues,
        VariableLengthData const & theUserSuppliedTag,
        OrderType sentOrder,
        TransportationType theType,
        SupplementalReceiveInfo theReceiveInfo)
        throw (
        FederateInternalError);

    virtual void receiveInteraction (
        InteractionClassHandle theInteraction,
        ParameterHandleValueMap const & theParameterValues,
        VariableLengthData const & theUserSuppliedTag,
        OrderType sentOrder,
        TransportationType theType,
        LogicalTime const & theTime,
        OrderType receivedOrder,
        SupplementalReceiveInfo theReceiveInfo)
        throw (
        FederateInternalError);

    virtual void receiveInteraction (
        InteractionClassHandle theInteraction,
        ParameterHandleValueMap const & theParameterValues,
        VariableLengthData const & theUserSuppliedTag,
        OrderType sentOrder,
        TransportationType theType,
        LogicalTime const & theTime,
        OrderType receivedOrder,
        MessageRetractionHandle theHandle,
        SupplementalReceiveInfo theReceiveInfo)
        throw (
        FederateInternalError);

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

    // 6.15
    virtual void removeObjectInstance (
        ObjectInstanceHandle theObject,
        VariableLengthData const & theUserSuppliedTag,
        OrderType sentOrder,
        SupplementalRemoveInfo theRemoveInfo)
        throw (
        FederateInternalError);

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

    virtual void removeObjectInstance (
        ObjectInstanceHandle theObject,
        VariableLengthData const & theUserSuppliedTag,
        OrderType sentOrder,
        LogicalTime const & theTime,
        OrderType receivedOrder,
        MessageRetractionHandle theHandle,
        SupplementalRemoveInfo theRemoveInfo)
        throw (
        FederateInternalError);

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

    // 6.17
    virtual void attributesInScope (
        ObjectInstanceHandle theObject,
        AttributeHandleSet const & theAttributes)
        throw (
        FederateInternalError);

    // 6.18
    virtual void attributesOutOfScope (
        ObjectInstanceHandle theObject,
        AttributeHandleSet const & theAttributes)
        throw (
        FederateInternalError);

    // 6.20
    virtual void provideAttributeValueUpdate (
        ObjectInstanceHandle theObject,
        AttributeHandleSet const & theAttributes,
        VariableLengthData const & theUserSuppliedTag)
        throw (
        FederateInternalError);

    // 6.21
    virtual void turnUpdatesOnForObjectInstance (
        ObjectInstanceHandle theObject,
        AttributeHandleSet const & theAttributes)
        throw (
        FederateInternalError);

    virtual void turnUpdatesOnForObjectInstance (
        ObjectInstanceHandle theObject,
        AttributeHandleSet const & theAttributes,
        std::wstring const & updateRateDesignator)
        throw (
        FederateInternalError);

    // 6.22
    virtual void turnUpdatesOffForObjectInstance (
        ObjectInstanceHandle theObject,
        AttributeHandleSet const & theAttributes)
        throw (
        FederateInternalError);

    // 6.24
    virtual void confirmAttributeTransportationTypeChange (
        ObjectInstanceHandle theObject,
        AttributeHandleSet theAttributes,
        TransportationType theTransportation)
        throw (
        FederateInternalError);

    // 6.26
    virtual void reportAttributeTransportationType (
        ObjectInstanceHandle theObject,
        AttributeHandle theAttribute,
        TransportationType theTransportation)
        throw (
        FederateInternalError);

    // 6.28
    virtual void confirmInteractionTransportationTypeChange (
        InteractionClassHandle theInteraction,
        TransportationType theTransportation)
        throw (
        FederateInternalError);

    // 6.30
    virtual void reportInteractionTransportationType (
        FederateHandle federateHandle,
        InteractionClassHandle theInteraction,
        TransportationType  theTransportation)
        throw (
        FederateInternalError);


    // Ownership Management Services //

    // 7.4
    virtual void requestAttributeOwnershipAssumption (
        ObjectInstanceHandle theObject,
        AttributeHandleSet const & offeredAttributes,
        VariableLengthData const & theUserSuppliedTag)
        throw (
        FederateInternalError);

    // 7.5
    virtual void requestDivestitureConfirmation (
        ObjectInstanceHandle theObject,
        AttributeHandleSet const & releasedAttributes)
        throw (
        FederateInternalError);

    // 7.7
    virtual void attributeOwnershipAcquisitionNotification (
        ObjectInstanceHandle theObject,
        AttributeHandleSet const & securedAttributes,
        VariableLengthData const & theUserSuppliedTag)
        throw (
        FederateInternalError);

    // 7.10
    virtual void attributeOwnershipUnavailable (
        ObjectInstanceHandle theObject,
        AttributeHandleSet const & theAttributes)
        throw (
        FederateInternalError);

    // 7.11
    virtual void requestAttributeOwnershipRelease (
        ObjectInstanceHandle theObject,
        AttributeHandleSet const & candidateAttributes,
        VariableLengthData const & theUserSuppliedTag)
        throw (
        FederateInternalError);

    // 7.16
    virtual void confirmAttributeOwnershipAcquisitionCancellation (
        ObjectInstanceHandle theObject,
        AttributeHandleSet const & theAttributes)
        throw (
        FederateInternalError);

    // 7.18
    virtual void informAttributeOwnership (
        ObjectInstanceHandle theObject,
        AttributeHandle theAttribute,
        FederateHandle theOwner)
        throw (
        FederateInternalError);

    virtual void attributeIsNotOwned (
        ObjectInstanceHandle theObject,
        AttributeHandle theAttribute)
        throw (
        FederateInternalError);

    virtual void attributeIsOwnedByRTI (
        ObjectInstanceHandle theObject,
        AttributeHandle theAttribute)
        throw (
        FederateInternalError);

    // Time Management Services //

    // 8.3
    virtual void timeRegulationEnabled (
        LogicalTime const & theFederateTime)
        throw (
        FederateInternalError);

    // 8.6
    virtual void timeConstrainedEnabled (
        LogicalTime const & theFederateTime)
        throw (
        FederateInternalError);

    // 8.13
    virtual void timeAdvanceGrant (
        LogicalTime const & theTime)
        throw (
        FederateInternalError);

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

   private:
      static const DtString theUnknownName;
};
#endif // DtIFSPEC1516E
#endif // netStatsFedAmb1516e_h__