v0.2.48..v0.2.49 changeset PertyTestRunResult.h

diff --git a/hoot-core/src/main/cpp/hoot/core/algorithms/perty/PertyTestRunResult.h b/hoot-core/src/main/cpp/hoot/core/algorithms/perty/PertyTestRunResult.h
new file mode 100644
index 0000000..ae7ace0
--- /dev/null
+++ b/hoot-core/src/main/cpp/hoot/core/algorithms/perty/PertyTestRunResult.h
@@ -0,0 +1,150 @@
+/*
+ * This file is part of Hootenanny.
+ *
+ * Hootenanny is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * --------------------------------------------------------------------
+ *
+ * The following copyright notices are generated automatically. If you
+ * have a new notice to add, please use the format:
+ * " * @copyright Copyright ..."
+ * This will properly maintain the copyright information. DigitalGlobe
+ * copyrights will be updated automatically.
+ *
+ * @copyright Copyright (C) 2015, 2018, 2019 DigitalGlobe (http://www.digitalglobe.com/)
+ */
+#ifndef PERTY_TEST_RUN_RESULT_H
+#define PERTY_TEST_RUN_RESULT_H
+
+// Qt
+#include <QString>
+#include <QStringList>
+
+// Standard
+#include <math.h>
+
+namespace hoot
+{
+
+/**
+ * Represents the outcome of a PERTY test run
+ */
+class PertyTestRunResult
+{
+
+public:
+
+  PertyTestRunResult(const QString& referenceInput, const QString& outputDir, const int testRunNum,
+                     const QList<double> simulationScores, const double score,
+                     const double expectedScore, const double scoreVariance,
+                     const double allowedScoreVariance, bool failOnBetterScore,
+                     const QStringList& dynamicVariables, const double dynamicVariableStartingValue,
+                     const double dynamicVariableIncrement, const double dynamicVariableValue);
+
+  /**
+    Returns the test run number
+    */
+  int getTestRunNum() const { return _testRunNum; }
+
+  /**
+    Returns the test run input
+    */
+  QString getReferenceInput() const { return _referenceInput; }
+
+  /**
+    Returns the expected score
+    */
+  double getExpectedScore() const { return _expectedScore; }
+
+  /**
+    Returns the score variance
+    */
+  double getScoreVariance() const { return _scoreVariance; }
+
+  /**
+    Returns the allowed score variance
+    */
+  double getAllowedScoreVariance() const { return _allowedScoreVariance; }
+
+  /**
+    Returns whether the test run should fail if its score is better that its expected score
+    */
+  bool getFailOnBetterScore() const { return _failOnBetterScore; }
+
+  /**
+    Returns the dynamic variables
+    */
+  QStringList getDynamicVariables() const { return _dynamicVariables; }
+
+  /**
+    Returns the dynamic variable starting value
+    */
+  double getDynamicVariableStartingValue() const { return _dynamicVariableStartingValue; }
+
+  /**
+    Returns the dynamic variable increment
+    */
+  double getDynamicVariableIncrement() const { return _dynamicVariableIncrement; }
+
+  /**
+    Returns the dynamic variable value
+    */
+  double getDynamicVariableValue() const { return _dynamicVariableValue; }
+
+  /**
+    Returns the test run score
+    */
+  double getScore() const { return _score; }
+
+  /**
+    Returns the simulation scores for the test run
+    */
+  QList<double> getSimulationScores() const { return _simulationScores; }
+
+  /**
+    Determines whether the test run passed
+    */
+  bool testPassed() const;
+
+  /**
+    Returns the output directory
+    */
+  QString getOutputDir() const { return _outputDir; }
+
+  /**
+    Returns a string representation of the object
+    */
+  QString toString() const;
+
+private:
+
+  const QString _referenceInput;
+  const QString _outputDir;
+  const int _testRunNum;
+  const double _score;
+  const QList<double> _simulationScores;
+  const double _expectedScore;
+  const double _scoreVariance;
+  const double _allowedScoreVariance;
+  const bool _failOnBetterScore;
+  const QStringList _dynamicVariables;
+  const double _dynamicVariableStartingValue;
+  const double _dynamicVariableIncrement;
+  const double _dynamicVariableValue;
+
+};
+
+}
+
+#endif // PERTY_TEST_RUN_RESULT_H