My Project  1.10.4
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://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  // 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 fromClass () const { return("ArrayType"); }
52 
53  // Copy constructor: same as the original ArrayType.
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
H5::ArrayType::fromClass
virtual H5std_string fromClass() const
Returns this class name.
Definition: H5ArrayType.h:51
H5::Exception
Exception provides wrappers of HDF5 error handling functions.
Definition: H5Exception.h:32
H5::DataType::getId
virtual hid_t getId() const
Get the id of this datatype.
Definition: H5DataType.cpp:898
H5::ArrayType::getArrayDims
int getArrayDims(hsize_t *dims) const
Retrieves the size of all dimensions of an array datatype.
Definition: H5ArrayType.cpp:191
H5::ArrayType::getArrayNDims
int getArrayNDims() const
Returns the number of dimensions for an array datatype.
Definition: H5ArrayType.cpp:171
H5::ArrayType::operator=
ArrayType & operator=(const ArrayType &rhs)
Assignment operator.
Definition: H5ArrayType.cpp:125
H5::DataTypeIException
Definition: H5Exception.h:116
H5::ArrayType::ArrayType
ArrayType()
Default constructor: Creates a stub ArrayType.
Definition: H5ArrayType.cpp:37
H5::ArrayType::decode
virtual DataType * decode() const
Returns an ArrayType object via DataType* by decoding the binary object description of this type.
Definition: H5ArrayType.cpp:150
H5::ArrayType::~ArrayType
virtual ~ArrayType()
Properly terminates access to this array datatype.
Definition: H5ArrayType.cpp:207
H5::ArrayType
Class ArrayType inherits from DataType and provides wrappers for the HDF5's Array Datatypes.
Definition: H5ArrayType.h:25
H5::Exception::getDetailMsg
H5std_string getDetailMsg() const
Returns the detailed message set at the time the exception is thrown.
Definition: H5Exception.cpp:256
H5::IdComponent::setId
void setId(const hid_t new_id)
Sets the identifier of this object to a new value.
Definition: H5IdComponent.cpp:307
H5
Definition: H5AbstractDs.cpp:34
H5::DataType
Class DataType provides generic operations on HDF5 datatypes.
Definition: H5DataType.h:28
H5::H5Location
H5Location is an abstract base class, added in version 1.8.12.
Definition: H5Location.h:31


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