vtkExecutableRunner.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-License-Identifier: BSD-3-Clause
#ifndef vtkExecutableRunner_h
#define vtkExecutableRunner_h
 
#include "vtkCommonSystemModule.h" // For export macro
#include "vtkObject.h"
 
#include "vtksys/Process.h" // For class vtksysProcess
 
#include <string> // for class std::string
#include <vector> // for class std::vector
 
VTK_ABI_NAMESPACE_BEGIN
class VTKCOMMONSYSTEM_EXPORT vtkExecutableRunner : public vtkObject
{
public:
  static vtkExecutableRunner* New();
  vtkTypeMacro(vtkExecutableRunner, vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent) override;
 
  vtkExecutableRunner() = default;
  ~vtkExecutableRunner() override = default;
 
  void Execute();
 
 
  vtkSetMacro(Timeout, double);
  vtkGetMacro(Timeout, double);
 
 
  vtkSetMacro(RightTrimResult, bool);
  vtkGetMacro(RightTrimResult, bool);
  vtkBooleanMacro(RightTrimResult, bool);
 
 
  vtkGetCharFromStdStringMacro(Command);
  vtkSetStdStringFromCharMacro(Command);
 
 
  vtkSetMacro(ExecuteInSystemShell, bool);
  vtkGetMacro(ExecuteInSystemShell, bool);
  vtkBooleanMacro(ExecuteInSystemShell, bool);
 
 
  virtual void AddArgument(const std::string& arg);
  virtual void ClearArguments();
  virtual vtkIdType GetNumberOfArguments() const;
 
 
  vtkGetCharFromStdStringMacro(StdOut);
  vtkGetCharFromStdStringMacro(StdErr);
 
  vtkGetMacro(ReturnValue, int);
 
protected:
  vtkSetMacro(StdOut, std::string);
  vtkSetMacro(StdErr, std::string);
 
  std::vector<std::string> GetCommandToExecute() const;
  int ExitProcess(vtksysProcess* process);
 
private:
  vtkExecutableRunner(const vtkExecutableRunner&) = delete;
  void operator=(const vtkExecutableRunner&) = delete;
 
  bool RightTrimResult = true;
  double Timeout = 5;
  std::string Command;
  int ReturnValue = -1;
  bool ExecuteInSystemShell = true;
  std::vector<std::string> Arguments;
 
  std::string StdOut;
  std::string StdErr;
};
 
VTK_ABI_NAMESPACE_END
#endif // vtkExecutableRunner_h