summaryrefslogtreecommitdiffstats
path: root/c++/src/H5AbstractDs.h
blob: eaa9d146e4006b84b2d4d2abd24e1f4162e231fe (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
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
// 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 __AbstractDs_H
#define __AbstractDs_H

namespace H5 {

class ArrayType;
class CompType;
class EnumType;
class FloatType;
class IntType;
class StrType;
class VarLenType;
class DataSpace;

/*! \class AbstractDs
    \brief AbstractDs is an abstract base class, inherited by Attribute
     and DataSet.

    It provides a collection of services that are common to both Attribute
    and DataSet.  AbstractDs inherits from H5Object.
*/
class H5_DLLCPP AbstractDs {
   public:
        // Gets a copy the datatype of that this abstract dataset uses.
        // Note that this datatype is a generic one and can only be accessed
        // via generic member functions, i.e., member functions belong
        // to DataType.  To get specific datatype, i.e. EnumType, FloatType,
        // etc..., use the specific functions, that follow, instead.
        DataType getDataType() const;

        // Gets a copy of the specific datatype of this abstract dataset.
        ArrayType getArrayType() const;
        CompType getCompType() const;
        EnumType getEnumType() const;
        IntType getIntType() const;
        FloatType getFloatType() const;
        StrType getStrType() const;
        VarLenType getVarLenType() const;

        ///\brief Gets the size in memory of this abstract dataset.
        virtual size_t getInMemDataSize() const = 0;

        ///\brief Gets the dataspace of this abstract dataset - pure virtual.
        virtual DataSpace getSpace() const = 0;

        // Gets the class of the datatype that is used by this abstract
        // dataset.
        H5T_class_t getTypeClass() const;

        ///\brief Returns the amount of storage size required - pure virtual.
        virtual hsize_t getStorageSize() const = 0;

        // Returns this class name - pure virtual.
        virtual H5std_string fromClass() const = 0;

        // Destructor
        virtual ~AbstractDs();

   protected:
        // Default constructor
        AbstractDs();

        // *** Deprecation warning ***
        // The following two constructors are no longer appropriate after the
        // data member "id" had been moved to the sub-classes.
        // The copy constructor is a noop and is removed in 1.8.15 and the
        // other will be removed from 1.10 release, and then from 1.8 if its
        // removal does not raise any problems in two 1.10 releases.

        // Mar 2016 -BMR, AbstractDs(const hid_t h5_id);

        // Copy constructor
        // AbstractDs( const AbstractDs& original );

   private:
        // This member function is implemented by DataSet and Attribute - pure virtual.
        virtual hid_t p_get_type() const = 0;
};
}
#endif // __AbstractDs_H