HDF5 C++ API  1.10.0-patch1 currently under development
 All Classes Namespaces Functions Variables Typedefs Friends Pages
H5ArrayType.h
1 // C++ informative line for the emacs editor: -*- C++ -*-
2 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
3  * Copyright by The HDF Group. *
4  * Copyright by the Board of Trustees of the University of Illinois. *
5  * All rights reserved. *
6  * *
7  * This file is part of HDF5. The full HDF5 copyright notice, including *
8  * terms governing use, modification, and redistribution, is contained in *
9  * the files COPYING and Copyright.html. COPYING can be found at the root *
10  * of the source code distribution tree; Copyright.html can be found at the *
11  * root level of an installed copy of the electronic HDF5 document set and *
12  * is linked from the top-level documents page. It can also be found at *
13  * http://hdfgroup.org/HDF5/doc/Copyright.html. If you do not have *
14  * access to either file, you may request a copy from help@hdfgroup.org. *
15  * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
16 
17 #ifndef __H5ArrayType_H
18 #define __H5ArrayType_H
19 
20 #ifndef H5_NO_NAMESPACE
21 namespace H5 {
22 #endif
23 
28 class H5_DLLCPP ArrayType : public DataType {
29  public:
30  // Constructor that creates a new array data type based on the
31  // specified base type.
32  ArrayType(const DataType& base_type, int ndims, const hsize_t* dims);
33 
34  // Assignment operator
35  ArrayType& operator=(const ArrayType& rhs);
36 
37  // Stores the rank and dimensions in memory.
38  void setArrayInfo();
39 
40  // Returns the number of dimensions of this array datatype.
41  int getArrayNDims();
42 
43  // Returns the sizes of dimensions of this array datatype.
44  int getArrayDims(hsize_t* dims);
45 
47  virtual H5std_string fromClass () const { return("ArrayType"); }
48 
49  // Copy constructor: makes copy of the original object.
50  ArrayType( const ArrayType& original );
51 
52  // Constructor that takes an existing id
53  ArrayType( const hid_t existing_id );
54 
55  // Noop destructor
56  virtual ~ArrayType();
57 
58  // Default constructor
59  ArrayType();
60 
61  private:
62  int rank; // Rank of the array
63  hsize_t* dimensions; // Sizes of the array dimensions
64 };
65 #ifndef H5_NO_NAMESPACE
66 }
67 #endif
68 #endif // __H5ArrayType_H
Definition: H5AbstractDs.cpp:31
virtual H5std_string fromClass() const
Returns this class name.
Definition: H5ArrayType.h:47
Class DataType provides generic operations on HDF5 datatypes.
Definition: H5DataType.h:34
Class ArrayType inherits from DataType and provides wrappers for the HDF5's Array Datatypes...
Definition: H5ArrayType.h:28


The HDF Group Help Desk:
  Copyright by The HDF Group
and the Board of Trustees of the University of Illinois