pqCoreConfiguration.h

Go to the documentation of this file.

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

#include "pqCoreModule.h" // for exports
#include <QObject>
#include <QVector>
#include <string>
#include <vector>

class vtkCLIOptions;

class PQCORE_EXPORT pqCoreConfiguration : public QObject
{
  Q_OBJECT
public:
  static pqCoreConfiguration* instance();

  const std::string& stateFileName() const { return this->StateFileName; }

  const std::vector<std::string>& dataFileNames() const { return this->DataFileNames; }

  const std::string& pythonScript() const { return this->PythonScript; }

  const std::string& baselineDirectory() const { return this->BaselineDirectory; }

  const std::string& testDirectory() const { return this->TestDirectory; }

  const std::string& dataDirectory() const { return this->DataDirectory; }


  int testScriptCount() const { return this->TestScripts.size(); }
  const std::string& testScript(int index) const { return this->TestScripts.at(index).FileName; }
  const std::string& testBaseline(int index) const { return this->TestScripts.at(index).Baseline; }
  double testThreshold(int index) const { return this->TestScripts.at(index).Threshold; }

  bool exitApplicationWhenTestsDone() const { return this->ExitAppWhenTestsDone; }

  int catalystLivePort() const { return this->CatalystLivePort; }

  bool populateOptions(vtkCLIOptions* options);


  void setActiveTestIndex(int index) { this->ActiveTestIndex = index; }
  const std::string& testScript() const { return this->testScript(this->ActiveTestIndex); }
  const std::string& testBaseline() const { return this->testBaseline(this->ActiveTestIndex); }
  double testThreshold() const { return this->testThreshold(this->ActiveTestIndex); }


  bool testMaster() const { return this->TestMaster; }
  bool testSlave() const { return this->TestSlave; }

protected:
  pqCoreConfiguration();
  ~pqCoreConfiguration() override;

  // not entirely sure why this is being done, but I'll let it be fore now.
  // pqPVApplicationCore uses this.
  friend class pqPVApplicationCore;
  void addDataFile(const std::string& data) { this->DataFileNames.push_back(data); }

private:
  Q_DISABLE_COPY(pqCoreConfiguration);

  std::string StateFileName;
  std::vector<std::string> DataFileNames;
  std::vector<std::string> PositionalFileNames;
  std::string PythonScript;
  std::string BaselineDirectory;
  std::string TestDirectory;
  std::string DataDirectory;
  bool ExitAppWhenTestsDone;
  int ActiveTestIndex = 0;
  int CatalystLivePort = -1;
  bool TestMaster = false;
  bool TestSlave = false;

  struct TestScriptInfo
  {
    std::string FileName;
    std::string Baseline;
    double Threshold = 0.05;
  };
  QVector<TestScriptInfo> TestScripts;
};

#endif