vtkProcessModuleConfiguration.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Kitware Inc.
// SPDX-License-Identifier: BSD-3-Clause
#ifndef vtkProcessModuleConfiguration_h
#define vtkProcessModuleConfiguration_h

#include "vtkLogger.h" // for vtkLogger::Verbosity
#include "vtkObject.h"
#include "vtkProcessModule.h"      // for vtkProcessModule::ProcessTypes
#include "vtkRemotingCoreModule.h" //needed for exports

#include <string> // for std::string
#include <vector> // for std::vector

class vtkCLIOptions;

class VTKREMOTINGCORE_EXPORT vtkProcessModuleConfiguration : public vtkObject
{
public:
  vtkTypeMacro(vtkProcessModuleConfiguration, vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  static vtkProcessModuleConfiguration* GetInstance();

  vtkGetMacro(ForceMPIInit, bool);

  vtkGetMacro(ForceNoMPIInit, bool);

  vtkGetMacro(UseMPISSend, bool);

  vtkGetMacro(SymmetricMPIMode, bool);

  vtkSetMacro(SymmetricMPIMode, bool);

  vtkGetMacro(VirtualEnvironmentPath, std::string);

  vtkGetMacro(LogStdErrVerbosity, vtkLogger::Verbosity);

  std::string GetCSLogFileName() const;

  vtkGetMacro(EnableStackTrace, bool);

  const std::vector<std::pair<std::string, vtkLogger::Verbosity>>& GetLogFiles() const
  {
    return this->LogFiles;
  }

  bool PopulateOptions(vtkCLIOptions* options, vtkProcessModule::ProcessTypes processType);

  static std::string GetRankAnnotatedFileName(const std::string& fname);

protected:
  vtkProcessModuleConfiguration();
  ~vtkProcessModuleConfiguration() override;

private:
  vtkProcessModuleConfiguration(const vtkProcessModuleConfiguration&) = delete;
  void operator=(const vtkProcessModuleConfiguration&) = delete;

  bool ForceMPIInit = false;
  bool ForceNoMPIInit = false;
  bool UseMPISSend = false;
  bool SymmetricMPIMode = false;
  std::string VirtualEnvironmentPath;
  bool EnableStackTrace = false;
  vtkLogger::Verbosity LogStdErrVerbosity = vtkLogger::VERBOSITY_INVALID;
  std::string CSLogFileName;
  std::vector<std::pair<std::string, vtkLogger::Verbosity>> LogFiles;
  static vtkProcessModuleConfiguration* New();
};

#endif