From ab371c0f6a875d07efba189e412c505656d45a92 Mon Sep 17 00:00:00 2001
From: Malin E <malin.ejdbo@gmail.com>
Date: Mon, 28 Feb 2022 15:51:36 +0100
Subject: [PATCH] Add warning when using Observer table Horizons data

---
 .../launcher/src/profile/horizonsdialog.cpp   |  2 +-
 modules/space/horizonsfile.cpp                | 32 +++++++++++--------
 2 files changed, 19 insertions(+), 15 deletions(-)

diff --git a/apps/OpenSpace/ext/launcher/src/profile/horizonsdialog.cpp b/apps/OpenSpace/ext/launcher/src/profile/horizonsdialog.cpp
index d247b1011e..6215c39f33 100644
--- a/apps/OpenSpace/ext/launcher/src/profile/horizonsdialog.cpp
+++ b/apps/OpenSpace/ext/launcher/src/profile/horizonsdialog.cpp
@@ -845,7 +845,7 @@ bool HorizonsDialog::handleResult(openspace::HorizonsFile::ResultCode& result) {
             // Format: ID#, Name, Designation, IAU/aliases/other
             // Line after data: Number of matches =  X. Use ID# to make unique selection.
 
-            appendLog("Multiple matches was found for target '" + _targetName + "'",
+            appendLog("Multiple matches were found for target '" + _targetName + "'",
                 HorizonsDialog::LogLevel::Warning
             );
 
diff --git a/modules/space/horizonsfile.cpp b/modules/space/horizonsfile.cpp
index fda4b97fce..4d8216f3a8 100644
--- a/modules/space/horizonsfile.cpp
+++ b/modules/space/horizonsfile.cpp
@@ -397,8 +397,8 @@ void HorizonsFile::displayErrorMessage(const ResultCode code) const {
             break;
 
         case ResultCode::ErrorNoData:
-            LERROR("There is not enough data to compute the state of target in relation "
-                "to the observer for the selected time range.");
+            LERROR("There is not enough data to compute the state of the target in "
+                "relation to the observer for the selected time range.");
             break;
 
         case ResultCode::MultipleObserverStations: {
@@ -454,7 +454,7 @@ void HorizonsFile::displayErrorMessage(const ResultCode code) const {
             // Format: ID#, Name, Designation, IAU/aliases/other
             // Line after data: Number of matches =  X. Use ID# to make unique selection.
 
-            LWARNING("Multiple matches was found for the target");
+            LWARNING("Multiple matches were found for the target");
 
             std::vector<std::string> matchingTargets =
                 parseMatches("Name", "matches");
@@ -482,11 +482,19 @@ void HorizonsFile::displayErrorMessage(const ResultCode code) const {
 }
 
 HorizonsFile::HorizonsResult HorizonsFile::readFile() const {
+    // Check if valid first
+    ResultCode code = isValidHorizonsFile();
+    if (code != ResultCode::Valid) {
+        HorizonsResult result;
+        result.errorCode = code;
+        return result;
+    }
+
     std::ifstream fileStream(_file);
 
     if (!fileStream.good()) {
         LERROR(fmt::format(
-            "Failed to open Horizons text file '{}'", _file
+            "Failed to open Horizons file '{}'", _file
         ));
         return HorizonsResult();
     }
@@ -514,13 +522,9 @@ HorizonsFile::HorizonsResult HorizonsFile::readFile() const {
 HorizonsFile::HorizonsResult HorizonsFile::readVectorFile() const {
     HorizonsResult result;
     result.type = HorizonsFile::Type::Vector;
-    result.errorCode = isValidHorizonsFile();
+    result.errorCode = ResultCode::Valid;
     std::vector<HorizonsKeyframe> data;
 
-    if (result.errorCode != ResultCode::Valid) {
-        return result;
-    }
-
     std::ifstream fileStream(_file);
     if (!fileStream.good()) {
         LERROR(fmt::format(
@@ -592,13 +596,9 @@ HorizonsFile::HorizonsResult HorizonsFile::readVectorFile() const {
 HorizonsFile::HorizonsResult HorizonsFile::readObserverFile() const {
     HorizonsResult result;
     result.type = HorizonsFile::Type::Observer;
-    result.errorCode = isValidHorizonsFile();
+    result.errorCode = ResultCode::Valid;
     std::vector<HorizonsKeyframe> data;
 
-    if (result.errorCode != ResultCode::Valid) {
-        return result;
-    }
-
     std::ifstream fileStream(_file);
     if (!fileStream.good()) {
         LERROR(fmt::format(
@@ -656,6 +656,10 @@ HorizonsFile::HorizonsResult HorizonsFile::readObserverFile() const {
 
     fileStream.close();
 
+    LWARNING("Observer table data from Horizons might not align with SPICE data well. "
+        "We recommend using Vector table data from Horizons instead"
+    );
+
     result.data = data;
     return result;
 }