diff options
author | Binh-Minh Ribler <bmribler@hdfgroup.org> | 2004-05-18 04:34:13 (GMT) |
---|---|---|
committer | Binh-Minh Ribler <bmribler@hdfgroup.org> | 2004-05-18 04:34:13 (GMT) |
commit | 7f7a952e12f8d445a361811fefe417a2d4092deb (patch) | |
tree | a7c235c36d8789938d10a4246bfd601b091d2f15 /c++/src/H5ArrayType.h | |
parent | 6123fcd9475ce2812da52541402f4d98bf972864 (diff) | |
download | hdf5-7f7a952e12f8d445a361811fefe417a2d4092deb.zip hdf5-7f7a952e12f8d445a361811fefe417a2d4092deb.tar.gz hdf5-7f7a952e12f8d445a361811fefe417a2d4092deb.tar.bz2 |
[svn-r8534] Purpose:
Add more C++ wrappers and documentation - incrementally check-in
Description:
Added class ArrayType to provide wrapper for:
H5Tarray_create
H5Tget_array_ndims
H5Tget_array_dims
Test for the new wrapper will follow in a few weeks.
Platforms:
SunOS 5.7 (arabica)
Linux 2.4 (eirene)
Windows 2000
Diffstat (limited to 'c++/src/H5ArrayType.h')
-rw-r--r-- | c++/src/H5ArrayType.h | 57 |
1 files changed, 57 insertions, 0 deletions
diff --git a/c++/src/H5ArrayType.h b/c++/src/H5ArrayType.h new file mode 100644 index 0000000..d98488e --- /dev/null +++ b/c++/src/H5ArrayType.h @@ -0,0 +1,57 @@ +// C++ informative line for the emacs editor: -*- C++ -*- +/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * + * Copyright by the Board of Trustees of the University of Illinois. * + * All rights reserved. * + * * + * This file is part of HDF5. The full HDF5 copyright notice, including * + * terms governing use, modification, and redistribution, is contained in * + * the files COPYING and Copyright.html. COPYING can be found at the root * + * of the source code distribution tree; Copyright.html can be found at the * + * root level of an installed copy of the electronic HDF5 document set and * + * is linked from the top-level documents page. It can also be found at * + * http://hdf.ncsa.uiuc.edu/HDF5/doc/Copyright.html. If you do not have * + * access to either file, you may request a copy from hdfhelp@ncsa.uiuc.edu. * + * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */ + +// Class ArrayType inherits from DataType and provides wrappers for the +// HDF5 C's Array Datatypes. + +#ifndef _H5ArrayType_H +#define _H5ArrayType_H + +#ifndef H5_NO_NAMESPACE +namespace H5 { +#endif +class H5_DLLCPP ArrayType : public DataType { + public: + // Constructor that creates a new array data type based on the + // specified base type. + ArrayType(const DataType& base_type, int ndims, const hsize_t* dims); + + // Returns the number of dimensions of this array datatype. + int getArrayNDims(); + + // Returns the sizes of dimensions of this array datatype. + int getArrayDims(hsize_t* dims); + + // Copy constructor - makes copy of the original object + ArrayType( const ArrayType& original ); + + // Default destructor + virtual ~ArrayType(); + + protected: + // Default constructor + ArrayType(); + + // Constructor that takes an existing id + ArrayType( const hid_t existing_id ); + + private: + int rank; // Rank of the array + hsize_t* dimensions; // Sizes of the array dimensions +}; +#ifndef H5_NO_NAMESPACE +} +#endif +#endif |