dataset_dimensions.hpp

//  Copyright (c) 2013-2014 Christopher Hinz
//
//  Distributed under the Boost Software License, Version 1.0. (See accompanying
//  file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)

#ifndef ECHELON_DATASET_DIMENSIONS_HPP
#define ECHELON_DATASET_DIMENSIONS_HPP

#include <echelon/type.hpp>
#include <echelon/dimension_scale.hpp>

#include <echelon/hdf5/group.hpp>
#include <echelon/hdf5/type_factory.hpp>

#include <hdf5.h> // hsize_t

#include <string>
#include <cstddef>

namespace echelon
{

class dimension
{
public:
    explicit dimension(hdf5::group containing_group_handle_, std::size_t index_);

    dimension_scale attach_dimension_scale(const std::string& name, const type& datatype);

    template <typename T>
    dimension_scale attach_dimension_scale(const std::string& name)
    {
        return attach_dimension_scale(name, type(hdf5::get_hdf5_type<T>()));
    }

    std::string label() const;

    void relabel(const std::string& new_label);

    hsize_t extend() const;

private:
    hdf5::group containing_group_handle_;
    std::size_t index_;
};

class dataset_dimensions
{
public:
    explicit dataset_dimensions(hdf5::group containing_group_handle_);

    using iterator = std::vector<dimension>::iterator;

    using const_iterator = std::vector<dimension>::const_iterator;

    dataset_dimensions(dataset& associated_dataset_, std::size_t rank_);

    dimension& operator[](std::size_t index)
    {
        return dimensions_[index];
    }

    const dimension& operator[](std::size_t index) const
    {
        return dimensions_[index];
    }

    iterator begin()
    {
        return dimensions_.begin();
    }

    iterator end()
    {
        return dimensions_.end();
    }

    const_iterator begin() const
    {
        return dimensions_.begin();
    }

    const_iterator end() const
    {
        return dimensions_.end();
    }

private:
    std::vector<dimension> dimensions_;
};
}

#endif