From add8f78ad50db88e8dfd9664099fbc9b50065ca5 Mon Sep 17 00:00:00 2001 From: Frank Baker Date: Wed, 1 May 2002 17:44:03 -0500 Subject: [svn-r5319] Purpose: 1 new function; 3 revised functions; 2 bugfixes; copy edits Solution: H5Tget_member_index: Added this new function. H5Tget_member_name: Revised, based on lessons learned with H5Tget_member_index. H5Tget_nmembers: Revised to indicate that function works for both compound and enumeration datatypes. --> Fixes Bug# 747. Cross-listed H5Tget_nmembers, H5Tget_member_index, and H5Tget_member_name under both compound and enum datatypes, as they work for both. H5Tset_tag: Corrected tag description (it is descriptive, uniqueness is not required). Corrected several spelling errors. --> Partially fixes Bug# 760 (though just for this file *sigh*). Platforms tested: IE 5 --- doc/html/RM_H5T.html | 111 +++++++++++++++++++++++++++++++++++++++------------ 1 file changed, 86 insertions(+), 25 deletions(-) diff --git a/doc/html/RM_H5T.html b/doc/html/RM_H5T.html index 76dfa11..c246f23 100644 --- a/doc/html/RM_H5T.html +++ b/doc/html/RM_H5T.html @@ -112,11 +112,15 @@ of a dataset.
  • H5Tenum_nameof
  • H5Tenum_valueof
  • H5Tget_member_value +
  • H5Tget_nmembers +
  • H5Tget_member_name +
  • H5Tget_member_index        Compound Datatype Properties
  • H5Tget_nmembers
  • H5Tget_member_class
  • H5Tget_member_name +
  • H5Tget_member_index
  • H5Tget_member_offset
  • H5Tget_member_type
  • H5Tinsert @@ -216,6 +220,7 @@ facilitate moving easily between them.
  • h5tget_nmembers_f
  • h5tget_member_name_f +
  • h5tget_member_offset_f
  • h5tget_member_type_f @@ -229,6 +234,9 @@ facilitate moving easily between them.
  • h5tenum_nameof_f
  • h5tenum_valueof_f
  • h5tget_member_value_f +
  • h5tget_nmembers_f +
  • h5tget_member_name_f +

    Opaque Datatypes

  • h5tset_tag_f @@ -559,9 +567,9 @@ H5Tget_overflow () size_tsize )
    Purpose: -
    Creates a new dataype. +
    Creates a new datatype.
    Description: -
    H5Tcreate creates a new dataype of the specified +
    H5Tcreate creates a new datatype of the specified class with the specified number of bytes.

    The following datatype classes are supported with this function: @@ -602,9 +610,9 @@ H5Tget_overflow ()

    hid_t H5Tvlen_create(hid_t base_type_id )
    Purpose: -
    Creates a new variable-length dataype. +
    Creates a new variable-length datatype.
    Description: -
    H5Tvlen_create creates a new variable-length (VL) dataype. +
    H5Tvlen_create creates a new variable-length (VL) datatype.

    The base datatype will be the datatype that the sequence is composed of, characters for character strings, vertex coordinates for polygon lists, etc. @@ -777,7 +785,7 @@ H5Tget_overflow ()

    Description:
    H5Tlock locks the datatype specified by the type_id identifier, making it read-only and - non-destrucible. This is normally done by the library for + non-destructible. This is normally done by the library for predefined datatypes so the application does not inadvertently change or delete a predefined type. Once a datatype is locked it can never be unlocked. @@ -1102,11 +1110,11 @@ H5Tget_overflow ()
    Retrieves the bit offset of the first significant bit.
    Description:
    H5Tget_offset retrieves the bit offset of the first significant bit. - The signficant bits of an atomic datum can be offset from the beginning + The significant bits of an atomic datum can be offset from the beginning of the memory for that datum by an amount of padding. The `offset' property specifies the number of bits of padding that appear to the "right of" the value. That is, if we have a 32-bit datum with 16-bits - of precision having the value 0x1122 then it will be layed out in + of precision having the value 0x1122 then it will be laid out in memory as (from small byte address toward larger byte addresses):

    @@ -1177,11 +1185,11 @@ H5Tget_overflow ()
    Sets the bit offset of the first significant bit.
    Description:
    H5Tset_offset sets the bit offset of the first significant bit. The - signficant bits of an atomic datum can be offset from the beginning of + significant bits of an atomic datum can be offset from the beginning of the memory for that datum by an amount of padding. The `offset' property specifies the number of bits of padding that appear to the "right of" the value. That is, if we have a 32-bit datum with 16-bits - of precision having the value 0x1122 then it will be layed out in + of precision having the value 0x1122 then it will be laid out in memory as (from small byte address toward larger byte addresses):

    @@ -1380,9 +1388,9 @@ zero. H5T_sign_t sign )
    Purpose: -
    Sets the sign proprety for an integer type. +
    Sets the sign property for an integer type.
    Description: -
    H5Tset_sign sets the sign proprety for an integer type. +
    H5Tset_sign sets the sign property for an integer type.