summaryrefslogtreecommitdiffstats
path: root/c++/src/H5IntType.h
blob: ae4b3df39ca15dc2a83984638454ce52a0a419c6 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
// C++ informative line for the emacs editor: -*- C++ -*-
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
 * Copyright by The HDF Group.                                               *
 * Copyright by the Board of Trustees of the University of Illinois.         *
 * All rights reserved.                                                      *
 *                                                                           *
 * This file is part of HDF5.  The full HDF5 copyright notice, including     *
 * terms governing use, modification, and redistribution, is contained in    *
 * the files COPYING and Copyright.html.  COPYING can be found at the root   *
 * of the source code distribution tree; Copyright.html can be found at the  *
 * root level of an installed copy of the electronic HDF5 document set and   *
 * is linked from the top-level documents page.  It can also be found at     *
 * http://hdfgroup.org/HDF5/doc/Copyright.html.  If you do not have          *
 * access to either file, you may request a copy from help@hdfgroup.org.     *
 * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */

#ifndef __H5IntType_H
#define __H5IntType_H

namespace H5 {

/*! \class IntType
    \brief IntType is a derivative of a DataType and operates on HDF5
    integer datatype.

    Inheritance: AtomType -> DataType -> H5Object -> H5Location -> IdComponent
*/
class H5_DLLCPP IntType : public AtomType {
   public:
        // Creates an integer type using a predefined type
        IntType(const PredType& pred_type);

        // Gets the integer datatype of the specified dataset
        IntType(const DataSet& dataset);

        // Constructors that open an HDF5 integer datatype, given a location.
        IntType(const H5Location& loc, const char* name);
        IntType(const H5Location& loc, const H5std_string& name);

        // Retrieves the sign type for an integer type
        H5T_sign_t getSign() const;

        // Sets the sign proprety for an integer type.
        void setSign(H5T_sign_t sign) const;

        ///\brief Returns this class name.
        virtual H5std_string fromClass () const { return("IntType"); }

        // Default constructor
        IntType();

        // Creates a integer datatype using an existing id
        IntType(const hid_t existing_id);

        // Copy constructor: makes copy of IntType object
        IntType(const IntType& original);

        // Noop destructor.
        virtual ~IntType();
};
}
#endif // __H5IntType_H