HDF5 C++ API  1.8.12
 All Classes Namespaces Files Functions Variables Typedefs Macros Pages
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 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  // Returns the number of dimensions of this array datatype.
35  int getArrayNDims();
36 
37  // Returns the sizes of dimensions of this array datatype.
38  int getArrayDims(hsize_t* dims);
39 
41  virtual H5std_string fromClass () const { return("ArrayType"); }
42 
43  // Copy constructor: makes copy of the original object.
44  ArrayType( const ArrayType& original );
45 
46  // Constructor that takes an existing id
47  ArrayType( const hid_t existing_id );
48 
49  // Noop destructor
50  virtual ~ArrayType();
51 
52  protected:
53  // Default constructor
54  ArrayType();
55 
56  private:
57  int rank; // Rank of the array
58  hsize_t* dimensions; // Sizes of the array dimensions
59 };
60 #ifndef H5_NO_NAMESPACE
61 }
62 #endif
63 #endif // __H5ArrayType_H
virtual H5std_string fromClass() const
Returns this class name.
Definition: H5ArrayType.h:41
#define H5std_string
Definition: H5Exception.h:29
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