/home/amesfoort/DAL/dal/hdf5/Dataset.h

/* Copyright 2011-2012  ASTRON, Netherlands Institute for Radio Astronomy
 * This file is part of the Data Access Library (DAL).
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of 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.
 *
 * This library 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public 
 * License along with this library.  If not, see <http://www.gnu.org/licenses/>.
 */
#ifndef DAL_DATASET_H
#define DAL_DATASET_H

#include <cstddef>
#include <cstdlib>
#include <cstring>
#include <sys/types.h>
#include <sys/stat.h>
#include <unistd.h>
#include <fcntl.h>
#ifdef __APPLE__
#include <machine/endian.h>
#else
#include <endian.h>
#endif
#if BYTE_ORDER != BIG_ENDIAN && BYTE_ORDER != LITTLE_ENDIAN
#error Byte order is neither big endian nor little endian: not supported
#endif

#include <string>
#include <vector>
#include <hdf5.h>
#include "types/h5typemap.h"
#include "exceptions/exceptions.h"
#include "Group.h"

namespace dal {

template<typename T> class Dataset: public Group {
public:
  enum Endianness { NATIVE = 0, LITTLE, BIG };

  Dataset( Group &parent, const std::string &name ): Group(parent, name) {}

  virtual ~Dataset() {}

  Dataset<T>& create( const std::vector<ssize_t> &dims, const std::vector<ssize_t> &maxdims = std::vector<ssize_t>(0),
                const std::string &filename = "", enum Endianness endianness = NATIVE );

  Dataset<T>& create1D( ssize_t len, ssize_t maxlen, const std::string &filename = "",
                enum Endianness endianness = NATIVE );

  size_t ndims();

  std::vector<ssize_t> dims();

  ssize_t dims1D();

  std::vector<ssize_t> maxdims();

  ssize_t maxdims1D();

  void resize( const std::vector<ssize_t> &newdims );

  void resize1D( ssize_t newlen );

  std::vector<std::string> externalFiles();

  void getMatrix( const std::vector<size_t> &pos, T *buffer, const std::vector<size_t> &size );

  void setMatrix( const std::vector<size_t> &pos, const T *buffer, const std::vector<size_t> &size );

  void get1D( size_t pos, T *outbuffer, size_t len, unsigned dimIndex = 0 );

  void set1D( size_t pos, const T *inbuffer, size_t len, unsigned dimIndex = 0 );

  void get2D( const std::vector<size_t> &pos, T *outbuffer2, size_t dim1, size_t dim2, unsigned dim1index = 0, unsigned dim2index = 1 );

  void set2D( const std::vector<size_t> &pos, const T *inbuffer2, size_t dim1, size_t dim2, unsigned dim1index = 0, unsigned dim2index = 1 );

  void get3D( const std::vector<size_t> &pos, T *outbuffer3, size_t dim1, size_t dim2, size_t dim3, unsigned dim1index = 0, unsigned dim2index = 1, unsigned dim3index = 2 );

  void set3D( const std::vector<size_t> &pos, const T *inbuffer3, size_t dim1, size_t dim2, size_t dim3, unsigned dim1index = 0, unsigned dim2index = 1, unsigned dim3index = 2 );

  T getScalar( const std::vector<size_t> &pos );

  T getScalar1D( size_t pos );

  void setScalar( const std::vector<size_t> &pos, const T &value );

  void setScalar1D( size_t pos, T value );

protected:
  bool bigEndian( enum Endianness endianness ) const;

  void matrixIO( const std::vector<size_t> &pos, T *buffer, const std::vector<size_t> &size, const std::vector<size_t> &strides, bool read );


  virtual Dataset<T>& create() {
    throw HDF5Exception("create() without parameters not supported on a dataset " + _name);
  }

private:
  virtual void open( hid_t parent, const std::string &name );
};

}

#include "Dataset.tcc"

#endif