throttle.h

Go to the documentation of this file.

/******************************************************************************
** Copyright (c) 2006 MÄK Technologies, Inc.** All rights reserved.
******************************************************************************/
/*******************************************************************************
* $RCSfile: throttle.h,v $ $Revision: 1.6 $ $State:  
$******************************************************************************/

#ifndef throttle_H_
#define throttle_H_


/* VR-Exchange includes */
 

/* VR-Link includes */
#include <vlpi/entityIdentifier.h> //DtEntityIdentifier
#include <vlpi/entityType.h>       //DtEntityType

#include <map> //std::map<>
#include <namespace.h>

class DtBaseEntityStateRepository;

namespace MAKVrExchange { namespace DtTenaBroker {


class DT_DLL_TENABROKER DtThrottle
{

public:

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

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

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

   DtThrottle( DtTime defaultValue = DtThrottle::thisDefaultValue );

   virtual ~DtThrottle();

   DtThrottle( const DtThrottle& original );

   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;

   static const DtTime thisDefaultValue;

protected:



   entityIdContainerType  myEntityIdThrottleSettings;

   entityTypeContainerType  myEntityTypeThrottleSettings;

   DtTime  myDefaultThrottleSetting;


}; //end class DtThrottle

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

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

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

}}

#endif //end #ifndef throttle_H_