typedef smart pointers. Reorganise DatapipeLine pimpl to hide the impl

Author: dezed-ukaea

include/fdp/fdp.hxx

@@ -1,22 +1,25 @@
+#ifndef __FDP__
+#define __FDP__
+
+#include <ghc/filesystem.hpp>
+
 #include "fdp/registry/datapipeline.hxx"
 
 namespace FDP {
+
 class DataPipeline {
+
 public:
   // 'initialise' method for the API
+
+  ~DataPipeline();
+
   explicit DataPipeline(
       const std::string &config_file_path,
       const std::string &script_file_path,
       std::string token = "",
-      spdlog::level::level_enum log_level = spdlog::level::info)
-      : pimpl_(std::make_shared<DataPipelineImpl_>(ghc::filesystem::path(config_file_path), ghc::filesystem::path(script_file_path), token,
-                                     log_level)) {
-          
-    APILogger->debug("DataPipeline: Initialising session '{0}'", Pimpl()->get_code_run_uuid());
-  }
-
-  // 'finalise' method for the API
-  ~DataPipeline();
+      spdlog::level::level_enum log_level = spdlog::level::info);
+
 
   DataPipeline(DataPipeline &&rhs) noexcept;
   DataPipeline &operator=(DataPipeline &&rhs) noexcept;
@@ -29,9 +32,10 @@ public:
   void finalise();
 
 private:
-  const DataPipelineImpl_* Pimpl() const {return pimpl_.get();}
-  DataPipelineImpl_* Pimpl() {return pimpl_.get();}
-  
-  std::shared_ptr<DataPipelineImpl_> pimpl_;
+   class impl;
+ 
+   std::shared_ptr< DataPipeline::impl > pimpl_;
 };
-}; // namespace FDP
+}; // namespace FDP
+
+#endif

include/fdp/objects/api_object.hxx

