Added helper functions and program defaults

One helper function is to check if a given jobId exists at the given path the other one checks whether the job data JSON is available. Added two global defaults one for config file name the other one for job data file name.

Author: Bas-Koerver

CMakeLists.txt

@@ -66,10 +66,9 @@ add_executable(
         src/global_variables/cli_defaults.hpp
         src/executors/board_runner.cpp src/executors/board_runner.hpp
         src/executors/recording_runner.cpp src/executors/recording_runner.hpp
-        src/executors/validation_runner.cpp
-        src/executors/validation_runner.hpp
-        src/executors/calibration_runner.cpp
-        src/executors/calibration_runner.hpp
+        src/executors/validation_runner.cpp src/executors/validation_runner.hpp
+        src/executors/calibration_runner.cpp src/executors/calibration_runner.hpp
+
 )
 
 target_link_libraries(

src/config/orchestrator.cpp

@@ -1,16 +1,18 @@
 #include "orchestrator.hpp"
 
+#include "../global_variables/program_defaults.hpp"
+
 #include "../recoding/recorders/camera_worker.hpp"
 
 namespace YACCP::Config {
     void loadConfig(FileConfig& config, const std::filesystem::path& path, const bool boardCreation) {
         // Load TOML configuration file.
         toml::table tbl;
         try {
-            tbl = toml::parse_file((path / "config.toml").string());
+            tbl = toml::parse_file((path / GlobalVariables::configFileName).string());
         } catch (const toml::parse_error& err) {
             std::stringstream ss{};
-            ss << err.description() << "\n At: " << err.source() << "\n";
+            ss << err.description() << "\n At: " << err.source();
             throw std::runtime_error(ss.str());
         }
 
@@ -24,10 +26,10 @@ namespace YACCP::Config {
         // Load TOML configuration file.
         toml::table tbl;
         try {
-            tbl = toml::parse_file((path / "config.toml").string());
+            tbl = toml::parse_file((path / GlobalVariables::configFileName).string());
         } catch (const toml::parse_error& err) {
             std::stringstream ss{};
-            ss << err.description() << "\n At: " << err.source() << "\n";
+            ss << err.description() << "\n At: " << err.source();
             throw std::runtime_error(ss.str());
         }
 

src/executors/board_runner.cpp

@@ -35,20 +35,20 @@ namespace YACCP::Executor {
                 // Check whether the given job exists.
                 if (!is_directory(jobPath)) {
                     std::stringstream ss;
-                    ss << "Job: " << jobPath.string() << " does not exist in the given path: " << dataPath << "\n";
+                    ss << "Job: " << jobPath.string() << " does not exist in the given path: " << dataPath;
                     throw std::runtime_error(ss.str());
                 }
 
                 // Load config from JSON file
-                nlohmann::json j = YACCP::Utility::loadJsonFromFile(jobPath, "job_data.json");
+                nlohmann::json j = Utility::loadJobDataFromFile(jobPath);
                 j.at("config").get_to(fileConfig);
             }
 
             CreateBoard::charuco(fileConfig, cliCmdConfig.boardCreationCmdConfig, jobPath);
 
             // Save the board creation variables to a JSON
             std::vector<CamData> empty{};
-            Utility::saveJsonToFile(jobPath, fileConfig, empty);
+            Utility::saveJobDataToFile(jobPath, fileConfig, empty);
         }
     }
 } // YACCP::Executor

src/executors/recording_runner.cpp

@@ -2,6 +2,8 @@
 
 #include "../utility.hpp"
 
+#include "../global_variables/program_defaults.hpp"
+
 // #include "../recoding/detection_validator.hpp"
 // #include "../recoding/job_data.hpp"
 // #include "../recoding/video_viewer.hpp"
@@ -55,10 +57,10 @@ namespace YACCP::Executor {
                         "The most recent job ID already has recoding data, creating a new job and copying job_config.json from previous one. \n";
                     jobPath = dataPath / ("job_" + dateTime.str());
                     std::filesystem::create_directories(jobPath);
-                    std::filesystem::copy(jobPathMostRecent / "job_data.json", jobPath / "job_data.json");
+                    std::filesystem::copy(jobPathMostRecent / GlobalVariables::jobDataFileName, jobPath / GlobalVariables::jobDataFileName);
 
                     // Load config from JSON file
-                    nlohmann::json j = Utility::loadJsonFromFile(jobPath, "job_data.json");
+                    nlohmann::json j = Utility::loadJobDataFromFile(jobPath);
                     j.at("config").get_to(fileConfig);
 
                     // Load config from TOML file
@@ -71,7 +73,7 @@ namespace YACCP::Executor {
                     Config::FileConfig jsonConfig;
 
                     // Load config from JSON file
-                    nlohmann::json j = Utility::loadJsonFromFile(jobPath, "job_data.json");
+                    nlohmann::json j = Utility::loadJobDataFromFile(jobPath);
                     j.at("config").get_to(jsonConfig);
 
                     // Load config from TOML file
@@ -104,7 +106,7 @@ namespace YACCP::Executor {
                 }
 
                 // Load config from JSON file
-                nlohmann::json j = Utility::loadJsonFromFile(jobPath, "job_data.json");
+                nlohmann::json j = Utility::loadJobDataFromFile(jobPath);
                 j.at("config").get_to(fileConfig);
 
                 // Load config from TOML file
@@ -239,7 +241,7 @@ namespace YACCP::Executor {
 
             // Create a JSON object with all information on this job,
             // that includes the configured parameters in the config.toml and information about the job itself.
-            Utility::saveJsonToFile(jobPath, fileConfig, camDatas);
+            Utility::saveJobDataToFile(jobPath, fileConfig, camDatas);
         }
         return 0;
     }

src/global_variables/cli_defaults.hpp

@@ -3,7 +3,6 @@
 
 namespace YACCP::GlobalVariables {
     // Default boardCreationCmd variables.
-
     inline constexpr auto generateImage{true};
     inline constexpr auto generateVideo{false};
 }

src/global_variables/program_defaults.hpp

@@ -0,0 +1,9 @@
+#ifndef YACCP_GLOBAL_VARIABLES_PROGRAM_DEFAULTS_HPP
+#define YACCP_GLOBAL_VARIABLES_PROGRAM_DEFAULTS_HPP
+
+namespace YACCP::GlobalVariables {
+    inline constexpr auto jobDataFileName("job_data.json");
+    inline constexpr auto configFileName("config.toml");
+}
+
+#endif //YACCP_GLOBAL_VARIABLES_PROGRAM_DEFAULTS_HPP

src/tools/image_validator.cpp

@@ -54,15 +54,11 @@ namespace YACCP {
                                         int resolutionHeight,
                                         const std::filesystem::path& dataPath,
                                         const std::string& jobId) {
+        Utility::checkJobPath(dataPath, jobId);
         jobPath_ = dataPath / jobId;
-        if (!exists(jobPath_)) {
-            std::stringstream ss;
-            ss << "Job: " << jobId << " does not exist in the given path: " << dataPath << "\n";
-            throw std::runtime_error(ss.str());
-        }
 
         if (!Utility::isNonEmptyDirectory(jobPath_ / "images" / "raw")) {
-            throw std::runtime_error("\nNo raw images found for job: " + jobId + "\n");
+            throw std::runtime_error("\nNo raw images found for job: " + jobId);
         }
 
         std::vector<std::filesystem::path> cams;
@@ -81,11 +77,7 @@ namespace YACCP {
 
         std::ranges::sort(images);
 
-        if (!exists(jobPath_ / "job_data.json")) {
-            throw std::runtime_error("No camera data was found.\nStopping! \n");
-        }
-
-        nlohmann::json j = Utility::loadJsonFromFile(jobPath_, "job_data.json");
+        nlohmann::json j = Utility::loadJobDataFromFile(jobPath_);
         j.at("config").get_to(fileConfig);
 
         std::vector<CamData::Info> camDatas(cams.size());
@@ -96,7 +88,6 @@ namespace YACCP {
 
         Metavision::FrameComposer frameComposer;
         for (const auto& cam : camDatas) {
-
             const int topLeftX = cam.ViewData.windowX;
             const int topLeftY = cam.ViewData.windowY;
             const unsigned width = cam.resolution.width;

src/utility.cpp

@@ -1,11 +1,14 @@
 #include "utility.hpp"
 
+#include "global_variables/program_defaults.hpp"
+
 #include <filesystem>
 #include <fstream>
 
 #include <opencv2/core/mat.hpp>
 #include <opencv2/objdetect/aruco_detector.hpp>
 
+
 namespace YACCP::Utility {
     void clearScreen() {
         // "\x1b" Escape character
@@ -59,9 +62,23 @@ namespace YACCP::Utility {
         return file;
     }
 
-    nlohmann::json loadJsonFromFile(const std::filesystem::path& path, const std::string& fileName) {
+    void checkJobPath(const std::filesystem::path& dataPath, const std::string& jobId) {
+        if (!exists(dataPath / jobId)) {
+            throw std::runtime_error("Job: " + jobId + " does not exist in the given path: " + dataPath.string());
+        }
+    }
+
+    void checkJobDataAvailable(const std::filesystem::path& jobPath) {
+        if (!exists(jobPath / GlobalVariables::jobDataFileName)) {
+            throw std::runtime_error("No " + static_cast<std::string>(GlobalVariables::jobDataFileName) + " was found.");
+        }
+    }
+
+    nlohmann::json loadJobDataFromFile(const std::filesystem::path& path) {
+
+        checkJobDataAvailable(path);
 
-        std::ifstream file{openFile(path, fileName)};
+        std::ifstream file{openFile(path, GlobalVariables::jobDataFileName)};
 
         nlohmann::json j;
         try {
@@ -75,7 +92,7 @@ namespace YACCP::Utility {
         return j;
     }
 
-    void saveJsonToFile(const std::filesystem::path& jobPath,
+    void saveJobDataToFile(const std::filesystem::path& jobPath,
                         Config::FileConfig& fileConfig,
                         std::vector<CamData>& camDatas) {
         // Create JSON object with all information on this job,
@@ -95,7 +112,7 @@ namespace YACCP::Utility {
         }
 
         // Save JSON to a file.
-        std::ofstream file(jobPath / "job_data.json");
+        std::ofstream file(jobPath / GlobalVariables::jobDataFileName);
         file << j.dump(4);
     }
 

src/utility.hpp

@@ -73,9 +73,13 @@ namespace YACCP::Utility {
 
     [[nodiscard]] std::ifstream openFile(const std::filesystem::path& path, const std::string& fileName);
 
-    [[nodiscard]] nlohmann::json loadJsonFromFile(const std::filesystem::path& path, const std::string& fileName);
+    void checkJobPath(const std::filesystem::path& dataPath, const std::string& jobId);
 
-    void saveJsonToFile(const std::filesystem::path& jobPath, Config::FileConfig& fileConfig, std::vector<CamData>& camDatas);
+    void checkJobDataAvailable(const std::filesystem::path& jobPath);
+
+    [[nodiscard]] nlohmann::json loadJobDataFromFile(const std::filesystem::path& path);
+
+    void saveJobDataToFile(const std::filesystem::path& jobPath, Config::FileConfig& fileConfig, std::vector<CamData>& camDatas);
 
     [[nodiscard]] nlohmann::json parseJsonFromFile(std::ifstream & file);
 

src/yaccp.cpp

@@ -22,7 +22,7 @@ int main(int argc, char** argv) {
 
     // Try to initialise GLFW
     if (!glfwInit()) {
-        std::cerr << "Failed to initialize GLFW." << std::endl;
+        std::cerr << "Failed to initialize GLFW.\n";
         raise(SIGABRT);
     }