MISR Toolkit  1.5.1
H5IntType.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 __H5IntType_H
16 #define __H5IntType_H
17 
18 namespace H5 {
19 
20 class PredType;
21 
26 // Inheritance: AtomType -> DataType -> H5Object -> H5Location -> IdComponent
27 class H5_DLLCPP IntType : public AtomType {
28  public:
29  // Creates an integer type using a predefined type
30  IntType(const PredType& pred_type);
31 
32  // Gets the integer datatype of the specified dataset
33  IntType(const DataSet& dataset);
34 
35  // Constructors that open an HDF5 integer datatype, given a location.
36  IntType(const H5Location& loc, const char* name);
37  IntType(const H5Location& loc, const H5std_string& name);
38 
39  // Returns an IntType object via DataType* by decoding the
40  // binary object description of this type.
41  virtual DataType* decode() const;
42 
43  // Retrieves the sign type for an integer type
44  H5T_sign_t getSign() const;
45 
46  // Sets the sign proprety for an integer type.
47  void setSign(H5T_sign_t sign) const;
48 
50  virtual H5std_string fromClass () const { return("IntType"); }
51 
52  // Default constructor
53  IntType();
54 
55  // Creates a integer datatype using an existing id
56  IntType(const hid_t existing_id);
57 
58  // Copy constructor: makes copy of IntType object
59  IntType(const IntType& original);
60 
61  // Noop destructor.
62  virtual ~IntType();
63 
64 }; // end of IntType
65 } // namespace H5
66 
67 #endif // __H5IntType_H
#define H5_DLLCPP
Definition: H5api_adpt.h:262
Class PredType holds the definition of all the HDF5 predefined datatypes.
Definition: H5PredType.h:28
H5T_sign_t
Definition: H5Tpublic.h:57
IntType is a derivative of a DataType and operates on HDF5 integer datatype.
Definition: H5IntType.h:27
Class DataType provides generic operations on HDF5 datatypes.
Definition: H5DataType.h:28
AtomType is a base class, inherited by IntType, FloatType, StrType, and PredType. ...
Definition: H5AtomType.h:28
H5Location is an abstract base class, providing a collection of wrappers of the C functions that take...
Definition: H5Location.h:42
int sign(double x)
Class DataSet operates on HDF5 datasets.
Definition: H5DataSet.h:28
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: H5IntType.h:50

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