My Project  1.10.8
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 COPYING file, which can be found at the root of the source code *
10  * distribution tree, or in https://www.hdfgroup.org/licenses. *
11  * If you do not have access to either file, you may request a copy from *
12  * help@hdfgroup.org. *
13  * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
14 
15 #ifndef H5ArrayType_H
16 #define H5ArrayType_H
17 
18 namespace H5 {
19 
24 // Inheritance: DataType -> H5Object -> H5Location -> IdComponent
25 class H5_DLLCPP ArrayType : public DataType {
26  public:
27  // Constructor that creates a new array data type based on the
28  // specified base type.
29  ArrayType(const DataType &base_type, int ndims, const hsize_t *dims);
30 
31  // Assignment operator
32  ArrayType &operator=(const ArrayType &rhs);
33 
34  // Constructors that open an array datatype, given a location.
35  ArrayType(const H5Location &loc, const char *name);
36  ArrayType(const H5Location &loc, const H5std_string &name);
37 
38  // Returns an ArrayType object via DataType* by decoding the
39  // binary object description of this type.
40  virtual DataType *decode() const;
41 
42  // Returns the number of dimensions of this array datatype.
43  int getArrayNDims() const;
44  // int getArrayNDims(); // removed 1.8.18 and 1.10.1
45 
46  // Returns the sizes of dimensions of this array datatype.
47  int getArrayDims(hsize_t *dims) const;
48  // int getArrayDims(hsize_t* dims); // removed 1.8.18 and 1.10.1
49 
51  virtual H5std_string
52  fromClass() const
53  {
54  return ("ArrayType");
55  }
56 
57  // Copy constructor: same as the original ArrayType.
58  ArrayType(const ArrayType &original);
59 
60  // Constructor that takes an existing id
61  ArrayType(const hid_t existing_id);
62 
63  // Noop destructor
64  virtual ~ArrayType();
65 
66  // Default constructor
67  ArrayType();
68 
69 }; // end of ArrayType
70 } // namespace H5
71 
72 #endif // H5ArrayType_H
Class ArrayType inherits from DataType and provides wrappers for the HDF5's Array Datatypes.
Definition: H5ArrayType.h:25
virtual H5std_string fromClass() const
Returns this class name.
Definition: H5ArrayType.h:52
Class DataType provides generic operations on HDF5 datatypes.
Definition: H5DataType.h:28
H5Location is an abstract base class, added in version 1.8.12.
Definition: H5Location.h:31
Definition: H5AbstractDs.cpp:34


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