ddsBroker/ddsBroker/throttle.h

Go to the documentation of this file.

/****************************************************************************
 * Copyright (c) 2013 MAK Technologies, Inc.
 * All rights reserved.
 ****************************************************************************/


#pragma once

#include <ddsBroker/dllExport.h>
#include <vlpi/entityIdentifier.h>
#include <vlpi/entityType.h>
#include <map>

class DtBaseEntityStateRepository;

namespace MAKVrExchange
{

   namespace DtDdsBroker
   {

      class DT_DLL_DDSBROKER DtThrottle
      {
      public:

         typedef std::map< DtEntityIdentifier, DtTime >  entityIdContainerType;

         typedef std::map< DtEntityType, DtTime >  entityTypeContainerType;

         typedef std::map< DtString, DtTime >  simpleThrottleContainerType;

         DtThrottle( DtTime defaultValue = 10 );

         DtThrottle( const DtThrottle& original );

         virtual ~DtThrottle();

         DtThrottle& operator = ( const DtThrottle& rightOperand );

         bool operator == ( const DtThrottle& rightOperand ) const;

         bool operator != ( const DtThrottle& rightOperand ) const;


         virtual void addEntityIdRate( const DtEntityIdentifier& id, const DtTime& time );

         virtual void addEntityIdRates( const entityIdContainerType& rates );
         virtual void addEntityIdRates( const simpleThrottleContainerType& rates );

         virtual void addEntityTypeRate( const DtEntityType& type, const DtTime& time );

         virtual void addEntityTypeRates( const entityTypeContainerType& rates );
         virtual void addEntityTypeRates( const simpleThrottleContainerType& rates );

         virtual void setDefaultRate( DtTime time );


         virtual bool isThrottlingRateOk( const DtBaseEntityStateRepository& stateInformation,
            const DtTime& lastTick, const DtTime& thisUpdate ) const;

         virtual bool isThrottlingRateOk( const DtTime& lastTick, const DtTime& thisUpdate ) const;

         virtual DtTime objectThrottleRate( const DtBaseEntityStateRepository& stateInformation ) const;

         virtual DtTime objectThrottleRate() const;

      protected:


         entityIdContainerType  myEntityIdThrottleSettings;

         entityTypeContainerType  myEntityTypeThrottleSettings;

         DtTime  myDefaultThrottleSetting;


      };


      inline void DtThrottle::addEntityIdRate( const DtEntityIdentifier& id, const DtTime& time )
      {
         myEntityIdThrottleSettings[ id ] = time;
      }

      inline void DtThrottle::addEntityTypeRate( const DtEntityType& type, const DtTime& time )
      {
         myEntityTypeThrottleSettings[ type ] = time;
      }

      inline void DtThrottle::setDefaultRate( DtTime time )
      {
         myDefaultThrottleSetting = time;
      }

   }
}