include/vrvCore/DtAgent.h

Go to the documentation of this file.

/******************************************************************************
** Copyright (c) 2010 MAK Technologies, Inc.
** All rights reserved.
******************************************************************************/
/******************************************************************************
** $RCSfile: DtAgent.h,v $ $Revision: 1.18 $ $State: Exp $
******************************************************************************/


#pragma once

#include <vrvCore/vrvCore.h>
#include <vrvCore/DtAgentManagerInterface.h>
#include <vrvCore/DtAgentManager.h>
#include <vrvUtil/templateUtil.h>


#include <boost/type_traits.hpp>
#include <map>
#include <string>
#include <list>

namespace makVrv
{  
   template <typename T,bool>
   struct ArgOverrideAsId;
     
   template <typename T>
   struct ArgOverrideAsId<T,false>
   {
      typedef T Type;
   };

   template <typename T>
   struct ArgOverrideAsId<T,true>
   {
      typedef DtUniqueID Type;
   };

   template <typename T>
   struct Arg
   {
      typedef typename ArgOverrideAsId<T,boost::is_pointer<T>::value && 
         boost::is_class<typename boost::remove_pointer<T>::type >::value>::Type Type;
   };



   class DT_DLL_VRVCORE DtAgent
   {
   public:    

      friend class DtAgentManagerInterface;
      friend class DtAgentManager;

      virtual ~DtAgent();

      inline DtAgentManagerInterface& sceneInterface();

      inline void setSceneInterface(DtAgentManagerInterface* iface);      

      void init(DtAgentManagerInterface& sceneInterface, bool bDistribute);

      inline const std::string& className() const;

      //Makes the object clean, it will not generate an update.
      inline void clean();

      //Makes the object dirty, indicating that it will be checked for an update
      inline void dirty();

      inline DtUniqueID uniqueId() const;

      inline bool distributeMessages() const;

   protected:

      inline DtMessage& startNewCall(unsigned int function);

      void addCreateObjectCall();

      void addDeleteObjectCall();

      inline unsigned int callCount() const;

      //This declares a template function for queuing a single operation call with N arguments
      #define DT_DECLARE_QUEUE_OPERATION_FUNCTION(argCount)\
      template <typename C, MAKE_LIST(typename T,argCount) >\
      inline void queueOperationCall(unsigned int state_function,\
         void (C::*m)( MAKE_LIST(T,argCount) ),\
         MAKE_MULTILIST(typename Arg<T,>::Type t,argCount));

      //No arguments are a special case
      template <typename C>
      inline void queueOperationCall(unsigned int state_function, void (C::*m)());

      DT_DECLARE_QUEUE_OPERATION_FUNCTION(1)
      DT_DECLARE_QUEUE_OPERATION_FUNCTION(2)
      DT_DECLARE_QUEUE_OPERATION_FUNCTION(3)
      DT_DECLARE_QUEUE_OPERATION_FUNCTION(4)
      DT_DECLARE_QUEUE_OPERATION_FUNCTION(5)
      DT_DECLARE_QUEUE_OPERATION_FUNCTION(6)
      DT_DECLARE_QUEUE_OPERATION_FUNCTION(7)
      DT_DECLARE_QUEUE_OPERATION_FUNCTION(8)
      DT_DECLARE_QUEUE_OPERATION_FUNCTION(9)

   protected:
      
      DtAgent(/* Do not add parameters here. Add them to init(). */);

      DtAgent(DtAgent&);

      inline DtAgentManagerInterface::OrderedCallList& callList();

   protected:

      DtAgentManagerInterface* mySceneInterface;
      DtUniqueID myUniqueId;
      std::string myClassName;
      bool myUpdateFlag;
      DtAgentManagerInterface::OrderedCallList myCalls;
      bool myDistributeObjectFlag;
   };
   
}

#define DtAgent_INL_ 
#include "DtAgent.inl"
#undef DtAgent_INL_