H5AbstractDs.h

Go to the documentation of this file.

// 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 COPYING file, which can be found at the root of the source code       *
 * distribution tree, or in https://support.hdfgroup.org/ftp/HDF5/releases.  *
 * 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 DataType;
class ArrayType;
class IntType;
class FloatType;
class StrType;
class CompType;
class EnumType;
class VarLenType;
class DataSpace;

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;

        virtual size_t getInMemDataSize() const = 0;

        virtual DataSpace getSpace() const = 0;

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

        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;

}; // end of AbstractDs
} // namespace H5

#endif // __AbstractDs_H