include/vrvCore/DtSimEntry.h

Go to the documentation of this file.

/******************************************************************************
** Copyright (c) 2009 MAK Technologies, Inc.
** All rights reserved.
******************************************************************************/
/******************************************************************************
** $RCSfile: DtSimEntry.h,v $ $Revision: 1.14 $ $State: Exp $
******************************************************************************/


#ifndef DtSimEntry_H_
#define DtSimEntry_H_

#include <vrvCore/vrvCore.h>
#include <vrvCore/DtUniqueID.h>
#include <vrvCore/DtSimEntryUpdater.h>

#include <vector>
#include <map>

namespace makVrv
{
   class DtDe;
   struct DtSimState;
   class DtBaseStateView;

   class DT_DLL_VRVCORE DtSimEntry
   {
   public:

      friend class DtSimData;

      DtSimEntry(DtDe& de, DtUniqueID id);

      virtual ~DtSimEntry();

      typedef std::vector<DtSimState*> SimStateVector;

      typedef std::multimap< DtSimEntryUpdater::UpdateRate, DtBaseStateView* > UpdateRateMap;

      const SimStateVector& simStates() const;

      bool addState(DtSimState* state);

      bool removeState(DtSimState* state);

      void forceUpdate(DtBaseStateView* stateView);

      void setUpdateRate(DtSimEntryUpdater::UpdateRate rate, DtBaseStateView* stateView);
     
      DtSimEntryUpdater::UpdateRate rateForView(DtBaseStateView* stateView) const;

      void stateUpdated();

      DtUniqueID id() const;

   protected:

      //Clears out the internal state.
      void reset();

      void addStateViewToUpdateRateMap(DtSimEntryUpdater::UpdateRate rate, 
         DtBaseStateView* stateView);

      void removeStateViewFromUpdateRateMap(DtBaseStateView* stateView);

      DtSimEntryUpdater::UpdateRate maxUpdateRate();

      DtSimEntryUpdater::UpdateRate minUpdateRate();

   protected:

      DtDe& myDe;
      DtUniqueID myId;
      SimStateVector mySimStateVector;
      UpdateRateMap myUpdateRateMap;
      unsigned long long myUpdateCounter;
      bool myForceUpdatePending;
   };
}

#endif