ReadIterations.hpp

/* Copyright 2025 Axel Huebl, Franz Poeschel
 *
 * This file is part of openPMD-api.
 *
 * openPMD-api is free software: you can redistribute it and/or modify
 * it under the terms of of either the GNU General Public License or
 * the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * openPMD-api is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License and the GNU Lesser General Public License
 * for more details.
 *
 * You should have received a copy of the GNU General Public License
 * and the GNU Lesser General Public License along with openPMD-api.
 * If not, see <http://www.gnu.org/licenses/>.
 */
#pragma once
 
/*
 * Legacy header.
 */
 
#include "openPMD/Iteration.hpp"
#include "openPMD/Series.hpp"
#include "openPMD/snapshots/Snapshots.hpp"
 
namespace openPMD
{
class LegacyIteratorAdaptor
{
    using value_type = IndexedIteration;
    using parent_t = Snapshots::iterator;
 
private:
    friend class ReadIterations;
    Snapshots::iterator m_iterator;
    LegacyIteratorAdaptor(Snapshots::iterator iterator);
 
public:
    value_type operator*() const;
    LegacyIteratorAdaptor &operator++();
    bool operator==(LegacyIteratorAdaptor const &other) const;
    bool operator!=(LegacyIteratorAdaptor const &other) const;
};

class ReadIterations
{
    friend class Series;
 
private:
    using iterations_t = decltype(internal::SeriesData::iterations);
    using iterator_t = LegacyIteratorAdaptor;
 
    Series m_series;
    std::optional<internal::ParsePreference> m_parsePreference;
 
    ReadIterations(
        Series,
        Access,
        std::optional<internal::ParsePreference> parsePreference);
 
public:
    auto begin() -> iterator_t;
    static auto end() -> iterator_t;
};
} // namespace openPMD