@@ -16,6 +16,10 @@ namespace FDP {
         private:
             Json::Value obj_;
         public:
+
+            typedef std::unique_ptr< ApiObject > uptr;
+            typedef std::shared_ptr< ApiObject > sptr;
+
             ApiObject() : obj_(Json::Value()){};
             /**
              * @brief Construct a new Api Object object
@@ -57,4 +61,4 @@ namespace FDP {
     };
 };
 
-#endif
+#endif

include/fdp/objects/config.hxx

@@ -41,24 +41,24 @@ namespace FDP {
             std::string token_;
             std::shared_ptr<API> api_;
 
-            std::unique_ptr<ApiObject> user_;
-            std::unique_ptr<ApiObject> author_;
+            ApiObject::uptr user_;
+            ApiObject::uptr author_;
 
-            std::unique_ptr<ApiObject> config_storage_root_;
-            std::unique_ptr<ApiObject> config_storage_location_;
-            std::unique_ptr<ApiObject> config_file_type_;
-            std::unique_ptr<ApiObject> config_obj_;
+            ApiObject::uptr config_storage_root_;
+            ApiObject::uptr config_storage_location_;
+            ApiObject::uptr config_file_type_;
+            ApiObject::uptr config_obj_;
 
-            std::unique_ptr<ApiObject> script_storage_root_;
-            std::unique_ptr<ApiObject> script_storage_location_;
-            std::unique_ptr<ApiObject> script_file_type_;
-            std::unique_ptr<ApiObject> script_obj_;
+            ApiObject::uptr script_storage_root_;
+            ApiObject::uptr script_storage_location_;
+            ApiObject::uptr script_file_type_;
+            ApiObject::uptr script_obj_;
 
-            std::unique_ptr<ApiObject> code_repo_storage_root_;
-            std::unique_ptr<ApiObject> code_repo_storage_location_;
-            std::unique_ptr<ApiObject> code_repo_obj_;
+            ApiObject::uptr code_repo_storage_root_;
+            ApiObject::uptr code_repo_storage_location_;
+            ApiObject::uptr code_repo_obj_;
 
-            std::unique_ptr<ApiObject> code_run_;
+            ApiObject::uptr code_run_;
 
             std::map<std::string, IOObject> writes_;
             std::map<std::string, IOObject> reads_;
@@ -72,6 +72,8 @@ namespace FDP {
             bool config_has_reads() const;
 
         public:
+            typedef std::unique_ptr< Config > uptr;
+
             Config(const ghc::filesystem::path &config_file_path,
             const ghc::filesystem::path &script_file_path,
             const std::string &token,
@@ -117,4 +119,4 @@ namespace FDP {
 
     };
 };
-#endif
+#endif

include/fdp/objects/io_object.hxx

@@ -25,40 +25,42 @@ namespace FDP {
             std::string component_description_ = "None";
             bool public_ = false;
 
-            std::shared_ptr<ApiObject> component_obj_;
-            std::shared_ptr<ApiObject> data_product_obj_;
+            ApiObject::sptr component_obj_;
+            ApiObject::sptr data_product_obj_;
 
         public:
             IOObject(){};
             IOObject(std::string data_product,
-                        std::string use_data_product,
-                        std::string use_version,
-                        std::string use_namespace,
-                        ghc::filesystem::path path,
-                        std::string data_product_description,
-                        bool isPublic):
-                        data_product_(data_product),
-                        use_data_product_(use_data_product),
-                        use_version_(use_version),
-                        use_namespace_(use_namespace),
-                        path_(path),
-                        data_product_description_(data_product_description),
-                        public_(isPublic){};
+                    std::string use_data_product,
+                    std::string use_version,
+                    std::string use_namespace,
+                    ghc::filesystem::path path,
+                    std::string data_product_description,
+                    bool isPublic)
+                :
+                    data_product_(data_product),
+                    use_data_product_(use_data_product),
+                    use_version_(use_version),
+                    use_namespace_(use_namespace),
+                    path_(path),
+                    data_product_description_(data_product_description),
+                    public_(isPublic){};
 
             IOObject(std::string data_product,
                         std::string use_data_product,
                         std::string use_version,
                         std::string use_namespace,
                         ghc::filesystem::path path,
                         ApiObject &component_obj,
-                        ApiObject &data_product_obj):
-                        data_product_(data_product),
-                        use_data_product_(use_data_product),
-                        use_version_(use_version),
-                        use_namespace_(use_namespace),
-                        path_(path),
-                        component_obj_(std::make_shared<ApiObject>(component_obj)),
-                        data_product_obj_(std::make_shared<ApiObject>(data_product_obj)){};
+                        ApiObject &data_product_obj) 
+                :
+                    data_product_(data_product),
+                    use_data_product_(use_data_product),
+                    use_version_(use_version),
+                    use_namespace_(use_namespace),
+                    path_(path),
+                    component_obj_(std::make_shared<ApiObject>(component_obj)),
+                    data_product_obj_(std::make_shared<ApiObject>(data_product_obj)){};
 
             std::string get_data_product() {return data_product_;}
             std::string get_use_data_product() {return use_data_product_;}
@@ -70,12 +72,12 @@ namespace FDP {
             std::string get_component_description() {return component_description_;}
             bool is_public() {return public_;}
 
-            std::shared_ptr<ApiObject> get_component_object() {return component_obj_;}
-            std::shared_ptr<ApiObject> get_data_product_object() {return data_product_obj_;}
+            ApiObject::sptr get_component_object() {return component_obj_;}
+            ApiObject::sptr get_data_product_object() {return data_product_obj_;}
 
-            void set_component_object(ApiObject &component_obj){component_obj_ = std::make_shared<ApiObject>(component_obj);}
+            void set_component_object(ApiObject& component_obj){component_obj_ = std::make_shared<ApiObject>(component_obj);}
             void set_data_product_object(ApiObject &data_product_obj){data_product_obj_ = std::make_shared<ApiObject>(data_product_obj);}
     };
 };
 
-#endif
+#endif

include/fdp/registry/datapipeline.hxx

@@ -8,8 +8,8 @@
  * with the FDP FAIR Data pipeline. They contain methods which parse
  * configurations and control calls to the RestAPI itself.
  ****************************************************************************/
-#ifndef __FDP_DATAPIPELINE_HXX__
-#define __FDP_DATAPIPELINE_HXX__
+#ifndef __FDP_DATAPIPELINE_IMP_HXX__
+#define __FDP_DATAPIPELINE_IMP_HXX__
 
 #include <algorithm>
 #include <fstream>
@@ -19,6 +19,8 @@
 #include "spdlog/spdlog.h"
 #include "json/json.h"
 
+#include "fdp/fdp.hxx"
+
 #include "fdp/objects/config.hxx"
 #include "fdp/objects/metadata.hxx"
 #include "fdp/registry/api.hxx"
@@ -42,51 +44,6 @@ namespace FDP {
  * but rather via an FDP::DataPipeline instance.
  *
  *****************************************************************************/
-class DataPipelineImpl_ {
-  private:
-    std::unique_ptr<Config> config_;
-
-    ghc::filesystem::path config_file_path_() const {return config_->get_config_file_path();}
-    ghc::filesystem::path script_file_path_() const {return config_->get_script_file_path();}
-    std::string token_() const {return config_->get_token();}
-    RESTAPI api_location_() {return config_->get_rest_api_location();}
-public:
-  
-  /*! *************************************************************************
-   * @brief construct a DataPipelineImpl_ instance from configurations and setup
-   * @author K. Zarebski (UKAEA)
-   *
-   * @param config_file_path location of the local configuration file
-   * @param access_token_file API authorisation token where required
-   * @param log_level level for the output logging statements
-   * @param api_location whether to use local/remote RestAPI endpoint
-   ***************************************************************************/
-  DataPipelineImpl_(const ghc::filesystem::path &config_file_path,
-                    const ghc::filesystem::path &file_system_path,
-                    const std::string token,
-                    spdlog::level::level_enum log_level = spdlog::level::info,
-                    RESTAPI api_location = RESTAPI::LOCAL);
-
-  DataPipelineImpl_(const DataPipelineImpl_ &dp){
-    DataPipelineImpl_(dp.config_file_path_(), dp.script_file_path_(), token_(), spdlog::level::info, api_location_());}
-
-  /**
-   * @brief Destroy the Data Pipeline Impl_ object
-   * 
-   */
-  ~DataPipelineImpl_() = default;
-  
-  //DataPipelineImpl_& operator=(DataPipelineImpl_ dp);
-
-
-
-  ghc::filesystem::path link_read(std::string &data_product);
-  ghc::filesystem::path link_write(std::string &data_product);
-  void finalise();
-
-  std::string get_code_run_uuid();
-
-};
 }; // namespace FDP
 
-#endif
+#endif