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


The HDF Group Help Desk:
  Copyright by The HDF Group