ENH : Add support for getting the pipeline json object from a dream3d…

… file (BlueQuartzSoftware#890)
imikejackson · Mar 19, 2024 · 2555ffc · 2555ffc
1 parent 5bbf33c
commit 2555ffc
Show file tree

Hide file tree

Showing 4 changed files with 55 additions and 5 deletions.
diff --git a/src/simplnx/Pipeline/Pipeline.cpp b/src/simplnx/Pipeline/Pipeline.cpp
@@ -24,7 +24,6 @@ constexpr StringLiteral k_PipelineItemsKey = "pipeline";
 constexpr StringLiteral k_PipelineVersionKey = "version";
 constexpr uint64 k_PipelineVersion = 1;
 
-constexpr StringLiteral k_SIMPLPipelineBuilderKey = "PipelineBuilder";
 constexpr StringLiteral k_SIMPLPipelineNameKey = "Name";
 constexpr StringLiteral k_SIMPLNumFilterseKey = "Number_Filters";
 

diff --git a/src/simplnx/Pipeline/Pipeline.hpp b/src/simplnx/Pipeline/Pipeline.hpp
@@ -33,6 +33,7 @@ class SIMPLNX_EXPORT Pipeline : public AbstractPipelineNode, protected PipelineN
   using const_iterator = collection_type::const_iterator;
 
   static constexpr StringLiteral k_Extension = ".d3dpipeline";
+  static constexpr StringLiteral k_SIMPLPipelineBuilderKey = "PipelineBuilder";
 
   /**
    * @brief Constructs a Pipeline from json.

diff --git a/src/simplnx/Utilities/Parsing/DREAM3D/Dream3dIO.cpp b/src/simplnx/Utilities/Parsing/DREAM3D/Dream3dIO.cpp
@@ -1331,21 +1331,39 @@ Result<DataStructure> DREAM3D::ImportDataStructureFromFile(const std::filesystem
 
 Result<Pipeline> DREAM3D::ImportPipelineFromFile(const nx::core::HDF5::FileReader& fileReader)
 {
-  if(GetPipelineVersion(fileReader) != k_CurrentPipelineVersion)
+  Result<nlohmann::json> pipelineJson = ImportPipelineJsonFromFile(fileReader);
+  if(pipelineJson.invalid())
   {
-    return MakeErrorResult<Pipeline>(k_InvalidPipelineVersion, fmt::format("Could not parse Pipeline version '{}'. Expected version: '{}'", GetPipelineVersion(fileReader), k_CurrentFileVersion));
+    return ConvertInvalidResult<Pipeline, nlohmann::json>(std::move(pipelineJson));
   }
+  const auto fileVersion = GetFileVersion(fileReader);
+  if(fileVersion == k_CurrentFileVersion)
+  {
+    if(GetPipelineVersion(fileReader) != k_CurrentPipelineVersion)
+    {
+      return MakeErrorResult<Pipeline>(k_InvalidPipelineVersion, fmt::format("Could not parse Pipeline version '{}'. Expected version: '{}'", GetPipelineVersion(fileReader), k_CurrentFileVersion));
+    }
+    return Pipeline::FromJson(pipelineJson.value());
+  }
+  if(fileVersion == Legacy::FileVersion)
+  {
+    return Pipeline::FromSIMPLJson(pipelineJson.value());
+  }
+  return MakeErrorResult<Pipeline>(k_InvalidPipelineVersion, fmt::format("Could not parse file version '{}'", k_CurrentFileVersion));
+}
 
+Result<nlohmann::json> DREAM3D::ImportPipelineJsonFromFile(const nx::core::HDF5::FileReader& fileReader)
+{
   auto pipelineGroupReader = fileReader.openGroup(k_PipelineJsonTag);
   auto pipelineDatasetReader = pipelineGroupReader.openDataset(k_PipelineJsonTag);
   if(!pipelineDatasetReader.isValid())
   {
-    return MakeErrorResult<Pipeline>(k_PipelineGroupUnavailable, "Could not open '/Pipeline' HDF5 Group.");
+    return MakeErrorResult<nlohmann::json>(k_PipelineGroupUnavailable, "Could not open '/Pipeline' HDF5 Group.");
   }
 
   auto pipelineJsonString = pipelineDatasetReader.readAsString();
   auto pipelineJson = nlohmann::json::parse(pipelineJsonString);
-  return Pipeline::FromJson(pipelineJson);
+  return {pipelineJson};
 }
 
 Result<Pipeline> DREAM3D::ImportPipelineFromFile(const std::filesystem::path& filePath)
@@ -1363,6 +1381,21 @@ Result<Pipeline> DREAM3D::ImportPipelineFromFile(const std::filesystem::path& fi
   return ImportPipelineFromFile(fileReader);
 }
 
+Result<nlohmann::json> DREAM3D::ImportPipelineJsonFromFile(const std::filesystem::path& filePath)
+{
+  if(!std::filesystem::exists(filePath))
+  {
+    return MakeErrorResult<nlohmann::json>(-1, fmt::format("DREAM3D::ImportPipelineFromFile: File does not exist. '{}'", filePath.string()));
+  }
+  nx::core::HDF5::FileReader fileReader(filePath);
+  if(!fileReader.isValid())
+  {
+    return MakeErrorResult<nlohmann::json>(-1, fmt::format("DREAM3D::ImportPipelineFromFile: Unable to open '{}' for reading", filePath.string()));
+  }
+
+  return ImportPipelineJsonFromFile(fileReader);
+}
+
 Result<DREAM3D::FileData> DREAM3D::ReadFile(const nx::core::HDF5::FileReader& fileReader, bool preflight)
 {
   // Pipeline pipeline;

diff --git a/src/simplnx/Utilities/Parsing/DREAM3D/Dream3dIO.hpp b/src/simplnx/Utilities/Parsing/DREAM3D/Dream3dIO.hpp
@@ -118,6 +118,23 @@ SIMPLNX_EXPORT Result<DataStructure> ImportDataStructureFromFile(const std::file
  */
 SIMPLNX_EXPORT Result<Pipeline> ImportPipelineFromFile(const nx::core::HDF5::FileReader& fileReader);
 
+/**
+ * @brief Imports and returns a Pipeline from the target .dream3d file.
+ *
+ * This method does not import legacy Pipelines.
+ * @param fileReader
+ * @return Pipeline
+ */
+SIMPLNX_EXPORT Result<nlohmann::json> ImportPipelineJsonFromFile(const nx::core::HDF5::FileReader& fileReader);
+
+/**
+ * @brief Imports and returns a Pipeline from the target .dream3d file.
+ * This method does not import legacy Pipelines.
+ * @param fileReader
+ * @return Pipeline
+ */
+SIMPLNX_EXPORT Result<nlohmann::json> ImportPipelineJsonFromFile(const std::filesystem::path& filePath);
+
 /**
  * @brief Imports and returns a Pipeline from the target .dream3d file.
  * This method does not import legacy Pipelines.