storage_commitment_types.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.
 
#ifndef PACS_SERVICES_STORAGE_COMMITMENT_TYPES_HPP
#define PACS_SERVICES_STORAGE_COMMITMENT_TYPES_HPP
 
#include <chrono>
#include <cstdint>
#include <string>
#include <string_view>
#include <utility>
#include <vector>
 
namespace kcenon::pacs::services {
 
// =============================================================================
// Storage Commitment SOP Class UIDs
// =============================================================================
 
inline constexpr std::string_view storage_commitment_push_model_sop_class_uid =
    "1.2.840.10008.1.20.1";
 
inline constexpr std::string_view storage_commitment_push_model_sop_instance_uid =
    "1.2.840.10008.1.20.1.1";
 
// =============================================================================
// Action and Event Type IDs
// =============================================================================
 
inline constexpr uint16_t storage_commitment_action_type_request = 1;
 
inline constexpr uint16_t storage_commitment_event_type_success = 1;
 
inline constexpr uint16_t storage_commitment_event_type_failure = 2;
 
// =============================================================================
// SOP Reference
// =============================================================================
 
struct sop_reference {
    std::string sop_class_uid;      
    std::string sop_instance_uid;   
};
 
// =============================================================================
// Commitment Failure Reasons
// =============================================================================
 
enum class commitment_failure_reason : uint16_t {
    processing_failure = 0x0110,
 
    no_such_object_instance = 0x0112,
 
    resource_limitation = 0x0213,
 
    referenced_sop_class_not_supported = 0x0122,
 
    class_instance_conflict = 0x0119,
 
    duplicate_transaction_uid = 0xA770
};
 
[[nodiscard]] inline std::string_view
to_string(commitment_failure_reason reason) noexcept {
    switch (reason) {
        case commitment_failure_reason::processing_failure:
            return "Processing failure";
        case commitment_failure_reason::no_such_object_instance:
            return "No such object instance";
        case commitment_failure_reason::resource_limitation:
            return "Resource limitation";
        case commitment_failure_reason::referenced_sop_class_not_supported:
            return "Referenced SOP Class not supported";
        case commitment_failure_reason::class_instance_conflict:
            return "Class/Instance conflict";
        case commitment_failure_reason::duplicate_transaction_uid:
            return "Duplicate Transaction UID";
    }
    return "Unknown failure reason";
}
 
// =============================================================================
// Commitment Result
// =============================================================================
 
struct commitment_result {
    std::string transaction_uid;
 
    std::vector<sop_reference> success_references;
 
    std::vector<std::pair<sop_reference, commitment_failure_reason>> failed_references;
 
    std::chrono::system_clock::time_point timestamp;
 
    [[nodiscard]] bool all_successful() const noexcept {
        return failed_references.empty() && !success_references.empty();
    }
 
    [[nodiscard]] std::size_t total_instances() const noexcept {
        return success_references.size() + failed_references.size();
    }
};
 
}  // namespace kcenon::pacs::services
 
#endif  // PACS_SERVICES_STORAGE_COMMITMENT_TYPES_HPP