image_transaction_plan.hpp

// SPDX-License-Identifier: LGPL-2.1-or-later
 
#pragma once
 
#include <vitrio/export.hpp>
#include <vitrio/image_transfer_shape.hpp>
#include <vitrio/index_table.hpp>
#include <vitrio/interned_key_list.hpp>
#include <vitrio/span.hpp>
 
#include <cstddef>
#include <string>
 
namespace vitrio
{
 
class image_transaction_plan
{
public:
    VITRIO_API
    explicit image_transaction_plan(image_transfer_shape shape);
 
    VITRIO_API
    image_transaction_plan(const image_transaction_plan &other);
    VITRIO_API
    image_transaction_plan(image_transaction_plan &&other) noexcept;
    VITRIO_API
    ~image_transaction_plan();
 
    VITRIO_API
    image_transaction_plan& operator=(const image_transaction_plan &other);
    VITRIO_API
    image_transaction_plan&
    operator=(image_transaction_plan &&other) noexcept;
 
    VITRIO_API
    std::size_t add_file(std::string key);
 
    VITRIO_API
    void add(
        std::size_t file_index,
        span<const std::size_t> file_offset,
        span<const std::size_t> array_offset
    );
 
    VITRIO_API
    void clear() noexcept;
 
    VITRIO_API
    void reserve(std::size_t files, std::size_t regions);
 
    VITRIO_API
    std::size_t get_region_count() const noexcept;
 
    VITRIO_API
    const image_transfer_shape& get_shape() const noexcept;
 
    VITRIO_API
    std::size_t get_file_count() const noexcept;
 
    VITRIO_API
    const std::string& get_file(std::size_t file_index) const noexcept;
 
    VITRIO_API
    std::size_t get_region_file(std::size_t region_index) const noexcept;
 
    VITRIO_API
    span<const std::size_t>
    get_file_offset(std::size_t region_index) const noexcept;
 
    VITRIO_API
    span<const std::size_t>
    get_array_offset(std::size_t region_index) const noexcept;
 
private:
    image_transfer_shape m_shape;
    interned_key_list m_files;
    index_table m_file_offsets;
    index_table m_array_offsets;
};
 
} // namespace vitrio