WsfThread.hpp

Go to the documentation of this file.

// ****************************************************************************
// CUI
//
// The Advanced Framework for Simulation, Integration, and Modeling (AFSIM)
//
// Copyright 2003-2015 The Boeing Company. All rights reserved.
//
// The use, dissemination or disclosure of data in this file is subject to
// limitation or restriction. See accompanying README and LICENSE for details.
// ****************************************************************************
 
#ifndef WSFTHREAD_HPP
#define WSFTHREAD_HPP
 
#include "wsf_export.h"
 
#include <condition_variable>
#include <mutex>
 
#include "UtThread.hpp"
 
class WSF_EXPORT WsfThread : public UtThread
{
public:
   enum FunctionType
   {
      STOPPED   = 0,
      AVAILABLE = 1,
      ASSIGNED  = 2,
      PAUSED    = 3,
      CRITICAL  = 4
   };
 
   WsfThread()           = default;
   ~WsfThread() override = default;
 
   void Run() override;
 
   FunctionType GetFunction() const { return mFunction; }


   bool CriticalWork() const { return (mFunction == CRITICAL); }
   bool ReadyForWork() const { return (mFunction == AVAILABLE); }
   bool Stopped() const { return (mFunction == STOPPED); }

   bool AssignWork() { return SetFunction(AVAILABLE, ASSIGNED); }
   bool StopWork() { return SetFunction(AVAILABLE, STOPPED); }
   bool ForceStopWork(); // attempts to stop thread, even if not available
   bool PauseWork();

   void EndThread();
 
   void WaitUntilWorkDone();
   bool TryWaitUntilWorkDone(double aTimeoutSecs);


   virtual void Available();

   virtual FunctionType DoWork() = 0;

   virtual FunctionType Pause() = 0;
 
protected:
   bool BeginCriticalWork();
   bool EndCriticalWork();
 
   FunctionType mSavedState = STOPPED;
 
   bool SetFunction(FunctionType aOldFunction, FunctionType aNewFunction);
 
   std::condition_variable mWorkDoneCond;
   std::mutex              mFunctionWriteMutex;
 
private:
   std::condition_variable mWorkAddedCond;

   FunctionType mFunction = AVAILABLE;

   bool mEndThread = false;
};
 
#endif // WSFTHREAD_HPP