storage_interface.h

Go to the documentation of this file.

// BSD 3-Clause License
// Copyright (c) 2021-2025, 🍀☀🌕🌥 🌊
// See the LICENSE file in the project root for full license information.
 
#pragma once
 
#include <kcenon/pacs/core/dicom_dataset.h>
 
#include <kcenon/common/patterns/result.h>
 
#include <cstddef>
#include <cstdint>
#include <memory>
#include <string>
#include <string_view>
#include <vector>
 
namespace kcenon::pacs::storage {
 
template <typename T>
using Result = kcenon::common::Result<T>;
 
using VoidResult = kcenon::common::VoidResult;
 
struct storage_statistics {
    std::size_t total_instances{0};
 
    std::size_t total_bytes{0};
 
    std::size_t studies_count{0};
 
    std::size_t series_count{0};
 
    std::size_t patients_count{0};
};
 
class storage_interface {
public:
    virtual ~storage_interface() = default;
 
    // =========================================================================
    // CRUD Operations
    // =========================================================================
 
    [[nodiscard]] virtual auto store(const core::dicom_dataset& dataset)
        -> VoidResult = 0;
 
    [[nodiscard]] virtual auto retrieve(std::string_view sop_instance_uid)
        -> Result<core::dicom_dataset> = 0;
 
    [[nodiscard]] virtual auto remove(std::string_view sop_instance_uid)
        -> VoidResult = 0;
 
    [[nodiscard]] virtual auto exists(std::string_view sop_instance_uid) const
        -> bool = 0;
 
    // =========================================================================
    // Query Operations
    // =========================================================================
 
    [[nodiscard]] virtual auto find(const core::dicom_dataset& query)
        -> Result<std::vector<core::dicom_dataset>> = 0;
 
    // =========================================================================
    // Batch Operations
    // =========================================================================
 
    [[nodiscard]] virtual auto store_batch(
        const std::vector<core::dicom_dataset>& datasets) -> VoidResult;
 
    [[nodiscard]] virtual auto retrieve_batch(
        const std::vector<std::string>& sop_instance_uids)
        -> Result<std::vector<core::dicom_dataset>>;
 
    // =========================================================================
    // Maintenance Operations
    // =========================================================================
 
    [[nodiscard]] virtual auto get_statistics() const
        -> storage_statistics = 0;
 
    [[nodiscard]] virtual auto verify_integrity() -> VoidResult = 0;
 
protected:
    storage_interface() = default;
 
    storage_interface(const storage_interface&) = delete;
    storage_interface& operator=(const storage_interface&) = delete;
 
    storage_interface(storage_interface&&) = default;
    storage_interface& operator=(storage_interface&&) = default;
};
 
}  // namespace kcenon::pacs::storage