hdf5/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_HDF5_DATASET_DIMENSIONS_HPP
#define ECHELON_HDF5_DATASET_DIMENSIONS_HPP

#include <echelon/hdf5/type.hpp>
#include <echelon/hdf5/type_factory.hpp>
#include <echelon/hdf5/object.hpp>
#include <echelon/hdf5/dimension_scale.hpp>

#include <hdf5.h> // hsize_t

#include <vector>
#include <string>
#include <cstddef>

namespace echelon
{
namespace hdf5
{
class dimension
{
public:
    dimension(const dataset& associated_dataset_, std::size_t index_);

    dimension_scale attach_dimension_scale(const std::string& scale_name, object location,
                                           const std::string& dataset_name, const type& datatype,
                                           const std::vector<hsize_t>& extent);

    template <typename T>
    dimension_scale attach_dimension_scale(const std::string& scale_name, object location,
                                           const std::string& dataset_name,
                                           const std::vector<hsize_t>& extent)
    {
        return attach_dimension_scale(scale_name, location, dataset_name, get_hdf5_type<T>(),
                                      extent);
    }

    std::string label() const;

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

    hsize_t extend() const;

private:
    const dataset* associated_dataset_;
    std::size_t index_;
};

class dataset_dimensions
{
public:
    typedef std::vector<dimension>::iterator iterator;

    typedef std::vector<dimension>::const_iterator const_iterator;

    dataset_dimensions(const 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();
    }

    std::size_t count() const;

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

#endif