lgrSystemInterface.h

Go to the documentation of this file.

/******************************************************************************
** Copyright (c) 1992-2024 MAK Technologies, Inc
** All rights reserved.
******************************************************************************/


#ifndef lgrSystemInterface_H_
#define lgrSystemInterface_H_

#include <lgrCore/lgrCore.h>
#include <lgrCore/lgrInterface.h>
#include <lgrUtil/virtualConstructor.h>
#include <lgrUtil/signalSlot.h>
#include <lgrUtil/threadSafe.h>

#include <vlutil/vlTime.h>

#include <memory>

namespace MAKLogger
{
   class DtLgrSystemCommandFactory;
   class DtLgrMessageOutputListener;

   class DT_DLL_LGRCORE DtLgrSystemInterface : public DtCommandInterface
   {
   public:

      typedef DtLgrSystemCommandFactory Factory;

      DT_VIRTUAL_CTR(DtLgrSystemInterface,(DtLogger&))

      
      virtual ~DtLgrSystemInterface();

   private:
      DtLgrSystemInterface(const DtLgrSystemInterface&);
      DtLgrSystemInterface& operator=(const DtLgrSystemInterface&);
   public:

      virtual void issueTextCommand(const DtString& commandString)  const;

      virtual void cancelLongOperation() const;

      virtual void deleteFile(const DtString& filename)  const;

      virtual void setNotifyLevel(int vlLevel,int lgrLevel) const;

      virtual void shutdown()  const;

      virtual bool timeToShutdown() const;

      virtual const DtString& operationName() const;

      virtual const DtString& operationMessage() const;

      virtual int operationProgress() const;

      virtual bool operationInterruptible() const;

      virtual bool wasOperationCanceled() const;

      virtual void installOutputListener(
         std::auto_ptr<DtLgrMessageOutputListener> listener) const;

      DtValueSignal<DtString> messageSignal;

      DtValueSignal<DtString> consoleMessageSignal;

      DtValueSignal<bool> operationSignal;

      DtValueSignal<bool> shutdownSignal;

      DtValueSignal<DtString> operationMessageSignal;

      DtValueSignal<int> operationProgressSignal;

      DtValueSignal<bool> performanceWarningSignal;

      bool basicGuiFlag() const;

      void setGuiConfigFilename(DtString guiConfigFilename);

      DtString guiConfigFilename() const;

      void setPerformanceWarning(bool behind, DtTime amountBehind);

      bool isPerformanceWarningEnabled() const;

      DtTime tickOverheadTime() const;

   protected:
      void connectResponseHandler(DtLgrCommandId id,
         void (DtLgrSystemInterface::* function)(DtResponse));

      void messageReceived(DtResponse);
      void consoleMessageReceived(DtResponse);
      void requestShutdown(DtResponse);

      void basicGuiFlagSet(DtResponse);

      void longOperationStarted(DtResponse);
      void longOperationFinished(DtResponse);
      void longOperationUpdated(DtResponse);

      void setGuiConfigFilename(DtResponse);
      void performanceWarningReceived(DtResponse);

      DtThreadSafe<bool>* myCancelFlag;
      DtString myMessage;
      DtString myConsoleMessage;

      DtString myOperationName;
      DtString myOperationMessage;
      bool myOperationRunningFlag;
      int myOperationProgress;
      bool myOperationInterruptible;
      bool myOperationCanceledFlag;

      bool myTimeToShutdown;
      bool myBasicGuiFlag;
      bool myPerformanceWarning;
      DtString myGuiConfigFilename;
      DtTime myTickOverheadTime;
   };

}

#endif