// 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 __H5AtomType_H
#define __H5AtomType_H

namespace H5 {

/*! \class AtomType
    \brief AtomType is a base class, inherited by IntType, FloatType,
     StrType, and PredType.

    AtomType provides operations on HDF5 atomic datatypes.  It also inherits
    from DataType.
*/
// Inheritance: DataType -> H5Object -> H5Location -> IdComponent
class H5_DLLCPP AtomType : public DataType {
   public:
        // Returns the byte order of an atomic datatype.
        H5T_order_t getOrder() const;
        H5T_order_t getOrder(H5std_string& order_string) const;

        // Sets the byte ordering of an atomic datatype.
        void setOrder(H5T_order_t order) const;

        // Retrieves the bit offset of the first significant bit.
        // 12/05/00 - changed return type to int from size_t - C API
        int getOffset() const;

        // Sets the bit offset of the first significant bit.
        void setOffset(size_t offset) const;

        // Retrieves the padding type of the least and most-significant bit padding.
        void getPad(H5T_pad_t& lsb, H5T_pad_t& msb) const;

        // Sets the least and most-significant bits padding types
        void setPad(H5T_pad_t lsb, H5T_pad_t msb) const;

        // Returns the precision of an atomic datatype.
        size_t getPrecision() const;

        // Sets the precision of an atomic datatype.
        void setPrecision(size_t precision) const;

        // Sets the total size for an atomic datatype.
        void setSize(size_t size) const;

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

#ifndef DOXYGEN_SHOULD_SKIP_THIS
        // Copy constructor: same as the original AtomType.
        AtomType(const AtomType& original);

        // Noop destructor
        virtual ~AtomType();
#endif // DOXYGEN_SHOULD_SKIP_THIS

   protected:
#ifndef DOXYGEN_SHOULD_SKIP_THIS
        // Default constructor
        AtomType();

        // Constructor that takes an existing id
        AtomType(const hid_t existing_id);
#endif // DOXYGEN_SHOULD_SKIP_THIS

}; // end of AtomType
} // namespace H5

#endif // __H5AtomType_H