My Project  1.10.11
H5IntType.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 H5IntType_H
15 #define H5IntType_H
16 
17 namespace H5 {
18 
23 // Inheritance: AtomType -> DataType -> H5Object -> H5Location -> IdComponent
24 class H5_DLLCPP IntType : public AtomType {
25  public:
26  // Creates an integer type using a predefined type
27  IntType(const PredType &pred_type);
28 
29  // Gets the integer datatype of the specified dataset
30  IntType(const DataSet &dataset);
31 
32  // Constructors that open an HDF5 integer datatype, given a location.
33  IntType(const H5Location &loc, const char *name);
34  IntType(const H5Location &loc, const H5std_string &name);
35 
36  // Returns an IntType object via DataType* by decoding the
37  // binary object description of this type.
38  virtual DataType *decode() const;
39 
40  // Retrieves the sign type for an integer type
41  H5T_sign_t getSign() const;
42 
43  // Sets the sign property for an integer type.
44  void setSign(H5T_sign_t sign) const;
45 
47  virtual H5std_string
48  fromClass() const
49  {
50  return ("IntType");
51  }
52 
53  // Default constructor
54  IntType();
55 
56  // Creates a integer datatype using an existing id
57  IntType(const hid_t existing_id);
58 
59  // Copy constructor: same as the original IntType.
60  IntType(const IntType &original);
61 
62  // Noop destructor.
63  virtual ~IntType();
64 
65 }; // end of IntType
66 } // namespace H5
67 
68 #endif // H5IntType_H
H5::IntType
IntType is a derivative of a DataType and operates on HDF5 integer datatype.
Definition: H5IntType.h:24
H5::AtomType
AtomType is a base class, inherited by IntType, FloatType, StrType, and PredType.
Definition: H5AtomType.h:27
H5::DataType::copy
void copy(const DataType &like_type)
Copies an existing datatype to this datatype object.
Definition: H5DataType.cpp:208
H5::IntType::fromClass
virtual H5std_string fromClass() const
Returns this class name.
Definition: H5IntType.h:48
H5::DataSet
Class DataSet operates on HDF5 datasets.
Definition: H5DataSet.h:27
H5::DataTypeIException
Definition: H5Exception.h:109
H5::IntType::getSign
H5T_sign_t getSign() const
Retrieves the sign type for an integer type.
Definition: H5IntType.cpp:166
H5::IntType::IntType
IntType()
Default constructor: Creates a stub integer datatype.
Definition: H5IntType.cpp:42
H5::IntType::setSign
void setSign(H5T_sign_t sign) const
Sets the sign property for an integer type.
Definition: H5IntType.cpp:186
H5::PredType
Class PredType holds the definition of all the HDF5 predefined datatypes.
Definition: H5PredType.h:27
H5::DataSet::getId
virtual hid_t getId() const
Get the id of this dataset.
Definition: H5DataSet.cpp:693
H5::IntType::~IntType
virtual ~IntType()
Noop destructor.
Definition: H5IntType.cpp:200
H5
Definition: H5AbstractDs.cpp:33
H5::DataType
Class DataType provides generic operations on HDF5 datatypes.
Definition: H5DataType.h:27
H5::H5Location
H5Location is an abstract base class, added in version 1.8.12.
Definition: H5Location.h:30
H5::IntType::decode
virtual DataType * decode() const
Returns an IntType object via DataType* by decoding the binary object description of this type.
Definition: H5IntType.cpp:144
H5::DataSetIException
Definition: H5Exception.h:130


The HDF Group Help Desk:
  Copyright by The HDF Group