My Project  1.10.6
H5IntType.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 __H5IntType_H
16 #define __H5IntType_H
17 
18 namespace H5 {
19 
24 // Inheritance: AtomType -> DataType -> H5Object -> H5Location -> IdComponent
25 class H5_DLLCPP IntType : public AtomType {
26  public:
27  // Creates an integer type using a predefined type
28  IntType(const PredType& pred_type);
29 
30  // Gets the integer datatype of the specified dataset
31  IntType(const DataSet& dataset);
32 
33  // Constructors that open an HDF5 integer datatype, given a location.
34  IntType(const H5Location& loc, const char* name);
35  IntType(const H5Location& loc, const H5std_string& name);
36 
37  // Returns an IntType object via DataType* by decoding the
38  // binary object description of this type.
39  virtual DataType* decode() const;
40 
41  // Retrieves the sign type for an integer type
42  H5T_sign_t getSign() const;
43 
44  // Sets the sign proprety for an integer type.
45  void setSign(H5T_sign_t sign) const;
46 
48  virtual H5std_string fromClass () const { return("IntType"); }
49 
50  // Default constructor
51  IntType();
52 
53  // Creates a integer datatype using an existing id
54  IntType(const hid_t existing_id);
55 
56  // Copy constructor: same as the original IntType.
57  IntType(const IntType& original);
58 
59  // Noop destructor.
60  virtual ~IntType();
61 
62 }; // end of IntType
63 } // namespace H5
64 
65 #endif // __H5IntType_H
H5::IntType
IntType is a derivative of a DataType and operates on HDF5 integer datatype.
Definition: H5IntType.h:25
H5::AtomType
AtomType is a base class, inherited by IntType, FloatType, StrType, and PredType.
Definition: H5AtomType.h:28
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:28
H5::DataTypeIException
Definition: H5Exception.h:116
H5::IntType::getSign
H5T_sign_t getSign() const
Retrieves the sign type for an integer type.
Definition: H5IntType.cpp:160
H5::IntType::IntType
IntType()
Default constructor: Creates a stub integer datatype.
Definition: H5IntType.cpp:43
H5::IntType::setSign
void setSign(H5T_sign_t sign) const
Sets the sign property for an integer type.
Definition: H5IntType.cpp:180
H5::PredType
Class PredType holds the definition of all the HDF5 predefined datatypes.
Definition: H5PredType.h:28
H5::DataSet::getId
virtual hid_t getId() const
Get the id of this dataset.
Definition: H5DataSet.cpp:704
H5::IntType::~IntType
virtual ~IntType()
Noop destructor.
Definition: H5IntType.cpp:195
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
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:139
H5::DataSetIException
Definition: H5Exception.h:137


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