MISR Toolkit  1.5.1
H5ArrayType.h
Go to the documentation of this file.
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://support.hdfgroup.org/ftp/HDF5/releases. *
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  // Constructors that open an array datatype, given a location.
32  ArrayType(const H5Location& loc, const char* name);
33  ArrayType(const H5Location& loc, const H5std_string& name);
34 
35  // Assignment operator
36  ArrayType& operator=(const ArrayType& rhs);
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 fromClass () const { return("ArrayType"); }
52 
53  // Copy constructor: makes copy of the original object.
54  ArrayType(const ArrayType& original);
55 
56  // Constructor that takes an existing id
57  ArrayType(const hid_t existing_id);
58 
59  // Noop destructor
60  virtual ~ArrayType();
61 
62  // Default constructor
63  ArrayType();
64 
65 }; // end of ArrayType
66 } // namespace H5
67 
68 #endif // __H5ArrayType_H
#define H5_DLLCPP
Definition: H5api_adpt.h:262
HDFFCLIBAPI void intf dims[]
Class DataType provides generic operations on HDF5 datatypes.
Definition: H5DataType.h:28
unsigned long long hsize_t
Definition: H5public.h:169
H5Location is an abstract base class, providing a collection of wrappers of the C functions that take...
Definition: H5Location.h:42
Class ArrayType inherits from DataType and provides wrappers for the HDF5's Array Datatypes...
Definition: H5ArrayType.h:25
HDFFCLIBAPI _fcd name
#define H5std_string
Definition: H5Exception.h:25
int hid_t
Definition: H5Ipublic.h:54
virtual H5std_string fromClass() const
Returns this class name.
Definition: H5ArrayType.h:51

MISR Toolkit - Copyright © 2005 - 2020 Jet Propulsion Laboratory
Generated on Fri Jun 19 2020 22:49:52