From d750905055feff3c91646dbc265419884024e221 Mon Sep 17 00:00:00 2001 From: Frank Baker Date: Tue, 6 May 2003 17:24:54 -0500 Subject: [svn-r6816] Purpose: New features. Description: Added 3 new functions: H5Tis_variable_str H5Tdetect_class H5Tget_native_type Platforms tested: Safari, IE 5 --- doc/html/RM_H5T.html | 153 +++++++++++++++++++++++++++++++++++++++++++++++---- 1 file changed, 141 insertions(+), 12 deletions(-) diff --git a/doc/html/RM_H5T.html b/doc/html/RM_H5T.html index f769561..5118863 100644 --- a/doc/html/RM_H5T.html +++ b/doc/html/RM_H5T.html @@ -68,6 +68,8 @@ of a dataset.
  • H5Tget_class
  • H5Tget_size
  • H5Tget_super +
  • H5Tget_native_type +
  • H5Tdetect_class
  • H5Tclose

    Conversion Functions @@ -169,6 +171,8 @@ facilitate moving easily between them.

  • h5tget_class_f
  • h5tget_size_f
  • h5tget_super_f + +
  • h5tclose_f @@ -650,15 +654,25 @@ H5Tget_overflow () - - - - -
    Name: H5Tis_variable_str - +
    Signature: +
    htri_t H5Tis_variable_str(hid_t dtype_id + ) +
    Purpose: +
    Determines whether datatype is a variable-length string. +
    Description: +
    H5Tvlen_create determines whether the datatype + identified in dtype_id is a variable-length string. +
    Parameters: +
    +
    hid_t dtype_id +
    Datatype identifier. +
    +
    Returns: +
    Returns TRUE or FALSE if successful; + otherwise returns a negative value.
    Non-C API(s):
    @@ -669,11 +683,6 @@ H5Tget_overflow ()
    - - - - -
    Name: H5Tcopy @@ -880,6 +889,42 @@ H5Tget_overflow ()
    +
    Name: H5Tdetect_class +
    Signature: +
    htri_t H5Tdetect_class(hid_t dtype_id, + H5T_class_tdtype_class + ) +
    Purpose: +
    Determines whether a datatype is of the given datatype class. +
    Description: +
    H5Tdetect_class determines whether the datatype + specified in dtype_id is of the + datatype class specified in dtype_class. +

    + Valid class identifiers are as defined in + H5Tget_class. +

    Parameters: +
    +
    hid_t dtype_id +
    Datatype identifier. +
    H5T_class_tdtype_class +
    Datatype class. +
    +
    Returns: +
    Returns TRUE or FALSE if successful; + otherwise returns a negative value. + +
    + + +
    +
    Name: H5Tget_size
    Signature:
    size_t H5Tget_size(hid_t type_id @@ -979,6 +1024,90 @@ H5Tget_overflow ()
    +
    Name: H5Tget_native_type +
    Signature: +
    hid_t H5Tget_native_type(hid_t type_id, + H5T_direction_t direction + ) +
    Purpose: +
    Returns the native datatype of a specified datatype. +
    Description: +
    H5Tget_native_type returns the equivalent native datatype + for the dataset datatype specified in type_id. +

    + H5Tget_native_type is a high-level function designed + primarily to facilitate use of the H5Dread function, + for which users otherwise must undertake a multi-step process to + determine the native datatype of a dataset prior to reading it + into memory. + It can be used not only to determine + the native datatype for atomic datatypes, + but also to determine the native datatypes of the individual components of + a compound datatype, an enumerated datatype, an array datatype, or + a variable-length datatype. +

    + H5Tget_native_type selects the matching native datatype + from the following list: + 

            H5T_NATIVE_CHAR         
+        H5T_NATIVE_SHORT        
+        H5T_NATIVE_INT          
+        H5T_NATIVE_LONG         
+        H5T_NATIVE_LLONG        
+
+        H5T_NATIVE_UCHAR
+        H5T_NATIVE_USHORT
+        H5T_NATIVE_UINT
+        H5T_NATIVE_ULONG
+        H5T_NATIVE_ULLONG
+
+        H5T_NATIVE_FLOAT
+        H5T_NATIVE_DOUBLE
+        H5T_NATIVE_LDOUBLE
    +

    + The direction parameter indicates the order + in which the library searches for a native datatype match. + Valid values for direction are as follows: + + + +
         + H5T_DIR_ASCEND + Searches the above list in ascending size of the datatype,
    + i.e., from top to bottom. (Default) +
      + H5T_DIR_DESCEND   + Searches the above list in descending size of the datatype,
    + i.e., from bottom to top. +
    +

    + H5Tget_native_type is designed primarily for + use with intenger and floating point datatypes. + Time, bifield, opaque, and reference datatypes are returned + as a copy of type_id. +

    Parameters: +
    +
    hid_t type_id +
    Datatype identifier for the dataset datatype. +
    H5T_direction_t direction +
    Direction of search. +
    +
    Returns: +
    Returns the native datatype identifier for the + specified dataset datatype if successful; + otherwise returns a negative value. + +
    + + +
    +
    Name: H5Tget_order
    Signature:
    H5T_order_t H5Tget_order(hid_t type_id @@ -2816,7 +2945,7 @@ And in this document, the Describes HDF5 Release 1.5, Unreleased Development Branch -Last modified: 7 April 2003 +Last modified: 1 May 2003 -- cgit v0.12