lgrSystemCommandFactory.h

Go to the documentation of this file.

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


#pragma once

#include <lgrCmds/lgrCmds.h>
#include <lgrCmds/lgrCommand.h>
#include <lgrUtil/collectors.h>
#include <vlutil/vlTime.h>
#include <utility>
class DtString;

namespace MAKLogger
{

   class DtCommandDefinition;
   class DtLgrMessageOutputListener;

   class DT_DLL_LGR_CMDS DtLgrSystemCommandFactory
   {
   private:
      DtLgrSystemCommandFactory();

   public:

      static const DtLgrCommandType theCommandType;



      DT_FACTORY_COMMAND_EXT(1, Shutdown,
         (),
         (const DtCommand&))

      DT_FACTORY_COMMAND_EXT(3, CreateDriver,
         (DtLgrCommandType driverType),
         (const DtCommand& command,DtLgrCommandType& driverType))

      DT_FACTORY_COMMAND_EXT(5, LoadPlugin,
         (const DtString& pluginName),
         (const DtCommand& command,DtString& pluginName))

      DT_FACTORY_COMMAND_EXT(6, SetNotifyLevel,
         (int vlLevel,int lgrLevel),
         (const DtCommand& command,int& vlLevel,int& lgrLevel))

      DT_FACTORY_COMMAND_EXT(7, SetPipelineDriver,
         (DtLgrDomainId domain),
         (const DtCommand& command,DtLgrDomainId& domain))

      DT_FACTORY_COMMAND_EXT(8, IssueTextCommand,
         (const DtString& textCommand),
         (const DtCommand& command,DtString& textCommand))

      DT_FACTORY_COMMAND_EXT(9,Help,
         (),
         (const DtCommand&))

      DT_FACTORY_COMMAND_EXT(10, DeleteFile
         ,(const DtString& filename),
         (const DtCommand&,DtString& filename))

      DT_FACTORY_COMMAND_EXT(11, Info,
         (),
         (const DtCommand&))

      DT_FACTORY_COMMAND_EXT(12, InstallOutputListener,
         (DtLgrMessageOutputListener* listener),
         (const DtCommand&,DtLgrMessageOutputListener*& listener))

      DT_FACTORY_COMMAND_EXT(13, SetTempDir,
         (const DtString& directory),
         (const DtCommand&,DtString& directory))

      DT_FACTORY_COMMAND_EXT(14, SetBasicGuiFlag,
         (bool basic),
         (const DtCommand& command,bool& basic))

      DT_FACTORY_COMMAND_EXT(15, SetNasmpMode,
         (const DtString& nasmpMode),
         (const DtCommand& command,DtString& nasmpMode))

      DT_FACTORY_COMMAND_EXT(16, SetEntityTracking,
         (bool enableEntityTracking),
         (const DtCommand& command, bool& enableEntityTracking))

      DT_FACTORY_COMMAND_EXT(17, SetFastJumpsWithoutDiff,
         (bool enableFastJumpsWithoutDiff),
         (const DtCommand& command, bool& enableFastJumpsWithoutDiff))

      DT_FACTORY_COMMAND_EXT(18, SetPlaybackReadTimeLimit,
         (double playbackReadTimeLimit),
         (const DtCommand& command, double& playbackReadTimeLimit))

      DT_FACTORY_COMMAND_EXT(19, SetDefaultTapeDirectory,
         (const DtString& defaultTapeDirectory),
         (const DtCommand&,DtString& defaultTapeDirectory))

      DT_FACTORY_COMMAND_EXT(20, SetGuiConfigFilename,
      (const DtString& defaultGuiConfigFilename),
         (const DtCommand&, DtString& defaultGuiConfigFilename))

      DT_FACTORY_COMMAND_EXT(21, SetPerformanceThreshold,
      (const double& performanceThreshold),
         (const DtCommand&, double& performanceThreshold))

         static const DtLgrCommandId theLastCommandId = 100;



      DT_FACTORY_RESPONSE_EXT(-1, LoadPluginFailed,
         (const DtString& filename,const DtString& reason),
         (DtResponse,DtString& filename,DtString& reason))

      DT_FACTORY_RESPONSE_EXT(-2, PluginLoaded,
         (const DtString& filename),
         (DtResponse,DtString& filename))

      DT_FACTORY_RESPONSE_EXT(-3, Message,
         (const DtString& message),
         (DtResponse,DtString& message))

      DT_FACTORY_RESPONSE_EXT(-4, ConsoleMessage,
         (const DtString& message),
         (DtResponse,DtString& message))

      DT_FACTORY_RESPONSE_EXT(-6,Shutdown,
         (),
         (DtResponse))

      DT_FACTORY_RESPONSE_EXT(-7, StartLongOperation,
         (const DtString& name, bool interruptible),
         (DtResponse,DtString& name,bool& interruptible))

      DT_FACTORY_RESPONSE_EXT(-8, FinishLongOperation,
         (bool canceled),
         (DtResponse,bool& canceled))

      DT_FACTORY_RESPONSE_EXT(-9, UpdateLongOperation,
         (const DtString& message,int percent),
         (DtResponse,DtString& message,int& percent))

      DT_FACTORY_RESPONSE_EXT(-10, SetBasicGuiFlag,
         (bool basic),
         (DtResponse,bool& basic))

      // Result: 1 - success, 0 file not found, -1 failed, -2 rejected
      DT_FACTORY_RESPONSE_EXT(-11,FileDelete,
         (const DtString& fileName, int deleteResult),
         (DtResponse,DtString& fileName,int& deleteResult))
         
      DT_FACTORY_RESPONSE_EXT(-12, SetGuiConfigFilename,
         (DtString guiConfigFilename),
            (DtResponse, DtString& guiConfigFilename))

      DT_FACTORY_RESPONSE_EXT(-13, PerformanceWarning,
         (bool behind, DtTime amountBehind),
         (DtResponse, bool& behind, DtTime& amountBehind))

      DT_FACTORY_RESPONSE_EXT(-14, SetPerformanceThreshold,
         (double performanceThreshold),
         (DtResponse, double& performanceThreshold))


      static const DtLgrCommandId theLastResponseId = 100;

      static const char* commandToString(int commandId);

      static const char* responseToString(int responseId);

   };

}