87 lines
3.2 KiB
C++
87 lines
3.2 KiB
C++
// C++ informative line for the emacs editor: -*- C++ -*-
|
|
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
|
|
* Copyright by The HDF Group. *
|
|
* 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://www.hdfgroup.org/licenses. *
|
|
* If you do not have access to either file, you may request a copy from *
|
|
* help@hdfgroup.org. *
|
|
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
|
|
|
|
#ifndef H5FloatType_H
|
|
#define H5FloatType_H
|
|
|
|
namespace H5 {
|
|
|
|
/*! \class FloatType
|
|
\brief FloatType is a derivative of a DataType and operates on HDF5
|
|
floating point datatype.
|
|
*/
|
|
// Inheritance: AtomType -> DataType -> H5Object -> H5Location -> IdComponent
|
|
class H5_DLLCPP FloatType : public AtomType {
|
|
public:
|
|
// Creates a floating-point type using a predefined type.
|
|
FloatType(const PredType &pred_type);
|
|
|
|
// Gets the floating-point datatype of the specified dataset.
|
|
FloatType(const DataSet &dataset);
|
|
|
|
// Constructors that open an HDF5 float datatype, given a location.
|
|
FloatType(const H5Location &loc, const char *name);
|
|
FloatType(const H5Location &loc, const H5std_string &name);
|
|
|
|
// Returns an FloatType object via DataType* by decoding the
|
|
// binary object description of this type.
|
|
virtual DataType *decode() const override;
|
|
|
|
// Retrieves the exponent bias of a floating-point type.
|
|
size_t getEbias() const;
|
|
|
|
// Sets the exponent bias of a floating-point type.
|
|
void setEbias(size_t ebias) const;
|
|
|
|
// Retrieves floating point datatype bit field information.
|
|
void getFields(size_t &spos, size_t &epos, size_t &esize, size_t &mpos, size_t &msize) const;
|
|
|
|
// Sets locations and sizes of floating point bit fields.
|
|
void setFields(size_t spos, size_t epos, size_t esize, size_t mpos, size_t msize) const;
|
|
|
|
// Retrieves the internal padding type for unused bits in floating-point datatypes.
|
|
H5T_pad_t getInpad(H5std_string &pad_string) const;
|
|
|
|
// Fills unused internal floating point bits.
|
|
void setInpad(H5T_pad_t inpad) const;
|
|
|
|
// Retrieves mantissa normalization of a floating-point datatype.
|
|
H5T_norm_t getNorm(H5std_string &norm_string) const;
|
|
|
|
// Sets the mantissa normalization of a floating-point datatype.
|
|
void setNorm(H5T_norm_t norm) const;
|
|
|
|
///\brief Returns this class name.
|
|
virtual H5std_string
|
|
fromClass() const override
|
|
{
|
|
return ("FloatType");
|
|
}
|
|
|
|
// Default constructor
|
|
FloatType();
|
|
|
|
// Creates a floating-point datatype using an existing id.
|
|
FloatType(const hid_t existing_id);
|
|
|
|
// Copy constructor: same as the original FloatType.
|
|
FloatType(const FloatType &original);
|
|
|
|
// Noop destructor.
|
|
virtual ~FloatType() override = default;
|
|
|
|
}; // end of FloatType
|
|
} // namespace H5
|
|
|
|
#endif // H5FloatType_H
|