include/vrvCore/DtStateView.h

Go to the documentation of this file.

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


#ifndef DtStateView_H_
#define DtStateView_H_

#include <vrvCore/vrvCore.h>
#include <vrvCore/DtSimEntryUpdater.h>
#include <vrvCore/DtSimEntry.h>
#include <boost/signal.hpp>

#include <vlutil/vlExceptions.h>

namespace makVrv
{

   class DT_DLL_VRVCORE DtBaseStateView
   {

   public:

      virtual ~DtBaseStateView();

      virtual void emitStateViewUpdated() = 0;

   protected :      
      
      DtBaseStateView();

   };
  
   template<class StateType>
   class DtStateView : public DtBaseStateView
   {

   public:

      DtStateView(DtSimEntry& entry);

      virtual ~DtStateView();

      void forceUpdate();

      void setUpdateRate(DtSimEntryUpdater::UpdateRate rate);

      virtual void emitStateViewUpdated();

      const StateType& state();

      const StateType& state() const;

      static bool isCompatible(DtSimEntry& entry);

      static StateType* findState(DtSimEntry& entry);

      boost::signal<void (DtStateView<StateType>*)> signal_stateViewUpdated;

      DtUniqueID id() const
      {
         return mySimEntry.id();
      }

   private:

      DtStateView();
      DtStateView(const DtStateView&);
      DtStateView& operator=(const DtStateView&);

   protected:

      DtSimEntry& mySimEntry;
      StateType* myState;
   };

   template<class StateType>
   DtStateView<StateType>::DtStateView( DtSimEntry& entry )
   : DtBaseStateView()
   , mySimEntry(entry)
   , myState(0)
   {
      myState = DtStateView<StateType>::findState(entry);
      if(!myState)
      {
         DtTHROW_NEW(DtCorruptedState,
            "Unable to create DtStateView from DtSimEntry."
            "Use isCompatible() before creating DtStateView.");
      }
   }

   template<class StateType>
   DtStateView<StateType>::~DtStateView()
   {
      mySimEntry.setUpdateRate(DtSimEntryUpdater::NoUpdates, this);
   }

   template<class StateType>
   void DtStateView<StateType>::forceUpdate()
   {
      mySimEntry.forceUpdate(this);
   }

   template<class StateType>
   void DtStateView<StateType>::setUpdateRate(DtSimEntryUpdater::UpdateRate rate)
   {
      mySimEntry.setUpdateRate(rate, this);
   }

   template<class StateType>
   void DtStateView<StateType>::emitStateViewUpdated()
   {
      signal_stateViewUpdated(this);
   }

   template<class StateType>
   bool DtStateView<StateType>::isCompatible(DtSimEntry& entry)
   {
      bool bRet = false;
      StateType* type = DtStateView<StateType>::findState(entry);
      if(type)
      {
         bRet = true;
      }
      return bRet;
   }

   template <class StateType>
   StateType* DtStateView<StateType>::findState(DtSimEntry& entry)
   {
      DtSimEntry::SimStateVector::const_iterator pos    = entry.simStates().begin();
      DtSimEntry::SimStateVector::const_iterator endPos = entry.simStates().end();
      for(; pos != endPos; ++pos)
      {
         StateType* tState = dynamic_cast<StateType*>(*pos);
         if(tState)
         {
            return tState;
         }
      }
      return 0;
   }

   template<class StateType>
   const StateType& DtStateView<StateType>::state()
   {
      return *myState;      
   }

   template<class StateType>
   const StateType& DtStateView<StateType>::state() const
   {
      return *myState;      
   }


}

#endif