DtExampleThreadedDriver.h

Go to the documentation of this file.

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


#pragma once

#include <vrvCore/DtDriver.h>

#include <vrvCore/DtSelectionManager.h>

#include <vrvUtil/DtLockedBufferedQueue.h>
#include <vrvUtil/DtSignalConnectionManager.h>

#include <vlutil/vlRunnable.h>

#include <boost/function.hpp>
#include <vrvUtil/signalslib.h>
#include <vlutil/vlThread.h>

#include <string>

namespace makVrv
{
   class DtAsynchronousAgentManager;
   class DtAsynchronousEventQueue;
}

class DtThread;
class DtThreadStart;
class DtExampleSimulationConnection;

// This driver creates and owns the example driver.
class DtExampleThreadedDriver : public makVrv::DtDriver, protected DtRunnable
{
public:
   DtExampleThreadedDriver( makVrv::DtAgentManager& am );

   virtual ~DtExampleThreadedDriver();
   
   virtual const std::string& className() const;

   virtual void queueDriverFunction(const boost::function<void ()>& function);

   virtual void queueConnectionFunction(const boost::function<void ()>& function);

   bool useThreadFlag() const;

   DtExampleSimulationConnection* simulationConnection();

   boost::signalslib::signal<void (DtExampleSimulationConnection*)> signal_simulationCreated;

   boost::signalslib::signal<void (DtExampleSimulationConnection*)> signal_simulationAboutToBeDestroyed;
      
protected:

   virtual bool onStart();

   virtual bool onStop();

   virtual bool onTick();

   virtual void attachObserverToEntity( const std::string& entityName );

   virtual void slot_displayEngineAdded( const makVrv::DtDeRecord& igRecord );
    
   virtual DtExampleSimulationConnection* createSimulationConnection();

   virtual void run();

   void startThread();

   void stopThread();
      
   void setSimulationConnectionState( bool state );
      
   virtual void connectToDynamicSignals();

   virtual void disconnectFromDynamicSignals();

   virtual void slot_togglePinnedLabel(
      const makVrv::DtSelectionManager::IdSet& sel );

   typedef makVrv::DtLockedBufferedQueue<boost::function<void ()> > FunctionCallQueue;
   typedef std::vector<boost::function<void ()> > FunctionCallList;

   virtual void runFunctionQueue(FunctionCallQueue& queue);

protected:
   //Main thread variables.
   std::string myClassName;

   bool myUseThreadFlag;
   DtThreadStartSP myStart;
   DtThread* myThread;
   FunctionCallQueue myConnectionThreadFunctions;
   FunctionCallQueue myDriverThreadFunctions;
   makVrv::DtAsynchronousAgentManager* myAsynchronousInterface;

   DtExampleSimulationConnection* mySimulationConnection;
   makVrv::DtAsynchronousEventQueue* myAsynchronousEventQueue;
   bool mySimulationConnectionState;

   makVrv::DtSignalConnectionManager myDynamicSignals;
};