H5CompType.h

// 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.     *
 * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */

// Class CompType inherits from DataType and provides accesses to a compound
// datatype.

#ifndef _H5CompType_H
#define _H5CompType_H

#ifndef H5_NO_NAMESPACE
namespace H5 {
#endif

class H5_DLLCPP CompType : public DataType {
   public:
        // Creates a new compound datatype, given the type's size
        CompType( size_t size ); // H5Tcreate

        // Gets the compound datatype of the specified dataset
        CompType( const DataSet& dataset );  // H5Dget_type

        // Returns the type class of the specified member of this compound
        // datatype.  It provides to the user a way of knowing what type
        // to create another datatype of the same class
        H5T_class_t getMemberClass( unsigned member_num ) const;

        // Returns the index of a member in this compound data type.
        int getMemberIndex(const char* name) const;
        int getMemberIndex(const H5std_string& name) const;

        // Returns the offset of a member of this compound datatype.
        size_t getMemberOffset( unsigned memb_no ) const;

        // Returns the name of a member of this compound datatype.
        H5std_string getMemberName( unsigned member_num ) const;

        // Returns the generic datatype of the specified member in
        // this compound datatype.
        DataType getMemberDataType( unsigned member_num ) const;

        // Returns the array datatype of the specified member in
        // this compound datatype.
        ArrayType getMemberArrayType( unsigned member_num ) const;

        // Returns the compound datatype of the specified member in
        // this compound datatype.
        CompType getMemberCompType( unsigned member_num ) const;

        // Returns the enumeration datatype of the specified member in
        // this compound datatype.
        EnumType getMemberEnumType( unsigned member_num ) const;

        // Returns the integer datatype of the specified member in
        // this compound datatype.
        IntType getMemberIntType( unsigned member_num ) const;

        // Returns the floating-point datatype of the specified member in
        // this compound datatype.
        FloatType getMemberFloatType( unsigned member_num ) const;

        // Returns the string datatype of the specified member in
        // this compound datatype.
        StrType getMemberStrType( unsigned member_num ) const;

        // Returns the variable length datatype of the specified member in
        // this compound datatype.
        VarLenType getMemberVarLenType( unsigned member_num ) const;

        // Returns the number of members in this compound datatype.
        int getNmembers() const;

        // Adds a new member to this compound datatype.
        void insertMember( const H5std_string& name, size_t offset, const DataType& new_member ) const;

        // Recursively removes padding from within this compound datatype.
        void pack() const;

        virtual H5std_string fromClass () const { return("CompType"); }

        // Default constructor
        CompType();

        // Creates a compound datatype using an existing id
        CompType( const hid_t existing_id );

        // Copy constructor - makes a copy of original object
        CompType( const CompType& original );

        // Noop destructor.
        virtual ~CompType();

   private:
        // Contains common code that is used by the member functions
        // getMemberXxxType
        hid_t p_get_member_type(unsigned member_num) const;
};
#ifndef H5_NO_NAMESPACE
}
#endif
#endif