Page tree

The license could not be verified: License Certificate has expired!

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Content Layer
id1195548671
Content Column
width50.00001%
id1195578110
classrm_pagetree_col mobile-hide
Content Block
id1195578111
 
Content Column
width50.00001%
id1195548673
classhdf-rm-main-column
Content Block
id1195548672

Include Content
render-without-blockstrue
page.rm-navbar
HTML Wrap
classhdf-print-only

Page Title

HTML Wrap
classhdf-rm-summary-block

Hdf rm anchor
AnchorNamesummary

Excerpt

Returns the property list class identifier for a property list

HTML Wrap
classhdf-rm-content-block

Hdf rm anchor
AnchorNameprocedure

Procedure:
HTML Wrap
classhdf-rm-section
HTML Wrap
classhdf_procedure

H5P_GET_CLASS ( plist )

Hdf rm anchor
AnchorNamesignature

Signature:
HTML Wrap
classhdf-rm-section
HTML Wrap
classhdf-togglebox hdf-c

HTML Add Class
hdf-togglebutton-visible
hdf-togglebutton-visible
selector.hdf-togglebutton.hdf-c

HTML
<pre><code class="language-c">hid_t H5Pget_class ( hid_t plist )</code></pre>
HTML Wrap
classhdf-togglebox hdf-fortran hdf-togglebox-hidden

HTML Add Class
hdf-togglebutton-visible
hdf-togglebutton-visible
selector.hdf-togglebutton.hdf-fortran

HTML
<pre><code class="language-fortran">Fortran90 Interface: h5pget_class_f
    
SUBROUTINE h5pget_class_f(prp_id, classtype, hdferr) 
  IMPLICIT NONE
  INTEGER(HID_T), INTENT(IN) :: prp_id ! Property list identifier 
  INTEGER, INTENT(OUT) :: classtype    ! The type of the property list 
                                       ! to be created 
  INTEGER, INTENT(OUT) :: hdferr       ! Error code
                                       ! 0 on success and -1 on failure
END SUBROUTINE h5pget_class_f
    </code></pre>

Hdf rm anchor
AnchorNameparameters

Parameters:
HTML Wrap
classhdf-rm-section

hid_t plist     IN: Identifier of property list to query

Hdf rm anchor
AnchorNamedescription

Description:
HTML Wrap
classhdf-rm-section

H5P_GET_CLASS returns the property list class identifier for the property list identified by the plist parameter.

Note that H5P_GET_CLASS returns a value of hid_t type, an internal HDF5 identifier, rather than directly returning a property list class. That identifier can then be used with either H5P_EQUAL or H5P_GET_CLASS_NAME to determine which predefined HDF5 property list class H5P_GET_CLASS has returned.

A full list of valid predefined property list classes appears in the description of H5P_CREATE.

Determining the HDF5 property list class name with H5P_EQUALrequires EQUAL requires a series of H5P_EQUAL calls in an if-else sequence. An iterative sequence of H5P_EQUALcalls EQUAL calls can compare the identifier returned by H5P_GET_CLASS to members of the list of valid property list class names. A pseudo-code snippet might read as follows:

    plist_class_id = H5Pget_class (dsetA_plist);

    if H5Pequal (plist_class_id, H5P_OBJECT_CREATE) = TRUE;        
            [ H5P_OBJECT_CREATE is the property list class    ]
            [ returned by H5Pget_class.                        ]

        else if H5Pequal (plist_class_id, H5P_DATASET_CREATE) = TRUE;
            [ H5P_DATASET_CREATE is the property list class.  ]

        else if H5Pequal (plist_class_id, H5P_DATASET_XFER) = TRUE;
            [ H5P_DATASET_XFER is the property list class.    ]

        .
        .   [ Continuing the iteration until a match is found. ]
        .  

H5P_GET_CLASS_NAME returns the property list class name directly as a string:

    plist_class_id = H5Pget_class (dsetA_plist);
    plist_class_name = H5Pget_class_name (plist_class_id) 
        

Note that frequent use of H5P_GET_CLASS_NAME can become a performance problem in a high-performance environment. The H5P_EQUAL approach is generally much faster.

 

Hdf rm anchor
AnchorNamereturns

Returns:
HTML Wrap
classhdf-rm-section

Returns a property list class identifier if successful. Otherwise returns a negative value.

Hdf rm anchor
AnchorNameexample

Example:
HTML Wrap
classhdf-rm-section

Coming Soon!

Comment (Hide)
HTML Wrap
classhdf-togglebox hdf-c

Bitbucket Server file
repoSlughdf5
branchIdrefs/heads/1.10/master
projectKeyHDFFV
filepathexamples/h5_subset.c
showLineNumberstrue
lineStart32
progLangcpp
lineEnd42
applicationLink5ac7b370-7412-3c8c-ad20-807a68261336

HTML Wrap
classhdf-togglebox hdf-fortran hdf-togglebox-hidden

Bitbucket Server file
repoSlughdf5
branchIdrefs/heads/1.10/master
projectKeyHDFFV
filepathfortran/examples/compound.f90
showLineNumberstrue
lineStart25
progLangplain
lineEnd35
applicationLink5ac7b370-7412-3c8c-ad20-807a68261336

Hdf rm anchor
AnchorNamehistory

History:
HTML Wrap
classhdf-rm-section
Release    Change
1.8.15Updated the Fortran subroutine.
1.6.0Return type changed in this release.