Package org.bytedeco.hdf5.global
Class hdf5
- java.lang.Object
-
- org.bytedeco.hdf5.presets.hdf5
-
- org.bytedeco.hdf5.global.hdf5
-
- All Implemented Interfaces:
InfoMapper
public class hdf5 extends hdf5
-
-
Field Summary
Fields Modifier and Type Field Description static StringDIMENSION_LABELSstatic StringDIMENSION_LISTstatic StringDIMENSION_SCALE_CLASSstatic StringH5_DEFAULT_PLUGINDIRstatic intH5_DEV_T_IS_SCALARstatic StringH5_EXAMPLESDIRstatic intH5_HAVE_ALARMstatic intH5_HAVE_ARPA_INET_Hstatic intH5_HAVE_ASPRINTFstatic intH5_HAVE_ATTRIBUTEstatic intH5_HAVE_CLOCK_GETTIMEstatic intH5_HAVE_DIRENT_Hstatic intH5_HAVE_DLFCN_Hstatic intH5_HAVE_EMBEDDED_LIBINFOstatic intH5_HAVE_FCNTLstatic intH5_HAVE_FEATURES_Hstatic intH5_HAVE_FILTER_DEFLATEstatic intH5_HAVE_FLOCKstatic intH5_HAVE_FORKstatic intH5_HAVE_GETHOSTNAMEstatic intH5_HAVE_GETPWUIDstatic intH5_HAVE_GETRUSAGEstatic intH5_HAVE_GETTIMEOFDAYstatic intH5_HAVE_INTTYPES_Hstatic intH5_HAVE_IOCTLstatic intH5_HAVE_LIBDLstatic intH5_HAVE_LIBMstatic intH5_HAVE_LIBZstatic intH5_HAVE_LSTATstatic intH5_HAVE_MEMORY_Hstatic intH5_HAVE_NETDB_Hstatic intH5_HAVE_NETINET_IN_Hstatic intH5_HAVE_PREADWRITEstatic intH5_HAVE_PWD_Hstatic intH5_HAVE_RAND_Rstatic intH5_HAVE_RANDOMstatic intH5_HAVE_SIGLONGJMPstatic intH5_HAVE_SIGPROCMASKstatic intH5_HAVE_SRANDOMstatic intH5_HAVE_STAT_ST_BLOCKSstatic intH5_HAVE_STDINT_Hstatic intH5_HAVE_STDLIB_Hstatic intH5_HAVE_STRCASESTRstatic intH5_HAVE_STRDUPstatic intH5_HAVE_STRING_Hstatic intH5_HAVE_STRINGS_Hstatic intH5_HAVE_SYMLINKstatic intH5_HAVE_SYS_FILE_Hstatic intH5_HAVE_SYS_IOCTL_Hstatic intH5_HAVE_SYS_RESOURCE_Hstatic intH5_HAVE_SYS_SOCKET_Hstatic intH5_HAVE_SYS_STAT_Hstatic intH5_HAVE_SYS_TIME_Hstatic intH5_HAVE_SYS_TYPES_Hstatic intH5_HAVE_TIMEZONEstatic intH5_HAVE_TIOCGETDstatic intH5_HAVE_TIOCGWINSZstatic intH5_HAVE_TM_GMTOFFstatic intH5_HAVE_TMPFILEstatic intH5_HAVE_UNISTD_Hstatic intH5_HAVE_VASPRINTFstatic intH5_HAVE_WAITPIDstatic intH5_HAVE_ZLIB_Hstatic intH5_IGNORE_DISABLED_FILE_LOCKSstatic intH5_INCLUDE_HLstatic intH5_INDEX_CRT_ORDERenum H5_index_tstatic intH5_INDEX_Nenum H5_index_tstatic intH5_INDEX_NAMEenum H5_index_tstatic intH5_INDEX_UNKNOWNenum H5_index_tstatic intH5_ITER_CONTContinue iterationstatic intH5_ITER_DECenum H5_iter_order_tstatic intH5_ITER_ERRORError, stop iterationstatic intH5_ITER_INCenum H5_iter_order_tstatic intH5_ITER_Nenum H5_iter_order_tstatic intH5_ITER_NATIVEenum H5_iter_order_tstatic intH5_ITER_STOPStop iteration, short-circuit successstatic intH5_ITER_UNKNOWNenum H5_iter_order_tstatic intH5_LDOUBLE_TO_LLONG_ACCURATEstatic intH5_LLONG_TO_LDOUBLE_CORRECTstatic StringH5_LT_OBJDIRstatic StringH5_PACKAGEstatic StringH5_PACKAGE_BUGREPORTstatic StringH5_PACKAGE_NAMEstatic StringH5_PACKAGE_STRINGstatic StringH5_PACKAGE_TARNAMEstatic StringH5_PACKAGE_URLstatic StringH5_PACKAGE_VERSIONstatic intH5_SIZEOF_BOOLstatic intH5_SIZEOF_CHARstatic intH5_SIZEOF_DOUBLEstatic intH5_SIZEOF_FLOATstatic intH5_SIZEOF_HADDR_TThe address of an object in the file.static intH5_SIZEOF_HID_TThe size of identifiersstatic intH5_SIZEOF_HSIZE_TThe size of file objects.static intH5_SIZEOF_HSSIZE_Tstatic intH5_SIZEOF_INTstatic intH5_SIZEOF_INT_FAST16_Tstatic intH5_SIZEOF_INT_FAST32_Tstatic intH5_SIZEOF_INT_FAST64_Tstatic intH5_SIZEOF_INT_FAST8_Tstatic intH5_SIZEOF_INT_LEAST16_Tstatic intH5_SIZEOF_INT_LEAST32_Tstatic intH5_SIZEOF_INT_LEAST64_Tstatic intH5_SIZEOF_INT_LEAST8_Tstatic intH5_SIZEOF_INT16_Tstatic intH5_SIZEOF_INT32_Tstatic intH5_SIZEOF_INT64_Tstatic intH5_SIZEOF_INT8_Tstatic intH5_SIZEOF_LONGstatic intH5_SIZEOF_LONG_DOUBLEstatic intH5_SIZEOF_LONG_LONGstatic intH5_SIZEOF_OFF_Tstatic intH5_SIZEOF_PTRDIFF_Tstatic intH5_SIZEOF_SHORTstatic intH5_SIZEOF_SIZE_Tstatic intH5_SIZEOF_SSIZE_Tstatic intH5_SIZEOF_TIME_Tstatic intH5_SIZEOF_UINT_FAST16_Tstatic intH5_SIZEOF_UINT_FAST32_Tstatic intH5_SIZEOF_UINT_FAST64_Tstatic intH5_SIZEOF_UINT_FAST8_Tstatic intH5_SIZEOF_UINT_LEAST16_Tstatic intH5_SIZEOF_UINT_LEAST32_Tstatic intH5_SIZEOF_UINT_LEAST64_Tstatic intH5_SIZEOF_UINT_LEAST8_Tstatic intH5_SIZEOF_UINT16_Tstatic intH5_SIZEOF_UINT32_Tstatic intH5_SIZEOF_UINT64_Tstatic intH5_SIZEOF_UINT8_Tstatic intH5_SIZEOF_UNSIGNEDstatic intH5_STDC_HEADERSstatic intH5_SZIP_ALLOW_K13_OPTION_MASK\ingroup SZIPstatic intH5_SZIP_CHIP_OPTION_MASK\ingroup SZIPstatic intH5_SZIP_EC_OPTION_MASK\ingroup SZIPstatic intH5_SZIP_MAX_PIXELS_PER_BLOCK\ingroup SZIPstatic intH5_SZIP_NN_OPTION_MASK\ingroup SZIPstatic intH5_TEST_EXPRESS_LEVEL_DEFAULTstatic intH5_USE_114_API_DEFAULTstatic intH5_USE_FILE_LOCKINGstatic StringH5_VERS_INFOFull version stringstatic intH5_VERS_MAJORFor major interface/format changesstatic intH5_VERS_MINORFor minor interface/format changesstatic intH5_VERS_RELEASEFor tweaks, bug-fixes, or developmentstatic StringH5_VERS_SUBRELEASEFor pre-releases like \c snap0.static StringH5_VERSIONstatic intH5_VFD_COREstatic intH5_VFD_DIRECTstatic intH5_VFD_FAMILYstatic intH5_VFD_HDFSstatic intH5_VFD_INVALIDstatic intH5_VFD_IOCstatic intH5_VFD_LOGstatic intH5_VFD_MAXstatic intH5_VFD_MIRRORstatic intH5_VFD_MPIOstatic intH5_VFD_MULTIstatic intH5_VFD_ONIONstatic intH5_VFD_RESERVEDstatic intH5_VFD_ROS3static intH5_VFD_SEC2static intH5_VFD_SPLITTERstatic intH5_VFD_STDIOstatic intH5_VFD_SUBFILINGstatic intH5_WANT_DATA_ACCURACYstatic intH5_WANT_DCONV_EXCEPTIONstatic intH5AC__CACHE_IMAGE__ENTRY_AGEOUT__MAXstatic intH5AC__CACHE_IMAGE__ENTRY_AGEOUT__NONEstatic intH5AC__CURR_CACHE_CONFIG_VERSIONstructure H5AC_cache_config_t H5AC_cache_config_t is a public structure intended for use in public APIs.static intH5AC__CURR_CACHE_IMAGE_CONFIG_VERSIONstatic intH5AC__MAX_TRACE_FILE_NAME_LENstatic intH5AC_METADATA_WRITE_STRATEGY__DISTRIBUTEDstatic intH5AC_METADATA_WRITE_STRATEGY__PROCESS_0_ONLYstatic intH5C_decr__age_outenum H5C_cache_decr_modestatic intH5C_decr__age_out_with_thresholdenum H5C_cache_decr_modestatic intH5C_decr__offenum H5C_cache_decr_modestatic intH5C_decr__thresholdenum H5C_cache_decr_modestatic intH5C_flash_incr__add_spaceenum H5C_cache_flash_incr_modestatic intH5C_flash_incr__offenum H5C_cache_flash_incr_modestatic intH5C_incr__offenum H5C_cache_incr_modestatic intH5C_incr__thresholdenum H5C_cache_incr_modestatic intH5D_ALLOC_TIME_DEFAULTenum H5D_alloc_time_tstatic intH5D_ALLOC_TIME_EARLYenum H5D_alloc_time_tstatic intH5D_ALLOC_TIME_ERRORenum H5D_alloc_time_tstatic intH5D_ALLOC_TIME_INCRenum H5D_alloc_time_tstatic intH5D_ALLOC_TIME_LATEenum H5D_alloc_time_tstatic intH5D_CHUNK_CACHE_NBYTES_DEFAULTstatic intH5D_CHUNK_CACHE_NSLOTS_DEFAULTstatic doubleH5D_CHUNK_CACHE_W0_DEFAULTstatic intH5D_CHUNK_DONT_FILTER_PARTIAL_CHUNKSBit flags for the H5Pset_chunk_opts() and H5Pget_chunk_opts()static intH5D_CHUNK_IDX_BT2enum H5D_chunk_index_tstatic intH5D_CHUNK_IDX_BTREEenum H5D_chunk_index_tstatic intH5D_CHUNK_IDX_EARRAYenum H5D_chunk_index_tstatic intH5D_CHUNK_IDX_FARRAYenum H5D_chunk_index_tstatic intH5D_CHUNK_IDX_NONEenum H5D_chunk_index_tstatic intH5D_CHUNK_IDX_NTYPESenum H5D_chunk_index_tstatic intH5D_CHUNK_IDX_SINGLEenum H5D_chunk_index_tstatic intH5D_CHUNKEDenum H5D_layout_tstatic intH5D_COMPACTenum H5D_layout_tstatic intH5D_CONTIGUOUSenum H5D_layout_tstatic intH5D_FILL_TIME_ALLOCenum H5D_fill_time_tstatic intH5D_FILL_TIME_ERRORenum H5D_fill_time_tstatic intH5D_FILL_TIME_IFSETenum H5D_fill_time_tstatic intH5D_FILL_TIME_NEVERenum H5D_fill_time_tstatic intH5D_FILL_VALUE_DEFAULTenum H5D_fill_value_tstatic intH5D_FILL_VALUE_ERRORenum H5D_fill_value_tstatic intH5D_FILL_VALUE_UNDEFINEDenum H5D_fill_value_tstatic intH5D_FILL_VALUE_USER_DEFINEDenum H5D_fill_value_tstatic intH5D_LAYOUT_ERRORenum H5D_layout_tstatic intH5D_MPIO_CHUNK_COLLECTIVEenum H5D_mpio_actual_io_mode_tstatic intH5D_MPIO_CHUNK_INDEPENDENTenum H5D_mpio_actual_io_mode_tstatic intH5D_MPIO_CHUNK_MIXEDenum H5D_mpio_actual_io_mode_tstatic intH5D_MPIO_COLLECTIVEenum H5D_mpio_no_collective_cause_tstatic intH5D_MPIO_CONTIGUOUS_COLLECTIVEenum H5D_mpio_actual_io_mode_tstatic intH5D_MPIO_DATA_TRANSFORMSenum H5D_mpio_no_collective_cause_tstatic intH5D_MPIO_DATATYPE_CONVERSIONenum H5D_mpio_no_collective_cause_tstatic intH5D_MPIO_ERROR_WHILE_CHECKING_COLLECTIVE_POSSIBLEenum H5D_mpio_no_collective_cause_tstatic intH5D_MPIO_LINK_CHUNKenum H5D_mpio_actual_chunk_opt_mode_tstatic intH5D_MPIO_MPI_OPT_TYPES_ENV_VAR_DISABLEDenum H5D_mpio_no_collective_cause_tstatic intH5D_MPIO_MULTI_CHUNKenum H5D_mpio_actual_chunk_opt_mode_tstatic intH5D_MPIO_NO_CHUNK_OPTIMIZATIONenum H5D_mpio_actual_chunk_opt_mode_tstatic intH5D_MPIO_NO_COLLECTIVEenum H5D_mpio_actual_io_mode_tstatic intH5D_MPIO_NO_COLLECTIVE_MAX_CAUSEenum H5D_mpio_no_collective_cause_tstatic intH5D_MPIO_NOT_CONTIGUOUS_OR_CHUNKED_DATASETenum H5D_mpio_no_collective_cause_tstatic intH5D_MPIO_NOT_SIMPLE_OR_SCALAR_DATASPACESenum H5D_mpio_no_collective_cause_tstatic intH5D_MPIO_PARALLEL_FILTERED_WRITES_DISABLEDenum H5D_mpio_no_collective_cause_tstatic intH5D_MPIO_SET_INDEPENDENTenum H5D_mpio_no_collective_cause_tstatic intH5D_MULTI_CHUNK_IO_COL_THRESHOLDMacros for multi-chunk collective IO case.static intH5D_NLAYOUTSenum H5D_layout_tstatic intH5D_ONE_LINK_CHUNK_IO_THRESHOLDMacros for One linked collective IO case.static intH5D_SPACE_STATUS_ALLOCATEDenum H5D_space_status_tstatic intH5D_SPACE_STATUS_ERRORenum H5D_space_status_tstatic intH5D_SPACE_STATUS_NOT_ALLOCATEDenum H5D_space_status_tstatic intH5D_SPACE_STATUS_PART_ALLOCATEDenum H5D_space_status_tstatic intH5D_VDS_ERRORenum H5D_vds_view_tstatic intH5D_VDS_FIRST_MISSINGenum H5D_vds_view_tstatic intH5D_VDS_LAST_AVAILABLEenum H5D_vds_view_tstatic intH5D_VIRTUALenum H5D_layout_tstatic intH5E_DEFAULTstatic intH5E_MAJORenum H5E_type_tstatic intH5E_MINORenum H5E_type_tstatic intH5E_WALK_DOWNWARDenum H5E_direction_tstatic intH5E_WALK_UPWARDenum H5E_direction_tstatic intH5F_ACC_CREATstatic intH5F_ACC_DEFAULTstatic intH5F_ACC_EXCLstatic intH5F_ACC_RDONLYstatic intH5F_ACC_RDWRstatic intH5F_ACC_SWMR_READstatic intH5F_ACC_SWMR_WRITEstatic intH5F_ACC_TRUNCstatic intH5F_CLOSE_DEFAULTenum H5F_close_degree_tstatic intH5F_CLOSE_SEMIenum H5F_close_degree_tstatic intH5F_CLOSE_STRONGenum H5F_close_degree_tstatic intH5F_CLOSE_WEAKenum H5F_close_degree_tstatic intH5F_FAMILY_DEFAULTstatic intH5F_FILE_SPACE_AGGR_VFDDeprecated.static intH5F_FILE_SPACE_ALLDeprecated.static intH5F_FILE_SPACE_ALL_PERSISTDeprecated.static intH5F_FILE_SPACE_DEFAULTDeprecated.static intH5F_FILE_SPACE_NTYPESDeprecated.static intH5F_FILE_SPACE_VFDDeprecated.static intH5F_FSPACE_STRATEGY_AGGRenum H5F_fspace_strategy_tstatic intH5F_FSPACE_STRATEGY_FSM_AGGRenum H5F_fspace_strategy_tstatic intH5F_FSPACE_STRATEGY_NONEenum H5F_fspace_strategy_tstatic intH5F_FSPACE_STRATEGY_NTYPESenum H5F_fspace_strategy_tstatic intH5F_FSPACE_STRATEGY_PAGEenum H5F_fspace_strategy_tstatic intH5F_LIBVER_EARLIESTenum H5F_libver_tstatic intH5F_LIBVER_ERRORenum H5F_libver_tstatic intH5F_LIBVER_LATESTstatic intH5F_LIBVER_NBOUNDSenum H5F_libver_tstatic intH5F_LIBVER_V110enum H5F_libver_tstatic intH5F_LIBVER_V112enum H5F_libver_tstatic intH5F_LIBVER_V114enum H5F_libver_tstatic intH5F_LIBVER_V18enum H5F_libver_tstatic intH5F_NUM_METADATA_READ_RETRY_TYPESstatic intH5F_OBJ_ALLstatic intH5F_OBJ_ATTRAttribute objectsstatic intH5F_OBJ_DATASETDataset objectsstatic intH5F_OBJ_DATATYPENamed datatype objectsstatic intH5F_OBJ_FILEFile objectsstatic intH5F_OBJ_GROUPGroup objectsstatic intH5F_OBJ_LOCALRestrict search to objects opened through current file ID \ (as opposed to objects opened through any file ID accessing this file)static intH5F_SCOPE_GLOBALenum H5F_scope_tstatic intH5F_SCOPE_LOCALenum H5F_scope_tstatic intH5F_UNLIMITEDstatic intH5FD_CLASS_VERSIONstatic intH5FD_COREstatic intH5FD_CORE_VALUEstatic intH5FD_CTL_FAIL_IF_UNKNOWN_FLAGstatic intH5FD_CTL_GET_MPI_COMMUNICATOR_OPCODEstatic intH5FD_CTL_GET_MPI_FILE_SYNC_OPCODEstatic intH5FD_CTL_GET_MPI_RANK_OPCODEstatic intH5FD_CTL_GET_MPI_SIZE_OPCODEstatic intH5FD_CTL_INVALID_OPCODEstatic intH5FD_CTL_MEM_ALLOCstatic intH5FD_CTL_MEM_COPYstatic intH5FD_CTL_MEM_FREEstatic intH5FD_CTL_OPC_EXPER_MAXstatic intH5FD_CTL_OPC_EXPER_MINstatic intH5FD_CTL_OPC_RESERVEDstatic intH5FD_CTL_ROUTE_TO_TERMINAL_VFD_FLAGstatic intH5FD_CTL_TEST_OPCODEstatic intH5FD_DIRECTstatic intH5FD_DIRECT_VALUEstatic intH5FD_FAMILYstatic intH5FD_FAMILY_VALUEstatic intH5FD_FEAT_ACCUMULATE_METADATAstatic intH5FD_FEAT_ACCUMULATE_METADATA_READstatic intH5FD_FEAT_ACCUMULATE_METADATA_WRITEstatic intH5FD_FEAT_AGGREGATE_METADATAstatic intH5FD_FEAT_AGGREGATE_SMALLDATAstatic intH5FD_FEAT_ALLOCATE_EARLYstatic intH5FD_FEAT_ALLOW_FILE_IMAGEstatic intH5FD_FEAT_CAN_USE_FILE_IMAGE_CALLBACKSstatic intH5FD_FEAT_DATA_SIEVEstatic intH5FD_FEAT_DEFAULT_VFD_COMPATIBLEstatic intH5FD_FEAT_DIRTY_DRVRINFO_LOADstatic intH5FD_FEAT_HAS_MPIstatic intH5FD_FEAT_IGNORE_DRVRINFOstatic intH5FD_FEAT_MEMMANAGEstatic intH5FD_FEAT_PAGED_AGGRstatic intH5FD_FEAT_POSIX_COMPAT_HANDLEstatic intH5FD_FEAT_SUPPORTS_SWMR_IOstatic intH5FD_FEAT_USE_ALLOC_SIZEstatic intH5FD_FILE_IMAGE_OP_FILE_CLOSEenum H5FD_file_image_op_tstatic intH5FD_FILE_IMAGE_OP_FILE_OPENenum H5FD_file_image_op_tstatic intH5FD_FILE_IMAGE_OP_FILE_RESIZEenum H5FD_file_image_op_tstatic intH5FD_FILE_IMAGE_OP_NO_OPenum H5FD_file_image_op_tstatic intH5FD_FILE_IMAGE_OP_PROPERTY_LIST_CLOSEenum H5FD_file_image_op_tstatic intH5FD_FILE_IMAGE_OP_PROPERTY_LIST_COPYenum H5FD_file_image_op_tstatic intH5FD_FILE_IMAGE_OP_PROPERTY_LIST_GETenum H5FD_file_image_op_tstatic intH5FD_FILE_IMAGE_OP_PROPERTY_LIST_SETenum H5FD_file_image_op_tstatic intH5FD_LOGstatic intH5FD_LOG_ALLstatic intH5FD_LOG_ALLOCstatic intH5FD_LOG_FILE_IOstatic intH5FD_LOG_FILE_READstatic intH5FD_LOG_FILE_WRITEstatic intH5FD_LOG_FLAVORstatic intH5FD_LOG_FREEstatic intH5FD_LOG_LOC_IOstatic intH5FD_LOG_LOC_READstatic intH5FD_LOG_LOC_SEEKstatic intH5FD_LOG_LOC_WRITEstatic intH5FD_LOG_META_IOstatic intH5FD_LOG_NUM_IOstatic intH5FD_LOG_NUM_READstatic intH5FD_LOG_NUM_SEEKstatic intH5FD_LOG_NUM_TRUNCATEstatic intH5FD_LOG_NUM_WRITEstatic intH5FD_LOG_TIME_CLOSEstatic intH5FD_LOG_TIME_IOstatic intH5FD_LOG_TIME_OPENstatic intH5FD_LOG_TIME_READstatic intH5FD_LOG_TIME_SEEKstatic intH5FD_LOG_TIME_STATstatic intH5FD_LOG_TIME_TRUNCATEstatic intH5FD_LOG_TIME_WRITEstatic intH5FD_LOG_TRUNCATEstatic intH5FD_LOG_VALUEstatic intH5FD_MEM_BTREEenum H5F_mem_tstatic intH5FD_MEM_DEFAULTenum H5F_mem_tstatic intH5FD_MEM_DRAWenum H5F_mem_tstatic intH5FD_MEM_EARRAY_DBLK_PAGEstatic intH5FD_MEM_EARRAY_DBLOCKstatic intH5FD_MEM_EARRAY_HDRstatic intH5FD_MEM_EARRAY_IBLOCKstatic intH5FD_MEM_EARRAY_SBLOCKstatic intH5FD_MEM_FARRAY_DBLK_PAGEstatic intH5FD_MEM_FARRAY_DBLOCKstatic intH5FD_MEM_FARRAY_HDRstatic intH5FD_MEM_FHEAP_DBLOCKstatic intH5FD_MEM_FHEAP_HDRstatic intH5FD_MEM_FHEAP_HUGE_OBJstatic intH5FD_MEM_FHEAP_IBLOCKstatic intH5FD_MEM_FSPACE_HDRstatic intH5FD_MEM_FSPACE_SINFOstatic intH5FD_MEM_GHEAPenum H5F_mem_tstatic intH5FD_MEM_LHEAPenum H5F_mem_tstatic intH5FD_MEM_NOLISTenum H5F_mem_tstatic intH5FD_MEM_NTYPESenum H5F_mem_tstatic intH5FD_MEM_OHDRenum H5F_mem_tstatic intH5FD_MEM_SOHM_INDEXstatic intH5FD_MEM_SOHM_TABLEstatic intH5FD_MEM_SUPERenum H5F_mem_tstatic intH5FD_MPIO_CHUNK_DEFAULTenum H5FD_mpio_chunk_opt_tstatic intH5FD_MPIO_CHUNK_MULTI_IOenum H5FD_mpio_chunk_opt_tstatic intH5FD_MPIO_CHUNK_ONE_IOenum H5FD_mpio_chunk_opt_tstatic intH5FD_MPIO_COLLECTIVEenum H5FD_mpio_xfer_tstatic intH5FD_MPIO_COLLECTIVE_IOenum H5FD_mpio_collective_opt_tstatic intH5FD_MPIO_INDEPENDENTenum H5FD_mpio_xfer_tstatic intH5FD_MPIO_INDIVIDUAL_IOenum H5FD_mpio_collective_opt_tstatic intH5FD_MULTIstatic intH5FD_SEC2static intH5FD_SEC2_VALUEstatic intH5FD_STDIOstatic intH5FD_VFD_DEFAULTstatic intH5G_STORAGE_TYPE_COMPACTenum H5G_storage_type_tstatic intH5G_STORAGE_TYPE_DENSEenum H5G_storage_type_tstatic intH5G_STORAGE_TYPE_SYMBOL_TABLEenum H5G_storage_type_tstatic intH5G_STORAGE_TYPE_UNKNOWNenum H5G_storage_type_tstatic intH5I_ATTRenum H5I_type_tstatic intH5I_BADIDenum H5I_type_tstatic intH5I_DATASETenum H5I_type_tstatic intH5I_DATASPACEenum H5I_type_tstatic intH5I_DATATYPEenum H5I_type_tstatic intH5I_ERROR_CLASSenum H5I_type_tstatic intH5I_ERROR_MSGenum H5I_type_tstatic intH5I_ERROR_STACKenum H5I_type_tstatic intH5I_EVENTSETenum H5I_type_tstatic intH5I_FILEenum H5I_type_tstatic intH5I_GENPROP_CLSenum H5I_type_tstatic intH5I_GENPROP_LSTenum H5I_type_tstatic intH5I_GROUPenum H5I_type_tstatic intH5I_INVALID_HIDAn invalid object ID.static intH5I_MAPenum H5I_type_tstatic intH5I_NTYPESenum H5I_type_tstatic intH5I_SPACE_SEL_ITERenum H5I_type_tstatic intH5I_UNINITenum H5I_type_tstatic intH5I_VFLenum H5I_type_tstatic intH5I_VOLenum H5I_type_tstatic intH5L_LINK_CLASS_T_VERS\brief Current version of the H5L_class_t structstatic intH5L_MAX_LINK_NAME_LENstatic intH5L_SAME_LOCstatic intH5L_TYPE_BUILTIN_MAX\brief Maximum value link value for "built-in" link typesstatic intH5L_TYPE_ERRORenum H5L_type_tstatic intH5L_TYPE_EXTERNALenum H5L_type_tstatic intH5L_TYPE_HARDenum H5L_type_tstatic intH5L_TYPE_MAXenum H5L_type_tstatic intH5L_TYPE_SOFTenum H5L_type_tstatic intH5L_TYPE_UD_MAX\brief Maximum link id value for "user-defined" link types.static intH5L_TYPE_UD_MIN\brief Link ids at or above this value are "user-defined" link types.static intH5LT_Cenum H5LT_lang_tstatic intH5LT_DDLenum H5LT_lang_tstatic intH5LT_FILE_IMAGE_ALLstatic intH5LT_FILE_IMAGE_DONT_COPYstatic intH5LT_FILE_IMAGE_DONT_RELEASEstatic intH5LT_FILE_IMAGE_OPEN_RWstatic intH5LT_FORTRANenum H5LT_lang_tstatic intH5LT_LANG_ERRenum H5LT_lang_tstatic intH5LT_NO_LANGenum H5LT_lang_tstatic intH5O_COPY_ALLAll object copying flags (for internal checking)static intH5O_COPY_EXPAND_EXT_LINK_FLAGExpand external links into new objectsstatic intH5O_COPY_EXPAND_REFERENCE_FLAGCopy objects that are pointed by referencesstatic intH5O_COPY_EXPAND_SOFT_LINK_FLAGExpand soft links into new objectsstatic intH5O_COPY_MERGE_COMMITTED_DTYPE_FLAGMerge committed datatypes in dest filestatic intH5O_COPY_PRESERVE_NULL_FLAGCopy NULL messages (empty space)static intH5O_COPY_SHALLOW_HIERARCHY_FLAGCopy only immediate membersstatic intH5O_COPY_WITHOUT_ATTR_FLAGCopy object without copying attributesstatic intH5O_HDR_ALL_FLAGSstatic intH5O_HDR_ATTR_CRT_ORDER_INDEXEDAttribute creation order has indexstatic intH5O_HDR_ATTR_CRT_ORDER_TRACKEDAttribute creation order is trackedstatic intH5O_HDR_ATTR_STORE_PHASE_CHANGENon-default attribute storage phase change values storedstatic intH5O_HDR_CHUNK0_SIZE2-bit field indicating # of bytes to store the size of chunk 0's datastatic intH5O_HDR_STORE_TIMESStore access, modification, change & birth times for objectstatic intH5O_INFO_ALLstatic intH5O_INFO_BASICFill in the fileno, addr, type, and rc fieldsstatic intH5O_INFO_NUM_ATTRSFill in the num_attrs fieldstatic intH5O_INFO_TIMEFill in the atime, mtime, ctime, and btime fieldsstatic intH5O_MAX_TOKEN_SIZEstatic intH5O_MCDT_SEARCH_CONTenum H5O_mcdt_search_ret_tstatic intH5O_MCDT_SEARCH_ERRORenum H5O_mcdt_search_ret_tstatic intH5O_MCDT_SEARCH_STOPenum H5O_mcdt_search_ret_tstatic intH5O_NATIVE_INFO_ALLstatic intH5O_NATIVE_INFO_HDRFill in the hdr fieldstatic intH5O_NATIVE_INFO_META_SIZEFill in the meta_size fieldstatic intH5O_SHMESG_ALL_FLAGstatic intH5O_SHMESG_ATTR_FLAGstatic intH5O_SHMESG_DTYPE_FLAGstatic intH5O_SHMESG_FILL_FLAGstatic intH5O_SHMESG_MAX_LIST_SIZEstatic intH5O_SHMESG_MAX_NINDEXESstatic intH5O_SHMESG_NONE_FLAGNo shared messagesstatic intH5O_SHMESG_PLINE_FLAGstatic intH5O_SHMESG_SDSPACE_FLAGstatic intH5O_TYPE_DATASETenum H5O_type_tstatic intH5O_TYPE_GROUPenum H5O_type_tstatic intH5O_TYPE_MAPenum H5O_type_tstatic intH5O_TYPE_NAMED_DATATYPEenum H5O_type_tstatic intH5O_TYPE_NTYPESenum H5O_type_tstatic intH5O_TYPE_UNKNOWNenum H5O_type_tstatic intH5O_VERSION_1static intH5O_VERSION_2static intH5P_ATTRIBUTE_ACCESSstatic intH5P_ATTRIBUTE_ACCESS_DEFAULTstatic intH5P_ATTRIBUTE_CREATEstatic intH5P_ATTRIBUTE_CREATE_DEFAULTstatic intH5P_CRT_ORDER_INDEXEDstatic intH5P_CRT_ORDER_TRACKEDstatic intH5P_DATASET_ACCESSstatic intH5P_DATASET_ACCESS_DEFAULTstatic intH5P_DATASET_CREATEstatic intH5P_DATASET_CREATE_DEFAULTstatic intH5P_DATASET_XFERstatic intH5P_DATASET_XFER_DEFAULTstatic intH5P_DATATYPE_ACCESSstatic intH5P_DATATYPE_ACCESS_DEFAULTstatic intH5P_DATATYPE_CREATEstatic intH5P_DATATYPE_CREATE_DEFAULTstatic intH5P_DEFAULTstatic intH5P_FILE_ACCESSstatic intH5P_FILE_ACCESS_DEFAULTstatic intH5P_FILE_CREATEstatic intH5P_FILE_CREATE_DEFAULTstatic intH5P_FILE_MOUNTstatic intH5P_FILE_MOUNT_DEFAULTstatic intH5P_GROUP_ACCESSstatic intH5P_GROUP_ACCESS_DEFAULTstatic intH5P_GROUP_CREATEstatic intH5P_GROUP_CREATE_DEFAULTstatic intH5P_LINK_ACCESSstatic intH5P_LINK_ACCESS_DEFAULTstatic intH5P_LINK_CREATEstatic intH5P_LINK_CREATE_DEFAULTstatic intH5P_MAP_ACCESSstatic intH5P_MAP_ACCESS_DEFAULTstatic intH5P_MAP_CREATEstatic intH5P_MAP_CREATE_DEFAULTstatic intH5P_OBJECT_COPYstatic intH5P_OBJECT_COPY_DEFAULTstatic intH5P_OBJECT_CREATEstatic intH5P_REFERENCE_ACCESSstatic intH5P_REFERENCE_ACCESS_DEFAULTstatic intH5P_ROOTstatic intH5P_STRING_CREATEstatic intH5P_VOL_INITIALIZEstatic intH5P_VOL_INITIALIZE_DEFAULTstatic intH5PL_ALL_PLUGINstatic intH5PL_FILTER_PLUGINstatic StringH5PL_NO_PLUGINstatic intH5PL_TYPE_ERRORenum H5PL_type_tstatic intH5PL_TYPE_FILTERenum H5PL_type_tstatic intH5PL_TYPE_NONEenum H5PL_type_tstatic intH5PL_TYPE_VFDenum H5PL_type_tstatic intH5PL_TYPE_VOLenum H5PL_type_tstatic intH5PL_VFD_PLUGINstatic intH5PL_VOL_PLUGINstatic intH5R_ATTRenum H5R_type_tstatic intH5R_BADTYPEenum H5R_type_tstatic intH5R_DATASET_REGIONstatic intH5R_DATASET_REGION1enum H5R_type_tstatic intH5R_DATASET_REGION2enum H5R_type_tstatic intH5R_DSET_REG_REF_BUF_SIZEstatic intH5R_MAXTYPEenum H5R_type_tstatic intH5R_OBJ_REF_BUF_SIZEstatic intH5R_OBJECT\endcondstatic intH5R_OBJECT1enum H5R_type_tstatic intH5R_OBJECT2enum H5R_type_tstatic intH5R_REF_BUF_SIZEDefault reference buffer size.static intH5S_ALLstatic intH5S_BLOCKstatic intH5S_MAX_RANKThe maximum dataspace rank or number of dimensionsstatic intH5S_NO_CLASSenum H5S_class_tstatic intH5S_NULLenum H5S_class_tstatic intH5S_PLISTstatic intH5S_SCALARenum H5S_class_tstatic intH5S_SEL_ALLenum H5S_sel_typestatic intH5S_SEL_ERRORenum H5S_sel_typestatic intH5S_SEL_HYPERSLABSenum H5S_sel_typestatic intH5S_SEL_ITER_GET_SEQ_LIST_SORTEDRetrieve elements from iterator in increasing offset order, for \ each call to retrieve sequences.static intH5S_SEL_ITER_SHARE_WITH_DATASPACEDon't copy the dataspace selection when creating the selection \ iterator.static intH5S_SEL_Nenum H5S_sel_typestatic intH5S_SEL_NONEenum H5S_sel_typestatic intH5S_SEL_POINTSenum H5S_sel_typestatic intH5S_SELECT_ANDenum H5S_seloper_tstatic intH5S_SELECT_APPENDenum H5S_seloper_tstatic intH5S_SELECT_INVALIDenum H5S_seloper_tstatic intH5S_SELECT_NOOPenum H5S_seloper_tstatic intH5S_SELECT_NOTAenum H5S_seloper_tstatic intH5S_SELECT_NOTBenum H5S_seloper_tstatic intH5S_SELECT_ORenum H5S_seloper_tstatic intH5S_SELECT_PREPENDenum H5S_seloper_tstatic intH5S_SELECT_SETenum H5S_seloper_tstatic intH5S_SELECT_XORenum H5S_seloper_tstatic intH5S_SIMPLEenum H5S_class_tstatic intH5S_UNLIMITEDValue for 'unlimited' dimensionsstatic intH5T_ALPHA_B16static intH5T_ALPHA_B32static intH5T_ALPHA_B64static intH5T_ALPHA_B8static intH5T_ALPHA_F32static intH5T_ALPHA_F64static intH5T_ALPHA_I16static intH5T_ALPHA_I32static intH5T_ALPHA_I64static intH5T_ALPHA_I8static intH5T_ALPHA_U16static intH5T_ALPHA_U32static intH5T_ALPHA_U64static intH5T_ALPHA_U8static intH5T_ARRAYenum H5T_class_tstatic intH5T_BITFIELDenum H5T_class_tstatic intH5T_BKG_NOenum H5T_bkg_tstatic intH5T_BKG_TEMPenum H5T_bkg_tstatic intH5T_BKG_YESenum H5T_bkg_tstatic intH5T_C_S1static intH5T_COMPOUNDenum H5T_class_tstatic intH5T_CONV_ABORTenum H5T_conv_ret_tstatic intH5T_CONV_CONVenum H5T_cmd_tstatic intH5T_CONV_EXCEPT_NANenum H5T_conv_except_tstatic intH5T_CONV_EXCEPT_NINFenum H5T_conv_except_tstatic intH5T_CONV_EXCEPT_PINFenum H5T_conv_except_tstatic intH5T_CONV_EXCEPT_PRECISIONenum H5T_conv_except_tstatic intH5T_CONV_EXCEPT_RANGE_HIenum H5T_conv_except_tstatic intH5T_CONV_EXCEPT_RANGE_LOWenum H5T_conv_except_tstatic intH5T_CONV_EXCEPT_TRUNCATEenum H5T_conv_except_tstatic intH5T_CONV_FREEenum H5T_cmd_tstatic intH5T_CONV_HANDLEDenum H5T_conv_ret_tstatic intH5T_CONV_INITenum H5T_cmd_tstatic intH5T_CONV_UNHANDLEDenum H5T_conv_ret_tstatic intH5T_CSET_ASCIIenum H5T_cset_tstatic intH5T_CSET_ERRORenum H5T_cset_tstatic intH5T_CSET_RESERVED_10enum H5T_cset_tstatic intH5T_CSET_RESERVED_11enum H5T_cset_tstatic intH5T_CSET_RESERVED_12enum H5T_cset_tstatic intH5T_CSET_RESERVED_13enum H5T_cset_tstatic intH5T_CSET_RESERVED_14enum H5T_cset_tstatic intH5T_CSET_RESERVED_15enum H5T_cset_tstatic intH5T_CSET_RESERVED_2enum H5T_cset_tstatic intH5T_CSET_RESERVED_3enum H5T_cset_tstatic intH5T_CSET_RESERVED_4enum H5T_cset_tstatic intH5T_CSET_RESERVED_5enum H5T_cset_tstatic intH5T_CSET_RESERVED_6enum H5T_cset_tstatic intH5T_CSET_RESERVED_7enum H5T_cset_tstatic intH5T_CSET_RESERVED_8enum H5T_cset_tstatic intH5T_CSET_RESERVED_9enum H5T_cset_tstatic intH5T_CSET_UTF8enum H5T_cset_tstatic intH5T_DIR_ASCENDenum H5T_direction_tstatic intH5T_DIR_DEFAULTenum H5T_direction_tstatic intH5T_DIR_DESCENDenum H5T_direction_tstatic intH5T_ENUMenum H5T_class_tstatic intH5T_FLOATenum H5T_class_tstatic intH5T_FORTRAN_S1static intH5T_IEEE_F32BEstatic intH5T_IEEE_F32LEstatic intH5T_IEEE_F64BEstatic intH5T_IEEE_F64LEstatic intH5T_INTEGERenum H5T_class_tstatic intH5T_INTEL_B16static intH5T_INTEL_B32static intH5T_INTEL_B64static intH5T_INTEL_B8static intH5T_INTEL_F32static intH5T_INTEL_F64static intH5T_INTEL_I16static intH5T_INTEL_I32static intH5T_INTEL_I64static intH5T_INTEL_I8static intH5T_INTEL_U16static intH5T_INTEL_U32static intH5T_INTEL_U64static intH5T_INTEL_U8static intH5T_MIPS_B16static intH5T_MIPS_B32static intH5T_MIPS_B64static intH5T_MIPS_B8static intH5T_MIPS_F32static intH5T_MIPS_F64static intH5T_MIPS_I16static intH5T_MIPS_I32static intH5T_MIPS_I64static intH5T_MIPS_I8static intH5T_MIPS_U16static intH5T_MIPS_U32static intH5T_MIPS_U64static intH5T_MIPS_U8static intH5T_NATIVE_B16static intH5T_NATIVE_B32static intH5T_NATIVE_B64static intH5T_NATIVE_B8static intH5T_NATIVE_CHARstatic intH5T_NATIVE_DOUBLEstatic intH5T_NATIVE_FLOATstatic intH5T_NATIVE_HADDRstatic intH5T_NATIVE_HBOOLstatic intH5T_NATIVE_HERRstatic intH5T_NATIVE_HSIZEstatic intH5T_NATIVE_HSSIZEstatic intH5T_NATIVE_INTstatic intH5T_NATIVE_INT_FAST16static intH5T_NATIVE_INT_FAST32static intH5T_NATIVE_INT_FAST64static intH5T_NATIVE_INT_FAST8static intH5T_NATIVE_INT_LEAST16static intH5T_NATIVE_INT_LEAST32static intH5T_NATIVE_INT_LEAST64static intH5T_NATIVE_INT_LEAST8static intH5T_NATIVE_INT16static intH5T_NATIVE_INT32static intH5T_NATIVE_INT64static intH5T_NATIVE_INT8static intH5T_NATIVE_LDOUBLEstatic intH5T_NATIVE_LLONGstatic intH5T_NATIVE_LONGstatic intH5T_NATIVE_OPAQUEstatic intH5T_NATIVE_SCHARstatic intH5T_NATIVE_SHORTstatic intH5T_NATIVE_UCHARstatic intH5T_NATIVE_UINTstatic intH5T_NATIVE_UINT_FAST16static intH5T_NATIVE_UINT_FAST32static intH5T_NATIVE_UINT_FAST64static intH5T_NATIVE_UINT_FAST8static intH5T_NATIVE_UINT_LEAST16static intH5T_NATIVE_UINT_LEAST32static intH5T_NATIVE_UINT_LEAST64static intH5T_NATIVE_UINT_LEAST8static intH5T_NATIVE_UINT16static intH5T_NATIVE_UINT32static intH5T_NATIVE_UINT64static intH5T_NATIVE_UINT8static intH5T_NATIVE_ULLONGstatic intH5T_NATIVE_ULONGstatic intH5T_NATIVE_USHORTstatic intH5T_NCLASSESenum H5T_class_tstatic intH5T_NCSETstatic intH5T_NO_CLASSenum H5T_class_tstatic intH5T_NORM_ERRORenum H5T_norm_tstatic intH5T_NORM_IMPLIEDenum H5T_norm_tstatic intH5T_NORM_MSBSETenum H5T_norm_tstatic intH5T_NORM_NONEenum H5T_norm_tstatic intH5T_NPADenum H5T_pad_tstatic intH5T_NSGNenum H5T_sign_tstatic intH5T_NSTRstatic intH5T_OPAQUEenum H5T_class_tstatic intH5T_OPAQUE_TAG_MAXMaximum length of an opaque tag \internal This could be raised without too much difficultystatic intH5T_ORDER_BEenum H5T_order_tstatic intH5T_ORDER_ERRORenum H5T_order_tstatic intH5T_ORDER_LEenum H5T_order_tstatic intH5T_ORDER_MIXEDenum H5T_order_tstatic intH5T_ORDER_NONEenum H5T_order_tstatic intH5T_ORDER_VAXenum H5T_order_tstatic intH5T_PAD_BACKGROUNDenum H5T_pad_tstatic intH5T_PAD_ERRORenum H5T_pad_tstatic intH5T_PAD_ONEenum H5T_pad_tstatic intH5T_PAD_ZEROenum H5T_pad_tstatic intH5T_PERS_DONTCAREenum H5T_pers_tstatic intH5T_PERS_HARDenum H5T_pers_tstatic intH5T_PERS_SOFTenum H5T_pers_tstatic intH5T_REFERENCEenum H5T_class_tstatic intH5T_SGN_2enum H5T_sign_tstatic intH5T_SGN_ERRORenum H5T_sign_tstatic intH5T_SGN_NONEenum H5T_sign_tstatic intH5T_STD_B16BEstatic intH5T_STD_B16LEstatic intH5T_STD_B32BEstatic intH5T_STD_B32LEstatic intH5T_STD_B64BEstatic intH5T_STD_B64LEstatic intH5T_STD_B8BEstatic intH5T_STD_B8LEstatic intH5T_STD_I16BEstatic intH5T_STD_I16LEstatic intH5T_STD_I32BEstatic intH5T_STD_I32LEstatic intH5T_STD_I64BEstatic intH5T_STD_I64LEstatic intH5T_STD_I8BEstatic intH5T_STD_I8LEstatic intH5T_STD_REFstatic intH5T_STD_REF_DSETREGstatic intH5T_STD_REF_OBJstatic intH5T_STD_U16BEstatic intH5T_STD_U16LEstatic intH5T_STD_U32BEstatic intH5T_STD_U32LEstatic intH5T_STD_U64BEstatic intH5T_STD_U64LEstatic intH5T_STD_U8BEstatic intH5T_STD_U8LEstatic intH5T_STR_ERRORenum H5T_str_tstatic intH5T_STR_NULLPADenum H5T_str_tstatic intH5T_STR_NULLTERMenum H5T_str_tstatic intH5T_STR_RESERVED_10enum H5T_str_tstatic intH5T_STR_RESERVED_11enum H5T_str_tstatic intH5T_STR_RESERVED_12enum H5T_str_tstatic intH5T_STR_RESERVED_13enum H5T_str_tstatic intH5T_STR_RESERVED_14enum H5T_str_tstatic intH5T_STR_RESERVED_15enum H5T_str_tstatic intH5T_STR_RESERVED_3enum H5T_str_tstatic intH5T_STR_RESERVED_4enum H5T_str_tstatic intH5T_STR_RESERVED_5enum H5T_str_tstatic intH5T_STR_RESERVED_6enum H5T_str_tstatic intH5T_STR_RESERVED_7enum H5T_str_tstatic intH5T_STR_RESERVED_8enum H5T_str_tstatic intH5T_STR_RESERVED_9enum H5T_str_tstatic intH5T_STR_SPACEPADenum H5T_str_tstatic intH5T_STRINGenum H5T_class_tstatic intH5T_TIMEenum H5T_class_tstatic intH5T_UNIX_D32BEstatic intH5T_UNIX_D32LEstatic intH5T_UNIX_D64BEstatic intH5T_UNIX_D64LEstatic intH5T_VARIABLEstatic intH5T_VAX_F32static intH5T_VAX_F64static intH5T_VLENenum H5T_class_tstatic intH5Z_CB_CONTenum H5Z_cb_return_tstatic intH5Z_CB_ERRORenum H5Z_cb_return_tstatic intH5Z_CB_FAILenum H5Z_cb_return_tstatic intH5Z_CB_NOenum H5Z_cb_return_tstatic intH5Z_CLASS_T_VERSCurrent version of the H5Z_class_t structstatic intH5Z_DISABLE_EDCenum H5Z_EDC_tstatic intH5Z_ENABLE_EDCenum H5Z_EDC_tstatic intH5Z_ERROR_EDCenum H5Z_EDC_tstatic intH5Z_FILTER_ALLSymbol to remove all filters in H5Premove_filter()static intH5Z_FILTER_CONFIG_DECODE_ENABLEDstatic intH5Z_FILTER_CONFIG_ENCODE_ENABLEDstatic intH5Z_FILTER_DEFLATEdeflation like gzipstatic intH5Z_FILTER_ERRORno filterstatic intH5Z_FILTER_FLETCHER32fletcher32 checksum of EDCstatic intH5Z_FILTER_MAXmaximum filter idstatic intH5Z_FILTER_NBITnbit compressionstatic intH5Z_FILTER_NONEreserved indefinitelystatic intH5Z_FILTER_RESERVEDfilter ids below this value are reserved for library usestatic intH5Z_FILTER_SCALEOFFSETscale+offset compressionstatic intH5Z_FILTER_SHUFFLEshuffle the datastatic intH5Z_FILTER_SZIPszip compressionstatic intH5Z_FLAG_DEFMASKdefinition flag maskstatic intH5Z_FLAG_INVMASKinvocation flag maskstatic intH5Z_FLAG_MANDATORYfilter is mandatorystatic intH5Z_FLAG_OPTIONALfilter is optionalstatic intH5Z_FLAG_REVERSEreverse direction; readstatic intH5Z_FLAG_SKIP_EDCskip EDC filters for readstatic intH5Z_MAX_NFILTERSMaximum number of filters allowed in a pipeline \internal (should probably be allowed to be an unlimited amount, but currently each filter uses a bit in a 32-bit field, so the format would have to be changed to accommodate that)static intH5Z_NBIT_USER_NPARMS\ingroup NBIT Number of parameters that users can set for the N-bit filterstatic intH5Z_NO_EDCenum H5Z_EDC_tstatic intH5Z_SCALEOFFSET_USER_NPARMS\ingroup SCALEOFFSET Number of parameters that users can set for the scale-offset filterstatic intH5Z_SHUFFLE_TOTAL_NPARMS\ingroup SHUFFLE Total number of parameters for the shuffle filterstatic intH5Z_SHUFFLE_USER_NPARMS\ingroup SHUFFLE Number of parameters that users can set for the shuffle filterstatic intH5Z_SO_FLOAT_DSCALEenum H5Z_SO_scale_type_tstatic intH5Z_SO_FLOAT_ESCALEenum H5Z_SO_scale_type_tstatic intH5Z_SO_INTenum H5Z_SO_scale_type_tstatic intH5Z_SO_INT_MINBITS_DEFAULT\ingroup SCALEOFFSETstatic intH5Z_SZIP_PARM_BPP\ingroup SZIP "Local" parameter for bits-per-pixelstatic intH5Z_SZIP_PARM_MASK\ingroup SZIP "User" parameter for option maskstatic intH5Z_SZIP_PARM_PPB\ingroup SZIP "User" parameter for pixels-per-blockstatic intH5Z_SZIP_PARM_PPS\ingroup SZIP "Local" parameter for pixels-per-scanlinestatic intH5Z_SZIP_TOTAL_NPARMS\ingroup SZIP Total number of parameters for SZIP filterstatic intH5Z_SZIP_USER_NPARMS\ingroup SZIP Number of parameters that users can set for SZIPstatic intHADDR_MAXstatic intHADDR_UNDEFstatic StringHDF5_DRIVERUsed to specify the name of an HDF5 Virtual File Driver to use as the default file driver for file access.static StringHDF5_DRIVER_CONFIGUsed to specify a configuration string for the HDF5 Virtual File Driver being used for file access.static StringHDF5_NOCLEANUPUsed to instruct HDF5 not to cleanup files created during testing.static StringHDF5_PLUGIN_PATHUsed to specify a delimiter-separated (currently, ';' for Windows and ':' for other systems) list of paths that HDF5 should search when loading plugins.static StringHDF5_PLUGIN_PRELOADUsed to control the loading of HDF5 plugins at runtime.static StringHDF5_USE_FILE_LOCKINGUsed to control whether HDF5 uses file locking when creating or opening a file.static StringHDF5_VOL_CONNECTORUsed to specify the name of an HDF5 Virtual Object Layer Connector to use as the default VOL connector for file access.static intHSIZE_UNDEFstatic StringREFERENCE_LISTstatic intWORDS_BIGENDIAN
-
Constructor Summary
Constructors Constructor Description hdf5()
-
Method Summary
All Methods Static Methods Concrete Methods Deprecated Methods Modifier and Type Method Description static intH5_VFD_CORE()static intH5_VFD_DIRECT()static intH5_VFD_FAMILY()static intH5_VFD_HDFS()static intH5_VFD_INVALID()static intH5_VFD_IOC()static intH5_VFD_LOG()static intH5_VFD_MIRROR()static intH5_VFD_MPIO()static intH5_VFD_MULTI()static intH5_VFD_ONION()static intH5_VFD_ROS3()static intH5_VFD_SEC2()static intH5_VFD_SPLITTER()static intH5_VFD_STDIO()static intH5_VFD_SUBFILING()static intH5Aclose(long attr_id)\ingroup H5A \brief Closes the specified attribute \attr_idstatic intH5Aclose_async(String app_file, String app_func, int app_line, long attr_id, long es_id)static intH5Aclose_async(BytePointer app_file, BytePointer app_func, int app_line, long attr_id, long es_id)\ingroup ASYNC \async_variant_of{H5Aclose}static longH5Acreate_async(String app_file, String app_func, int app_line, long loc_id, String attr_name, long type_id, long space_id, long acpl_id, long aapl_id, long es_id)static longH5Acreate_async(BytePointer app_file, BytePointer app_func, int app_line, long loc_id, BytePointer attr_name, long type_id, long space_id, long acpl_id, long aapl_id, long es_id)\ingroup ASYNC \async_variant_of{H5Acreate}static longH5Acreate_by_name(long loc_id, String obj_name, String attr_name, long type_id, long space_id, long acpl_id, long aapl_id, long lapl_id)static longH5Acreate_by_name(long loc_id, BytePointer obj_name, BytePointer attr_name, long type_id, long space_id, long acpl_id, long aapl_id, long lapl_id)\ingroup H5A \brief Creates an attribute attached to a specified object \fgdt_loc_idstatic longH5Acreate_by_name_async(String app_file, String app_func, int app_line, long loc_id, String obj_name, String attr_name, long type_id, long space_id, long acpl_id, long aapl_id, long lapl_id, long es_id)static longH5Acreate_by_name_async(BytePointer app_file, BytePointer app_func, int app_line, long loc_id, BytePointer obj_name, BytePointer attr_name, long type_id, long space_id, long acpl_id, long aapl_id, long lapl_id, long es_id)\ingroup ASYNC \async_variant_of{H5Acreate_by_name}static longH5Acreate2(long loc_id, String attr_name, long type_id, long space_id, long acpl_id, long aapl_id)static longH5Acreate2(long loc_id, BytePointer attr_name, long type_id, long space_id, long acpl_id, long aapl_id)\ingroup H5A \brief Creates an attribute attached to a specified object \fgdt_loc_idstatic intH5Adelete(long loc_id, String attr_name)static intH5Adelete(long loc_id, BytePointer attr_name)\ingroup H5A \brief Deletes an attribute from a specified location \fgdt_loc_idstatic intH5Adelete_by_idx(long loc_id, String obj_name, int idx_type, int order, long n, long lapl_id)static intH5Adelete_by_idx(long loc_id, BytePointer obj_name, int idx_type, int order, long n, long lapl_id)\ingroup H5A \brief Deletes an attribute from an object according to index order \fgdt_loc_idstatic intH5Adelete_by_name(long loc_id, String obj_name, String attr_name, long lapl_id)static intH5Adelete_by_name(long loc_id, BytePointer obj_name, BytePointer attr_name, long lapl_id)\ingroup H5A \brief Removes an attribute from a specified location \fgdt_loc_idstatic intH5Aexists(long obj_id, String attr_name)static intH5Aexists(long obj_id, BytePointer attr_name)\ingroup H5A \brief Determines whether an attribute with a given name exists on an object \fgdt_loc_id{obj_id}static intH5Aexists_async(String app_file, String app_func, int app_line, long obj_id, String attr_name, boolean[] exists, long es_id)static intH5Aexists_async(BytePointer app_file, BytePointer app_func, int app_line, long obj_id, BytePointer attr_name, BoolPointer exists, long es_id)\ingroup ASYNC \async_variant_of{H5Aexists}static intH5Aexists_by_name(long obj_id, String obj_name, String attr_name, long lapl_id)static intH5Aexists_by_name(long obj_id, BytePointer obj_name, BytePointer attr_name, long lapl_id)\ingroup H5A \brief Determines whether an attribute with a given name exists on an object \fgdt_loc_id{obj_id}static intH5Aexists_by_name_async(String app_file, String app_func, int app_line, long loc_id, String obj_name, String attr_name, boolean[] exists, long lapl_id, long es_id)static intH5Aexists_by_name_async(BytePointer app_file, BytePointer app_func, int app_line, long loc_id, BytePointer obj_name, BytePointer attr_name, BoolPointer exists, long lapl_id, long es_id)\ingroup ASYNC \async_variant_of{H5Aexists_by_name}static longH5Aget_create_plist(long attr_id)\ingroup H5A \brief Gets an attribute creation property list identifier \attr_idstatic intH5Aget_info(long attr_id, H5A_info_t ainfo)\ingroup H5A \brief Retrieves attribute information, by attribute identifier \attr_idstatic intH5Aget_info_by_idx(long loc_id, String obj_name, int idx_type, int order, long n, H5A_info_t ainfo, long lapl_id)static intH5Aget_info_by_idx(long loc_id, BytePointer obj_name, int idx_type, int order, long n, H5A_info_t ainfo, long lapl_id)\ingroup H5A \brief Retrieves attribute information by attribute index position \fgdt_loc_idstatic intH5Aget_info_by_name(long loc_id, String obj_name, String attr_name, H5A_info_t ainfo, long lapl_id)static intH5Aget_info_by_name(long loc_id, BytePointer obj_name, BytePointer attr_name, H5A_info_t ainfo, long lapl_id)\ingroup H5A \brief Retrieves attribute information, by attribute name \fgdt_loc_idstatic longH5Aget_name(long attr_id, long buf_size, byte[] buf)static longH5Aget_name(long attr_id, long buf_size, ByteBuffer buf)static longH5Aget_name(long attr_id, long buf_size, BytePointer buf)\ingroup H5A \brief Gets an attribute name \attr_idstatic longH5Aget_name_by_idx(long loc_id, String obj_name, int idx_type, int order, long n, byte[] name, long size, long lapl_id)static longH5Aget_name_by_idx(long loc_id, String obj_name, int idx_type, int order, long n, ByteBuffer name, long size, long lapl_id)static longH5Aget_name_by_idx(long loc_id, String obj_name, int idx_type, int order, long n, BytePointer name, long size, long lapl_id)static longH5Aget_name_by_idx(long loc_id, BytePointer obj_name, int idx_type, int order, long n, byte[] name, long size, long lapl_id)static longH5Aget_name_by_idx(long loc_id, BytePointer obj_name, int idx_type, int order, long n, ByteBuffer name, long size, long lapl_id)static longH5Aget_name_by_idx(long loc_id, BytePointer obj_name, int idx_type, int order, long n, BytePointer name, long size, long lapl_id)\ingroup H5A \brief Gets an attribute name by attribute index position \fgdt_loc_idstatic longH5Aget_space(long attr_id)\ingroup H5A \brief Gets a copy of the dataspace for an attribute \attr_idstatic longH5Aget_storage_size(long attr_id)\ingroup H5A \brief Returns the amount of storage used to store an attribute \attr_idstatic longH5Aget_type(long attr_id)\ingroup H5A \brief Gets an attribute's datatype \attr_idstatic intH5Aiterate_by_name(long loc_id, String obj_name, int idx_type, int order, long[] idx, H5A_operator2_t op, Pointer op_data, long lapl_id)static intH5Aiterate_by_name(long loc_id, String obj_name, int idx_type, int order, LongBuffer idx, H5A_operator2_t op, Pointer op_data, long lapl_id)static intH5Aiterate_by_name(long loc_id, String obj_name, int idx_type, int order, LongPointer idx, H5A_operator2_t op, Pointer op_data, long lapl_id)static intH5Aiterate_by_name(long loc_id, BytePointer obj_name, int idx_type, int order, long[] idx, H5A_operator2_t op, Pointer op_data, long lapl_id)static intH5Aiterate_by_name(long loc_id, BytePointer obj_name, int idx_type, int order, LongBuffer idx, H5A_operator2_t op, Pointer op_data, long lapl_id)static intH5Aiterate_by_name(long loc_id, BytePointer obj_name, int idx_type, int order, LongPointer idx, H5A_operator2_t op, Pointer op_data, long lapl_id)\ingroup H5A \brief Calls user-defined function for each attribute on an object \fgdt_loc_idstatic intH5Aiterate2(long loc_id, int idx_type, int order, long[] idx, H5A_operator2_t op, Pointer op_data)static intH5Aiterate2(long loc_id, int idx_type, int order, LongBuffer idx, H5A_operator2_t op, Pointer op_data)static intH5Aiterate2(long loc_id, int idx_type, int order, LongPointer idx, H5A_operator2_t op, Pointer op_data)\ingroup H5A \brief Calls a user-defined function for each attribute on an object \fgdt_loc_idstatic PointerH5allocate_memory(long size, boolean clear)\ingroup H5 \brief Frees memory allocated by the HDF5 librarystatic longH5Aopen(long obj_id, String attr_name, long aapl_id)static longH5Aopen(long obj_id, BytePointer attr_name, long aapl_id)\ingroup H5A \brief Opens an attribute for an object specified by object identifier and attribute name \fgdt_loc_id{obj_id}static longH5Aopen_async(String app_file, String app_func, int app_line, long obj_id, String attr_name, long aapl_id, long es_id)static longH5Aopen_async(BytePointer app_file, BytePointer app_func, int app_line, long obj_id, BytePointer attr_name, long aapl_id, long es_id)\ingroup ASYNC \async_variant_of{H5Aopen}static longH5Aopen_by_idx(long loc_id, String obj_name, int idx_type, int order, long n, long aapl_id, long lapl_id)static longH5Aopen_by_idx(long loc_id, BytePointer obj_name, int idx_type, int order, long n, long aapl_id, long lapl_id)\ingroup H5A \brief Opens the nth attribute attached to an object \loc_idstatic longH5Aopen_by_idx_async(String app_file, String app_func, int app_line, long loc_id, String obj_name, int idx_type, int order, long n, long aapl_id, long lapl_id, long es_id)static longH5Aopen_by_idx_async(BytePointer app_file, BytePointer app_func, int app_line, long loc_id, BytePointer obj_name, int idx_type, int order, long n, long aapl_id, long lapl_id, long es_id)\ingroup ASYNC \async_variant_of{H5Aopen_by_idx}static longH5Aopen_by_name(long loc_id, String obj_name, String attr_name, long aapl_id, long lapl_id)static longH5Aopen_by_name(long loc_id, BytePointer obj_name, BytePointer attr_name, long aapl_id, long lapl_id)\ingroup H5A \brief Opens an attribute for an object by object name and attribute name \fgdt_loc_idstatic longH5Aopen_by_name_async(String app_file, String app_func, int app_line, long loc_id, String obj_name, String attr_name, long aapl_id, long lapl_id, long es_id)static longH5Aopen_by_name_async(BytePointer app_file, BytePointer app_func, int app_line, long loc_id, BytePointer obj_name, BytePointer attr_name, long aapl_id, long lapl_id, long es_id)\ingroup ASYNC \async_variant_of{H5Aopen_by_name}static intH5Aread(long attr_id, long type_id, Pointer buf)\ingroup H5A \brief Reads the value of an attribute \attr_id \mem_type_id{type_id}static intH5Aread_async(String app_file, String app_func, int app_line, long attr_id, long dtype_id, Pointer buf, long es_id)static intH5Aread_async(BytePointer app_file, BytePointer app_func, int app_line, long attr_id, long dtype_id, Pointer buf, long es_id)\ingroup ASYNC \async_variant_of{H5Aread}static intH5Arename(long loc_id, String old_name, String new_name)static intH5Arename(long loc_id, BytePointer old_name, BytePointer new_name)\ingroup H5A \brief Renames an attribute \fgdt_loc_idstatic intH5Arename_async(String app_file, String app_func, int app_line, long loc_id, String old_name, String new_name, long es_id)static intH5Arename_async(BytePointer app_file, BytePointer app_func, int app_line, long loc_id, BytePointer old_name, BytePointer new_name, long es_id)\ingroup ASYNC \async_variant_of{H5Arename}static intH5Arename_by_name(long loc_id, String obj_name, String old_attr_name, String new_attr_name, long lapl_id)static intH5Arename_by_name(long loc_id, BytePointer obj_name, BytePointer old_attr_name, BytePointer new_attr_name, long lapl_id)\ingroup H5A \fgdt_loc_idstatic intH5Arename_by_name_async(String app_file, String app_func, int app_line, long loc_id, String obj_name, String old_attr_name, String new_attr_name, long lapl_id, long es_id)static intH5Arename_by_name_async(BytePointer app_file, BytePointer app_func, int app_line, long loc_id, BytePointer obj_name, BytePointer old_attr_name, BytePointer new_attr_name, long lapl_id, long es_id)\ingroup ASYNC \async_variant_of{H5Arename_by_name}static intH5atclose(H5_atclose_func_t func, Pointer ctx)\ingroup H5 \brief Registers a callback for the library to invoke when it's closing.static intH5Awrite(long attr_id, long type_id, Pointer buf)\ingroup H5A \brief Writes data to an attribute \attr_id \mem_type_id{type_id}static intH5Awrite_async(String app_file, String app_func, int app_line, long attr_id, long type_id, Pointer buf, long es_id)static intH5Awrite_async(BytePointer app_file, BytePointer app_func, int app_line, long attr_id, long type_id, Pointer buf, long es_id)\ingroup ASYNC \async_variant_of{H5Awrite}static intH5check_version(int majnum, int minnum, int relnum)\ingroup H5 \brief Verifies that HDF5 library versions are consistentstatic intH5close()\ingroup H5 \brief Flushes all data to disk, closes all open objects, and releases memorystatic intH5D_CHUNK_CACHE_NBYTES_DEFAULT()static intH5D_CHUNK_CACHE_NSLOTS_DEFAULT()static intH5Dchunk_iter(long dset_id, long dxpl_id, H5D_chunk_iter_op_t cb, Pointer op_data)-------------------------------------------------------------------------- \ingroup H5D \brief Iterate over all chunks of a chunked dataset \dset_idstatic intH5Dclose(long dset_id)-------------------------------------------------------------------------- \ingroup H5D \brief Closes the specified dataset \dset_idstatic intH5Dclose_async(String app_file, String app_func, int app_line, long dset_id, long es_id)static intH5Dclose_async(BytePointer app_file, BytePointer app_func, int app_line, long dset_id, long es_id)-------------------------------------------------------------------------- \ingroup ASYNC \async_variant_of{H5Dclose}static longH5Dcreate_anon(long loc_id, long type_id, long space_id, long dcpl_id, long dapl_id)-------------------------------------------------------------------------- \ingroup H5D \brief Creates a dataset in a file without linking it into the file structure \fgdta_loc_id \type_id \space_id \dcpl_id \dapl_idstatic longH5Dcreate_async(String app_file, String app_func, int app_line, long loc_id, String name, long type_id, long space_id, long lcpl_id, long dcpl_id, long dapl_id, long es_id)static longH5Dcreate_async(BytePointer app_file, BytePointer app_func, int app_line, long loc_id, BytePointer name, long type_id, long space_id, long lcpl_id, long dcpl_id, long dapl_id, long es_id)-------------------------------------------------------------------------- \ingroup ASYNC \async_variant_of{H5Dcreate}static longH5Dcreate2(long loc_id, String name, long type_id, long space_id, long lcpl_id, long dcpl_id, long dapl_id)static longH5Dcreate2(long loc_id, BytePointer name, long type_id, long space_id, long lcpl_id, long dcpl_id, long dapl_id)-------------------------------------------------------------------------- \ingroup H5D \brief Creates a new dataset and links it into the file \fgdta_loc_idstatic intH5Ddebug(long dset_id)\cond DEVstatic intH5Dfill(Pointer _fill, long fill_type_id, Pointer buf, long buf_type_id, long space_id)-------------------------------------------------------------------------- \ingroup H5D \brief Fills dataspace elements with a fill value in a memory bufferstatic intH5Dflush(long dset_id)-------------------------------------------------------------------------- \ingroup H5D \brief Flushes all buffers associated with a dataset to disk \dset_idstatic intH5Dformat_convert(long dset_id)static intH5Dgather(long src_space_id, Pointer src_buf, long type_id, long dst_buf_size, Pointer dst_buf, H5D_gather_func_t op, Pointer op_data)-------------------------------------------------------------------------- \ingroup H5D \brief Gathers data from a selection within a memory buffer raw data chunk in a datasetstatic longH5Dget_access_plist(long dset_id)-------------------------------------------------------------------------- \ingroup H5D \brief Returns the dataset access property list associated with a dataset \dset_idstatic intH5Dget_chunk_index_type(long did, int[] idx_type)static intH5Dget_chunk_index_type(long did, IntBuffer idx_type)static intH5Dget_chunk_index_type(long did, IntPointer idx_type)static intH5Dget_chunk_info(long dset_id, long fspace_id, long chk_idx, long[] offset, int[] filter_mask, long[] addr, long... size)static intH5Dget_chunk_info(long dset_id, long fspace_id, long chk_idx, LongBuffer offset, IntBuffer filter_mask, LongBuffer addr, LongBuffer size)static intH5Dget_chunk_info(long dset_id, long fspace_id, long chk_idx, LongPointer offset, IntPointer filter_mask, LongPointer addr, LongPointer size)-------------------------------------------------------------------------- \ingroup H5D \brief Retrieves information about a chunk specified by its index \dset_idstatic intH5Dget_chunk_info_by_coord(long dset_id, long[] offset, int[] filter_mask, long[] addr, long... size)static intH5Dget_chunk_info_by_coord(long dset_id, LongBuffer offset, IntBuffer filter_mask, LongBuffer addr, LongBuffer size)static intH5Dget_chunk_info_by_coord(long dset_id, LongPointer offset, IntPointer filter_mask, LongPointer addr, LongPointer size)-------------------------------------------------------------------------- \ingroup H5D \brief Retrieves information about a chunk specified by its coordinates \dset_idstatic intH5Dget_chunk_storage_size(long dset_id, long[] offset, long... chunk_bytes)static intH5Dget_chunk_storage_size(long dset_id, LongBuffer offset, LongBuffer chunk_bytes)static intH5Dget_chunk_storage_size(long dset_id, LongPointer offset, LongPointer chunk_bytes)-------------------------------------------------------------------------- \ingroup H5D \brief Returns the amount of storage allocated within the file for a raw data chunk in a dataset \dset_idstatic longH5Dget_create_plist(long dset_id)-------------------------------------------------------------------------- \ingroup H5D \brief Returns an identifier for a copy of the dataset creation property list for a dataset \dset_idstatic intH5Dget_num_chunks(long dset_id, long fspace_id, long... nchunks)static intH5Dget_num_chunks(long dset_id, long fspace_id, LongBuffer nchunks)static intH5Dget_num_chunks(long dset_id, long fspace_id, LongPointer nchunks)-------------------------------------------------------------------------- \ingroup H5D \brief Retrieves number of chunks that have nonempty intersection with a specified selection \dset_idstatic longH5Dget_offset(long dset_id)-------------------------------------------------------------------------- \ingroup H5D \brief Returns dataset address in file \dset_idstatic longH5Dget_space(long dset_id)-------------------------------------------------------------------------- \ingroup H5D \brief Returns an identifier for a copy of the dataspace for a dataset \dset_idstatic longH5Dget_space_async(String app_file, String app_func, int app_line, long dset_id, long es_id)static longH5Dget_space_async(BytePointer app_file, BytePointer app_func, int app_line, long dset_id, long es_id)-------------------------------------------------------------------------- \ingroup ASYNC \async_variant_of{H5Dget_space}static intH5Dget_space_status(long dset_id, int[] allocation)static intH5Dget_space_status(long dset_id, IntBuffer allocation)static intH5Dget_space_status(long dset_id, IntPointer allocation)-------------------------------------------------------------------------- \ingroup H5D \brief Determines whether space has been allocated for a dataset \dset_idstatic longH5Dget_storage_size(long dset_id)-------------------------------------------------------------------------- \ingroup H5D \brief Returns the amount of storage allocated for a dataset \dset_idstatic longH5Dget_type(long dset_id)-------------------------------------------------------------------------- \ingroup H5D \brief Returns an identifier for a copy of the datatype for a dataset \dset_idstatic intH5Diterate(Pointer buf, long type_id, long space_id, H5D_operator_t op, Pointer operator_data)-------------------------------------------------------------------------- \ingroup H5D \brief Iterates over all selected elements in a dataspacestatic intH5DOappend(long dset_id, long dxpl_id, int axis, long extension, long memtype, Pointer buf)-------------------------------------------------------------------------- \ingroup H5DO \brief Appends data to a dataset along a specified dimension.static intH5dont_atexit()\ingroup H5 \brief Instructs library not to install atexit() cleanup routinestatic longH5Dopen_async(String app_file, String app_func, int app_line, long loc_id, String name, long dapl_id, long es_id)static longH5Dopen_async(BytePointer app_file, BytePointer app_func, int app_line, long loc_id, BytePointer name, long dapl_id, long es_id)-------------------------------------------------------------------------- \ingroup ASYNC \async_variant_of{H5Dopen}static longH5Dopen2(long loc_id, String name, long dapl_id)static longH5Dopen2(long loc_id, BytePointer name, long dapl_id)-------------------------------------------------------------------------- \ingroup H5D \brief Opens an existing dataset \fgdta_loc_idstatic intH5Dread(long dset_id, long mem_type_id, long mem_space_id, long file_space_id, long dxpl_id, Pointer buf)-------------------------------------------------------------------------- \ingroup H5D \brief Reads raw data from a dataset into a provided buffer \dset_id Identifier of the dataset to read fromstatic intH5Dread_async(String app_file, String app_func, int app_line, long dset_id, long mem_type_id, long mem_space_id, long file_space_id, long dxpl_id, Pointer buf, long es_id)static intH5Dread_async(BytePointer app_file, BytePointer app_func, int app_line, long dset_id, long mem_type_id, long mem_space_id, long file_space_id, long dxpl_id, Pointer buf, long es_id)-------------------------------------------------------------------------- \ingroup ASYNC \async_variant_of{H5Dread}static intH5Dread_chunk(long dset_id, long dxpl_id, long[] offset, int[] filters, Pointer buf)static intH5Dread_chunk(long dset_id, long dxpl_id, LongBuffer offset, IntBuffer filters, Pointer buf)static intH5Dread_chunk(long dset_id, long dxpl_id, LongPointer offset, IntPointer filters, Pointer buf)-------------------------------------------------------------------------- \ingroup H5D \brief Reads a raw data chunk directly from a dataset in a file into a buffer \dset_id \dxpl_idstatic intH5Dread_multi(long count, long[] dset_id, long[] mem_type_id, long[] mem_space_id, long[] file_space_id, long dxpl_id, Pointer buf)static intH5Dread_multi(long count, LongBuffer dset_id, LongBuffer mem_type_id, LongBuffer mem_space_id, LongBuffer file_space_id, long dxpl_id, Pointer buf)static intH5Dread_multi(long count, LongPointer dset_id, LongPointer mem_type_id, LongPointer mem_space_id, LongPointer file_space_id, long dxpl_id, Pointer buf)static intH5Dread_multi(long count, LongPointer dset_id, LongPointer mem_type_id, LongPointer mem_space_id, LongPointer file_space_id, long dxpl_id, PointerPointer buf)-------------------------------------------------------------------------- \ingroup H5D \brief Reads raw data from a set of datasets into the provided buffersstatic intH5Dread_multi_async(String app_file, String app_func, int app_line, long count, long[] dset_id, long[] mem_type_id, long[] mem_space_id, long[] file_space_id, long dxpl_id, Pointer buf, long es_id)static intH5Dread_multi_async(String app_file, String app_func, int app_line, long count, LongBuffer dset_id, LongBuffer mem_type_id, LongBuffer mem_space_id, LongBuffer file_space_id, long dxpl_id, Pointer buf, long es_id)static intH5Dread_multi_async(String app_file, String app_func, int app_line, long count, LongPointer dset_id, LongPointer mem_type_id, LongPointer mem_space_id, LongPointer file_space_id, long dxpl_id, Pointer buf, long es_id)static intH5Dread_multi_async(BytePointer app_file, BytePointer app_func, int app_line, long count, long[] dset_id, long[] mem_type_id, long[] mem_space_id, long[] file_space_id, long dxpl_id, Pointer buf, long es_id)static intH5Dread_multi_async(BytePointer app_file, BytePointer app_func, int app_line, long count, LongBuffer dset_id, LongBuffer mem_type_id, LongBuffer mem_space_id, LongBuffer file_space_id, long dxpl_id, Pointer buf, long es_id)static intH5Dread_multi_async(BytePointer app_file, BytePointer app_func, int app_line, long count, LongPointer dset_id, LongPointer mem_type_id, LongPointer mem_space_id, LongPointer file_space_id, long dxpl_id, Pointer buf, long es_id)static intH5Dread_multi_async(BytePointer app_file, BytePointer app_func, int app_line, long count, LongPointer dset_id, LongPointer mem_type_id, LongPointer mem_space_id, LongPointer file_space_id, long dxpl_id, PointerPointer buf, long es_id)-------------------------------------------------------------------------- \ingroup ASYNC \async_variant_of{H5Dread_multi}static intH5Drefresh(long dset_id)-------------------------------------------------------------------------- \ingroup H5D \brief Refreshes all buffers associated with a dataset \dset_idstatic intH5DSattach_scale(long did, long dsid, int idx)-------------------------------------------------------------------------- \ingroup H5DS \brief Attach dimension scale \p dsid to dimension \p idx of dataset did.static intH5Dscatter(H5D_scatter_func_t op, Pointer op_data, long type_id, long dst_space_id, Pointer dst_buf)-------------------------------------------------------------------------- \ingroup H5D \brief Scatters data into a selection within a memory bufferstatic intH5DSdetach_scale(long did, long dsid, int idx)-------------------------------------------------------------------------- \ingroup H5DS \brief Detach dimension scale \p dsid from the dimension \p idx of dataset \p did.static intH5Dset_extent(long dset_id, long... size)static intH5Dset_extent(long dset_id, LongBuffer size)static intH5Dset_extent(long dset_id, LongPointer size)-------------------------------------------------------------------------- \ingroup H5D \brief Changes the sizes of a datasetâs dimensions \dset_idstatic intH5Dset_extent_async(String app_file, String app_func, int app_line, long dset_id, long[] size, long es_id)static intH5Dset_extent_async(String app_file, String app_func, int app_line, long dset_id, LongBuffer size, long es_id)static intH5Dset_extent_async(String app_file, String app_func, int app_line, long dset_id, LongPointer size, long es_id)static intH5Dset_extent_async(BytePointer app_file, BytePointer app_func, int app_line, long dset_id, long[] size, long es_id)static intH5Dset_extent_async(BytePointer app_file, BytePointer app_func, int app_line, long dset_id, LongBuffer size, long es_id)static intH5Dset_extent_async(BytePointer app_file, BytePointer app_func, int app_line, long dset_id, LongPointer size, long es_id)-------------------------------------------------------------------------- \ingroup ASYNC \async_variant_of{H5Dset_extent}static longH5DSget_label(long did, int idx, byte[] label, long size)static longH5DSget_label(long did, int idx, ByteBuffer label, long size)static longH5DSget_label(long did, int idx, BytePointer label, long size)-------------------------------------------------------------------------- \ingroup H5DS \brief Read the label for dimension \p idx of \p did into buffer \p label.static intH5DSget_num_scales(long did, int idx)-------------------------------------------------------------------------- \ingroup H5DS \brief Determines how many Dimension Scales are attached to dimension \p idx of \p did.static longH5DSget_scale_name(long did, byte[] name, long size)static longH5DSget_scale_name(long did, ByteBuffer name, long size)static longH5DSget_scale_name(long did, BytePointer name, long size)-------------------------------------------------------------------------- \ingroup H5DS \brief Retrieves name of scale \p did into buffer \p name.static intH5DSis_attached(long did, long dsid, int idx)-------------------------------------------------------------------------- \ingroup H5DS \brief Report if dimension scale \p dsid is currently attached to dimension \p idx of dataset \p did.static intH5DSis_scale(long did)-------------------------------------------------------------------------- \ingroup H5DS \brief Determines whether \p did is a Dimension Scale.static intH5DSiterate_scales(long did, int dim, int[] idx, H5DS_iterate_t visitor, Pointer visitor_data)static intH5DSiterate_scales(long did, int dim, IntBuffer idx, H5DS_iterate_t visitor, Pointer visitor_data)static intH5DSiterate_scales(long did, int dim, IntPointer idx, H5DS_iterate_t visitor, Pointer visitor_data)-------------------------------------------------------------------------- \ingroup H5DS \brief Iterates the operation visitor through the scales attached to dimension \p dim.static intH5DSset_label(long did, int idx, String label)static intH5DSset_label(long did, int idx, BytePointer label)-------------------------------------------------------------------------- \ingroup H5DS \brief Set label for the dimension \p idx of \p did to the value \p label.static intH5DSset_scale(long dsid, String dimname)static intH5DSset_scale(long dsid, BytePointer dimname)-------------------------------------------------------------------------- \ingroup H5DS \brief Convert dataset \p dsid to a dimension scale, with optional name, \p dimname.static intH5DSwith_new_ref(long obj_id, boolean[] with_new_ref)static intH5DSwith_new_ref(long obj_id, BoolPointer with_new_ref)-------------------------------------------------------------------------- \ingroup H5DS \brief Determines if new references are used with dimension scales.static intH5Dvlen_get_buf_size(long dset_id, long type_id, long space_id, long... size)static intH5Dvlen_get_buf_size(long dset_id, long type_id, long space_id, LongBuffer size)static intH5Dvlen_get_buf_size(long dset_id, long type_id, long space_id, LongPointer size)-------------------------------------------------------------------------- \ingroup H5D \brief Determines the number of bytes required to store variable-length (VL) data \dset_id \type_id \space_idstatic intH5Dwrite(long dset_id, long mem_type_id, long mem_space_id, long file_space_id, long dxpl_id, Pointer buf)-------------------------------------------------------------------------- \ingroup H5D \brief Writes raw data from a buffer to a datasetstatic intH5Dwrite_async(String app_file, String app_func, int app_line, long dset_id, long mem_type_id, long mem_space_id, long file_space_id, long dxpl_id, Pointer buf, long es_id)static intH5Dwrite_async(BytePointer app_file, BytePointer app_func, int app_line, long dset_id, long mem_type_id, long mem_space_id, long file_space_id, long dxpl_id, Pointer buf, long es_id)-------------------------------------------------------------------------- \ingroup ASYNC \async_variant_of{H5Dwrite}static intH5Dwrite_chunk(long dset_id, long dxpl_id, int filters, long[] offset, long data_size, Pointer buf)static intH5Dwrite_chunk(long dset_id, long dxpl_id, int filters, LongBuffer offset, long data_size, Pointer buf)static intH5Dwrite_chunk(long dset_id, long dxpl_id, int filters, LongPointer offset, long data_size, Pointer buf)-------------------------------------------------------------------------- \ingroup H5D \brief Writes a raw data chunk from a buffer directly to a dataset in a file \dset_id \dxpl_idstatic intH5Dwrite_multi(long count, long[] dset_id, long[] mem_type_id, long[] mem_space_id, long[] file_space_id, long dxpl_id, Pointer buf)static intH5Dwrite_multi(long count, LongBuffer dset_id, LongBuffer mem_type_id, LongBuffer mem_space_id, LongBuffer file_space_id, long dxpl_id, Pointer buf)static intH5Dwrite_multi(long count, LongPointer dset_id, LongPointer mem_type_id, LongPointer mem_space_id, LongPointer file_space_id, long dxpl_id, Pointer buf)static intH5Dwrite_multi(long count, LongPointer dset_id, LongPointer mem_type_id, LongPointer mem_space_id, LongPointer file_space_id, long dxpl_id, PointerPointer buf)-------------------------------------------------------------------------- \ingroup H5D \brief Writes raw data from a set buffers to a set of datasetsstatic intH5Dwrite_multi_async(String app_file, String app_func, int app_line, long count, long[] dset_id, long[] mem_type_id, long[] mem_space_id, long[] file_space_id, long dxpl_id, Pointer buf, long es_id)static intH5Dwrite_multi_async(String app_file, String app_func, int app_line, long count, LongBuffer dset_id, LongBuffer mem_type_id, LongBuffer mem_space_id, LongBuffer file_space_id, long dxpl_id, Pointer buf, long es_id)static intH5Dwrite_multi_async(String app_file, String app_func, int app_line, long count, LongPointer dset_id, LongPointer mem_type_id, LongPointer mem_space_id, LongPointer file_space_id, long dxpl_id, Pointer buf, long es_id)static intH5Dwrite_multi_async(BytePointer app_file, BytePointer app_func, int app_line, long count, long[] dset_id, long[] mem_type_id, long[] mem_space_id, long[] file_space_id, long dxpl_id, Pointer buf, long es_id)static intH5Dwrite_multi_async(BytePointer app_file, BytePointer app_func, int app_line, long count, LongBuffer dset_id, LongBuffer mem_type_id, LongBuffer mem_space_id, LongBuffer file_space_id, long dxpl_id, Pointer buf, long es_id)static intH5Dwrite_multi_async(BytePointer app_file, BytePointer app_func, int app_line, long count, LongPointer dset_id, LongPointer mem_type_id, LongPointer mem_space_id, LongPointer file_space_id, long dxpl_id, Pointer buf, long es_id)static intH5Dwrite_multi_async(BytePointer app_file, BytePointer app_func, int app_line, long count, LongPointer dset_id, LongPointer mem_type_id, LongPointer mem_space_id, LongPointer file_space_id, long dxpl_id, PointerPointer buf, long es_id)-------------------------------------------------------------------------- \ingroup ASYNC \async_variant_of{H5Dwrite_multi}static intH5E_DEFAULT()\endcondstatic intH5Eauto_is_v2(long err_stack, int[] is_stack)static intH5Eauto_is_v2(long err_stack, IntBuffer is_stack)static intH5Eauto_is_v2(long err_stack, IntPointer is_stack)-------------------------------------------------------------------------- \ingroup H5E \brief Determines the type of error stack \estack_id{err_stack}static intH5Eclear2(long err_stack)-------------------------------------------------------------------------- \ingroup H5E \brief Clears the specified error stack or the error stack for the current thread \estack_id{err_stack}static intH5Eclose_msg(long err_id)-------------------------------------------------------------------------- \ingroup H5E \brief Closes an error messagestatic intH5Eclose_stack(long stack_id)-------------------------------------------------------------------------- \ingroup H5E \brief Closes an error stack handle \estack_id{stack_id}static longH5Ecreate_msg(long cls, int msg_type, String msg)static longH5Ecreate_msg(long cls, int msg_type, BytePointer msg)-------------------------------------------------------------------------- \ingroup H5E \brief Adds a major error message to an error classstatic longH5Ecreate_stack()-------------------------------------------------------------------------- \ingroup H5E \brief Creates a new, empty error stackstatic intH5Eget_auto2(long estack_id, H5E_auto2_t func, Pointer client_data)static intH5Eget_auto2(long estack_id, H5E_auto2_t func, PointerPointer client_data)-------------------------------------------------------------------------- \ingroup H5E \brief Returns the settings for the automatic error stack traversal function and its data \estack_idstatic longH5Eget_class_name(long class_id, byte[] name, long size)static longH5Eget_class_name(long class_id, ByteBuffer name, long size)static longH5Eget_class_name(long class_id, BytePointer name, long size)-------------------------------------------------------------------------- \ingroup H5E \brief Retrieves error class namestatic longH5Eget_current_stack()-------------------------------------------------------------------------- \ingroup H5E \brief Returns a copy of the current error stackstatic longH5Eget_msg(long msg_id, int[] type, byte[] msg, long size)static longH5Eget_msg(long msg_id, IntBuffer type, ByteBuffer msg, long size)static longH5Eget_msg(long msg_id, IntPointer type, BytePointer msg, long size)-------------------------------------------------------------------------- \ingroup H5E \brief Retrieves an error messagestatic longH5Eget_num(long error_stack_id)-------------------------------------------------------------------------- \ingroup H5E \brief Retrieves the number of error messages in an error stack \estack_id{error_stack_id}static intH5Epop(long err_stack, long count)-------------------------------------------------------------------------- \ingroup H5E \brief Deletes specified number of error messages from the error stack \estack_id{err_stack}static intH5Eprint2(long err_stack, Pointer stream)-------------------------------------------------------------------------- \ingroup H5E \brief Prints the specified error stack in a default manner \estack_id{err_stack}static intH5Epush2(long err_stack, String file, String func, int line, long cls_id, long maj_id, long min_id, String msg)static intH5Epush2(long err_stack, BytePointer file, BytePointer func, int line, long cls_id, long maj_id, long min_id, BytePointer msg)-------------------------------------------------------------------------- \ingroup H5E \brief Pushes a new error record onto an error stack \estack_id{err_stack}.static longH5Eregister_class(String cls_name, String lib_name, String version)static longH5Eregister_class(BytePointer cls_name, BytePointer lib_name, BytePointer version)-------------------------------------------------------------------------- \ingroup H5E \brief Registers a client library or application program to the HDF5 error APIstatic intH5Eset_auto2(long estack_id, H5E_auto2_t func, Pointer client_data)-------------------------------------------------------------------------- \ingroup H5E \brief Turns automatic error printing on or off \estack_idstatic intH5Eset_current_stack(long err_stack_id)-------------------------------------------------------------------------- \ingroup H5E \brief Replaces the current error stack \estack_id{err_stack_id}static intH5ESget_requests(long es_id, int order, long[] connector_ids, Pointer requests, long array_len, SizeTPointer count)static intH5ESget_requests(long es_id, int order, LongBuffer connector_ids, Pointer requests, long array_len, SizeTPointer count)static intH5ESget_requests(long es_id, int order, LongPointer connector_ids, Pointer requests, long array_len, SizeTPointer count)static intH5ESget_requests(long es_id, int order, LongPointer connector_ids, PointerPointer requests, long array_len, SizeTPointer count)static intH5ESinsert_request(long es_id, long connector_id, Pointer request)static intH5Eunregister_class(long class_id)-------------------------------------------------------------------------- \ingroup H5E \brief Removes an error classstatic intH5Ewalk2(long err_stack, int direction, H5E_walk2_t func, Pointer client_data)-------------------------------------------------------------------------- \ingroup H5E \brief Walks the specified error stack, calling the specified function \estack_id{err_stack}static intH5F_ACC_CREAT()Create non-existing filesstatic intH5F_ACC_DEFAULT()Default property list identifier \internal Value passed to H5Pset_elink_acc_flags to cause flags to be taken from the parent file.static intH5F_ACC_EXCL()Fail if file already existsstatic intH5F_ACC_RDONLY()Absence of RDWR: read-onlystatic intH5F_ACC_RDWR()Open for read and writestatic intH5F_ACC_SWMR_READ()Indicate that this file is open for reading in a \ single-writer/multi-reader (SWMR) scenario.static intH5F_ACC_SWMR_WRITE()Indicate that this file is open for writing in a \ single-writer/multi-reader (SWMR) scenario.static intH5F_ACC_TRUNC()Overwrite existing filesstatic intH5F_FAMILY_DEFAULT()static intH5F_UNLIMITED()Unlimited file size for H5Pset_external()static intH5Fclear_elink_file_cache(long file_id)\ingroup H5F \brief Clears the external link open file cache \file_idstatic intH5Fclose(long file_id)\ingroup H5F \brief Terminates access to an HDF5 file \file_idstatic intH5Fclose_async(String app_file, String app_func, int app_line, long file_id, long es_id)static intH5Fclose_async(BytePointer app_file, BytePointer app_func, int app_line, long file_id, long es_id)-------------------------------------------------------------------------- \ingroup ASYNC \async_variant_of{H5Fclose}static longH5Fcreate(String filename, int flags, long fcpl_id, long fapl_id)static longH5Fcreate(BytePointer filename, int flags, long fcpl_id, long fapl_id)\ingroup H5F \brief Creates an HDF5 filestatic longH5Fcreate_async(String app_file, String app_func, int app_line, String filename, int flags, long fcpl_id, long fapl_id, long es_id)static longH5Fcreate_async(BytePointer app_file, BytePointer app_func, int app_line, BytePointer filename, int flags, long fcpl_id, long fapl_id, long es_id)-------------------------------------------------------------------------- \ingroup ASYNC \async_variant_of{H5Fcreate}static intH5FD_CORE()static longH5FD_core_init()static intH5FD_FAMILY()static longH5FD_family_init()static intH5FD_LOG()static longH5FD_log_init()static intH5FD_MULTI()static longH5FD_multi_init()static intH5FD_SEC2()static longH5FD_sec2_init()static intH5FD_STDIO()static longH5FD_stdio_init()static longH5FDalloc(H5FD_t file, int type, long dxpl_id, long size)static intH5FDclose(H5FD_t file)static intH5FDcmp(H5FD_t f1, H5FD_t f2)static intH5FDctl(H5FD_t file, long op_code, long flags, Pointer input, Pointer output)static intH5FDctl(H5FD_t file, long op_code, long flags, Pointer input, PointerPointer output)static intH5FDdelete(String name, long fapl_id)static intH5FDdelete(BytePointer name, long fapl_id)static intH5FDdriver_query(long driver_id, CLongPointer flags)\ingroup H5FD \brief Allows querying a VFD ID for features before the file is openedstatic intH5Fdelete(String filename, long fapl_id)static intH5Fdelete(BytePointer filename, long fapl_id)\ingroup H5F \brief Deletes an HDF5 filestatic intH5FDflush(H5FD_t file, long dxpl_id, boolean closing)static intH5FDfree(H5FD_t file, int type, long dxpl_id, long addr, long size)static longH5FDget_eoa(H5FD_t file, int type)static longH5FDget_eof(H5FD_t file, int type)static intH5FDget_vfd_handle(H5FD_t file, long fapl, Pointer file_handle)static intH5FDget_vfd_handle(H5FD_t file, long fapl, PointerPointer file_handle)static intH5FDis_driver_registered_by_name(String driver_name)static intH5FDis_driver_registered_by_name(BytePointer driver_name)static intH5FDis_driver_registered_by_value(int driver_value)static intH5FDlock(H5FD_t file, boolean rw)static H5FD_tH5FDopen(String name, int flags, long fapl_id, long maxaddr)static H5FD_tH5FDopen(BytePointer name, int flags, long fapl_id, long maxaddr)static longH5FDperform_init(H5FD_init_t op)static intH5FDquery(H5FD_t f, CLongPointer flags)static intH5FDread(H5FD_t file, int type, long dxpl_id, long addr, long size, Pointer buf)static intH5FDread_selection(H5FD_t file, int type, long dxpl_id, int count, long[] mem_spaces, long[] file_spaces, long[] offsets, SizeTPointer element_sizes, Pointer bufs)static intH5FDread_selection(H5FD_t file, int type, long dxpl_id, int count, LongBuffer mem_spaces, LongBuffer file_spaces, LongBuffer offsets, SizeTPointer element_sizes, Pointer bufs)static intH5FDread_selection(H5FD_t file, int type, long dxpl_id, int count, LongPointer mem_spaces, LongPointer file_spaces, LongPointer offsets, SizeTPointer element_sizes, Pointer bufs)static intH5FDread_selection(H5FD_t file, int type, long dxpl_id, int count, LongPointer mem_spaces, LongPointer file_spaces, LongPointer offsets, SizeTPointer element_sizes, PointerPointer bufs)static intH5FDread_vector(H5FD_t file, long dxpl_id, int count, int[] types, long[] addrs, SizeTPointer sizes, Pointer bufs)static intH5FDread_vector(H5FD_t file, long dxpl_id, int count, IntBuffer types, LongBuffer addrs, SizeTPointer sizes, Pointer bufs)static intH5FDread_vector(H5FD_t file, long dxpl_id, int count, IntPointer types, LongPointer addrs, SizeTPointer sizes, Pointer bufs)static intH5FDread_vector(H5FD_t file, long dxpl_id, int count, IntPointer types, LongPointer addrs, SizeTPointer sizes, PointerPointer bufs)static longH5FDregister(H5FD_class_t cls)static intH5FDset_eoa(H5FD_t file, int type, long eoa)static intH5FDtruncate(H5FD_t file, long dxpl_id, boolean closing)static intH5FDunlock(H5FD_t file)static intH5FDunregister(long driver_id)static intH5FDwrite(H5FD_t file, int type, long dxpl_id, long addr, long size, Pointer buf)static intH5FDwrite_selection(H5FD_t file, int type, long dxpl_id, int count, long[] mem_spaces, long[] file_spaces, long[] offsets, SizeTPointer element_sizes, Pointer bufs)static intH5FDwrite_selection(H5FD_t file, int type, long dxpl_id, int count, LongBuffer mem_spaces, LongBuffer file_spaces, LongBuffer offsets, SizeTPointer element_sizes, Pointer bufs)static intH5FDwrite_selection(H5FD_t file, int type, long dxpl_id, int count, LongPointer mem_spaces, LongPointer file_spaces, LongPointer offsets, SizeTPointer element_sizes, Pointer bufs)static intH5FDwrite_selection(H5FD_t file, int type, long dxpl_id, int count, LongPointer mem_spaces, LongPointer file_spaces, LongPointer offsets, SizeTPointer element_sizes, PointerPointer bufs)static intH5FDwrite_vector(H5FD_t file, long dxpl_id, int count, int[] types, long[] addrs, SizeTPointer sizes, Pointer bufs)static intH5FDwrite_vector(H5FD_t file, long dxpl_id, int count, IntBuffer types, LongBuffer addrs, SizeTPointer sizes, Pointer bufs)static intH5FDwrite_vector(H5FD_t file, long dxpl_id, int count, IntPointer types, LongPointer addrs, SizeTPointer sizes, Pointer bufs)static intH5FDwrite_vector(H5FD_t file, long dxpl_id, int count, IntPointer types, LongPointer addrs, SizeTPointer sizes, PointerPointer bufs)static intH5Fflush(long object_id, int scope)\ingroup H5F \brief Flushes all buffers associated with a file to storage \loc_id{object_id}static intH5Fflush_async(String app_file, String app_func, int app_line, long object_id, int scope, long es_id)static intH5Fflush_async(BytePointer app_file, BytePointer app_func, int app_line, long object_id, int scope, long es_id)-------------------------------------------------------------------------- \ingroup ASYNC \async_variant_of{H5Fflush}static intH5Fformat_convert(long fid)\cond DEVstatic longH5Fget_access_plist(long file_id)\ingroup H5F \brief Returns a file access property list identifier \file_idstatic longH5Fget_create_plist(long file_id)\ingroup H5F \brief Returns a file creation property list identifier \file_idstatic intH5Fget_dset_no_attrs_hint(long file_id, boolean[] minimize)static intH5Fget_dset_no_attrs_hint(long file_id, BoolPointer minimize)\ingroup H5F \brief Retrieves the setting for whether or not a file will create minimized dataset object headers \file_idstatic intH5Fget_eoa(long file_id, long... eoa)static intH5Fget_eoa(long file_id, LongBuffer eoa)static intH5Fget_eoa(long file_id, LongPointer eoa)\ingroup H5F \brief Retrieves the file's end-of-allocation (EOA) \file_idstatic longH5Fget_file_image(long file_id, Pointer buf_ptr, long buf_len)\ingroup H5F \brief Retrieves a copy of the image of an existing, open file \file_idstatic intH5Fget_fileno(long file_id, CLongPointer fileno)\ingroup H5F \brief Retrieves a file's file number that uniquely identifies an open file \file_idstatic intH5Fget_filesize(long file_id, long... size)static intH5Fget_filesize(long file_id, LongBuffer size)static intH5Fget_filesize(long file_id, LongPointer size)\ingroup H5F \brief Returns the size of an HDF5 file (in bytes) \file_idstatic longH5Fget_free_sections(long file_id, int type, long nsects, H5F_sect_info_t sect_info)\ingroup H5F \brief Retrieves free-space section information for a file \file_idstatic longH5Fget_freespace(long file_id)\ingroup H5F \brief Returns the amount of free space in a file (in bytes) \file_idstatic intH5Fget_info2(long obj_id, H5F_info2_t file_info)\ingroup H5F \brief Retrieves name of file to which object belongs \fgdta_obj_idstatic intH5Fget_intent(long file_id, int[] intent)static intH5Fget_intent(long file_id, IntBuffer intent)static intH5Fget_intent(long file_id, IntPointer intent)\ingroup H5F \brief Determines the read/write or read-only status of a file \file_idstatic intH5Fget_mdc_config(long file_id, H5AC_cache_config_t config_ptr)\ingroup MDC \brief Obtains current metadata cache configuration for target file \file_idstatic intH5Fget_mdc_hit_rate(long file_id, double[] hit_rate_ptr)static intH5Fget_mdc_hit_rate(long file_id, DoubleBuffer hit_rate_ptr)static intH5Fget_mdc_hit_rate(long file_id, DoublePointer hit_rate_ptr)\ingroup MDC \brief Obtains target file's metadata cache hit rate \file_idstatic intH5Fget_mdc_image_info(long file_id, long[] image_addr, long... image_size)static intH5Fget_mdc_image_info(long file_id, LongBuffer image_addr, LongBuffer image_size)static intH5Fget_mdc_image_info(long file_id, LongPointer image_addr, LongPointer image_size)\ingroup MDC \brief Obtains information about a cache image if it exists \file_idstatic intH5Fget_mdc_logging_status(long file_id, boolean[] is_enabled, boolean[] is_currently_logging)static intH5Fget_mdc_logging_status(long file_id, BoolPointer is_enabled, BoolPointer is_currently_logging)\ingroup MDC \brief Gets the current metadata cache logging status \file_idstatic intH5Fget_mdc_size(long file_id, SizeTPointer max_size_ptr, SizeTPointer min_clean_size_ptr, SizeTPointer cur_size_ptr, int[] cur_num_entries_ptr)static intH5Fget_mdc_size(long file_id, SizeTPointer max_size_ptr, SizeTPointer min_clean_size_ptr, SizeTPointer cur_size_ptr, IntBuffer cur_num_entries_ptr)static intH5Fget_mdc_size(long file_id, SizeTPointer max_size_ptr, SizeTPointer min_clean_size_ptr, SizeTPointer cur_size_ptr, IntPointer cur_num_entries_ptr)\ingroup MDC \brief Obtains current metadata cache size data for specified file \file_idstatic intH5Fget_metadata_read_retry_info(long file_id, H5F_retry_info_t info)\ingroup SWMR \brief Retrieves the collection of read retries for metadata entries with checksum \file_idstatic longH5Fget_name(long obj_id, byte[] name, long size)static longH5Fget_name(long obj_id, ByteBuffer name, long size)static longH5Fget_name(long obj_id, BytePointer name, long size)\ingroup H5F \brief Retrieves name of file to which object belongs \obj_idstatic longH5Fget_obj_count(long file_id, int types)\ingroup H5F \brief Returns the number of open object identifiers for an open file \file_id or #H5F_OBJ_ALL for all currently-open HDF5 filesstatic longH5Fget_obj_ids(long file_id, int types, long max_objs, long... obj_id_list)static longH5Fget_obj_ids(long file_id, int types, long max_objs, LongBuffer obj_id_list)static longH5Fget_obj_ids(long file_id, int types, long max_objs, LongPointer obj_id_list)------------------------------------------------------------------------- \ingroup H5F \brief Returns a list of open object identifiers \file_id or #H5F_OBJ_ALL for all currently-open HDF5 filesstatic intH5Fget_page_buffering_stats(long file_id, int[] accesses, int[] hits, int[] misses, int[] evictions, int[] bypasses)static intH5Fget_page_buffering_stats(long file_id, IntBuffer accesses, IntBuffer hits, IntBuffer misses, IntBuffer evictions, IntBuffer bypasses)static intH5Fget_page_buffering_stats(long file_id, IntPointer accesses, IntPointer hits, IntPointer misses, IntPointer evictions, IntPointer bypasses)\ingroup H5F \brief Retrieves statistics about page access when it is enabled \file_idstatic intH5Fget_vfd_handle(long file_id, long fapl, Pointer file_handle)static intH5Fget_vfd_handle(long file_id, long fapl, PointerPointer file_handle)\ingroup H5F \brief Returns pointer to the file handle from the virtual file driver \file_id \fapl_id{fapl}static intH5Fincrement_filesize(long file_id, long increment)\ingroup H5F \brief Sets the file' EOA to the maximum of (EOA, EOF) + increment \file_idstatic intH5Fis_accessible(String container_name, long fapl_id)static intH5Fis_accessible(BytePointer container_name, long fapl_id)\ingroup H5F \brief Checks if a file can be opened with a given file access property liststatic intH5Fmount(long loc, String name, long child, long plist)static intH5Fmount(long loc, BytePointer name, long child, long plist)\ingroup H5F \brief Mounts an HDF5 file \loc_id{loc}static longH5Fopen(String filename, int flags, long fapl_id)static longH5Fopen(BytePointer filename, int flags, long fapl_id)\ingroup H5F \brief Opens an existing HDF5 filestatic longH5Fopen_async(String app_file, String app_func, int app_line, String filename, int flags, long access_plist, long es_id)static longH5Fopen_async(BytePointer app_file, BytePointer app_func, int app_line, BytePointer filename, int flags, long access_plist, long es_id)-------------------------------------------------------------------------- \ingroup ASYNC \async_variant_of{H5Fopen}static intH5free_memory(Pointer mem)\ingroup H5 \brief Frees memory allocated by the HDF5 librarystatic longH5Freopen(long file_id)\ingroup H5F \brief Returns a new identifier for a previously-opened HDF5 filestatic longH5Freopen_async(String app_file, String app_func, int app_line, long file_id, long es_id)static longH5Freopen_async(BytePointer app_file, BytePointer app_func, int app_line, long file_id, long es_id)-------------------------------------------------------------------------- \ingroup ASYNC \async_variant_of{H5Freopen}static intH5Freset_mdc_hit_rate_stats(long file_id)\ingroup MDC \brief Resets hit rate statistics counters for the target file \file_idstatic intH5Freset_page_buffering_stats(long file_id)\ingroup H5F \brief Resets the page buffer statistics \file_idstatic intH5Fset_dset_no_attrs_hint(long file_id, boolean minimize)\ingroup H5F \brief Sets the flag to create minimized dataset object headers \file_idstatic intH5Fset_libver_bounds(long file_id, int low, int high)\ingroup H5F \brief Enables the switch of version bounds setting for a file \file_idstatic intH5Fset_mdc_config(long file_id, H5AC_cache_config_t config_ptr)\ingroup MDC \brief Attempts to configure metadata cache of target file \file_idstatic intH5Fstart_mdc_logging(long file_id)\ingroup MDC \brief Starts logging metadata cache events if logging was previously enabled \file_idstatic intH5Fstart_swmr_write(long file_id)\ingroup SWMR \brief Retrieves free-space section information for a file \file_idstatic intH5Fstop_mdc_logging(long file_id)\ingroup MDC \brief Stops logging metadata cache events if logging was previously enabled and is currently ongoing \file_idstatic intH5Funmount(long loc, String name)static intH5Funmount(long loc, BytePointer name)\ingroup H5F \brief Unounts an HDF5 file \loc_id{loc}static intH5garbage_collect()\ingroup H5 \brief Garbage collects on all free-lists of all typesstatic intH5Gclose(long group_id)------------------------------------------------------------------------- \ingroup H5G \brief Closes the specified group \group_idstatic intH5Gclose_async(String app_file, String app_func, int app_line, long group_id, long es_id)static intH5Gclose_async(BytePointer app_file, BytePointer app_func, int app_line, long group_id, long es_id)-------------------------------------------------------------------------- \ingroup ASYNC \async_variant_of{H5Gclose}static longH5Gcreate_anon(long loc_id, long gcpl_id, long gapl_id)------------------------------------------------------------------------- \ingroup H5G \brief Creates a new empty group without linking it into the file structure \fgdta_loc_id \gcpl_id \gapl_idstatic longH5Gcreate_async(String app_file, String app_func, int app_line, long loc_id, String name, long lcpl_id, long gcpl_id, long gapl_id, long es_id)static longH5Gcreate_async(BytePointer app_file, BytePointer app_func, int app_line, long loc_id, BytePointer name, long lcpl_id, long gcpl_id, long gapl_id, long es_id)-------------------------------------------------------------------------- \ingroup ASYNC \async_variant_of{H5Gcreate}static longH5Gcreate2(long loc_id, String name, long lcpl_id, long gcpl_id, long gapl_id)static longH5Gcreate2(long loc_id, BytePointer name, long lcpl_id, long gcpl_id, long gapl_id)------------------------------------------------------------------------- \ingroup H5G \brief Creates a new group and links it into the file \fgdta_loc_idstatic intH5get_free_list_sizes(SizeTPointer reg_size, SizeTPointer arr_size, SizeTPointer blk_size, SizeTPointer fac_size)\ingroup H5 \brief Gets the current size of the free lists used to manage memorystatic intH5get_libversion(int[] majnum, int[] minnum, int[] relnum)static intH5get_libversion(IntBuffer majnum, IntBuffer minnum, IntBuffer relnum)static intH5get_libversion(IntPointer majnum, IntPointer minnum, IntPointer relnum)\ingroup H5 \brief Returns the HDF library release numberstatic intH5Gflush(long group_id)------------------------------------------------------------------------- \ingroup H5G \brief Flushes all buffers associated with a group to disk \group_idstatic longH5Gget_create_plist(long group_id)------------------------------------------------------------------------- \ingroup H5G \brief Gets a group creation property list identifier \group_idstatic intH5Gget_info(long loc_id, H5G_info_t ginfo)------------------------------------------------------------------------- \ingroup H5G \brief Retrieves information about a group \fgdta_loc_idstatic intH5Gget_info_async(String app_file, String app_func, int app_line, long loc_id, H5G_info_t ginfo, long es_id)static intH5Gget_info_async(BytePointer app_file, BytePointer app_func, int app_line, long loc_id, H5G_info_t ginfo, long es_id)-------------------------------------------------------------------------- \ingroup ASYNC \async_variant_of{H5Gget_info}static intH5Gget_info_by_idx(long loc_id, String group_name, int idx_type, int order, long n, H5G_info_t ginfo, long lapl_id)static intH5Gget_info_by_idx(long loc_id, BytePointer group_name, int idx_type, int order, long n, H5G_info_t ginfo, long lapl_id)------------------------------------------------------------------------- \ingroup H5G \brief Retrieves information about a group, according to the groupâs position within an index \fgdta_loc_idstatic intH5Gget_info_by_idx_async(String app_file, String app_func, int app_line, long loc_id, String group_name, int idx_type, int order, long n, H5G_info_t ginfo, long lapl_id, long es_id)static intH5Gget_info_by_idx_async(BytePointer app_file, BytePointer app_func, int app_line, long loc_id, BytePointer group_name, int idx_type, int order, long n, H5G_info_t ginfo, long lapl_id, long es_id)-------------------------------------------------------------------------- \ingroup ASYNC \async_variant_of{H5Gget_info_by_idx}static intH5Gget_info_by_name(long loc_id, String name, H5G_info_t ginfo, long lapl_id)static intH5Gget_info_by_name(long loc_id, BytePointer name, H5G_info_t ginfo, long lapl_id)------------------------------------------------------------------------- \ingroup H5G \brief Retrieves information about a group by its name \fgdta_loc_idstatic intH5Gget_info_by_name_async(String app_file, String app_func, int app_line, long loc_id, String name, H5G_info_t ginfo, long lapl_id, long es_id)static intH5Gget_info_by_name_async(BytePointer app_file, BytePointer app_func, int app_line, long loc_id, BytePointer name, H5G_info_t ginfo, long lapl_id, long es_id)-------------------------------------------------------------------------- \ingroup ASYNC \async_variant_of{H5Gget_info_by_name}static longH5Gopen_async(String app_file, String app_func, int app_line, long loc_id, String name, long gapl_id, long es_id)static longH5Gopen_async(BytePointer app_file, BytePointer app_func, int app_line, long loc_id, BytePointer name, long gapl_id, long es_id)-------------------------------------------------------------------------- \ingroup ASYNC \async_variant_of{H5Gopen}static longH5Gopen2(long loc_id, String name, long gapl_id)static longH5Gopen2(long loc_id, BytePointer name, long gapl_id)------------------------------------------------------------------------- \ingroup H5G \brief Opens an existing group in a file \fgdta_loc_idstatic intH5Grefresh(long group_id)------------------------------------------------------------------------- \ingroup H5G \brief Refreshes all buffers associated with a group \group_idstatic intH5Iclear_type(int type, boolean force)\ingroup H5IUD \brief Deletes all identifiers of the given typestatic intH5Idec_ref(long id)\ingroup H5I \brief Decrements the reference count for an object \obj_id{id}static intH5Idec_type_ref(int type)\ingroup H5IUD \brief Decrements the reference count on an identifier typestatic intH5Idestroy_type(int type)\ingroup H5IUD \brief Removes an identifier type and all identifiers within that typestatic longH5Iget_file_id(long id)\ingroup H5I \brief Retrieves an identifier for the file containing the specified object \obj_id{id}static longH5Iget_name(long id, byte[] name, long size)static longH5Iget_name(long id, ByteBuffer name, long size)static longH5Iget_name(long id, BytePointer name, long size)\ingroup H5I \brief Retrieves a name of an object based on the object identifier \obj_id{id}static intH5Iget_ref(long id)\ingroup H5I \brief Retrieves the reference count for an object \obj_id{id}static intH5Iget_type(long id)\ingroup H5I \brief Retrieves the type of an object \obj_id{id}static intH5Iget_type_ref(int type)\ingroup H5IUD \brief Retrieves the reference count on an ID typestatic intH5Iinc_ref(long id)\ingroup H5I \brief Increments the reference count for an object \obj_id{id}static intH5Iinc_type_ref(int type)\ingroup H5IUD \brief Increments the reference count on an ID typestatic intH5Iis_valid(long id)\ingroup H5I \brief Determines whether an identifier is valid \obj_id{id}static intH5Iiterate(int type, H5I_iterate_func_t op, Pointer op_data)\ingroup H5IUD \brief Calls a callback for each member of the identifier type specifiedstatic intH5IMget_image_info(long loc_id, String dset_name, long[] width, long[] height, long[] planes, byte[] interlace, long... npals)static intH5IMget_image_info(long loc_id, String dset_name, LongBuffer width, LongBuffer height, LongBuffer planes, ByteBuffer interlace, LongBuffer npals)static intH5IMget_image_info(long loc_id, String dset_name, LongPointer width, LongPointer height, LongPointer planes, BytePointer interlace, LongPointer npals)static intH5IMget_image_info(long loc_id, BytePointer dset_name, long[] width, long[] height, long[] planes, byte[] interlace, long... npals)static intH5IMget_image_info(long loc_id, BytePointer dset_name, LongBuffer width, LongBuffer height, LongBuffer planes, ByteBuffer interlace, LongBuffer npals)static intH5IMget_image_info(long loc_id, BytePointer dset_name, LongPointer width, LongPointer height, LongPointer planes, BytePointer interlace, LongPointer npals)------------------------------------------------------------------------- \ingroup H5IM \brief Gets information about an image dataset (dimensions, interlace mode and number of associated palettes).static intH5IMget_npalettes(long loc_id, String image_name, long... npals)static intH5IMget_npalettes(long loc_id, String image_name, LongBuffer npals)static intH5IMget_npalettes(long loc_id, String image_name, LongPointer npals)static intH5IMget_npalettes(long loc_id, BytePointer image_name, long... npals)static intH5IMget_npalettes(long loc_id, BytePointer image_name, LongBuffer npals)static intH5IMget_npalettes(long loc_id, BytePointer image_name, LongPointer npals)-------------------------------------------------------------------------- \ingroup H5IM \brief Gets the number of palettes associated to an image.static intH5IMget_palette(long loc_id, String image_name, int pal_number, byte[] pal_data)static intH5IMget_palette(long loc_id, String image_name, int pal_number, ByteBuffer pal_data)static intH5IMget_palette(long loc_id, String image_name, int pal_number, BytePointer pal_data)static intH5IMget_palette(long loc_id, BytePointer image_name, int pal_number, byte[] pal_data)static intH5IMget_palette(long loc_id, BytePointer image_name, int pal_number, ByteBuffer pal_data)static intH5IMget_palette(long loc_id, BytePointer image_name, int pal_number, BytePointer pal_data)-------------------------------------------------------------------------- \ingroup H5IM \brief Gets the palette dataset.static intH5IMget_palette_info(long loc_id, String image_name, int pal_number, long... pal_dims)static intH5IMget_palette_info(long loc_id, String image_name, int pal_number, LongBuffer pal_dims)static intH5IMget_palette_info(long loc_id, String image_name, int pal_number, LongPointer pal_dims)static intH5IMget_palette_info(long loc_id, BytePointer image_name, int pal_number, long... pal_dims)static intH5IMget_palette_info(long loc_id, BytePointer image_name, int pal_number, LongBuffer pal_dims)static intH5IMget_palette_info(long loc_id, BytePointer image_name, int pal_number, LongPointer pal_dims)-------------------------------------------------------------------------- \ingroup H5IM \brief Gets information about a palette dataset (dimensions).static intH5IMis_image(long loc_id, String dset_name)static intH5IMis_image(long loc_id, BytePointer dset_name)-------------------------------------------------------------------------- \ingroup H5IM \brief Inquires if a dataset is an image.static intH5IMis_palette(long loc_id, String dset_name)static intH5IMis_palette(long loc_id, BytePointer dset_name)-------------------------------------------------------------------------- \ingroup H5IM \brief Inquires if a dataset is a palette \fg_loc_idstatic intH5IMlink_palette(long loc_id, String image_name, String pal_name)static intH5IMlink_palette(long loc_id, BytePointer image_name, BytePointer pal_name)-------------------------------------------------------------------------- \ingroup H5IM \brief Attaches a palette to an image.static intH5IMmake_image_24bit(long loc_id, String dset_name, long width, long height, String interlace, byte[] buffer)static intH5IMmake_image_24bit(long loc_id, String dset_name, long width, long height, String interlace, ByteBuffer buffer)static intH5IMmake_image_24bit(long loc_id, String dset_name, long width, long height, String interlace, BytePointer buffer)static intH5IMmake_image_24bit(long loc_id, BytePointer dset_name, long width, long height, BytePointer interlace, byte[] buffer)static intH5IMmake_image_24bit(long loc_id, BytePointer dset_name, long width, long height, BytePointer interlace, ByteBuffer buffer)static intH5IMmake_image_24bit(long loc_id, BytePointer dset_name, long width, long height, BytePointer interlace, BytePointer buffer)-------------------------------------------------------------------------- \ingroup H5IM \brief Creates and writes a true color image.static intH5IMmake_image_8bit(long loc_id, String dset_name, long width, long height, byte[] buffer)static intH5IMmake_image_8bit(long loc_id, String dset_name, long width, long height, ByteBuffer buffer)static intH5IMmake_image_8bit(long loc_id, String dset_name, long width, long height, BytePointer buffer)static intH5IMmake_image_8bit(long loc_id, BytePointer dset_name, long width, long height, byte[] buffer)static intH5IMmake_image_8bit(long loc_id, BytePointer dset_name, long width, long height, ByteBuffer buffer)static intH5IMmake_image_8bit(long loc_id, BytePointer dset_name, long width, long height, BytePointer buffer)-------------------------------------------------------------------------- \ingroup H5IM \brief Creates and writes an image.static intH5IMmake_palette(long loc_id, String pal_name, long[] pal_dims, byte[] pal_data)static intH5IMmake_palette(long loc_id, String pal_name, LongBuffer pal_dims, ByteBuffer pal_data)static intH5IMmake_palette(long loc_id, String pal_name, LongPointer pal_dims, BytePointer pal_data)static intH5IMmake_palette(long loc_id, BytePointer pal_name, long[] pal_dims, byte[] pal_data)static intH5IMmake_palette(long loc_id, BytePointer pal_name, LongBuffer pal_dims, ByteBuffer pal_data)static intH5IMmake_palette(long loc_id, BytePointer pal_name, LongPointer pal_dims, BytePointer pal_data)-------------------------------------------------------------------------- \ingroup H5IM \brief Creates and writes a palette.static intH5IMread_image(long loc_id, String dset_name, byte[] buffer)static intH5IMread_image(long loc_id, String dset_name, ByteBuffer buffer)static intH5IMread_image(long loc_id, String dset_name, BytePointer buffer)static intH5IMread_image(long loc_id, BytePointer dset_name, byte[] buffer)static intH5IMread_image(long loc_id, BytePointer dset_name, ByteBuffer buffer)static intH5IMread_image(long loc_id, BytePointer dset_name, BytePointer buffer)-------------------------------------------------------------------------- \ingroup H5IM \brief Reads image data from disk.static intH5IMunlink_palette(long loc_id, String image_name, String pal_name)static intH5IMunlink_palette(long loc_id, BytePointer image_name, BytePointer pal_name)-------------------------------------------------------------------------- \ingroup H5IM \brief Dettaches a palette from an image.static intH5Inmembers(int type, long... num_members)static intH5Inmembers(int type, LongBuffer num_members)static intH5Inmembers(int type, LongPointer num_members)\ingroup H5IUD \brief Returns the number of identifiers in a given identifier typestatic PointerH5Iobject_verify(long id, int type)\ingroup H5IUD \brief Returns the object referenced by an IDstatic longH5Iregister(int type, Pointer object)\ingroup H5IUD \brief Registers an object under a type and returns an ID for itstatic longH5Iregister_future(int type, Pointer object, H5I_future_realize_func_t realize_cb, H5I_future_discard_func_t discard_cb)\ingroup H5I \brief Registers a "future" object under a type and returns an ID for itstatic intH5Iregister_type(long hash_size, int reserved, H5I_free_t free_func)\ingroup H5IUD \brief Creates and returns a new ID typestatic PointerH5Iremove_verify(long id, int type)\ingroup H5IUD \brief Removes an ID from its typestatic intH5is_library_terminating(boolean[] is_terminating)static intH5is_library_terminating(BoolPointer is_terminating)\ingroup H5 \brief Checks whether the HDF5 library is closing.static intH5is_library_threadsafe(boolean[] is_ts)static intH5is_library_threadsafe(BoolPointer is_ts)\ingroup H5 \brief Determines whether the HDF5 library was built with the thread-safety feature enabledstatic PointerH5Isearch(int type, H5I_search_func_t func, Pointer key)\ingroup H5IUD \brief Finds the memory referred to by an ID within the given ID type such that some criterion is satisfiedstatic intH5Itype_exists(int type)\ingroup H5IUD \brief Determines whether an identifier type is registeredstatic intH5L_MAX_LINK_NAME_LEN()\brief Maximum length of a link's name The maximum length of a link's name is encoded in a 32-bit unsigned integer.static intH5L_SAME_LOC()\brief Macro to indicate operation occurs on same locationstatic intH5Lcopy(long src_loc, String src_name, long dst_loc, String dst_name, long lcpl_id, long lapl_id)static intH5Lcopy(long src_loc, BytePointer src_name, long dst_loc, BytePointer dst_name, long lcpl_id, long lapl_id)\ingroup H5L \brief Creates an identical copy of a link with the same creation time and target.static intH5Lcreate_external(String file_name, String obj_name, long link_loc_id, String link_name, long lcpl_id, long lapl_id)static intH5Lcreate_external(BytePointer file_name, BytePointer obj_name, long link_loc_id, BytePointer link_name, long lcpl_id, long lapl_id)\ingroup H5L \brief Creates an external link, a soft link to an object in a different file.static intH5Lcreate_hard(long cur_loc, String cur_name, long dst_loc, String dst_name, long lcpl_id, long lapl_id)static intH5Lcreate_hard(long cur_loc, BytePointer cur_name, long dst_loc, BytePointer dst_name, long lcpl_id, long lapl_id)\ingroup H5L \brief Creates a hard link to an object \fgdta_loc_id{cur_loc}static intH5Lcreate_hard_async(String app_file, String app_func, int app_line, long cur_loc_id, String cur_name, long new_loc_id, String new_name, long lcpl_id, long lapl_id, long es_id)static intH5Lcreate_hard_async(BytePointer app_file, BytePointer app_func, int app_line, long cur_loc_id, BytePointer cur_name, long new_loc_id, BytePointer new_name, long lcpl_id, long lapl_id, long es_id)-------------------------------------------------------------------------- \ingroup ASYNC \async_variant_of{H5Lcreate_hard}static intH5Lcreate_soft(String link_target, long link_loc_id, String link_name, long lcpl_id, long lapl_id)static intH5Lcreate_soft(BytePointer link_target, long link_loc_id, BytePointer link_name, long lcpl_id, long lapl_id)\ingroup H5L \brief Creates a soft linkstatic intH5Lcreate_soft_async(String app_file, String app_func, int app_line, String link_target, long link_loc_id, String link_name, long lcpl_id, long lapl_id, long es_id)static intH5Lcreate_soft_async(BytePointer app_file, BytePointer app_func, int app_line, BytePointer link_target, long link_loc_id, BytePointer link_name, long lcpl_id, long lapl_id, long es_id)-------------------------------------------------------------------------- \ingroup ASYNC \async_variant_of{H5Lcreate_soft}static intH5Lcreate_ud(long link_loc_id, String link_name, int link_type, Pointer udata, long udata_size, long lcpl_id, long lapl_id)static intH5Lcreate_ud(long link_loc_id, BytePointer link_name, int link_type, Pointer udata, long udata_size, long lcpl_id, long lapl_id)\ingroup H5L \brief Creates a link of a user-defined type \loc_id{link_loc_id}static intH5Ldelete(long loc_id, String name, long lapl_id)static intH5Ldelete(long loc_id, BytePointer name, long lapl_id)\ingroup H5L \brief Removes a link from a group \fgdta_loc_idstatic intH5Ldelete_async(String app_file, String app_func, int app_line, long loc_id, String name, long lapl_id, long es_id)static intH5Ldelete_async(BytePointer app_file, BytePointer app_func, int app_line, long loc_id, BytePointer name, long lapl_id, long es_id)-------------------------------------------------------------------------- \ingroup ASYNC \async_variant_of{H5Ldelete}static intH5Ldelete_by_idx(long loc_id, String group_name, int idx_type, int order, long n, long lapl_id)static intH5Ldelete_by_idx(long loc_id, BytePointer group_name, int idx_type, int order, long n, long lapl_id)\ingroup H5L \brief Removes the \Emph{n}-th link in a group \fgdta_loc_idstatic intH5Ldelete_by_idx_async(String app_file, String app_func, int app_line, long loc_id, String group_name, int idx_type, int order, long n, long lapl_id, long es_id)static intH5Ldelete_by_idx_async(BytePointer app_file, BytePointer app_func, int app_line, long loc_id, BytePointer group_name, int idx_type, int order, long n, long lapl_id, long es_id)-------------------------------------------------------------------------- \ingroup ASYNC \async_variant_of{H5Ldelete_by_idx}static intH5LDget_dset_dims(long did, long... cur_dims)static intH5LDget_dset_dims(long did, LongBuffer cur_dims)static intH5LDget_dset_dims(long did, LongPointer cur_dims)------------------------------------------------------------------------- \ingroup H5LT \brief Retrieves the current dimension sizes of a dataset.static intH5LDget_dset_elmts(long did, long[] prev_dims, long[] cur_dims, String fields, Pointer buf)static intH5LDget_dset_elmts(long did, long[] prev_dims, long[] cur_dims, BytePointer fields, Pointer buf)static intH5LDget_dset_elmts(long did, LongBuffer prev_dims, LongBuffer cur_dims, String fields, Pointer buf)static intH5LDget_dset_elmts(long did, LongBuffer prev_dims, LongBuffer cur_dims, BytePointer fields, Pointer buf)static intH5LDget_dset_elmts(long did, LongPointer prev_dims, LongPointer cur_dims, String fields, Pointer buf)static intH5LDget_dset_elmts(long did, LongPointer prev_dims, LongPointer cur_dims, BytePointer fields, Pointer buf)------------------------------------------------------------------------- \ingroup H5LT \brief Retrieves selected data from the datasetstatic longH5LDget_dset_type_size(long did, String fields)static longH5LDget_dset_type_size(long did, BytePointer fields)------------------------------------------------------------------------- \ingroup H5LT \brief Returns the size in bytes of the datasetâs datatypestatic intH5Lexists(long loc_id, String name, long lapl_id)static intH5Lexists(long loc_id, BytePointer name, long lapl_id)\ingroup H5L \brief Determines whether a link with the specified name exists in a group \fgdta_loc_idstatic intH5Lexists_async(String app_file, String app_func, int app_line, long loc_id, String name, boolean[] exists, long lapl_id, long es_id)static intH5Lexists_async(BytePointer app_file, BytePointer app_func, int app_line, long loc_id, BytePointer name, BoolPointer exists, long lapl_id, long es_id)-------------------------------------------------------------------------- \ingroup ASYNC \async_variant_of{H5Lexists}static intH5Lget_info_by_idx2(long loc_id, String group_name, int idx_type, int order, long n, H5L_info2_t linfo, long lapl_id)static intH5Lget_info_by_idx2(long loc_id, BytePointer group_name, int idx_type, int order, long n, H5L_info2_t linfo, long lapl_id)\ingroup H5L \brief Retrieves metadata for a link in a group, according to the order within a field or index \loc_idstatic intH5Lget_info2(long loc_id, String name, H5L_info2_t linfo, long lapl_id)static intH5Lget_info2(long loc_id, BytePointer name, H5L_info2_t linfo, long lapl_id)\ingroup H5L \brief Returns information about a link \fgdta_loc_idstatic longH5Lget_name_by_idx(long loc_id, String group_name, int idx_type, int order, long n, byte[] name, long size, long lapl_id)static longH5Lget_name_by_idx(long loc_id, String group_name, int idx_type, int order, long n, ByteBuffer name, long size, long lapl_id)static longH5Lget_name_by_idx(long loc_id, String group_name, int idx_type, int order, long n, BytePointer name, long size, long lapl_id)static longH5Lget_name_by_idx(long loc_id, BytePointer group_name, int idx_type, int order, long n, byte[] name, long size, long lapl_id)static longH5Lget_name_by_idx(long loc_id, BytePointer group_name, int idx_type, int order, long n, ByteBuffer name, long size, long lapl_id)static longH5Lget_name_by_idx(long loc_id, BytePointer group_name, int idx_type, int order, long n, BytePointer name, long size, long lapl_id)\ingroup H5L \brief Retrieves name of the \Emph{n}-th link in a group, according to the order within a specified field or index \loc_idstatic intH5Lget_val(long loc_id, String name, Pointer buf, long size, long lapl_id)static intH5Lget_val(long loc_id, BytePointer name, Pointer buf, long size, long lapl_id)\ingroup H5L \brief Returns the value of a link \fgdta_loc_idstatic intH5Lget_val_by_idx(long loc_id, String group_name, int idx_type, int order, long n, Pointer buf, long size, long lapl_id)static intH5Lget_val_by_idx(long loc_id, BytePointer group_name, int idx_type, int order, long n, Pointer buf, long size, long lapl_id)\ingroup H5L \brief Retrieves value of the \Emph{n}-th link in a group, according to the order within an index \fgdta_loc_idstatic intH5Lis_registered(int id)\ingroup H5LA \brief Determines whether a class of user-defined links is registeredstatic intH5Literate_async(String app_file, String app_func, int app_line, long group_id, int idx_type, int order, long[] idx_p, H5L_iterate2_t op, Pointer op_data, long es_id)static intH5Literate_async(String app_file, String app_func, int app_line, long group_id, int idx_type, int order, LongBuffer idx_p, H5L_iterate2_t op, Pointer op_data, long es_id)static intH5Literate_async(String app_file, String app_func, int app_line, long group_id, int idx_type, int order, LongPointer idx_p, H5L_iterate2_t op, Pointer op_data, long es_id)static intH5Literate_async(BytePointer app_file, BytePointer app_func, int app_line, long group_id, int idx_type, int order, long[] idx_p, H5L_iterate2_t op, Pointer op_data, long es_id)static intH5Literate_async(BytePointer app_file, BytePointer app_func, int app_line, long group_id, int idx_type, int order, LongBuffer idx_p, H5L_iterate2_t op, Pointer op_data, long es_id)static intH5Literate_async(BytePointer app_file, BytePointer app_func, int app_line, long group_id, int idx_type, int order, LongPointer idx_p, H5L_iterate2_t op, Pointer op_data, long es_id)-------------------------------------------------------------------------- \ingroup ASYNC \warning The returned value of the callback routine op will not be set in the return value for H5Literate_async(), so the \p herr_t value should not be used for determining the return state of the callback routine.static intH5Literate_by_name2(long loc_id, String group_name, int idx_type, int order, long[] idx, H5L_iterate2_t op, Pointer op_data, long lapl_id)static intH5Literate_by_name2(long loc_id, String group_name, int idx_type, int order, LongBuffer idx, H5L_iterate2_t op, Pointer op_data, long lapl_id)static intH5Literate_by_name2(long loc_id, String group_name, int idx_type, int order, LongPointer idx, H5L_iterate2_t op, Pointer op_data, long lapl_id)static intH5Literate_by_name2(long loc_id, BytePointer group_name, int idx_type, int order, long[] idx, H5L_iterate2_t op, Pointer op_data, long lapl_id)static intH5Literate_by_name2(long loc_id, BytePointer group_name, int idx_type, int order, LongBuffer idx, H5L_iterate2_t op, Pointer op_data, long lapl_id)static intH5Literate_by_name2(long loc_id, BytePointer group_name, int idx_type, int order, LongPointer idx, H5L_iterate2_t op, Pointer op_data, long lapl_id)\ingroup TRAV \brief Iterates through links in a group \loc_idstatic intH5Literate2(long grp_id, int idx_type, int order, long[] idx, H5L_iterate2_t op, Pointer op_data)static intH5Literate2(long grp_id, int idx_type, int order, LongBuffer idx, H5L_iterate2_t op, Pointer op_data)static intH5Literate2(long grp_id, int idx_type, int order, LongPointer idx, H5L_iterate2_t op, Pointer op_data)\ingroup TRAV \brief Iterates over links in a group, with user callback routine, according to the order within an index.static intH5Lmove(long src_loc, String src_name, long dst_loc, String dst_name, long lcpl_id, long lapl_id)static intH5Lmove(long src_loc, BytePointer src_name, long dst_loc, BytePointer dst_name, long lcpl_id, long lapl_id)\ingroup H5L \brief Moves a link within an HDF5 file \fgdta_loc_id{src_loc}static intH5Lregister(H5L_class_t cls)\ingroup H5LA \brief Registers a user-defined link class or changes behavior of an existing classstatic intH5LTdtype_to_text(long dtype, byte[] str, int lang_type, SizeTPointer len)static intH5LTdtype_to_text(long dtype, ByteBuffer str, int lang_type, SizeTPointer len)static intH5LTdtype_to_text(long dtype, BytePointer str, int lang_type, SizeTPointer len)------------------------------------------------------------------------- \ingroup H5LT \brief Creates a text description of an HDF5 datatype.static intH5LTfind_attribute(long loc_id, String name)static intH5LTfind_attribute(long loc_id, BytePointer name)------------------------------------------------------------------------- \ingroup H5LT \brief Determines whether an attribute exists.static intH5LTfind_dataset(long loc_id, String name)static intH5LTfind_dataset(long loc_id, BytePointer name)------------------------------------------------------------------------- \ingroup H5LT \brief Determines whether a dataset exists.static intH5LTget_attribute(long loc_id, String obj_name, String attr_name, long mem_type_id, Pointer data)static intH5LTget_attribute(long loc_id, BytePointer obj_name, BytePointer attr_name, long mem_type_id, Pointer data)------------------------------------------------------------------------- \ingroup H5LT \brief Reads an attribute from disk.static intH5LTget_attribute_char(long loc_id, String obj_name, String attr_name, byte[] data)static intH5LTget_attribute_char(long loc_id, String obj_name, String attr_name, ByteBuffer data)static intH5LTget_attribute_char(long loc_id, String obj_name, String attr_name, BytePointer data)static intH5LTget_attribute_char(long loc_id, BytePointer obj_name, BytePointer attr_name, byte[] data)static intH5LTget_attribute_char(long loc_id, BytePointer obj_name, BytePointer attr_name, ByteBuffer data)static intH5LTget_attribute_char(long loc_id, BytePointer obj_name, BytePointer attr_name, BytePointer data)------------------------------------------------------------------------- \ingroup H5LT \brief Reads an attribute from disk.static intH5LTget_attribute_double(long loc_id, String obj_name, String attr_name, double[] data)static intH5LTget_attribute_double(long loc_id, String obj_name, String attr_name, DoubleBuffer data)static intH5LTget_attribute_double(long loc_id, String obj_name, String attr_name, DoublePointer data)static intH5LTget_attribute_double(long loc_id, BytePointer obj_name, BytePointer attr_name, double[] data)static intH5LTget_attribute_double(long loc_id, BytePointer obj_name, BytePointer attr_name, DoubleBuffer data)static intH5LTget_attribute_double(long loc_id, BytePointer obj_name, BytePointer attr_name, DoublePointer data)------------------------------------------------------------------------- \ingroup H5LT \brief Reads an attribute from disk.static intH5LTget_attribute_float(long loc_id, String obj_name, String attr_name, float[] data)static intH5LTget_attribute_float(long loc_id, String obj_name, String attr_name, FloatBuffer data)static intH5LTget_attribute_float(long loc_id, String obj_name, String attr_name, FloatPointer data)static intH5LTget_attribute_float(long loc_id, BytePointer obj_name, BytePointer attr_name, float[] data)static intH5LTget_attribute_float(long loc_id, BytePointer obj_name, BytePointer attr_name, FloatBuffer data)static intH5LTget_attribute_float(long loc_id, BytePointer obj_name, BytePointer attr_name, FloatPointer data)------------------------------------------------------------------------- \ingroup H5LT \brief Reads an attribute from disk.static intH5LTget_attribute_info(long loc_id, String obj_name, String attr_name, long[] dims, int[] type_class, SizeTPointer type_size)static intH5LTget_attribute_info(long loc_id, String obj_name, String attr_name, LongBuffer dims, IntBuffer type_class, SizeTPointer type_size)static intH5LTget_attribute_info(long loc_id, String obj_name, String attr_name, LongPointer dims, IntPointer type_class, SizeTPointer type_size)static intH5LTget_attribute_info(long loc_id, BytePointer obj_name, BytePointer attr_name, long[] dims, int[] type_class, SizeTPointer type_size)static intH5LTget_attribute_info(long loc_id, BytePointer obj_name, BytePointer attr_name, LongBuffer dims, IntBuffer type_class, SizeTPointer type_size)static intH5LTget_attribute_info(long loc_id, BytePointer obj_name, BytePointer attr_name, LongPointer dims, IntPointer type_class, SizeTPointer type_size)------------------------------------------------------------------------- \ingroup H5LT \brief Gets information about an attribute.static intH5LTget_attribute_int(long loc_id, String obj_name, String attr_name, int[] data)static intH5LTget_attribute_int(long loc_id, String obj_name, String attr_name, IntBuffer data)static intH5LTget_attribute_int(long loc_id, String obj_name, String attr_name, IntPointer data)static intH5LTget_attribute_int(long loc_id, BytePointer obj_name, BytePointer attr_name, int[] data)static intH5LTget_attribute_int(long loc_id, BytePointer obj_name, BytePointer attr_name, IntBuffer data)static intH5LTget_attribute_int(long loc_id, BytePointer obj_name, BytePointer attr_name, IntPointer data)------------------------------------------------------------------------- \ingroup H5LT \brief Reads an attribute from disk.static intH5LTget_attribute_long(long loc_id, String obj_name, String attr_name, CLongPointer data)static intH5LTget_attribute_long(long loc_id, BytePointer obj_name, BytePointer attr_name, CLongPointer data)------------------------------------------------------------------------- \ingroup H5LT \brief Reads an attribute from disk.static intH5LTget_attribute_long_long(long loc_id, String obj_name, String attr_name, long[] data)static intH5LTget_attribute_long_long(long loc_id, String obj_name, String attr_name, LongBuffer data)static intH5LTget_attribute_long_long(long loc_id, String obj_name, String attr_name, LongPointer data)static intH5LTget_attribute_long_long(long loc_id, BytePointer obj_name, BytePointer attr_name, long[] data)static intH5LTget_attribute_long_long(long loc_id, BytePointer obj_name, BytePointer attr_name, LongBuffer data)static intH5LTget_attribute_long_long(long loc_id, BytePointer obj_name, BytePointer attr_name, LongPointer data)------------------------------------------------------------------------- \ingroup H5LT \brief Reads a \e long \e long attribute.static intH5LTget_attribute_ndims(long loc_id, String obj_name, String attr_name, int[] rank)static intH5LTget_attribute_ndims(long loc_id, String obj_name, String attr_name, IntBuffer rank)static intH5LTget_attribute_ndims(long loc_id, String obj_name, String attr_name, IntPointer rank)static intH5LTget_attribute_ndims(long loc_id, BytePointer obj_name, BytePointer attr_name, int[] rank)static intH5LTget_attribute_ndims(long loc_id, BytePointer obj_name, BytePointer attr_name, IntBuffer rank)static intH5LTget_attribute_ndims(long loc_id, BytePointer obj_name, BytePointer attr_name, IntPointer rank)------------------------------------------------------------------------- \ingroup H5LT \brief Gets the dimensionality of an attribute.static intH5LTget_attribute_short(long loc_id, String obj_name, String attr_name, short[] data)static intH5LTget_attribute_short(long loc_id, String obj_name, String attr_name, ShortBuffer data)static intH5LTget_attribute_short(long loc_id, String obj_name, String attr_name, ShortPointer data)static intH5LTget_attribute_short(long loc_id, BytePointer obj_name, BytePointer attr_name, short[] data)static intH5LTget_attribute_short(long loc_id, BytePointer obj_name, BytePointer attr_name, ShortBuffer data)static intH5LTget_attribute_short(long loc_id, BytePointer obj_name, BytePointer attr_name, ShortPointer data)------------------------------------------------------------------------- \ingroup H5LT \brief Reads an attribute from disk.static intH5LTget_attribute_string(long loc_id, String obj_name, String attr_name, byte[] data)static intH5LTget_attribute_string(long loc_id, String obj_name, String attr_name, ByteBuffer data)static intH5LTget_attribute_string(long loc_id, String obj_name, String attr_name, BytePointer data)static intH5LTget_attribute_string(long loc_id, BytePointer obj_name, BytePointer attr_name, byte[] data)static intH5LTget_attribute_string(long loc_id, BytePointer obj_name, BytePointer attr_name, ByteBuffer data)static intH5LTget_attribute_string(long loc_id, BytePointer obj_name, BytePointer attr_name, BytePointer data)------------------------------------------------------------------------- \ingroup H5LT \brief Reads an attribute from disk.static intH5LTget_attribute_uchar(long loc_id, String obj_name, String attr_name, byte[] data)static intH5LTget_attribute_uchar(long loc_id, String obj_name, String attr_name, ByteBuffer data)static intH5LTget_attribute_uchar(long loc_id, String obj_name, String attr_name, BytePointer data)static intH5LTget_attribute_uchar(long loc_id, BytePointer obj_name, BytePointer attr_name, byte[] data)static intH5LTget_attribute_uchar(long loc_id, BytePointer obj_name, BytePointer attr_name, ByteBuffer data)static intH5LTget_attribute_uchar(long loc_id, BytePointer obj_name, BytePointer attr_name, BytePointer data)------------------------------------------------------------------------- \ingroup H5LT \brief Reads an attribute from disk.static intH5LTget_attribute_uint(long loc_id, String obj_name, String attr_name, int[] data)static intH5LTget_attribute_uint(long loc_id, String obj_name, String attr_name, IntBuffer data)static intH5LTget_attribute_uint(long loc_id, String obj_name, String attr_name, IntPointer data)static intH5LTget_attribute_uint(long loc_id, BytePointer obj_name, BytePointer attr_name, int[] data)static intH5LTget_attribute_uint(long loc_id, BytePointer obj_name, BytePointer attr_name, IntBuffer data)static intH5LTget_attribute_uint(long loc_id, BytePointer obj_name, BytePointer attr_name, IntPointer data)------------------------------------------------------------------------- \ingroup H5LT \brief Reads an attribute from disk.static intH5LTget_attribute_ullong(long loc_id, String obj_name, String attr_name, long[] data)static intH5LTget_attribute_ullong(long loc_id, String obj_name, String attr_name, LongBuffer data)static intH5LTget_attribute_ullong(long loc_id, String obj_name, String attr_name, LongPointer data)static intH5LTget_attribute_ullong(long loc_id, BytePointer obj_name, BytePointer attr_name, long[] data)static intH5LTget_attribute_ullong(long loc_id, BytePointer obj_name, BytePointer attr_name, LongBuffer data)static intH5LTget_attribute_ullong(long loc_id, BytePointer obj_name, BytePointer attr_name, LongPointer data)------------------------------------------------------------------------- \ingroup H5LT \brief Reads an attribute from disk.static intH5LTget_attribute_ulong(long loc_id, String obj_name, String attr_name, CLongPointer data)static intH5LTget_attribute_ulong(long loc_id, BytePointer obj_name, BytePointer attr_name, CLongPointer data)------------------------------------------------------------------------- \ingroup H5LT \brief Reads an attribute from disk.static intH5LTget_attribute_ushort(long loc_id, String obj_name, String attr_name, short[] data)static intH5LTget_attribute_ushort(long loc_id, String obj_name, String attr_name, ShortBuffer data)static intH5LTget_attribute_ushort(long loc_id, String obj_name, String attr_name, ShortPointer data)static intH5LTget_attribute_ushort(long loc_id, BytePointer obj_name, BytePointer attr_name, short[] data)static intH5LTget_attribute_ushort(long loc_id, BytePointer obj_name, BytePointer attr_name, ShortBuffer data)static intH5LTget_attribute_ushort(long loc_id, BytePointer obj_name, BytePointer attr_name, ShortPointer data)------------------------------------------------------------------------- \ingroup H5LT \brief Reads an attribute from disk.static intH5LTget_dataset_info(long loc_id, String dset_name, long[] dims, int[] type_class, SizeTPointer type_size)static intH5LTget_dataset_info(long loc_id, String dset_name, LongBuffer dims, IntBuffer type_class, SizeTPointer type_size)static intH5LTget_dataset_info(long loc_id, String dset_name, LongPointer dims, IntPointer type_class, SizeTPointer type_size)static intH5LTget_dataset_info(long loc_id, BytePointer dset_name, long[] dims, int[] type_class, SizeTPointer type_size)static intH5LTget_dataset_info(long loc_id, BytePointer dset_name, LongBuffer dims, IntBuffer type_class, SizeTPointer type_size)static intH5LTget_dataset_info(long loc_id, BytePointer dset_name, LongPointer dims, IntPointer type_class, SizeTPointer type_size)------------------------------------------------------------------------- \ingroup H5LT \brief Retrieves information about a datasetstatic intH5LTget_dataset_ndims(long loc_id, String dset_name, int[] rank)static intH5LTget_dataset_ndims(long loc_id, String dset_name, IntBuffer rank)static intH5LTget_dataset_ndims(long loc_id, String dset_name, IntPointer rank)static intH5LTget_dataset_ndims(long loc_id, BytePointer dset_name, int[] rank)static intH5LTget_dataset_ndims(long loc_id, BytePointer dset_name, IntBuffer rank)static intH5LTget_dataset_ndims(long loc_id, BytePointer dset_name, IntPointer rank)------------------------------------------------------------------------- \ingroup H5LT \brief Gets the dimensionality of a datasetstatic intH5LTmake_dataset(long loc_id, String dset_name, int rank, long[] dims, long type_id, Pointer buffer)static intH5LTmake_dataset(long loc_id, String dset_name, int rank, LongBuffer dims, long type_id, Pointer buffer)static intH5LTmake_dataset(long loc_id, String dset_name, int rank, LongPointer dims, long type_id, Pointer buffer)static intH5LTmake_dataset(long loc_id, BytePointer dset_name, int rank, long[] dims, long type_id, Pointer buffer)static intH5LTmake_dataset(long loc_id, BytePointer dset_name, int rank, LongBuffer dims, long type_id, Pointer buffer)static intH5LTmake_dataset(long loc_id, BytePointer dset_name, int rank, LongPointer dims, long type_id, Pointer buffer)------------------------------------------------------------------------- \ingroup H5LT \brief Creates and writes a dataset of a type \p type_id.static intH5LTmake_dataset_char(long loc_id, String dset_name, int rank, long[] dims, String buffer)static intH5LTmake_dataset_char(long loc_id, String dset_name, int rank, LongBuffer dims, String buffer)static intH5LTmake_dataset_char(long loc_id, String dset_name, int rank, LongPointer dims, String buffer)static intH5LTmake_dataset_char(long loc_id, BytePointer dset_name, int rank, long[] dims, BytePointer buffer)static intH5LTmake_dataset_char(long loc_id, BytePointer dset_name, int rank, LongBuffer dims, BytePointer buffer)static intH5LTmake_dataset_char(long loc_id, BytePointer dset_name, int rank, LongPointer dims, BytePointer buffer)------------------------------------------------------------------------- \ingroup H5LT \brief Creates and writes a dataset.static intH5LTmake_dataset_double(long loc_id, String dset_name, int rank, long[] dims, double[] buffer)static intH5LTmake_dataset_double(long loc_id, String dset_name, int rank, LongBuffer dims, DoubleBuffer buffer)static intH5LTmake_dataset_double(long loc_id, String dset_name, int rank, LongPointer dims, DoublePointer buffer)static intH5LTmake_dataset_double(long loc_id, BytePointer dset_name, int rank, long[] dims, double[] buffer)static intH5LTmake_dataset_double(long loc_id, BytePointer dset_name, int rank, LongBuffer dims, DoubleBuffer buffer)static intH5LTmake_dataset_double(long loc_id, BytePointer dset_name, int rank, LongPointer dims, DoublePointer buffer)------------------------------------------------------------------------- \ingroup H5LT \brief Creates and writes a dataset.static intH5LTmake_dataset_float(long loc_id, String dset_name, int rank, long[] dims, float[] buffer)static intH5LTmake_dataset_float(long loc_id, String dset_name, int rank, LongBuffer dims, FloatBuffer buffer)static intH5LTmake_dataset_float(long loc_id, String dset_name, int rank, LongPointer dims, FloatPointer buffer)static intH5LTmake_dataset_float(long loc_id, BytePointer dset_name, int rank, long[] dims, float[] buffer)static intH5LTmake_dataset_float(long loc_id, BytePointer dset_name, int rank, LongBuffer dims, FloatBuffer buffer)static intH5LTmake_dataset_float(long loc_id, BytePointer dset_name, int rank, LongPointer dims, FloatPointer buffer)------------------------------------------------------------------------- \ingroup H5LT \brief Creates and writes a dataset.static intH5LTmake_dataset_int(long loc_id, String dset_name, int rank, long[] dims, int[] buffer)static intH5LTmake_dataset_int(long loc_id, String dset_name, int rank, LongBuffer dims, IntBuffer buffer)static intH5LTmake_dataset_int(long loc_id, String dset_name, int rank, LongPointer dims, IntPointer buffer)static intH5LTmake_dataset_int(long loc_id, BytePointer dset_name, int rank, long[] dims, int[] buffer)static intH5LTmake_dataset_int(long loc_id, BytePointer dset_name, int rank, LongBuffer dims, IntBuffer buffer)static intH5LTmake_dataset_int(long loc_id, BytePointer dset_name, int rank, LongPointer dims, IntPointer buffer)------------------------------------------------------------------------- \ingroup H5LT \brief Creates and writes a dataset.static intH5LTmake_dataset_long(long loc_id, String dset_name, int rank, long[] dims, CLongPointer buffer)static intH5LTmake_dataset_long(long loc_id, String dset_name, int rank, LongBuffer dims, CLongPointer buffer)static intH5LTmake_dataset_long(long loc_id, String dset_name, int rank, LongPointer dims, CLongPointer buffer)static intH5LTmake_dataset_long(long loc_id, BytePointer dset_name, int rank, long[] dims, CLongPointer buffer)static intH5LTmake_dataset_long(long loc_id, BytePointer dset_name, int rank, LongBuffer dims, CLongPointer buffer)static intH5LTmake_dataset_long(long loc_id, BytePointer dset_name, int rank, LongPointer dims, CLongPointer buffer)------------------------------------------------------------------------- \ingroup H5LT \brief Creates and writes a dataset.static intH5LTmake_dataset_short(long loc_id, String dset_name, int rank, long[] dims, short[] buffer)static intH5LTmake_dataset_short(long loc_id, String dset_name, int rank, LongBuffer dims, ShortBuffer buffer)static intH5LTmake_dataset_short(long loc_id, String dset_name, int rank, LongPointer dims, ShortPointer buffer)static intH5LTmake_dataset_short(long loc_id, BytePointer dset_name, int rank, long[] dims, short[] buffer)static intH5LTmake_dataset_short(long loc_id, BytePointer dset_name, int rank, LongBuffer dims, ShortBuffer buffer)static intH5LTmake_dataset_short(long loc_id, BytePointer dset_name, int rank, LongPointer dims, ShortPointer buffer)------------------------------------------------------------------------- \ingroup H5LT \brief Creates and writes a dataset.static intH5LTmake_dataset_string(long loc_id, String dset_name, String buf)static intH5LTmake_dataset_string(long loc_id, BytePointer dset_name, BytePointer buf)------------------------------------------------------------------------- \ingroup H5LT \brief Creates and writes a dataset with string datatype.static longH5LTopen_file_image(Pointer buf_ptr, long buf_size, int flags)------------------------------------------------------------------------- \ingroup H5LT \brief Opens an HDF5 file image in memory.static intH5LTpath_valid(long loc_id, String path, boolean check_object_valid)static intH5LTpath_valid(long loc_id, BytePointer path, boolean check_object_valid)------------------------------------------------------------------------- \ingroup H5LT \brief Determines whether an HDF5 path is valid and, optionally, whether the path resolves to an HDF5 object.static intH5LTread_dataset(long loc_id, String dset_name, long type_id, Pointer buffer)static intH5LTread_dataset(long loc_id, BytePointer dset_name, long type_id, Pointer buffer)------------------------------------------------------------------------- \ingroup H5LT \brief Reads a dataset from disk.static intH5LTread_dataset_char(long loc_id, String dset_name, byte[] buffer)static intH5LTread_dataset_char(long loc_id, String dset_name, ByteBuffer buffer)static intH5LTread_dataset_char(long loc_id, String dset_name, BytePointer buffer)static intH5LTread_dataset_char(long loc_id, BytePointer dset_name, byte[] buffer)static intH5LTread_dataset_char(long loc_id, BytePointer dset_name, ByteBuffer buffer)static intH5LTread_dataset_char(long loc_id, BytePointer dset_name, BytePointer buffer)------------------------------------------------------------------------- \ingroup H5LT \brief Reads a dataset from disk.static intH5LTread_dataset_double(long loc_id, String dset_name, double[] buffer)static intH5LTread_dataset_double(long loc_id, String dset_name, DoubleBuffer buffer)static intH5LTread_dataset_double(long loc_id, String dset_name, DoublePointer buffer)static intH5LTread_dataset_double(long loc_id, BytePointer dset_name, double[] buffer)static intH5LTread_dataset_double(long loc_id, BytePointer dset_name, DoubleBuffer buffer)static intH5LTread_dataset_double(long loc_id, BytePointer dset_name, DoublePointer buffer)------------------------------------------------------------------------- \ingroup H5LT \brief Reads a dataset from disk.static intH5LTread_dataset_float(long loc_id, String dset_name, float[] buffer)static intH5LTread_dataset_float(long loc_id, String dset_name, FloatBuffer buffer)static intH5LTread_dataset_float(long loc_id, String dset_name, FloatPointer buffer)static intH5LTread_dataset_float(long loc_id, BytePointer dset_name, float[] buffer)static intH5LTread_dataset_float(long loc_id, BytePointer dset_name, FloatBuffer buffer)static intH5LTread_dataset_float(long loc_id, BytePointer dset_name, FloatPointer buffer)------------------------------------------------------------------------- \ingroup H5LT \brief Reads a dataset from disk.static intH5LTread_dataset_int(long loc_id, String dset_name, int[] buffer)static intH5LTread_dataset_int(long loc_id, String dset_name, IntBuffer buffer)static intH5LTread_dataset_int(long loc_id, String dset_name, IntPointer buffer)static intH5LTread_dataset_int(long loc_id, BytePointer dset_name, int[] buffer)static intH5LTread_dataset_int(long loc_id, BytePointer dset_name, IntBuffer buffer)static intH5LTread_dataset_int(long loc_id, BytePointer dset_name, IntPointer buffer)------------------------------------------------------------------------- \ingroup H5LT \brief Reads a dataset from disk.static intH5LTread_dataset_long(long loc_id, String dset_name, CLongPointer buffer)static intH5LTread_dataset_long(long loc_id, BytePointer dset_name, CLongPointer buffer)------------------------------------------------------------------------- \ingroup H5LT \brief Reads a dataset from disk.static intH5LTread_dataset_short(long loc_id, String dset_name, short[] buffer)static intH5LTread_dataset_short(long loc_id, String dset_name, ShortBuffer buffer)static intH5LTread_dataset_short(long loc_id, String dset_name, ShortPointer buffer)static intH5LTread_dataset_short(long loc_id, BytePointer dset_name, short[] buffer)static intH5LTread_dataset_short(long loc_id, BytePointer dset_name, ShortBuffer buffer)static intH5LTread_dataset_short(long loc_id, BytePointer dset_name, ShortPointer buffer)------------------------------------------------------------------------- \ingroup H5LT \brief Reads a dataset from disk.static intH5LTread_dataset_string(long loc_id, String dset_name, byte[] buf)static intH5LTread_dataset_string(long loc_id, String dset_name, ByteBuffer buf)static intH5LTread_dataset_string(long loc_id, String dset_name, BytePointer buf)static intH5LTread_dataset_string(long loc_id, BytePointer dset_name, byte[] buf)static intH5LTread_dataset_string(long loc_id, BytePointer dset_name, ByteBuffer buf)static intH5LTread_dataset_string(long loc_id, BytePointer dset_name, BytePointer buf)------------------------------------------------------------------------- \ingroup H5LT \brief Reads a dataset from disk.static intH5LTset_attribute_char(long loc_id, String obj_name, String attr_name, String buffer, long size)static intH5LTset_attribute_char(long loc_id, BytePointer obj_name, BytePointer attr_name, BytePointer buffer, long size)------------------------------------------------------------------------- \ingroup H5LT \brief Creates and writes an attribute.static intH5LTset_attribute_double(long loc_id, String obj_name, String attr_name, double[] buffer, long size)static intH5LTset_attribute_double(long loc_id, String obj_name, String attr_name, DoubleBuffer buffer, long size)static intH5LTset_attribute_double(long loc_id, String obj_name, String attr_name, DoublePointer buffer, long size)static intH5LTset_attribute_double(long loc_id, BytePointer obj_name, BytePointer attr_name, double[] buffer, long size)static intH5LTset_attribute_double(long loc_id, BytePointer obj_name, BytePointer attr_name, DoubleBuffer buffer, long size)static intH5LTset_attribute_double(long loc_id, BytePointer obj_name, BytePointer attr_name, DoublePointer buffer, long size)------------------------------------------------------------------------- \ingroup H5LT \brief Creates and writes an attribute.static intH5LTset_attribute_float(long loc_id, String obj_name, String attr_name, float[] buffer, long size)static intH5LTset_attribute_float(long loc_id, String obj_name, String attr_name, FloatBuffer buffer, long size)static intH5LTset_attribute_float(long loc_id, String obj_name, String attr_name, FloatPointer buffer, long size)static intH5LTset_attribute_float(long loc_id, BytePointer obj_name, BytePointer attr_name, float[] buffer, long size)static intH5LTset_attribute_float(long loc_id, BytePointer obj_name, BytePointer attr_name, FloatBuffer buffer, long size)static intH5LTset_attribute_float(long loc_id, BytePointer obj_name, BytePointer attr_name, FloatPointer buffer, long size)------------------------------------------------------------------------- \ingroup H5LT \brief Creates and writes an attribute.static intH5LTset_attribute_int(long loc_id, String obj_name, String attr_name, int[] buffer, long size)static intH5LTset_attribute_int(long loc_id, String obj_name, String attr_name, IntBuffer buffer, long size)static intH5LTset_attribute_int(long loc_id, String obj_name, String attr_name, IntPointer buffer, long size)static intH5LTset_attribute_int(long loc_id, BytePointer obj_name, BytePointer attr_name, int[] buffer, long size)static intH5LTset_attribute_int(long loc_id, BytePointer obj_name, BytePointer attr_name, IntBuffer buffer, long size)static intH5LTset_attribute_int(long loc_id, BytePointer obj_name, BytePointer attr_name, IntPointer buffer, long size)------------------------------------------------------------------------- \ingroup H5LT \brief Creates and writes an attribute.static intH5LTset_attribute_long(long loc_id, String obj_name, String attr_name, CLongPointer buffer, long size)static intH5LTset_attribute_long(long loc_id, BytePointer obj_name, BytePointer attr_name, CLongPointer buffer, long size)------------------------------------------------------------------------- \ingroup H5LT \brief Creates and writes an attribute.static intH5LTset_attribute_long_long(long loc_id, String obj_name, String attr_name, long[] buffer, long size)static intH5LTset_attribute_long_long(long loc_id, String obj_name, String attr_name, LongBuffer buffer, long size)static intH5LTset_attribute_long_long(long loc_id, String obj_name, String attr_name, LongPointer buffer, long size)static intH5LTset_attribute_long_long(long loc_id, BytePointer obj_name, BytePointer attr_name, long[] buffer, long size)static intH5LTset_attribute_long_long(long loc_id, BytePointer obj_name, BytePointer attr_name, LongBuffer buffer, long size)static intH5LTset_attribute_long_long(long loc_id, BytePointer obj_name, BytePointer attr_name, LongPointer buffer, long size)------------------------------------------------------------------------- \ingroup H5LT \brief Creates and writes an attribute.static intH5LTset_attribute_short(long loc_id, String obj_name, String attr_name, short[] buffer, long size)static intH5LTset_attribute_short(long loc_id, String obj_name, String attr_name, ShortBuffer buffer, long size)static intH5LTset_attribute_short(long loc_id, String obj_name, String attr_name, ShortPointer buffer, long size)static intH5LTset_attribute_short(long loc_id, BytePointer obj_name, BytePointer attr_name, short[] buffer, long size)static intH5LTset_attribute_short(long loc_id, BytePointer obj_name, BytePointer attr_name, ShortBuffer buffer, long size)static intH5LTset_attribute_short(long loc_id, BytePointer obj_name, BytePointer attr_name, ShortPointer buffer, long size)------------------------------------------------------------------------- \ingroup H5LT \brief Creates and writes an attribute.static intH5LTset_attribute_string(long loc_id, String obj_name, String attr_name, String attr_data)static intH5LTset_attribute_string(long loc_id, BytePointer obj_name, BytePointer attr_name, BytePointer attr_data)------------------------------------------------------------------------- \ingroup H5LT \brief Creates and writes a string attribute.static intH5LTset_attribute_uchar(long loc_id, String obj_name, String attr_name, byte[] buffer, long size)static intH5LTset_attribute_uchar(long loc_id, String obj_name, String attr_name, ByteBuffer buffer, long size)static intH5LTset_attribute_uchar(long loc_id, String obj_name, String attr_name, BytePointer buffer, long size)static intH5LTset_attribute_uchar(long loc_id, BytePointer obj_name, BytePointer attr_name, byte[] buffer, long size)static intH5LTset_attribute_uchar(long loc_id, BytePointer obj_name, BytePointer attr_name, ByteBuffer buffer, long size)static intH5LTset_attribute_uchar(long loc_id, BytePointer obj_name, BytePointer attr_name, BytePointer buffer, long size)------------------------------------------------------------------------- \ingroup H5LT \brief Creates and writes an attribute.static intH5LTset_attribute_uint(long loc_id, String obj_name, String attr_name, int[] buffer, long size)static intH5LTset_attribute_uint(long loc_id, String obj_name, String attr_name, IntBuffer buffer, long size)static intH5LTset_attribute_uint(long loc_id, String obj_name, String attr_name, IntPointer buffer, long size)static intH5LTset_attribute_uint(long loc_id, BytePointer obj_name, BytePointer attr_name, int[] buffer, long size)static intH5LTset_attribute_uint(long loc_id, BytePointer obj_name, BytePointer attr_name, IntBuffer buffer, long size)static intH5LTset_attribute_uint(long loc_id, BytePointer obj_name, BytePointer attr_name, IntPointer buffer, long size)------------------------------------------------------------------------- \ingroup H5LT \brief Creates and writes an attribute.static intH5LTset_attribute_ullong(long loc_id, String obj_name, String attr_name, long[] buffer, long size)static intH5LTset_attribute_ullong(long loc_id, String obj_name, String attr_name, LongBuffer buffer, long size)static intH5LTset_attribute_ullong(long loc_id, String obj_name, String attr_name, LongPointer buffer, long size)static intH5LTset_attribute_ullong(long loc_id, BytePointer obj_name, BytePointer attr_name, long[] buffer, long size)static intH5LTset_attribute_ullong(long loc_id, BytePointer obj_name, BytePointer attr_name, LongBuffer buffer, long size)static intH5LTset_attribute_ullong(long loc_id, BytePointer obj_name, BytePointer attr_name, LongPointer buffer, long size)------------------------------------------------------------------------- \ingroup H5LT \brief Creates and writes an attribute.static intH5LTset_attribute_ulong(long loc_id, String obj_name, String attr_name, CLongPointer buffer, long size)static intH5LTset_attribute_ulong(long loc_id, BytePointer obj_name, BytePointer attr_name, CLongPointer buffer, long size)------------------------------------------------------------------------- \ingroup H5LT \brief Creates and writes an attribute.static intH5LTset_attribute_ushort(long loc_id, String obj_name, String attr_name, short[] buffer, long size)static intH5LTset_attribute_ushort(long loc_id, String obj_name, String attr_name, ShortBuffer buffer, long size)static intH5LTset_attribute_ushort(long loc_id, String obj_name, String attr_name, ShortPointer buffer, long size)static intH5LTset_attribute_ushort(long loc_id, BytePointer obj_name, BytePointer attr_name, short[] buffer, long size)static intH5LTset_attribute_ushort(long loc_id, BytePointer obj_name, BytePointer attr_name, ShortBuffer buffer, long size)static intH5LTset_attribute_ushort(long loc_id, BytePointer obj_name, BytePointer attr_name, ShortPointer buffer, long size)------------------------------------------------------------------------- \ingroup H5LT \brief Creates and writes an attribute.static longH5LTtext_to_dtype(String text, int lang_type)static longH5LTtext_to_dtype(BytePointer text, int lang_type)------------------------------------------------------------------------- \ingroup H5LT \brief Creates an HDF5 datatype given a text description.static intH5Lunpack_elink_val(Pointer ext_linkval, long link_size, int[] flags, byte[] filename, byte[] obj_path)static intH5Lunpack_elink_val(Pointer ext_linkval, long link_size, IntBuffer flags, ByteBuffer filename, ByteBuffer obj_path)static intH5Lunpack_elink_val(Pointer ext_linkval, long link_size, IntPointer flags, BytePointer filename, BytePointer obj_path)static intH5Lunpack_elink_val(Pointer ext_linkval, long link_size, IntPointer flags, PointerPointer filename, PointerPointer obj_path)\ingroup H5L \brief Decodes external link informationstatic intH5Lunregister(int id)\ingroup H5LA \brief Unregisters a class of user-defined linksstatic intH5Lvisit_by_name2(long loc_id, String group_name, int idx_type, int order, H5L_iterate2_t op, Pointer op_data, long lapl_id)static intH5Lvisit_by_name2(long loc_id, BytePointer group_name, int idx_type, int order, H5L_iterate2_t op, Pointer op_data, long lapl_id)\ingroup TRAV \brief Recursively visits all links starting from a specified group \loc_idstatic intH5Lvisit2(long grp_id, int idx_type, int order, H5L_iterate2_t op, Pointer op_data)\ingroup TRAV \brief Recursively visits all links starting from a specified group \group_id{grp_id} \idx_type \order \op \op_datastatic intH5O_SHMESG_ATTR_FLAG()Attribute Message.static intH5O_SHMESG_DTYPE_FLAG()Datatype Message.static intH5O_SHMESG_FILL_FLAG()Fill Value Message.static intH5O_SHMESG_PLINE_FLAG()Filter pipeline message.static intH5O_SHMESG_SDSPACE_FLAG()Simple Dataspace Message.static H5O_token_tH5O_TOKEN_UNDEF_g()\endcondstatic intH5Oare_mdc_flushes_disabled(long object_id, boolean[] are_disabled)static intH5Oare_mdc_flushes_disabled(long object_id, BoolPointer are_disabled)------------------------------------------------------------------------- \ingroup H5O \brief Retrieves comment for specified objectstatic intH5Oclose(long object_id)------------------------------------------------------------------------- \ingroup H5O \brief Closes an object in an HDF5 file \obj_id{object_id}static intH5Oclose_async(String app_file, String app_func, int app_line, long object_id, long es_id)static intH5Oclose_async(BytePointer app_file, BytePointer app_func, int app_line, long object_id, long es_id)-------------------------------------------------------------------------- \ingroup ASYNC \async_variant_of{H5Oclose}static intH5Ocopy(long src_loc_id, String src_name, long dst_loc_id, String dst_name, long ocpypl_id, long lcpl_id)static intH5Ocopy(long src_loc_id, BytePointer src_name, long dst_loc_id, BytePointer dst_name, long ocpypl_id, long lcpl_id)------------------------------------------------------------------------- \ingroup H5O \brief Copies an object in an HDF5 filestatic intH5Ocopy_async(String app_file, String app_func, int app_line, long src_loc_id, String src_name, long dst_loc_id, String dst_name, long ocpypl_id, long lcpl_id, long es_id)static intH5Ocopy_async(BytePointer app_file, BytePointer app_func, int app_line, long src_loc_id, BytePointer src_name, long dst_loc_id, BytePointer dst_name, long ocpypl_id, long lcpl_id, long es_id)-------------------------------------------------------------------------- \ingroup ASYNC \async_variant_of{H5Ocopy}static intH5Odecr_refcount(long object_id)------------------------------------------------------------------------- \ingroup H5O \brief Decrements an object reference count \fgdta_loc_obj_id{object_id}static intH5Odisable_mdc_flushes(long object_id)------------------------------------------------------------------------- \ingroup H5O \brief Prevents metadata entries for an HDF5 object from being flushed from the metadata cache to storagestatic intH5Oenable_mdc_flushes(long object_id)------------------------------------------------------------------------- \ingroup H5O \brief Enables flushing of dirty metadata entries from a fileâs metadata cachestatic intH5Oexists_by_name(long loc_id, String name, long lapl_id)static intH5Oexists_by_name(long loc_id, BytePointer name, long lapl_id)------------------------------------------------------------------------- \ingroup H5O \brief Determines whether a link resolves to an actual object.static intH5Oflush(long obj_id)------------------------------------------------------------------------- \ingroup H5O \brief Flushes all buffers associated with an HDF5 object to disk \fgdta_loc_obj_id{obj_id}static intH5Oflush_async(String app_file, String app_func, int app_line, long obj_id, long es_id)static intH5Oflush_async(BytePointer app_file, BytePointer app_func, int app_line, long obj_id, long es_id)-------------------------------------------------------------------------- \ingroup ASYNC \async_variant_of{H5Oflush}static longH5Oget_comment(long obj_id, byte[] comment, long bufsize)static longH5Oget_comment(long obj_id, ByteBuffer comment, long bufsize)static longH5Oget_comment(long obj_id, BytePointer comment, long bufsize)------------------------------------------------------------------------- \ingroup H5O \brief Retrieves comment for specified object \fgdta_loc_obj_id{obj_id}static longH5Oget_comment_by_name(long loc_id, String name, byte[] comment, long bufsize, long lapl_id)static longH5Oget_comment_by_name(long loc_id, String name, ByteBuffer comment, long bufsize, long lapl_id)static longH5Oget_comment_by_name(long loc_id, String name, BytePointer comment, long bufsize, long lapl_id)static longH5Oget_comment_by_name(long loc_id, BytePointer name, byte[] comment, long bufsize, long lapl_id)static longH5Oget_comment_by_name(long loc_id, BytePointer name, ByteBuffer comment, long bufsize, long lapl_id)static longH5Oget_comment_by_name(long loc_id, BytePointer name, BytePointer comment, long bufsize, long lapl_id)------------------------------------------------------------------------- \ingroup H5O \brief Retrieves comment for specified object \fgdta_loc_obj_id{loc_id}static intH5Oget_info_by_idx3(long loc_id, String group_name, int idx_type, int order, long n, H5O_info2_t oinfo, int fields, long lapl_id)static intH5Oget_info_by_idx3(long loc_id, BytePointer group_name, int idx_type, int order, long n, H5O_info2_t oinfo, int fields, long lapl_id)------------------------------------------------------------------------- \ingroup H5O \brief Retrieves the metadata for an object, identifying the object by an index position \fgdta_loc_obj_id{loc_id}static intH5Oget_info_by_name_async(String app_file, String app_func, int app_line, long loc_id, String name, H5O_info2_t oinfo, int fields, long lapl_id, long es_id)static intH5Oget_info_by_name_async(BytePointer app_file, BytePointer app_func, int app_line, long loc_id, BytePointer name, H5O_info2_t oinfo, int fields, long lapl_id, long es_id)-------------------------------------------------------------------------- \ingroup ASYNC \async_variant_of{H5Oget_info_by_name}static intH5Oget_info_by_name3(long loc_id, String name, H5O_info2_t oinfo, int fields, long lapl_id)static intH5Oget_info_by_name3(long loc_id, BytePointer name, H5O_info2_t oinfo, int fields, long lapl_id)------------------------------------------------------------------------- \ingroup H5O \brief Retrieves the metadata for an object, identifying the object by location and relative name \fgdta_loc_obj_id{loc_id}static intH5Oget_info3(long loc_id, H5O_info2_t oinfo, int fields)------------------------------------------------------------------------- \ingroup H5O \brief Retrieves the metadata for an object specified by an identifier \fgdta_loc_obj_id{loc_id}static intH5Oget_native_info(long loc_id, H5O_native_info_t oinfo, int fields)------------------------------------------------------------------------- \ingroup H5O \brief Retrieve native file format information about an object \fgdta_loc_obj_id{loc_id}static intH5Oget_native_info_by_idx(long loc_id, String group_name, int idx_type, int order, long n, H5O_native_info_t oinfo, int fields, long lapl_id)static intH5Oget_native_info_by_idx(long loc_id, BytePointer group_name, int idx_type, int order, long n, H5O_native_info_t oinfo, int fields, long lapl_id)------------------------------------------------------------------------- \ingroup H5O \brief Retrieve native file format information about an object according to the order of an index \fgdta_loc_obj_id{loc_id}static intH5Oget_native_info_by_name(long loc_id, String name, H5O_native_info_t oinfo, int fields, long lapl_id)static intH5Oget_native_info_by_name(long loc_id, BytePointer name, H5O_native_info_t oinfo, int fields, long lapl_id)------------------------------------------------------------------------- \ingroup H5O \brief Retrieve native file format information about an object given its name \fgdta_loc_obj_id{loc_id}static intH5Oincr_refcount(long object_id)------------------------------------------------------------------------- \ingroup H5O \brief Increments an object reference count \fgdta_loc_obj_id{object_id}static intH5Olink(long obj_id, long new_loc_id, String new_name, long lcpl_id, long lapl_id)static intH5Olink(long obj_id, long new_loc_id, BytePointer new_name, long lcpl_id, long lapl_id)------------------------------------------------------------------------- \ingroup H5O \brief Creates a hard link to an object in an HDF5 filestatic longH5Oopen(long loc_id, String name, long lapl_id)static longH5Oopen(long loc_id, BytePointer name, long lapl_id)------------------------------------------------------------------------- \ingroup H5O \brief Opens an object in an HDF5 file by location identifier and path name.static longH5Oopen_async(String app_file, String app_func, int app_line, long loc_id, String name, long lapl_id, long es_id)static longH5Oopen_async(BytePointer app_file, BytePointer app_func, int app_line, long loc_id, BytePointer name, long lapl_id, long es_id)-------------------------------------------------------------------------- \ingroup ASYNC \async_variant_of{H5Oopen}static longH5Oopen_by_idx(long loc_id, String group_name, int idx_type, int order, long n, long lapl_id)static longH5Oopen_by_idx(long loc_id, BytePointer group_name, int idx_type, int order, long n, long lapl_id)------------------------------------------------------------------------- \ingroup H5O \brief Opens the nth object in a group \fgdta_loc_obj_id{loc_id}static longH5Oopen_by_idx_async(String app_file, String app_func, int app_line, long loc_id, String group_name, int idx_type, int order, long n, long lapl_id, long es_id)static longH5Oopen_by_idx_async(BytePointer app_file, BytePointer app_func, int app_line, long loc_id, BytePointer group_name, int idx_type, int order, long n, long lapl_id, long es_id)-------------------------------------------------------------------------- \ingroup ASYNC \async_variant_of{H5Oopen_by_idx}static longH5Oopen_by_token(long loc_id, H5O_token_t token)------------------------------------------------------------------------- \ingroup H5O \brief Opens an object in an HDF5 file using its VOL independent token \fgdta_loc_obj_id{loc_id}static intH5open()\ingroup H5 \brief Initializes the HDF5 librarystatic intH5Orefresh(long oid)------------------------------------------------------------------------- \ingroup H5O \brief Refreshes all buffers associated with an HDF5 object \fgdta_loc_obj_id{oid}static intH5Orefresh_async(String app_file, String app_func, int app_line, long oid, long es_id)static intH5Orefresh_async(BytePointer app_file, BytePointer app_func, int app_line, long oid, long es_id)-------------------------------------------------------------------------- \ingroup ASYNC \async_variant_of{H5Orefresh}static intH5Oset_comment(long obj_id, String comment)static intH5Oset_comment(long obj_id, BytePointer comment)------------------------------------------------------------------------- \ingroup H5O \brief Sets comment for specified object \fgdta_loc_obj_id{obj_id}static intH5Oset_comment_by_name(long loc_id, String name, String comment, long lapl_id)static intH5Oset_comment_by_name(long loc_id, BytePointer name, BytePointer comment, long lapl_id)------------------------------------------------------------------------- \ingroup H5O \brief Sets comment for specified object \fgdta_loc_obj_id{loc_id}static intH5Otoken_cmp(long loc_id, H5O_token_t token1, H5O_token_t token2, int[] cmp_value)static intH5Otoken_cmp(long loc_id, H5O_token_t token1, H5O_token_t token2, IntBuffer cmp_value)static intH5Otoken_cmp(long loc_id, H5O_token_t token1, H5O_token_t token2, IntPointer cmp_value)------------------------------------------------------------------------- \ingroup H5O \brief Compares two VOL connector object tokens \fgdta_loc_obj_id{loc_id}static intH5Otoken_from_str(long loc_id, String token_str, H5O_token_t token)static intH5Otoken_from_str(long loc_id, BytePointer token_str, H5O_token_t token)------------------------------------------------------------------------- \ingroup H5O \brief Deserializes a string into a connector object token \fgdta_loc_obj_id{loc_id}static intH5Otoken_to_str(long loc_id, H5O_token_t token, byte[] token_str)static intH5Otoken_to_str(long loc_id, H5O_token_t token, ByteBuffer token_str)static intH5Otoken_to_str(long loc_id, H5O_token_t token, BytePointer token_str)static intH5Otoken_to_str(long loc_id, H5O_token_t token, PointerPointer token_str)------------------------------------------------------------------------- \ingroup H5O \brief Serializes a connector's object token into a string \fgdta_loc_obj_id{loc_id}static intH5Ovisit_by_name3(long loc_id, String obj_name, int idx_type, int order, H5O_iterate2_t op, Pointer op_data, int fields, long lapl_id)static intH5Ovisit_by_name3(long loc_id, BytePointer obj_name, int idx_type, int order, H5O_iterate2_t op, Pointer op_data, int fields, long lapl_id)------------------------------------------------------------------------- \ingroup H5O \brief Recursively visits all objects accessible from a specified object \fgdta_loc_obj_id{loc_id}static intH5Ovisit3(long obj_id, int idx_type, int order, H5O_iterate2_t op, Pointer op_data, int fields)------------------------------------------------------------------------- \ingroup H5O \brief Recursively visits all objects accessible from a specified object \fgdta_loc_obj_id{obj_id} \idx_type \orderstatic intH5P_ATTRIBUTE_ACCESS()static intH5P_ATTRIBUTE_ACCESS_DEFAULT()static intH5P_ATTRIBUTE_CREATE()static intH5P_ATTRIBUTE_CREATE_DEFAULT()static longH5P_CLS_ATTRIBUTE_ACCESS_ID_g()static voidH5P_CLS_ATTRIBUTE_ACCESS_ID_g(long setter)static longH5P_CLS_ATTRIBUTE_CREATE_ID_g()static voidH5P_CLS_ATTRIBUTE_CREATE_ID_g(long setter)static longH5P_CLS_DATASET_ACCESS_ID_g()static voidH5P_CLS_DATASET_ACCESS_ID_g(long setter)static longH5P_CLS_DATASET_CREATE_ID_g()static voidH5P_CLS_DATASET_CREATE_ID_g(long setter)static longH5P_CLS_DATASET_XFER_ID_g()static voidH5P_CLS_DATASET_XFER_ID_g(long setter)static longH5P_CLS_DATATYPE_ACCESS_ID_g()static voidH5P_CLS_DATATYPE_ACCESS_ID_g(long setter)static longH5P_CLS_DATATYPE_CREATE_ID_g()static voidH5P_CLS_DATATYPE_CREATE_ID_g(long setter)static longH5P_CLS_FILE_ACCESS_ID_g()static voidH5P_CLS_FILE_ACCESS_ID_g(long setter)static longH5P_CLS_FILE_CREATE_ID_g()static voidH5P_CLS_FILE_CREATE_ID_g(long setter)static longH5P_CLS_FILE_MOUNT_ID_g()static voidH5P_CLS_FILE_MOUNT_ID_g(long setter)static longH5P_CLS_GROUP_ACCESS_ID_g()static voidH5P_CLS_GROUP_ACCESS_ID_g(long setter)static longH5P_CLS_GROUP_CREATE_ID_g()static voidH5P_CLS_GROUP_CREATE_ID_g(long setter)static longH5P_CLS_LINK_ACCESS_ID_g()static voidH5P_CLS_LINK_ACCESS_ID_g(long setter)static longH5P_CLS_LINK_CREATE_ID_g()static voidH5P_CLS_LINK_CREATE_ID_g(long setter)static longH5P_CLS_MAP_ACCESS_ID_g()static voidH5P_CLS_MAP_ACCESS_ID_g(long setter)static longH5P_CLS_MAP_CREATE_ID_g()static voidH5P_CLS_MAP_CREATE_ID_g(long setter)static longH5P_CLS_OBJECT_COPY_ID_g()static voidH5P_CLS_OBJECT_COPY_ID_g(long setter)static longH5P_CLS_OBJECT_CREATE_ID_g()static voidH5P_CLS_OBJECT_CREATE_ID_g(long setter)static longH5P_CLS_REFERENCE_ACCESS_ID_g()static voidH5P_CLS_REFERENCE_ACCESS_ID_g(long setter)static longH5P_CLS_ROOT_ID_g()static voidH5P_CLS_ROOT_ID_g(long setter)static longH5P_CLS_STRING_CREATE_ID_g()static voidH5P_CLS_STRING_CREATE_ID_g(long setter)static longH5P_CLS_VOL_INITIALIZE_ID_g()static voidH5P_CLS_VOL_INITIALIZE_ID_g(long setter)static intH5P_DATASET_ACCESS()static intH5P_DATASET_ACCESS_DEFAULT()static intH5P_DATASET_CREATE()static intH5P_DATASET_CREATE_DEFAULT()static intH5P_DATASET_XFER()static intH5P_DATASET_XFER_DEFAULT()static intH5P_DATATYPE_ACCESS()static intH5P_DATATYPE_ACCESS_DEFAULT()static intH5P_DATATYPE_CREATE()static intH5P_DATATYPE_CREATE_DEFAULT()static intH5P_DEFAULT()Default value of type \ref hid_t for all property list classesstatic intH5P_FILE_ACCESS()static intH5P_FILE_ACCESS_DEFAULT()static intH5P_FILE_CREATE()static intH5P_FILE_CREATE_DEFAULT()static intH5P_FILE_MOUNT()static intH5P_FILE_MOUNT_DEFAULT()static intH5P_GROUP_ACCESS()static intH5P_GROUP_ACCESS_DEFAULT()static intH5P_GROUP_CREATE()static intH5P_GROUP_CREATE_DEFAULT()static intH5P_LINK_ACCESS()static intH5P_LINK_ACCESS_DEFAULT()static intH5P_LINK_CREATE()static intH5P_LINK_CREATE_DEFAULT()static longH5P_LST_ATTRIBUTE_ACCESS_ID_g()static voidH5P_LST_ATTRIBUTE_ACCESS_ID_g(long setter)static longH5P_LST_ATTRIBUTE_CREATE_ID_g()static voidH5P_LST_ATTRIBUTE_CREATE_ID_g(long setter)static longH5P_LST_DATASET_ACCESS_ID_g()static voidH5P_LST_DATASET_ACCESS_ID_g(long setter)static longH5P_LST_DATASET_CREATE_ID_g()static voidH5P_LST_DATASET_CREATE_ID_g(long setter)static longH5P_LST_DATASET_XFER_ID_g()static voidH5P_LST_DATASET_XFER_ID_g(long setter)static longH5P_LST_DATATYPE_ACCESS_ID_g()static voidH5P_LST_DATATYPE_ACCESS_ID_g(long setter)static longH5P_LST_DATATYPE_CREATE_ID_g()static voidH5P_LST_DATATYPE_CREATE_ID_g(long setter)static longH5P_LST_FILE_ACCESS_ID_g()static voidH5P_LST_FILE_ACCESS_ID_g(long setter)static longH5P_LST_FILE_CREATE_ID_g()static voidH5P_LST_FILE_CREATE_ID_g(long setter)static longH5P_LST_FILE_MOUNT_ID_g()static voidH5P_LST_FILE_MOUNT_ID_g(long setter)static longH5P_LST_GROUP_ACCESS_ID_g()static voidH5P_LST_GROUP_ACCESS_ID_g(long setter)static longH5P_LST_GROUP_CREATE_ID_g()static voidH5P_LST_GROUP_CREATE_ID_g(long setter)static longH5P_LST_LINK_ACCESS_ID_g()static voidH5P_LST_LINK_ACCESS_ID_g(long setter)static longH5P_LST_LINK_CREATE_ID_g()static voidH5P_LST_LINK_CREATE_ID_g(long setter)static longH5P_LST_MAP_ACCESS_ID_g()static voidH5P_LST_MAP_ACCESS_ID_g(long setter)static longH5P_LST_MAP_CREATE_ID_g()static voidH5P_LST_MAP_CREATE_ID_g(long setter)static longH5P_LST_OBJECT_COPY_ID_g()static voidH5P_LST_OBJECT_COPY_ID_g(long setter)static longH5P_LST_REFERENCE_ACCESS_ID_g()static voidH5P_LST_REFERENCE_ACCESS_ID_g(long setter)static longH5P_LST_VOL_INITIALIZE_ID_g()static voidH5P_LST_VOL_INITIALIZE_ID_g(long setter)static intH5P_MAP_ACCESS()static intH5P_MAP_ACCESS_DEFAULT()static intH5P_MAP_CREATE()static intH5P_MAP_CREATE_DEFAULT()static intH5P_OBJECT_COPY()static intH5P_OBJECT_COPY_DEFAULT()static intH5P_OBJECT_CREATE()static intH5P_REFERENCE_ACCESS()static intH5P_REFERENCE_ACCESS_DEFAULT()static intH5P_ROOT()static intH5P_STRING_CREATE()static intH5P_VOL_INITIALIZE()static intH5P_VOL_INITIALIZE_DEFAULT()static intH5Padd_merge_committed_dtype_path(long plist_id, String path)static intH5Padd_merge_committed_dtype_path(long plist_id, BytePointer path)\ingroup OCPYPL \brief Adds a path to the list of paths that will be searched in the destination file for a matching committed datatypestatic intH5Pall_filters_avail(long plist_id)\ingroup DCPL \brief Verifies that all required filters are available \plist_idstatic intH5Pclose(long plist_id)\ingroup PLCR \brief Terminates access to a property list \plist_idstatic intH5Pclose_class(long plist_id)\ingroup PLCRA \brief Closes an existing property list class \plistcls_id{plist_id}static longH5Pcopy(long plist_id)\ingroup PLCR \brief Copies an existing property list to create a new property list \plist_idstatic intH5Pcopy_prop(long dst_id, long src_id, String name)static intH5Pcopy_prop(long dst_id, long src_id, BytePointer name)\ingroup PLCRA \brief Copies a property from one list or class to anotherstatic longH5Pcreate(long cls_id)\ingroup PLCR \brief Creates a new property list as an instance of a property list class \plistcls_id{cls_id}static longH5Pcreate_class(long parent, String name, H5P_cls_create_func_t create, Pointer create_data, H5P_cls_copy_func_t copy, Pointer copy_data, H5P_cls_close_func_t _close, Pointer close_data)static longH5Pcreate_class(long parent, BytePointer name, H5P_cls_create_func_t create, Pointer create_data, H5P_cls_copy_func_t copy, Pointer copy_data, H5P_cls_close_func_t _close, Pointer close_data)\ingroup PLCRA \brief Creates a new property list class \plistcls_id{parent}static longH5Pdecode(Pointer buf)\ingroup PLCR \brief Decodes property list received in a binary object buffer and returns a new property list identifierstatic intH5Pencode2(long plist_id, Pointer buf, SizeTPointer nalloc, long fapl_id)\ingroup PLCR \brief Encodes the property values in a property list into a binary buffer \plist_idstatic intH5Pequal(long id1, long id2)\ingroup PLCRA \brief Compares two property lists or classes for equalitystatic intH5Pexist(long plist_id, String name)static intH5Pexist(long plist_id, BytePointer name)\ingroup PLCRA \brief Queries whether a property name exists in a property list or classstatic intH5Pfill_value_defined(long plist, int[] status)static intH5Pfill_value_defined(long plist, IntBuffer status)static intH5Pfill_value_defined(long plist, IntPointer status)\ingroup DCPL \brief Determines whether fill value is defined \dcpl_id{plist}static intH5Pfree_merge_committed_dtype_paths(long plist_id)\ingroup OCPYPL \brief Clears the list of paths stored in the object copy property liststatic intH5Pget(long plist_id, String name, Pointer value)static intH5Pget(long plist_id, BytePointer name, Pointer value)\ingroup PLCRA \brief Queries the value of a property \plist_idstatic intH5Pget_alignment(long fapl_id, long[] threshold, long... alignment)static intH5Pget_alignment(long fapl_id, LongBuffer threshold, LongBuffer alignment)static intH5Pget_alignment(long fapl_id, LongPointer threshold, LongPointer alignment)\ingroup FAPL \brief Retrieves the current settings for alignment properties from a file access property list \fapl_idstatic intH5Pget_alloc_time(long plist_id, int[] alloc_time)static intH5Pget_alloc_time(long plist_id, IntBuffer alloc_time)static intH5Pget_alloc_time(long plist_id, IntPointer alloc_time)\ingroup DCPL \brief Retrieves the timing for storage space allocation \dcpl_id{plist_id}static intH5Pget_append_flush(long dapl_id, int dims, long[] boundary, H5D_append_cb_t func, Pointer udata)static intH5Pget_append_flush(long dapl_id, int dims, LongBuffer boundary, H5D_append_cb_t func, Pointer udata)static intH5Pget_append_flush(long dapl_id, int dims, LongPointer boundary, H5D_append_cb_t func, Pointer udata)static intH5Pget_append_flush(long dapl_id, int dims, LongPointer boundary, H5D_append_cb_t func, PointerPointer udata)\ingroup DAPL \brief Retrieves the values of the append property that is set up in the dataset access property list \dapl_idstatic intH5Pget_attr_creation_order(long plist_id, int[] crt_order_flags)static intH5Pget_attr_creation_order(long plist_id, IntBuffer crt_order_flags)static intH5Pget_attr_creation_order(long plist_id, IntPointer crt_order_flags)\ingroup OCPL \brief Retrieves tracking and indexing settings for attribute creation order \plist_idstatic intH5Pget_attr_phase_change(long plist_id, int[] max_compact, int[] min_dense)static intH5Pget_attr_phase_change(long plist_id, IntBuffer max_compact, IntBuffer min_dense)static intH5Pget_attr_phase_change(long plist_id, IntPointer max_compact, IntPointer min_dense)\ingroup OCPL \brief Retrieves attribute storage phase change thresholds \plist_idstatic intH5Pget_btree_ratios(long plist_id, double[] left, double[] middle, double[] right)static intH5Pget_btree_ratios(long plist_id, DoubleBuffer left, DoubleBuffer middle, DoubleBuffer right)static intH5Pget_btree_ratios(long plist_id, DoublePointer left, DoublePointer middle, DoublePointer right)\ingroup DXPL \brief Gets B-tree split ratios for a dataset transfer property list \dxpl_id{plist_id}static longH5Pget_buffer(long plist_id, PointerPointer tconv, PointerPointer bkg)\ingroup DXPL \brief Reads buffer settingsstatic longH5Pget_buffer(long plist_id, Pointer tconv, Pointer bkg)static intH5Pget_cache(long plist_id, int[] mdc_nelmts, SizeTPointer rdcc_nslots, SizeTPointer rdcc_nbytes, double[] rdcc_w0)static intH5Pget_cache(long plist_id, IntBuffer mdc_nelmts, SizeTPointer rdcc_nslots, SizeTPointer rdcc_nbytes, DoubleBuffer rdcc_w0)static intH5Pget_cache(long plist_id, IntPointer mdc_nelmts, SizeTPointer rdcc_nslots, SizeTPointer rdcc_nbytes, DoublePointer rdcc_w0)\ingroup FAPL \brief Queries the raw data chunk cache parameters \fapl_id{plist_id}static intH5Pget_char_encoding(long plist_id, int[] encoding)static intH5Pget_char_encoding(long plist_id, IntBuffer encoding)static intH5Pget_char_encoding(long plist_id, IntPointer encoding)\ingroup ACPL \brief Retrieves the character encoding used to create a link or attribute namestatic intH5Pget_chunk(long plist_id, int max_ndims, long... dim)static intH5Pget_chunk(long plist_id, int max_ndims, LongBuffer dim)static intH5Pget_chunk(long plist_id, int max_ndims, LongPointer dim)\ingroup DCPL \brief Retrieves the size of chunks for the raw data of a chunked layout dataset \dcpl_id{plist_id}static intH5Pget_chunk_cache(long dapl_id, SizeTPointer rdcc_nslots, SizeTPointer rdcc_nbytes, double[] rdcc_w0)static intH5Pget_chunk_cache(long dapl_id, SizeTPointer rdcc_nslots, SizeTPointer rdcc_nbytes, DoubleBuffer rdcc_w0)static intH5Pget_chunk_cache(long dapl_id, SizeTPointer rdcc_nslots, SizeTPointer rdcc_nbytes, DoublePointer rdcc_w0)\ingroup DAPL \brief Retrieves the raw data chunk cache parameters \dapl_idstatic intH5Pget_chunk_opts(long plist_id, int[] opts)static intH5Pget_chunk_opts(long plist_id, IntBuffer opts)static intH5Pget_chunk_opts(long plist_id, IntPointer opts)\ingroup DCPL \brief Retrieves the edge chunk option setting from a dataset creation property list \dcpl_id{plist_id}static longH5Pget_class(long plist_id)\ingroup PLCR \brief Returns the property list class identifier for a property list \plist_idstatic BytePointerH5Pget_class_name(long pclass_id)\ingroup PLCRA \brief Retrieves the name of a class \plistcls_id{pclass_id}static longH5Pget_class_parent(long pclass_id)\ingroup PLCRA \brief Retrieves the parent class of a property class \plistcls_id{pclass_id}static intH5Pget_copy_object(long plist_id, int[] copy_options)static intH5Pget_copy_object(long plist_id, IntBuffer copy_options)static intH5Pget_copy_object(long plist_id, IntPointer copy_options)\ingroup OCPYPL \brief Retrieves the properties to be used when an object is copiedstatic intH5Pget_core_write_tracking(long fapl_id, boolean[] is_enabled, SizeTPointer page_size)static intH5Pget_core_write_tracking(long fapl_id, BoolPointer is_enabled, SizeTPointer page_size)\ingroup FAPL \brief Gets information about the write tracking feature used by the core VFD \fapl_idstatic intH5Pget_create_intermediate_group(long plist_id, int[] crt_intmd)static intH5Pget_create_intermediate_group(long plist_id, IntBuffer crt_intmd)static intH5Pget_create_intermediate_group(long plist_id, IntPointer crt_intmd)\ingroup LCPL \brief Determines whether property is set to enable creating missing intermediate groups \lcpl_id{plist_id}static longH5Pget_data_transform(long plist_id, byte[] expression, long size)static longH5Pget_data_transform(long plist_id, ByteBuffer expression, long size)static longH5Pget_data_transform(long plist_id, BytePointer expression, long size)\ingroup DXPL \brief Retrieves a data transform expressionstatic longH5Pget_driver(long plist_id)\ingroup FAPL \brief Returns low-lever driver identifier \plist_idstatic longH5Pget_driver_config_str(long fapl_id, byte[] config_buf, long buf_size)static longH5Pget_driver_config_str(long fapl_id, ByteBuffer config_buf, long buf_size)static longH5Pget_driver_config_str(long fapl_id, BytePointer config_buf, long buf_size)\ingroup FAPL \brief Retrieves a string representation of the configuration for the driver set on the given FAPL.static PointerH5Pget_driver_info(long plist_id)\ingroup FAPL \brief Returns a pointer to file driver informationstatic intH5Pget_dset_no_attrs_hint(long dcpl_id, boolean[] minimize)static intH5Pget_dset_no_attrs_hint(long dcpl_id, BoolPointer minimize)\ingroup DCPL \brief Retrieves the setting for whether or not to create minimized dataset object headers \dcpl_idstatic intH5Pget_edc_check(long plist_id)\ingroup DXPL \brief Determines whether error-detection is enabled for dataset readsstatic longH5Pget_efile_prefix(long dapl_id, byte[] prefix, long size)static longH5Pget_efile_prefix(long dapl_id, ByteBuffer prefix, long size)static longH5Pget_efile_prefix(long dapl_id, BytePointer prefix, long size)\ingroup DAPL \brief Retrieves the prefix for external raw data storage files as set in the dataset access property list \dapl_idstatic intH5Pget_elink_acc_flags(long lapl_id, int[] flags)static intH5Pget_elink_acc_flags(long lapl_id, IntBuffer flags)static intH5Pget_elink_acc_flags(long lapl_id, IntPointer flags)\ingroup LAPL \brief Retrieves the external link traversal file access flag from the specified link access property list \lapl_idstatic intH5Pget_elink_cb(long lapl_id, H5L_elink_traverse_t func, Pointer op_data)static intH5Pget_elink_cb(long lapl_id, H5L_elink_traverse_t func, PointerPointer op_data)\ingroup LAPL \brief Retrieves the external link traversal callback function from the specified link access property list \lapl_idstatic longH5Pget_elink_fapl(long lapl_id)\ingroup LAPL \brief Retrieves the file access property list identifier associated with the link access property list \lapl_idstatic intH5Pget_elink_file_cache_size(long plist_id, int[] efc_size)static intH5Pget_elink_file_cache_size(long plist_id, IntBuffer efc_size)static intH5Pget_elink_file_cache_size(long plist_id, IntPointer efc_size)\ingroup FAPL \brief Retrieves the size of the external link open file cache \fapl_id{plist_id}static longH5Pget_elink_prefix(long plist_id, byte[] prefix, long size)static longH5Pget_elink_prefix(long plist_id, ByteBuffer prefix, long size)static longH5Pget_elink_prefix(long plist_id, BytePointer prefix, long size)\ingroup LAPL \brief Retrieves prefix applied to external link paths \lapl_id{plist_id}static intH5Pget_est_link_info(long plist_id, int[] est_num_entries, int[] est_name_len)static intH5Pget_est_link_info(long plist_id, IntBuffer est_num_entries, IntBuffer est_name_len)static intH5Pget_est_link_info(long plist_id, IntPointer est_num_entries, IntPointer est_name_len)\ingroup GCPL \brief Returns the estimated link count and average link name length in a group \gcpl_id{plist_id}static intH5Pget_evict_on_close(long fapl_id, boolean[] evict_on_close)static intH5Pget_evict_on_close(long fapl_id, BoolPointer evict_on_close)\ingroup FAPL \brief Retrieves the file access property list setting that determines whether an HDF5 object will be evicted from the library's metadata cache when it is closed \fapl_idstatic intH5Pget_external(long plist_id, int idx, long name_size, byte[] name, SizeTPointer offset, long... size)static intH5Pget_external(long plist_id, int idx, long name_size, ByteBuffer name, SizeTPointer offset, LongBuffer size)static intH5Pget_external(long plist_id, int idx, long name_size, BytePointer name, SizeTPointer offset, LongPointer size)\ingroup DCPL \brief Returns information about an external file \dcpl_id{plist_id}static intH5Pget_external_count(long plist_id)\ingroup DCPL \brief Returns the number of external files for a dataset \dcpl_id{plist_id}static intH5Pget_family_offset(long fapl_id, long... offset)static intH5Pget_family_offset(long fapl_id, LongBuffer offset)static intH5Pget_family_offset(long fapl_id, LongPointer offset)\ingroup FAPL \brief Retrieves a data offset from the file access property list \fapl_idstatic intH5Pget_fapl_core(long fapl_id, SizeTPointer increment, boolean[] backing_store)static intH5Pget_fapl_core(long fapl_id, SizeTPointer increment, BoolPointer backing_store)\ingroup FAPL \brief Queries core file driver properties \fapl_idstatic intH5Pget_fapl_family(long fapl_id, long[] memb_size, long... memb_fapl_id)static intH5Pget_fapl_family(long fapl_id, LongBuffer memb_size, LongBuffer memb_fapl_id)static intH5Pget_fapl_family(long fapl_id, LongPointer memb_size, LongPointer memb_fapl_id)\ingroup FAPL \brief Returns file access property list information \fapl_idstatic intH5Pget_fapl_multi(long fapl_id, int[] memb_map, long[] memb_fapl, byte[] memb_name, long[] memb_addr, boolean[] relax)static intH5Pget_fapl_multi(long fapl_id, int[] memb_map, long[] memb_fapl, byte[] memb_name, long[] memb_addr, BoolPointer relax)static intH5Pget_fapl_multi(long fapl_id, IntBuffer memb_map, LongBuffer memb_fapl, ByteBuffer memb_name, LongBuffer memb_addr, boolean[] relax)static intH5Pget_fapl_multi(long fapl_id, IntBuffer memb_map, LongBuffer memb_fapl, ByteBuffer memb_name, LongBuffer memb_addr, BoolPointer relax)static intH5Pget_fapl_multi(long fapl_id, IntPointer memb_map, LongPointer memb_fapl, BytePointer memb_name, LongPointer memb_addr, boolean[] relax)static intH5Pget_fapl_multi(long fapl_id, IntPointer memb_map, LongPointer memb_fapl, BytePointer memb_name, LongPointer memb_addr, BoolPointer relax)static intH5Pget_fapl_multi(long fapl_id, IntPointer memb_map, LongPointer memb_fapl, PointerPointer memb_name, LongPointer memb_addr, BoolPointer relax)\ingroup FAPL \brief Returns information about the multi-file access property list \fapl_idstatic intH5Pget_fclose_degree(long fapl_id, int[] degree)static intH5Pget_fclose_degree(long fapl_id, IntBuffer degree)static intH5Pget_fclose_degree(long fapl_id, IntPointer degree)\ingroup FAPL \brief Returns the file close degree \fapl_idstatic intH5Pget_file_image(long fapl_id, PointerPointer buf_ptr_ptr, SizeTPointer buf_len_ptr)\ingroup FAPL \brief Retrieves a copy of the file image designated as the initial content and structure of a file \fapl_idstatic intH5Pget_file_image(long fapl_id, Pointer buf_ptr_ptr, SizeTPointer buf_len_ptr)static intH5Pget_file_image_callbacks(long fapl_id, H5FD_file_image_callbacks_t callbacks_ptr)\ingroup FAPL \brief Retrieves callback routines for working with file images \fapl_idstatic intH5Pget_file_locking(long fapl_id, boolean[] use_file_locking, boolean[] ignore_when_disabled)static intH5Pget_file_locking(long fapl_id, BoolPointer use_file_locking, BoolPointer ignore_when_disabled)\ingroup FAPL \brief Retrieves the file locking property values \fapl_idstatic intH5Pget_file_space_page_size(long plist_id, long... fsp_size)static intH5Pget_file_space_page_size(long plist_id, LongBuffer fsp_size)static intH5Pget_file_space_page_size(long plist_id, LongPointer fsp_size)\ingroup FCPL \brief Retrieves the file space page size for a file creation property list \fcpl_id{plist_id}static intH5Pget_file_space_strategy(long plist_id, int[] strategy, boolean[] persist, long... threshold)static intH5Pget_file_space_strategy(long plist_id, int[] strategy, BoolPointer persist, long... threshold)static intH5Pget_file_space_strategy(long plist_id, IntBuffer strategy, boolean[] persist, LongBuffer threshold)static intH5Pget_file_space_strategy(long plist_id, IntBuffer strategy, BoolPointer persist, LongBuffer threshold)static intH5Pget_file_space_strategy(long plist_id, IntPointer strategy, boolean[] persist, LongPointer threshold)static intH5Pget_file_space_strategy(long plist_id, IntPointer strategy, BoolPointer persist, LongPointer threshold)\ingroup FCPL \brief Retrieves the file space handling strategy, persisting free-space condition and threshold value for a file creation property list \fcpl_id{plist_id}static intH5Pget_fill_time(long plist_id, int[] fill_time)static intH5Pget_fill_time(long plist_id, IntBuffer fill_time)static intH5Pget_fill_time(long plist_id, IntPointer fill_time)\ingroup DCPL \brief Retrieves the time when fill values are written to a dataset \dcpl_id{plist_id}static intH5Pget_fill_value(long plist_id, long type_id, Pointer value)\ingroup DCPL \brief Retrieves a dataset fill value \dcpl_id{plist_id}static intH5Pget_filter_by_id2(long plist_id, int filter_id, int[] flags, SizeTPointer cd_nelmts, int[] cd_values, long namelen, byte[] name, int[] filter_config)static intH5Pget_filter_by_id2(long plist_id, int filter_id, IntBuffer flags, SizeTPointer cd_nelmts, IntBuffer cd_values, long namelen, ByteBuffer name, IntBuffer filter_config)static intH5Pget_filter_by_id2(long plist_id, int filter_id, IntPointer flags, SizeTPointer cd_nelmts, IntPointer cd_values, long namelen, BytePointer name, IntPointer filter_config)\ingroup OCPL \brief Returns information about the specified filter \ocpl_id{plist_id}static intH5Pget_filter2(long plist_id, int idx, int[] flags, SizeTPointer cd_nelmts, int[] cd_values, long namelen, byte[] name, int[] filter_config)static intH5Pget_filter2(long plist_id, int idx, IntBuffer flags, SizeTPointer cd_nelmts, IntBuffer cd_values, long namelen, ByteBuffer name, IntBuffer filter_config)static intH5Pget_filter2(long plist_id, int idx, IntPointer flags, SizeTPointer cd_nelmts, IntPointer cd_values, long namelen, BytePointer name, IntPointer filter_config)\ingroup OCPL \brief Returns information about a filter in a pipeline \ocpl_id{plist_id}static intH5Pget_gc_references(long fapl_id, int[] gc_ref)static intH5Pget_gc_references(long fapl_id, IntBuffer gc_ref)static intH5Pget_gc_references(long fapl_id, IntPointer gc_ref)\ingroup FAPL \brief Returns garbage collecting references setting \fapl_idstatic intH5Pget_hyper_vector_size(long fapl_id, SizeTPointer size)\ingroup DXPL \brief Retrieves number of I/O vectors to be read/written in hyperslab I/Ostatic intH5Pget_istore_k(long plist_id, int[] ik)static intH5Pget_istore_k(long plist_id, IntBuffer ik)static intH5Pget_istore_k(long plist_id, IntPointer ik)\ingroup FCPL \brief Queries the 1/2 rank of an indexed storage B-tree \fcpl_id{plist_id}static intH5Pget_layout(long plist_id)\ingroup DCPL \brief Returns the layout of the raw data for a dataset \dcpl_id{plist_id}static intH5Pget_libver_bounds(long plist_id, int[] low, int[] high)static intH5Pget_libver_bounds(long plist_id, IntBuffer low, IntBuffer high)static intH5Pget_libver_bounds(long plist_id, IntPointer low, IntPointer high)\ingroup FAPL \brief Retrieves library version bounds settings that indirectly control the format versions used when creating objects \fapl_id{plist_id}static intH5Pget_link_creation_order(long plist_id, int[] crt_order_flags)static intH5Pget_link_creation_order(long plist_id, IntBuffer crt_order_flags)static intH5Pget_link_creation_order(long plist_id, IntPointer crt_order_flags)\ingroup GCPL \brief Queries whether link creation order is tracked and/or indexed in a groupstatic intH5Pget_link_phase_change(long plist_id, int[] max_compact, int[] min_dense)static intH5Pget_link_phase_change(long plist_id, IntBuffer max_compact, IntBuffer min_dense)static intH5Pget_link_phase_change(long plist_id, IntPointer max_compact, IntPointer min_dense)\ingroup GCPL \brief Queries the settings for conversion between compact and dense groups \gcpl_id{plist_id}static intH5Pget_local_heap_size_hint(long plist_id, SizeTPointer size_hint)\ingroup GCPL \brief Retrieves the anticipated size of the local heap for original-style groups \gcpl_id{plist_id}static intH5Pget_mcdt_search_cb(long plist_id, H5O_mcdt_search_cb_t func, Pointer op_data)static intH5Pget_mcdt_search_cb(long plist_id, H5O_mcdt_search_cb_t func, PointerPointer op_data)\ingroup OCPYPL \brief Retrieves the callback function from the specified object copy property liststatic intH5Pget_mdc_config(long plist_id, H5AC_cache_config_t config_ptr)\ingroup FAPL \brief Get the current initial metadata cache configuration from the provided file access property list \fapl_id{plist_id}static intH5Pget_mdc_image_config(long plist_id, H5AC_cache_image_config_t config_ptr)\ingroup FAPL \brief Retrieves the metadata cache image configuration values for a file access property list \fapl_id{plist_id}static intH5Pget_mdc_log_options(long plist_id, boolean[] is_enabled, byte[] location, SizeTPointer location_size, boolean[] start_on_access)static intH5Pget_mdc_log_options(long plist_id, boolean[] is_enabled, ByteBuffer location, SizeTPointer location_size, boolean[] start_on_access)static intH5Pget_mdc_log_options(long plist_id, boolean[] is_enabled, BytePointer location, SizeTPointer location_size, boolean[] start_on_access)static intH5Pget_mdc_log_options(long plist_id, BoolPointer is_enabled, byte[] location, SizeTPointer location_size, BoolPointer start_on_access)static intH5Pget_mdc_log_options(long plist_id, BoolPointer is_enabled, ByteBuffer location, SizeTPointer location_size, BoolPointer start_on_access)static intH5Pget_mdc_log_options(long plist_id, BoolPointer is_enabled, BytePointer location, SizeTPointer location_size, BoolPointer start_on_access)\ingroup FAPL \brief Gets metadata cache logging options \fapl_id{plist_id}static intH5Pget_meta_block_size(long fapl_id, long... size)static intH5Pget_meta_block_size(long fapl_id, LongBuffer size)static intH5Pget_meta_block_size(long fapl_id, LongPointer size)\ingroup FAPL \brief Returns the current metadata block size setting \fapl_id{fapl_id}static intH5Pget_metadata_read_attempts(long plist_id, int[] attempts)static intH5Pget_metadata_read_attempts(long plist_id, IntBuffer attempts)static intH5Pget_metadata_read_attempts(long plist_id, IntPointer attempts)\ingroup FAPL \brief Retrieves the number of read attempts from a file access property list \fapl_id{plist_id}static intH5Pget_multi_type(long fapl_id, int[] type)static intH5Pget_multi_type(long fapl_id, IntBuffer type)static intH5Pget_multi_type(long fapl_id, IntPointer type)\ingroup FAPL \brief Retrieves type of data property for MULTI driverstatic intH5Pget_nfilters(long plist_id)\ingroup OCPL \brief Returns the number of filters in the pipeline \ocpl_id{plist_id}static intH5Pget_nlinks(long plist_id, SizeTPointer nlinks)\ingroup LAPL \brief Retrieves the maximum number of link traversals \lapl_id{plist_id}static intH5Pget_nprops(long id, SizeTPointer nprops)\ingroup PLCRA \brief Queries the number of properties in a property list or classstatic intH5Pget_obj_track_times(long plist_id, boolean[] track_times)static intH5Pget_obj_track_times(long plist_id, BoolPointer track_times)\ingroup OCPL \brief Determines whether times associated with an object are being recorded \plist_idstatic intH5Pget_object_flush_cb(long plist_id, H5F_flush_cb_t func, Pointer udata)static intH5Pget_object_flush_cb(long plist_id, H5F_flush_cb_t func, PointerPointer udata)\ingroup FAPL \brief Retrieves the object flush property values from the file access property list \fapl_id{plist_id}static intH5Pget_page_buffer_size(long plist_id, SizeTPointer buf_size, int[] min_meta_perc, int[] min_raw_perc)static intH5Pget_page_buffer_size(long plist_id, SizeTPointer buf_size, IntBuffer min_meta_perc, IntBuffer min_raw_perc)static intH5Pget_page_buffer_size(long plist_id, SizeTPointer buf_size, IntPointer min_meta_perc, IntPointer min_raw_perc)\ingroup FAPL \brief Retrieves the maximum size for the page buffer and the minimum percentage for metadata and raw data pages \fapl_id{plist_id}static intH5Pget_preserve(long plist_id)Deprecated.{H5Pget_preserve() is deprecated as it is no longer useful; compound datatype field preservation is now core functionality in the HDF5 library.}static intH5Pget_shared_mesg_index(long plist_id, int index_num, int[] mesg_type_flags, int[] min_mesg_size)static intH5Pget_shared_mesg_index(long plist_id, int index_num, IntBuffer mesg_type_flags, IntBuffer min_mesg_size)static intH5Pget_shared_mesg_index(long plist_id, int index_num, IntPointer mesg_type_flags, IntPointer min_mesg_size)\ingroup FCPL \brief Retrieves the configuration settings for a shared message index \fcpl_id{plist_id}static intH5Pget_shared_mesg_nindexes(long plist_id, int[] nindexes)static intH5Pget_shared_mesg_nindexes(long plist_id, IntBuffer nindexes)static intH5Pget_shared_mesg_nindexes(long plist_id, IntPointer nindexes)\ingroup FCPL \brief Retrieves the number of shared object header message indexes in file creation property list \fcpl_id{plist_id}static intH5Pget_shared_mesg_phase_change(long plist_id, int[] max_list, int[] min_btree)static intH5Pget_shared_mesg_phase_change(long plist_id, IntBuffer max_list, IntBuffer min_btree)static intH5Pget_shared_mesg_phase_change(long plist_id, IntPointer max_list, IntPointer min_btree)\ingroup FCPL \brief Retrieves shared object header message phase change information \fcpl_id{plist_id}static intH5Pget_sieve_buf_size(long fapl_id, SizeTPointer size)\ingroup FAPL \brief Returns maximum data sieve buffer size \fapl_id{fapl_id}static intH5Pget_size(long id, String name, SizeTPointer size)static intH5Pget_size(long id, BytePointer name, SizeTPointer size)\ingroup PLCRA \brief Queries the size of a property value in bytesstatic intH5Pget_sizes(long plist_id, SizeTPointer sizeof_addr, SizeTPointer sizeof_size)\ingroup FCPL \brief Retrieves the size of the offsets and lengths used in an HDF5 file \fcpl_id{plist_id}static intH5Pget_small_data_block_size(long fapl_id, long... size)static intH5Pget_small_data_block_size(long fapl_id, LongBuffer size)static intH5Pget_small_data_block_size(long fapl_id, LongPointer size)\ingroup FAPL \brief Retrieves the current small data block size setting \fapl_id{fapl_id}static intH5Pget_sym_k(long plist_id, int[] ik, int[] lk)static intH5Pget_sym_k(long plist_id, IntBuffer ik, IntBuffer lk)static intH5Pget_sym_k(long plist_id, IntPointer ik, IntPointer lk)\ingroup FCPL \brief Retrieves the size of the symbol table B-tree 1/2 rank and the symbol table leaf node 1/2 size \fcpl_id{plist_id}static intH5Pget_type_conv_cb(long dxpl_id, H5T_conv_except_func_t op, Pointer operate_data)static intH5Pget_type_conv_cb(long dxpl_id, H5T_conv_except_func_t op, PointerPointer operate_data)\ingroup DXPL \brief Gets user-defined datatype conversion callback functionstatic intH5Pget_userblock(long plist_id, long... size)static intH5Pget_userblock(long plist_id, LongBuffer size)static intH5Pget_userblock(long plist_id, LongPointer size)\ingroup FCPL \brief Retrieves the size of a user block \fcpl_id{plist_id}static intH5Pget_virtual_count(long dcpl_id, SizeTPointer count)\ingroup DCPL \brief Gets the number of mappings for the virtual dataset \dcpl_idstatic longH5Pget_virtual_dsetname(long dcpl_id, long index, byte[] name, long size)static longH5Pget_virtual_dsetname(long dcpl_id, long index, ByteBuffer name, long size)static longH5Pget_virtual_dsetname(long dcpl_id, long index, BytePointer name, long size)\ingroup DCPL \brief Gets the name of a source dataset used in the mapping \dcpl_idstatic longH5Pget_virtual_filename(long dcpl_id, long index, byte[] name, long size)static longH5Pget_virtual_filename(long dcpl_id, long index, ByteBuffer name, long size)static longH5Pget_virtual_filename(long dcpl_id, long index, BytePointer name, long size)\ingroup DCPL \brief Gets the filename of a source dataset used in the mapping \dcpl_idstatic longH5Pget_virtual_prefix(long dapl_id, byte[] prefix, long size)static longH5Pget_virtual_prefix(long dapl_id, ByteBuffer prefix, long size)static longH5Pget_virtual_prefix(long dapl_id, BytePointer prefix, long size)\ingroup DAPL \brief Retrieves prefix applied to VDS source file paths \dapl_idstatic intH5Pget_virtual_printf_gap(long dapl_id, long... gap_size)static intH5Pget_virtual_printf_gap(long dapl_id, LongBuffer gap_size)static intH5Pget_virtual_printf_gap(long dapl_id, LongPointer gap_size)\ingroup DAPL \brief Returns the maximum number of missing source files and/or datasets with the printf-style names when getting the extent for an unlimited virtual dataset \dapl_idstatic longH5Pget_virtual_srcspace(long dcpl_id, long index)\ingroup DCPL \brief Gets a dataspace identifier for the selection within the source dataset used in the mapping \dcpl_idstatic intH5Pget_virtual_view(long dapl_id, int[] view)static intH5Pget_virtual_view(long dapl_id, IntBuffer view)static intH5Pget_virtual_view(long dapl_id, IntPointer view)\ingroup DAPL \brief Retrieves the view of a virtual dataset accessed with \p dapl_id \dapl_idstatic longH5Pget_virtual_vspace(long dcpl_id, long index)\ingroup DCPL \brief Gets a dataspace identifier for the selection within the virtual dataset used in the mapping \dcpl_idstatic intH5Pget_vlen_mem_manager(long plist_id, H5MM_allocate_t alloc_func, PointerPointer alloc_info, H5MM_free_t free_func, PointerPointer free_info)\ingroup DXPL \brief Gets the memory manager for variable-length datatype allocation in H5Dread() and H5Dvlen_reclaim()static intH5Pget_vlen_mem_manager(long plist_id, H5MM_allocate_t alloc_func, Pointer alloc_info, H5MM_free_t free_func, Pointer free_info)static intH5Pget_vol_cap_flags(long plist_id, long[] cap_flags)static intH5Pget_vol_cap_flags(long plist_id, LongBuffer cap_flags)static intH5Pget_vol_cap_flags(long plist_id, LongPointer cap_flags)\ingroup FAPL \brief Query the capability flags for the VOL connector that will be used with this file access property list (FAPL).static intH5Pget_vol_id(long plist_id, long... vol_id)static intH5Pget_vol_id(long plist_id, LongBuffer vol_id)static intH5Pget_vol_id(long plist_id, LongPointer vol_id)\ingroup FAPL \brief Returns the identifier of the current VOL connector \fapl_id{plist_id}static intH5Pget_vol_info(long plist_id, Pointer vol_info)static intH5Pget_vol_info(long plist_id, PointerPointer vol_info)\ingroup FAPL \brief Returns a copy of the VOL information for a connector \fapl_id{plist_id}static intH5Pinsert2(long plist_id, String name, long size, Pointer value, H5P_prp_cb2_t set, H5P_prp_cb2_t get, H5P_prp_cb2_t prp_del, H5P_prp_cb1_t copy, H5P_prp_compare_func_t compare, H5P_prp_cb1_t _close)static intH5Pinsert2(long plist_id, BytePointer name, long size, Pointer value, H5P_prp_cb2_t set, H5P_prp_cb2_t get, H5P_prp_cb2_t prp_del, H5P_prp_cb1_t copy, H5P_prp_compare_func_t compare, H5P_prp_cb1_t _close)\ingroup PLCRA \brief Registers a temporary property with a property list \plist_idstatic intH5Pisa_class(long plist_id, long pclass_id)\ingroup PLCRA \brief Determines whether a property list is a member of a class \plist_id \plistcls_id{pclass_id}static intH5Piterate(long id, int[] idx, H5P_iterate_t iter_func, Pointer iter_data)static intH5Piterate(long id, IntBuffer idx, H5P_iterate_t iter_func, Pointer iter_data)static intH5Piterate(long id, IntPointer idx, H5P_iterate_t iter_func, Pointer iter_data)\ingroup PLCRA \brief Iterates over properties in a property class or liststatic intH5PLappend(String search_path)static intH5PLappend(BytePointer search_path)\ingroup H5PL \brief Inserts a plugin path at the end of the plugin search path liststatic longH5PLget(int index, byte[] path_buf, long buf_size)static longH5PLget(int index, ByteBuffer path_buf, long buf_size)static longH5PLget(int index, BytePointer path_buf, long buf_size)\ingroup H5PL \brief Queries the plugin search path list at the specified indexstatic intH5PLget_loading_state(int[] plugin_control_mask)static intH5PLget_loading_state(IntBuffer plugin_control_mask)static intH5PLget_loading_state(IntPointer plugin_control_mask)\ingroup H5PL \brief Queries the loadability of dynamic plugin typesstatic intH5PLinsert(String search_path, int index)static intH5PLinsert(BytePointer search_path, int index)\ingroup H5PL \brief Inserts a path at the specified index in the plugin search path liststatic intH5PLprepend(String search_path)static intH5PLprepend(BytePointer search_path)\ingroup H5PL \brief Inserts a plugin path at the beginning of the plugin search path liststatic intH5PLremove(int index)\ingroup H5PL \brief Removes a plugin path at a specified index from the plugin search path liststatic intH5PLreplace(String search_path, int index)static intH5PLreplace(BytePointer search_path, int index)\ingroup H5PL \brief Replaces the path at the specified index in the plugin search path liststatic intH5PLset_loading_state(int plugin_control_mask)\ingroup H5PL \brief Controls the loadability of dynamic plugin typesstatic intH5PLsize(int[] num_paths)static intH5PLsize(IntBuffer num_paths)static intH5PLsize(IntPointer num_paths)\ingroup H5PL \brief Retrieves the number of stored plugin pathsstatic intH5Pmodify_filter(long plist_id, int filter, int flags, long cd_nelmts, int[] cd_values)static intH5Pmodify_filter(long plist_id, int filter, int flags, long cd_nelmts, IntBuffer cd_values)static intH5Pmodify_filter(long plist_id, int filter, int flags, long cd_nelmts, IntPointer cd_values)\ingroup OCPL \brief Modifies a filter in the filter pipeline \ocpl_id{plist_id}static intH5Pregister2(long cls_id, String name, long size, Pointer def_value, H5P_prp_cb1_t create, H5P_prp_cb2_t set, H5P_prp_cb2_t get, H5P_prp_cb2_t prp_del, H5P_prp_cb1_t copy, H5P_prp_compare_func_t compare, H5P_prp_cb1_t _close)static intH5Pregister2(long cls_id, BytePointer name, long size, Pointer def_value, H5P_prp_cb1_t create, H5P_prp_cb2_t set, H5P_prp_cb2_t get, H5P_prp_cb2_t prp_del, H5P_prp_cb1_t copy, H5P_prp_compare_func_t compare, H5P_prp_cb1_t _close)\ingroup PLCRA \brief Registers a permanent property with a property list class \plistcls_id{cls_id}static intH5Premove(long plist_id, String name)static intH5Premove(long plist_id, BytePointer name)\ingroup PLCRA \brief Removes a property from a property list \plist_idstatic intH5Premove_filter(long plist_id, int filter)\ingroup OCPL \brief Delete one or more filters in the filter pipeline \ocpl_id{plist_id}static intH5Pset(long plist_id, String name, Pointer value)static intH5Pset(long plist_id, BytePointer name, Pointer value)\ingroup PLCRA \brief Sets a property list value \plist_idstatic intH5Pset_alignment(long fapl_id, long threshold, long alignment)\ingroup FAPL \brief Sets alignment properties of a file access property list \fapl_idstatic intH5Pset_alloc_time(long plist_id, int alloc_time)\ingroup DCPL \brief Sets the timing for storage space allocation \dcpl_id{plist_id}static intH5Pset_append_flush(long dapl_id, int ndims, long[] boundary, H5D_append_cb_t func, Pointer udata)static intH5Pset_append_flush(long dapl_id, int ndims, LongBuffer boundary, H5D_append_cb_t func, Pointer udata)static intH5Pset_append_flush(long dapl_id, int ndims, LongPointer boundary, H5D_append_cb_t func, Pointer udata)\ingroup DAPL \brief Sets two actions to perform when the size of a datasetâs dimension being appended reaches a specified boundary \dapl_idstatic intH5Pset_attr_creation_order(long plist_id, int crt_order_flags)\ingroup OCPL \brief Sets tracking and indexing of attribute creation order \plist_idstatic intH5Pset_attr_phase_change(long plist_id, int max_compact, int min_dense)\ingroup OCPL \brief Sets attribute storage phase change thresholds \plist_idstatic intH5Pset_btree_ratios(long plist_id, double left, double middle, double right)\ingroup DXPL \brief Sets B-tree split ratios for a dataset transfer property liststatic intH5Pset_buffer(long plist_id, long size, Pointer tconv, Pointer bkg)\ingroup DXPL \brief Sets type conversion and background buffers \dxpl_id{plist_id}static intH5Pset_cache(long plist_id, int mdc_nelmts, long rdcc_nslots, long rdcc_nbytes, double rdcc_w0)\ingroup FAPL \brief Sets the raw data chunk cache parameters \fapl_id{plist_id}static intH5Pset_char_encoding(long plist_id, int encoding)\ingroup ACPL \brief Sets the character encoding used to encode link and attribute namesstatic intH5Pset_chunk(long plist_id, int ndims, long... dim)static intH5Pset_chunk(long plist_id, int ndims, LongBuffer dim)static intH5Pset_chunk(long plist_id, int ndims, LongPointer dim)\ingroup DCPL \brief Sets the size of the chunks used to store a chunked layout dataset \dcpl_id{plist_id}static intH5Pset_chunk_cache(long dapl_id, long rdcc_nslots, long rdcc_nbytes, double rdcc_w0)\ingroup DAPL \brief Sets the raw data chunk cache parameters \dapl_idstatic intH5Pset_chunk_opts(long plist_id, int opts)\ingroup DCPL \brief Sets the edge chunk option in a dataset creation property list \dcpl_id{plist_id}static intH5Pset_copy_object(long plist_id, int copy_options)\ingroup OCPYPL \brief Sets properties to be used when an object is copiedstatic intH5Pset_core_write_tracking(long fapl_id, boolean is_enabled, long page_size)\ingroup FAPL \brief Sets write tracking information for core driver, #H5FD_CORE \fapl_id{fapl_id}static intH5Pset_create_intermediate_group(long plist_id, int crt_intmd)\ingroup LCPL \brief Specifies in property list whether to create missing intermediate groups \lcpl_id{plist_id}static intH5Pset_data_transform(long plist_id, String expression)static intH5Pset_data_transform(long plist_id, BytePointer expression)\ingroup DXPL \brief Sets a data transform expression \dxpl_id{plist_id}static intH5Pset_dataset_io_hyperslab_selection(long plist_id, int rank, int op, long[] start, long[] stride, long[] count, long... block)static intH5Pset_dataset_io_hyperslab_selection(long plist_id, int rank, int op, LongBuffer start, LongBuffer stride, LongBuffer count, LongBuffer block)static intH5Pset_dataset_io_hyperslab_selection(long plist_id, int rank, int op, LongPointer start, LongPointer stride, LongPointer count, LongPointer block)\ingroup DXPL \brief Sets a hyperslab file selection for a dataset I/O operationstatic intH5Pset_deflate(long plist_id, int level)\ingroup DCPL \brief Sets deflate (GNU gzip) compression method and compression level \ocpl_id{plist_id}static intH5Pset_driver(long plist_id, long driver_id, Pointer driver_info)\ingroup FAPL \brief Sets a file driver \plist_idstatic intH5Pset_driver_by_name(long plist_id, String driver_name, String driver_config)static intH5Pset_driver_by_name(long plist_id, BytePointer driver_name, BytePointer driver_config)\ingroup FAPL \brief Sets a file driver according to a given driver name \plist_idstatic intH5Pset_driver_by_value(long plist_id, int driver_value, String driver_config)static intH5Pset_driver_by_value(long plist_id, int driver_value, BytePointer driver_config)\ingroup FAPL \brief Sets a file driver according to a given driver value (ID).static intH5Pset_dset_no_attrs_hint(long dcpl_id, boolean minimize)\ingroup DCPL \brief Sets the flag to create minimized dataset object headers \dcpl_idstatic intH5Pset_edc_check(long plist_id, int check)\ingroup DXPL \brief Sets the dataset transfer property list to enable or disable error detection when reading data \dxpl_id{plist_id}static intH5Pset_efile_prefix(long dapl_id, String prefix)static intH5Pset_efile_prefix(long dapl_id, BytePointer prefix)\ingroup DAPL \brief Sets the external dataset storage file prefix in the dataset access property list \dapl_idstatic intH5Pset_elink_acc_flags(long lapl_id, int flags)\ingroup LAPL \brief Sets the external link traversal file access flag in a link access property list \lapl_idstatic intH5Pset_elink_cb(long lapl_id, H5L_elink_traverse_t func, Pointer op_data)\ingroup LAPL \brief Sets the external link traversal callback function in a link access property list \lapl_idstatic intH5Pset_elink_fapl(long lapl_id, long fapl_id)\ingroup LAPL \brief Sets a file access property list for use in accessing a file pointed to by an external link \lapl_id \fapl_idstatic intH5Pset_elink_file_cache_size(long plist_id, int efc_size)\ingroup FAPL \brief Sets the number of files that can be held open in an external link open file cache \par Motivation \parblock The external link open file cache holds files open after they have been accessed via an external link.static intH5Pset_elink_prefix(long plist_id, String prefix)static intH5Pset_elink_prefix(long plist_id, BytePointer prefix)\ingroup LAPL \brief Sets prefix to be applied to external link paths \lapl_id{plist_id}static intH5Pset_est_link_info(long plist_id, int est_num_entries, int est_name_len)\ingroup GCPL \brief Sets estimated number of links and length of link names in a group \gcpl_id{plist_id}static intH5Pset_evict_on_close(long fapl_id, boolean evict_on_close)\ingroup FAPL \brief Controls the library's behavior of evicting metadata associated with a closed object \fapl_idstatic intH5Pset_external(long plist_id, String name, long offset, long size)static intH5Pset_external(long plist_id, BytePointer name, long offset, long size)\ingroup DCPL \brief Adds an external file to the list of external files \dcpl_id{plist_id}static intH5Pset_family_offset(long fapl_id, long offset)\ingroup FAPL \brief Sets offset property for low-level access to a file in a family of files \fapl_idstatic intH5Pset_fapl_core(long fapl_id, long increment, boolean backing_store)\ingroup FAPL \brief Modifies the file access property list to use the #H5FD_CORE driver \fapl_idstatic intH5Pset_fapl_family(long fapl_id, long memb_size, long memb_fapl_id)\ingroup FAPL \brief Sets the file access property list to use the family driver \fapl_idstatic intH5Pset_fapl_log(long fapl_id, String logfile, long flags, long buf_size)static intH5Pset_fapl_log(long fapl_id, BytePointer logfile, long flags, long buf_size)\ingroup FAPL \brief Sets up the logging virtual file driver (#H5FD_LOG) for use \fapl_idstatic intH5Pset_fapl_multi(long fapl_id, int[] memb_map, long[] memb_fapl, byte[] memb_name, long[] memb_addr, boolean relax)static intH5Pset_fapl_multi(long fapl_id, IntBuffer memb_map, LongBuffer memb_fapl, ByteBuffer memb_name, LongBuffer memb_addr, boolean relax)static intH5Pset_fapl_multi(long fapl_id, IntPointer memb_map, LongPointer memb_fapl, BytePointer memb_name, LongPointer memb_addr, boolean relax)static intH5Pset_fapl_multi(long fapl_id, IntPointer memb_map, LongPointer memb_fapl, PointerPointer memb_name, LongPointer memb_addr, boolean relax)\ingroup FAPL \brief Sets up use of the multi-file driver \fapl_idstatic intH5Pset_fapl_sec2(long fapl_id)static intH5Pset_fapl_split(long fapl, String meta_ext, long meta_plist_id, String raw_ext, long raw_plist_id)static intH5Pset_fapl_split(long fapl, BytePointer meta_ext, long meta_plist_id, BytePointer raw_ext, long raw_plist_id)\ingroup FAPL \brief Emulates the old split file driver \fapl_id{fapl}static intH5Pset_fapl_stdio(long fapl_id)\ingroup FAPL \brief Sets the standard I/O driver \fapl_idstatic intH5Pset_fclose_degree(long fapl_id, int degree)\ingroup FAPL \brief Sets the file close degree \fapl_idstatic intH5Pset_file_image(long fapl_id, Pointer buf_ptr, long buf_len)\ingroup FAPL \brief Sets an initial file image in a memory buffer \fapl_idstatic intH5Pset_file_image_callbacks(long fapl_id, H5FD_file_image_callbacks_t callbacks_ptr)\ingroup FAPL \brief Sets the callbacks for working with file images \note **Motivation:** H5Pset_file_image_callbacks() and other elements of HDF5 are used to load an image of an HDF5 file into system memory and open that image as a regular HDF5 file.static intH5Pset_file_locking(long fapl_id, boolean use_file_locking, boolean ignore_when_disabled)\ingroup FAPL \brief Sets the file locking property values \fapl_idstatic intH5Pset_file_space_page_size(long plist_id, long fsp_size)\ingroup FCPL \brief Sets the file space page size for a file creation property list \fcpl_id{plist_id}static intH5Pset_file_space_strategy(long plist_id, int strategy, boolean persist, long threshold)\ingroup FCPL \brief Sets the file space handling strategy and persisting free-space values for a file creation property list \fcpl_id{plist_id}static intH5Pset_fill_time(long plist_id, int fill_time)\ingroup DCPL \brief Sets the time when fill values are written to a dataset \dcpl_id{plist_id}static intH5Pset_fill_value(long plist_id, long type_id, Pointer value)\ingroup DCPL \brief Sets the fill value for a dataset \dcpl_id{plist_id}static intH5Pset_filter(long plist_id, int filter, int flags, long cd_nelmts, int[] c_values)static intH5Pset_filter(long plist_id, int filter, int flags, long cd_nelmts, IntBuffer c_values)static intH5Pset_filter(long plist_id, int filter, int flags, long cd_nelmts, IntPointer c_values)\ingroup OCPL \brief Adds a filter to the filter pipeline \ocpl_id{plist_id}static intH5Pset_filter_callback(long plist_id, H5Z_filter_func_t func, Pointer op_data)\ingroup DXPL \brief Sets user-defined filter callback function \dxpl_id{plist_id}static intH5Pset_fletcher32(long plist_id)\ingroup OCPL \brief Sets up use of the Fletcher32 checksum filter \ocpl_id{plist_id}static intH5Pset_gc_references(long fapl_id, int gc_ref)\ingroup FAPL \brief Sets garbage collecting references flag \fapl_idstatic intH5Pset_hyper_vector_size(long plist_id, long size)\ingroup DXPL \brief Sets number of I/O vectors to be read/written in hyperslab I/O \dxpl_id{plist_id}static intH5Pset_istore_k(long plist_id, int ik)\ingroup FCPL \brief Sets the size of the parameter used to control the B-trees for indexing chunked datasets \fcpl_id{plist_id}static intH5Pset_layout(long plist_id, int layout)\ingroup DCPL \brief Sets the type of storage used to store the raw data for a dataset \dcpl_id{plist_id}static intH5Pset_libver_bounds(long plist_id, int low, int high)\ingroup FAPL \brief Controls the range of library release versions used when creating objects in a file \fapl_id{plist_id}static intH5Pset_link_creation_order(long plist_id, int crt_order_flags)\ingroup GCPL \brief Sets creation order tracking and indexing for links in a groupstatic intH5Pset_link_phase_change(long plist_id, int max_compact, int min_dense)\ingroup GCPL \brief Sets the parameters for conversion between compact and dense groups \gcpl_id{plist_id}static intH5Pset_local_heap_size_hint(long plist_id, long size_hint)\ingroup GCPL \brief Specifies the anticipated maximum size of a local heap \gcpl_id{plist_id}static intH5Pset_mcdt_search_cb(long plist_id, H5O_mcdt_search_cb_t func, Pointer op_data)\ingroup OCPYPL \brief Sets the callback function that H5Ocopy() will invoke before searching the entire destination file for a matching committed datatypestatic intH5Pset_mdc_config(long plist_id, H5AC_cache_config_t config_ptr)\ingroup FAPL \brief Set the initial metadata cache configuration in the indicated File Access Property List to the supplied value \fapl_id{plist_id}static intH5Pset_mdc_image_config(long plist_id, H5AC_cache_image_config_t config_ptr)\ingroup FAPL \brief Sets the metadata cache image option for a file access property list \fapl_id{plist_id}static intH5Pset_mdc_log_options(long plist_id, boolean is_enabled, String location, boolean start_on_access)static intH5Pset_mdc_log_options(long plist_id, boolean is_enabled, BytePointer location, boolean start_on_access)\ingroup FAPL \brief Sets metadata cache logging options \fapl_id{plist_id}static intH5Pset_meta_block_size(long fapl_id, long size)\ingroup FAPL \brief Sets the minimum metadata block size \fapl_id{fapl_id}static intH5Pset_metadata_read_attempts(long plist_id, int attempts)\ingroup FAPL \brief Sets the number of read attempts in a file access property list \fapl_id{plist_id}static intH5Pset_multi_type(long fapl_id, int type)\ingroup FAPL \brief Specifies type of data to be accessed via the \Code{MULTI} driver, enabling more direct access \fapl_id{fapl_id}static intH5Pset_nbit(long plist_id)\ingroup DCPL \brief Sets up the use of the N-Bit filter \dcpl_id{plist_id}static intH5Pset_nlinks(long plist_id, long nlinks)\ingroup LAPL \brief Sets maximum number of soft or user-defined link traversals \lapl_id{plist_id}static intH5Pset_obj_track_times(long plist_id, boolean track_times)\ingroup OCPL \brief Sets the recording of times associated with an objectstatic intH5Pset_object_flush_cb(long plist_id, H5F_flush_cb_t func, Pointer udata)\ingroup FAPL \brief Sets a callback function to invoke when an object flush occurs in the file \fapl_id{plist_id} \op{func} \op_data_in{udata}static intH5Pset_page_buffer_size(long plist_id, long buf_size, int min_meta_per, int min_raw_per)\ingroup FAPL \brief Sets the maximum size for the page buffer and the minimum percentage for metadata and raw data pages \fapl_id{plist_id}static intH5Pset_preserve(long plist_id, boolean status)Deprecated.This function is deprecated as it no longer has any effect; compound datatype field preservation is now core functionality in the HDF5 library.static intH5Pset_scaleoffset(long plist_id, int scale_type, int scale_factor)\ingroup DCPL \brief Sets up the use of the scale-offset filter \dcpl_id{plist_id}static intH5Pset_shared_mesg_index(long plist_id, int index_num, int mesg_type_flags, int min_mesg_size)\ingroup FCPL \brief Configures the specified shared object header message index \fcpl_id{plist_id}static intH5Pset_shared_mesg_nindexes(long plist_id, int nindexes)\ingroup FCPL \brief Sets number of shared object header message indexes \fcpl_id{plist_id}static intH5Pset_shared_mesg_phase_change(long plist_id, int max_list, int min_btree)\ingroup FCPL \brief Sets shared object header message storage phase change thresholds \fcpl_id{plist_id}static intH5Pset_shuffle(long plist_id)\ingroup DCPL \brief Sets up use of the shuffle filter \dcpl_id{plist_id}static intH5Pset_sieve_buf_size(long fapl_id, long size)\ingroup FAPL \brief Sets the maximum size of the data sieve buffer \fapl_id{fapl_id}static intH5Pset_sizes(long plist_id, long sizeof_addr, long sizeof_size)\ingroup FCPL \brief Sets the byte size of the offsets and lengths used to address objects in an HDF5 file \fcpl_id{plist_id}static intH5Pset_small_data_block_size(long fapl_id, long size)\ingroup FAPL \brief Sets the size of a contiguous block reserved for small data \fapl_id{fapl_id}static intH5Pset_sym_k(long plist_id, int ik, int lk)\ingroup FCPL \brief \fcpl_id{plist_id}static intH5Pset_szip(long plist_id, int options_mask, int pixels_per_block)\ingroup DCPL \brief Sets up use of the SZIP compression filter \dcpl_id{plist_id}static intH5Pset_type_conv_cb(long dxpl_id, H5T_conv_except_func_t op, Pointer operate_data)\ingroup DXPL \brief Sets user-defined datatype conversion callback function \dxpl_idstatic intH5Pset_userblock(long plist_id, long size)\ingroup FCPL \brief Sets user block size \fcpl_id{plist_id}static intH5Pset_virtual(long dcpl_id, long vspace_id, String src_file_name, String src_dset_name, long src_space_id)static intH5Pset_virtual(long dcpl_id, long vspace_id, BytePointer src_file_name, BytePointer src_dset_name, long src_space_id)\ingroup DCPL \brief Sets the mapping between virtual and source datasets \dcpl_idstatic intH5Pset_virtual_prefix(long dapl_id, String prefix)static intH5Pset_virtual_prefix(long dapl_id, BytePointer prefix)\ingroup DAPL \brief Sets prefix to be applied to VDS source file paths \dapl_idstatic intH5Pset_virtual_printf_gap(long dapl_id, long gap_size)\ingroup DAPL \brief Sets the maximum number of missing source files and/or datasets with the printf-style names when getting the extent of an unlimited virtual dataset \dapl_idstatic intH5Pset_virtual_view(long dapl_id, int view)\ingroup DAPL \brief Sets the view of the virtual dataset (VDS) to include or exclude missing mapped elements \dapl_idstatic intH5Pset_vlen_mem_manager(long plist_id, H5MM_allocate_t alloc_func, Pointer alloc_info, H5MM_free_t free_func, Pointer free_info)\ingroup DXPL \brief Sets the memory manager for variable-length datatype allocation in H5Dread() and H5Dvlen_reclaim() \dxpl_id{plist_id}static intH5Pset_vol(long plist_id, long new_vol_id, Pointer new_vol_info)\ingroup FAPL \brief Set the file VOL connector for a file access property list \fapl_id{plist_id}static intH5PTappend(long table_id, long nrecords, Pointer data)-------------------------------------------------------------------------- \ingroup H5PT \brief Appends packets to the end of a packet table.static intH5PTclose(long table_id)-------------------------------------------------------------------------- \ingroup H5PT \brief Closes an open packet table.static longH5PTcreate(long loc_id, String dset_name, long dtype_id, long chunk_size, long plist_id)static longH5PTcreate(long loc_id, BytePointer dset_name, long dtype_id, long chunk_size, long plist_id)-------------------------------------------------------------------------- \ingroup H5PT \brief Creates a packet table to store fixed-length or variable-length packets.static longH5PTcreate_fl(long loc_id, String dset_name, long dtype_id, long chunk_size, int compression)static longH5PTcreate_fl(long loc_id, BytePointer dset_name, long dtype_id, long chunk_size, int compression)Deprecated.This function was deprecated in favor of the function H5PTcreate().static intH5PTcreate_index(long table_id)-------------------------------------------------------------------------- \ingroup H5PT \brief Resets a packet table's index to the first packet.static intH5PTfree_vlen_buff(long table_id, long bufflen, Pointer buff)-------------------------------------------------------------------------- \ingroup H5PT \brief Releases memory allocated in the process of reading variable-length packets.static longH5PTget_dataset(long table_id)-------------------------------------------------------------------------- \ingroup H5PT \brief Returns the backend dataset of this packet table.static intH5PTget_index(long table_id, long... pt_index)static intH5PTget_index(long table_id, LongBuffer pt_index)static intH5PTget_index(long table_id, LongPointer pt_index)-------------------------------------------------------------------------- \ingroup H5PT \brief Gets the current record index for a packet table.static intH5PTget_next(long table_id, long nrecords, Pointer data)-------------------------------------------------------------------------- \ingroup H5PT \brief Reads packets from a packet table starting at the current index.static intH5PTget_num_packets(long table_id, long... nrecords)static intH5PTget_num_packets(long table_id, LongBuffer nrecords)static intH5PTget_num_packets(long table_id, LongPointer nrecords)-------------------------------------------------------------------------- \ingroup H5PT \brief Returns the number of packets in a packet table.static longH5PTget_type(long table_id)-------------------------------------------------------------------------- \ingroup H5PT \brief Returns the backend datatype of this packet table.static intH5PTis_valid(long table_id)-------------------------------------------------------------------------- \ingroup H5PT \brief Determines whether an identifier points to a packet table.static intH5PTis_varlen(long table_id)-------------------------------------------------------------------------- \ingroup H5PT \brief Determines whether a packet table contains variable-length or fixed-length packets.static longH5PTopen(long loc_id, String dset_name)static longH5PTopen(long loc_id, BytePointer dset_name)-------------------------------------------------------------------------- \ingroup H5PT \brief Opens an existing packet table.static intH5PTread_packets(long table_id, long start, long nrecords, Pointer data)-------------------------------------------------------------------------- \ingroup H5PT \brief Reads a number of packets from a packet table.static intH5PTset_index(long table_id, long pt_index)-------------------------------------------------------------------------- \ingroup H5PT \brief Sets a packet table's index.static intH5Punregister(long pclass_id, String name)static intH5Punregister(long pclass_id, BytePointer name)\ingroup PLCRA \brief Removes a property from a property list class \plistcls_id{pclass_id}static intH5R_DSET_REG_REF_BUF_SIZE()static intH5R_OBJ_REF_BUF_SIZE()static intH5Rcopy(H5R_ref_t src_ref_ptr, H5R_ref_t dst_ref_ptr)-------------------------------------------------------------------------- \ingroup H5R \brief Copies an existing referencestatic intH5Rcreate(Pointer ref, long loc_id, String name, int ref_type, long space_id)static intH5Rcreate(Pointer ref, long loc_id, BytePointer name, int ref_type, long space_id)-------------------------------------------------------------------------- \ingroup H5R \brief Creates a referencestatic intH5Rcreate_attr(long loc_id, String name, String attr_name, long oapl_id, H5R_ref_t ref_ptr)static intH5Rcreate_attr(long loc_id, BytePointer name, BytePointer attr_name, long oapl_id, H5R_ref_t ref_ptr)-------------------------------------------------------------------------- \ingroup H5R \brief Creates an attribute reference \fgdta_loc_idstatic intH5Rcreate_object(long loc_id, String name, long oapl_id, H5R_ref_t ref_ptr)static intH5Rcreate_object(long loc_id, BytePointer name, long oapl_id, H5R_ref_t ref_ptr)Deprecated.static intH5Rcreate_region(long loc_id, String name, long space_id, long oapl_id, H5R_ref_t ref_ptr)static intH5Rcreate_region(long loc_id, BytePointer name, long space_id, long oapl_id, H5R_ref_t ref_ptr)-------------------------------------------------------------------------- \ingroup H5R \brief Creates a region reference \fgdta_loc_idstatic longH5Rdereference2(long obj_id, long oapl_id, int ref_type, Pointer ref)-------------------------------------------------------------------------- \ingroup H5R \brief Opens the HDF5 object referenced \obj_id \oapl_idstatic intH5Rdestroy(H5R_ref_t ref_ptr)-------------------------------------------------------------------------- \ingroup H5R \brief Closes a referencestatic intH5Requal(H5R_ref_t ref1_ptr, H5R_ref_t ref2_ptr)-------------------------------------------------------------------------- \ingroup H5R \brief Determines whether two references are equalstatic PointerH5resize_memory(Pointer mem, long size)\ingroup H5 \brief Resizes and, if required, re-allocates memory that will later be freed internally by the HDF5 librarystatic longH5Rget_attr_name(H5R_ref_t ref_ptr, byte[] name, long size)static longH5Rget_attr_name(H5R_ref_t ref_ptr, ByteBuffer name, long size)static longH5Rget_attr_name(H5R_ref_t ref_ptr, BytePointer name, long size)-------------------------------------------------------------------------- \ingroup H5R \brief Retrieves the attribute name for a referenced objectstatic longH5Rget_file_name(H5R_ref_t ref_ptr, byte[] name, long size)static longH5Rget_file_name(H5R_ref_t ref_ptr, ByteBuffer name, long size)static longH5Rget_file_name(H5R_ref_t ref_ptr, BytePointer name, long size)-------------------------------------------------------------------------- \ingroup H5R \brief Retrieves the file name for a referenced objectstatic longH5Rget_name(long loc_id, int ref_type, Pointer ref, byte[] name, long size)static longH5Rget_name(long loc_id, int ref_type, Pointer ref, ByteBuffer name, long size)static longH5Rget_name(long loc_id, int ref_type, Pointer ref, BytePointer name, long size)-------------------------------------------------------------------------- \ingroup H5R \brief Retrieves a name for a referenced objectstatic longH5Rget_obj_name(H5R_ref_t ref_ptr, long rapl_id, byte[] name, long size)static longH5Rget_obj_name(H5R_ref_t ref_ptr, long rapl_id, ByteBuffer name, long size)static longH5Rget_obj_name(H5R_ref_t ref_ptr, long rapl_id, BytePointer name, long size)-------------------------------------------------------------------------- \ingroup H5R \brief Retrieves the object name for a referenced objectstatic intH5Rget_obj_type2(long id, int ref_type, Pointer ref, int[] obj_type)static intH5Rget_obj_type2(long id, int ref_type, Pointer ref, IntBuffer obj_type)static intH5Rget_obj_type2(long id, int ref_type, Pointer ref, IntPointer obj_type)-------------------------------------------------------------------------- \ingroup H5R \brief Retrieves the type of object that an object reference points tostatic intH5Rget_obj_type3(H5R_ref_t ref_ptr, long rapl_id, int[] obj_type)static intH5Rget_obj_type3(H5R_ref_t ref_ptr, long rapl_id, IntBuffer obj_type)static intH5Rget_obj_type3(H5R_ref_t ref_ptr, long rapl_id, IntPointer obj_type)-------------------------------------------------------------------------- \ingroup H5R \brief Retrieves the type of object that an object reference points tostatic longH5Rget_region(long dataset, int ref_type, Pointer ref)-------------------------------------------------------------------------- \ingroup H5R \brief Sets up a dataspace and selection as specified by a region referencestatic intH5Rget_type(H5R_ref_t ref_ptr)-------------------------------------------------------------------------- \ingroup H5R \brief Retrieves the type of a referencestatic longH5Ropen_attr(H5R_ref_t ref_ptr, long rapl_id, long aapl_id)-------------------------------------------------------------------------- \ingroup H5R \brief Opens the HDF5 attribute referencedstatic longH5Ropen_attr_async(String app_file, String app_func, int app_line, H5R_ref_t ref_ptr, long rapl_id, long aapl_id, long es_id)static longH5Ropen_attr_async(BytePointer app_file, BytePointer app_func, int app_line, H5R_ref_t ref_ptr, long rapl_id, long aapl_id, long es_id)-------------------------------------------------------------------------- \ingroup ASYNC \async_variant_of{H5Ropen_attr}static longH5Ropen_object(H5R_ref_t ref_ptr, long rapl_id, long oapl_id)-------------------------------------------------------------------------- \ingroup H5R \brief Opens the HDF5 object referencedstatic longH5Ropen_object_async(String app_file, String app_func, int app_line, H5R_ref_t ref_ptr, long rapl_id, long oapl_id, long es_id)static longH5Ropen_object_async(BytePointer app_file, BytePointer app_func, int app_line, H5R_ref_t ref_ptr, long rapl_id, long oapl_id, long es_id)-------------------------------------------------------------------------- \ingroup ASYNC \async_variant_of{H5Ropen_object}static longH5Ropen_region(H5R_ref_t ref_ptr, long rapl_id, long oapl_id)-------------------------------------------------------------------------- \ingroup H5R \brief Sets up a dataspace and selection as specified by a region reference.static longH5Ropen_region_async(String app_file, String app_func, int app_line, H5R_ref_t ref_ptr, long rapl_id, long oapl_id, long es_id)static longH5Ropen_region_async(BytePointer app_file, BytePointer app_func, int app_line, H5R_ref_t ref_ptr, long rapl_id, long oapl_id, long es_id)-------------------------------------------------------------------------- \ingroup ASYNC \async_variant_of{H5Ropen_region}static intH5S_ALL()static intH5Sclose(long space_id)\ingroup H5S \brief Releases and terminates access to a dataspace \space_idstatic longH5Scombine_hyperslab(long space_id, int op, long[] start, long[] stride, long[] count, long... block)static longH5Scombine_hyperslab(long space_id, int op, LongBuffer start, LongBuffer stride, LongBuffer count, LongBuffer block)static longH5Scombine_hyperslab(long space_id, int op, LongPointer start, LongPointer stride, LongPointer count, LongPointer block)\ingroup H5S \brief Performs an operation on a hyperslab and an existing selection and returns the resulting selection \space_idstatic longH5Scombine_select(long space1_id, int op, long space2_id)\ingroup H5S \brief Combine two hyperslab selections with an operation, returning a dataspace with the resulting selection \space_id{space1_id}static longH5Scopy(long space_id)\ingroup H5S \brief Creates an exact copy of a dataspace \space_idstatic longH5Screate(int type)\ingroup H5S \brief Creates a new dataspace of a specified typestatic longH5Screate_simple(int rank, long[] dims, long... maxdims)static longH5Screate_simple(int rank, LongBuffer dims, LongBuffer maxdims)static longH5Screate_simple(int rank, LongPointer dims, LongPointer maxdims)\ingroup H5S \brief Creates a new simple dataspace and opens it for accessstatic longH5Sdecode(Pointer buf)\ingroup H5S \brief Decodes a binary object description of data space and returns a new object handlestatic intH5Sencode2(long obj_id, Pointer buf, SizeTPointer nalloc, long fapl)\ingroup H5S \brief Encodes a data space object description into a binary buffer \space_id{obj_id}static intH5set_free_list_limits(int reg_global_lim, int reg_list_lim, int arr_global_lim, int arr_list_lim, int blk_global_lim, int blk_list_lim)\ingroup H5 \brief Sets free-list size limitsstatic intH5Sextent_copy(long dst_id, long src_id)\ingroup H5S \brief Copies the extent of a dataspace \space_id{dst_id} \space_id{src_id}static intH5Sextent_equal(long space1_id, long space2_id)\ingroup H5S \brief Determines whether two dataspace extents are equal \space_id{space1_id} \space_id{space2_id}static intH5Sget_regular_hyperslab(long spaceid, long[] start, long[] stride, long[] count, long... block)static intH5Sget_regular_hyperslab(long spaceid, LongBuffer start, LongBuffer stride, LongBuffer count, LongBuffer block)static intH5Sget_regular_hyperslab(long spaceid, LongPointer start, LongPointer stride, LongPointer count, LongPointer block)\ingroup H5S \brief Retrieves a regular hyperslab selection \space_id{spaceid}static intH5Sget_select_bounds(long spaceid, long[] start, long... end)static intH5Sget_select_bounds(long spaceid, LongBuffer start, LongBuffer end)static intH5Sget_select_bounds(long spaceid, LongPointer start, LongPointer end)\ingroup H5S \brief Gets the bounding box containing the current selection \space_id{spaceid}static longH5Sget_select_elem_npoints(long spaceid)\ingroup H5S \brief Gets the number of element points in the current selection \space_id{spaceid}static intH5Sget_select_elem_pointlist(long spaceid, long startpoint, long numpoints, long... buf)static intH5Sget_select_elem_pointlist(long spaceid, long startpoint, long numpoints, LongBuffer buf)static intH5Sget_select_elem_pointlist(long spaceid, long startpoint, long numpoints, LongPointer buf)\ingroup H5S \brief Gets the list of element points currently selected \space_id{spaceid}static intH5Sget_select_hyper_blocklist(long spaceid, long startblock, long numblocks, long... buf)static intH5Sget_select_hyper_blocklist(long spaceid, long startblock, long numblocks, LongBuffer buf)static intH5Sget_select_hyper_blocklist(long spaceid, long startblock, long numblocks, LongPointer buf)\ingroup H5S \brief Gets the list of hyperslab blocks currently selected \space_id{spaceid}static longH5Sget_select_hyper_nblocks(long spaceid)\ingroup H5S \brief Get number of hyperslab blocks \space_id{spaceid}static longH5Sget_select_npoints(long spaceid)\ingroup H5S \brief Determines the number of elements in a dataspace selection \space_id{spaceid}static intH5Sget_select_type(long spaceid)\ingroup H5S \brief Determines the type of the dataspace selection \space_id{spaceid}static intH5Sget_simple_extent_dims(long space_id, long[] dims, long... maxdims)static intH5Sget_simple_extent_dims(long space_id, LongBuffer dims, LongBuffer maxdims)static intH5Sget_simple_extent_dims(long space_id, LongPointer dims, LongPointer maxdims)\ingroup H5S \brief Retrieves dataspace dimension size and maximum size \space_idstatic intH5Sget_simple_extent_ndims(long space_id)\ingroup H5S \brief Determines the dimensionality of a dataspace \space_idstatic longH5Sget_simple_extent_npoints(long space_id)\ingroup H5S \brief Determines the number of elements in a dataspace \space_idstatic intH5Sget_simple_extent_type(long space_id)\ingroup H5S \brief Determines the current class of a dataspace \space_idstatic intH5Sis_regular_hyperslab(long spaceid)\ingroup H5S \brief Determines if a hyperslab selection is regular \space_id{spaceid}static intH5Sis_simple(long space_id)\ingroup H5S \brief Determines whether a dataspace is a simple dataspace \space_idstatic intH5Smodify_select(long space1_id, int op, long space2_id)\ingroup H5S \brief Refines a hyperslab selection with an operation, using a second hyperslab to modify it \space_id{space1_id}static intH5Soffset_simple(long space_id, long... offset)static intH5Soffset_simple(long space_id, LongBuffer offset)static intH5Soffset_simple(long space_id, LongPointer offset)\ingroup H5S \brief Sets the offset of a simple dataspace \space_idstatic intH5Ssel_iter_close(long sel_iter_id)\ingroup H5S \brief Closes a dataspace selection iterator \space_id{sel_iter_id}static longH5Ssel_iter_create(long spaceid, long elmt_size, int flags)\ingroup H5S \brief Creates a dataspace selection iterator for a dataspace's selection \space_id{spaceid}static intH5Ssel_iter_get_seq_list(long sel_iter_id, long maxseq, long maxbytes, SizeTPointer nseq, SizeTPointer nbytes, long[] off, SizeTPointer len)static intH5Ssel_iter_get_seq_list(long sel_iter_id, long maxseq, long maxbytes, SizeTPointer nseq, SizeTPointer nbytes, LongBuffer off, SizeTPointer len)static intH5Ssel_iter_get_seq_list(long sel_iter_id, long maxseq, long maxbytes, SizeTPointer nseq, SizeTPointer nbytes, LongPointer off, SizeTPointer len)\ingroup H5S \brief Retrieves a list of offset / length sequences for the elements in an iterator \space_id{sel_iter_id}static intH5Ssel_iter_reset(long sel_iter_id, long space_id)\ingroup H5S \brief Resets a dataspace selection iterator back to an initial statestatic intH5Sselect_adjust(long spaceid, long... offset)static intH5Sselect_adjust(long spaceid, LongBuffer offset)static intH5Sselect_adjust(long spaceid, LongPointer offset)\ingroup H5S \brief Adjusts a selection by subtracting an offset \space_id{spaceid}static intH5Sselect_all(long spaceid)\ingroup H5S \brief Selects an entire dataspace \space_id{spaceid}static intH5Sselect_copy(long dst_id, long src_id)\ingroup H5S \brief Copies a selection from one dataspace to another \space_id{dst_id} \space_id{src_id}static intH5Sselect_elements(long space_id, int op, long num_elem, long... coord)static intH5Sselect_elements(long space_id, int op, long num_elem, LongBuffer coord)static intH5Sselect_elements(long space_id, int op, long num_elem, LongPointer coord)\ingroup H5S \brief Selects array elements to be included in the selection for a dataspace \space_idstatic intH5Sselect_hyperslab(long space_id, int op, long[] start, long[] stride, long[] count, long... block)static intH5Sselect_hyperslab(long space_id, int op, LongBuffer start, LongBuffer stride, LongBuffer count, LongBuffer block)static intH5Sselect_hyperslab(long space_id, int op, LongPointer start, LongPointer stride, LongPointer count, LongPointer block)\ingroup H5S \brief Selects a hyperslab region to add to the current selected region \space_idstatic intH5Sselect_intersect_block(long space_id, long[] start, long... end)static intH5Sselect_intersect_block(long space_id, LongBuffer start, LongBuffer end)static intH5Sselect_intersect_block(long space_id, LongPointer start, LongPointer end)\ingroup H5S \brief Checks if current selection intersects with a block \space_idstatic intH5Sselect_none(long spaceid)\ingroup H5S \brief Resets the selection region to include no elements \space_id{spaceid}static longH5Sselect_project_intersection(long src_space_id, long dst_space_id, long src_intersect_space_id)\ingroup H5S \brief Projects the intersection of two source selections to a destination selection \space_id{src_space_id} \space_id{dst_space_id} \space_id{src_intersect_space_id}static intH5Sselect_shape_same(long space1_id, long space2_id)\ingroup H5S \brief Checks if two selections are the same shape \space_id{space1_id} \space_id{space2_id}static intH5Sselect_valid(long spaceid)\ingroup H5S \brief Verifies that the selection is within the extent of the dataspace \space_id{spaceid}static intH5Sset_extent_none(long space_id)\ingroup H5S \brief Resets the extent of a dataspace back to "none" \space_idstatic intH5Sset_extent_simple(long space_id, int rank, long[] dims, long... max)static intH5Sset_extent_simple(long space_id, int rank, LongBuffer dims, LongBuffer max)static intH5Sset_extent_simple(long space_id, int rank, LongPointer dims, LongPointer max)\ingroup H5S \brief Sets or resets the size of an existing dataspace \space_idstatic intH5T_ALPHA_B16()\ingroup PDTALPHA 16-bit little-endian bitfield for DEC Alpha CPUsstatic intH5T_ALPHA_B32()\ingroup PDTALPHA 32-bit little-endian bitfield for DEC Alpha CPUsstatic intH5T_ALPHA_B64()\ingroup PDTALPHA 64-bit little-endian bitfield for DEC Alpha CPUsstatic intH5T_ALPHA_B8()\ingroup PDTALPHA 8-bit little-endian bitfield for DEC Alpha CPUsstatic intH5T_ALPHA_F32()\ingroup PDTALPHA 32-bit little-endian IEEE floating-point numbers for DEC Alpha CPUsstatic intH5T_ALPHA_F64()\ingroup PDTALPHA 64-bit little-endian IEEE floating-point numbers for DEC Alpha CPUsstatic intH5T_ALPHA_I16()\ingroup PDTALPHA 16-bit little-endian signed (2's complement) integers for DEC Alpha CPUsstatic intH5T_ALPHA_I32()\ingroup PDTALPHA 32-bit little-endian signed (2's complement) integers for DEC Alpha CPUsstatic intH5T_ALPHA_I64()\ingroup PDTALPHA 64-bit little-endian signed (2's complement) integers for DEC Alpha CPUsstatic intH5T_ALPHA_I8()\ingroup PDTALPHA 8-bit little-endian signed (2's complement) integers for DEC Alpha CPUsstatic intH5T_ALPHA_U16()\ingroup PDTALPHA 16-bit little-endian unsigned integers for DEC Alpha CPUsstatic intH5T_ALPHA_U32()\ingroup PDTALPHA 32-bit little-endian unsigned integers for DEC Alpha CPUsstatic intH5T_ALPHA_U64()\ingroup PDTALPHA 64-bit little-endian unsigned integers for DEC Alpha CPUsstatic intH5T_ALPHA_U8()\ingroup PDTALPHA 8-bit little-endian unsigned integers for DEC Alpha CPUsstatic intH5T_C_S1()\ingroup PDTS String datatype in C (size defined in bytes rather than in bits)static longH5T_C_S1_g()static voidH5T_C_S1_g(long setter)static intH5T_FORTRAN_S1()\ingroup PDTS String datatype in Fortran (as defined for the HDF5 C library)static longH5T_FORTRAN_S1_g()static voidH5T_FORTRAN_S1_g(long setter)static intH5T_IEEE_F32BE()\ingroup PDTIEEE 32-bit big-endian IEEE floating-point numbersstatic longH5T_IEEE_F32BE_g()static voidH5T_IEEE_F32BE_g(long setter)static intH5T_IEEE_F32LE()\ingroup PDTIEEE 32-bit little-endian IEEE floating-point numbersstatic longH5T_IEEE_F32LE_g()static voidH5T_IEEE_F32LE_g(long setter)static intH5T_IEEE_F64BE()\ingroup PDTIEEE 64-bit big-endian IEEE floating-point numbersstatic longH5T_IEEE_F64BE_g()static voidH5T_IEEE_F64BE_g(long setter)static intH5T_IEEE_F64LE()\ingroup PDTIEEE 64-bit little-endian IEEE floating-point numbersstatic longH5T_IEEE_F64LE_g()static voidH5T_IEEE_F64LE_g(long setter)static intH5T_INTEL_B16()\ingroup PDTX86 16-bit little-endian bitfield for Intel CPUsstatic intH5T_INTEL_B32()\ingroup PDTX86 32-bit little-endian bitfield for Intel CPUsstatic intH5T_INTEL_B64()\ingroup PDTX86 64-bit little-endian bitfield for Intel CPUsstatic intH5T_INTEL_B8()\ingroup PDTX86 8-bit little-endian bitfield for Intel CPUsstatic intH5T_INTEL_F32()\ingroup PDTX86 32-bit little-endian IEEE floating-point numbers for Intel CPUsstatic intH5T_INTEL_F64()\ingroup PDTX86 64-bit little-endian IEEE floating-point numbers for Intel CPUsstatic intH5T_INTEL_I16()\ingroup PDTX86 16-bit little-endian signed (2's complement) integers for Intel CPUsstatic intH5T_INTEL_I32()\ingroup PDTX86 32-bit little-endian signed (2's complement) integers for Intel CPUsstatic intH5T_INTEL_I64()\ingroup PDTX86 64-bit little-endian signed (2's complement) integers for Intel CPUsstatic intH5T_INTEL_I8()\ingroup PDTX86 8-bit little-endian signed (2's complement) integers for Intel CPUsstatic intH5T_INTEL_U16()\ingroup PDTX86 16-bit little-endian unsigned integers for Intel CPUsstatic intH5T_INTEL_U32()\ingroup PDTX86 32-bit little-endian unsigned integers for Intel CPUsstatic intH5T_INTEL_U64()\ingroup PDTX86 64-bit little-endian unsigned integers for Intel CPUsstatic intH5T_INTEL_U8()\ingroup PDTX86 8-bit little-endian unsigned integers for Intel CPUsstatic intH5T_MIPS_B16()\ingroup PDTMIPS 16-bit big-endian bitfield for SGI MIPS CPUsstatic intH5T_MIPS_B32()\ingroup PDTMIPS 32-bit big-endian bitfield for SGI MIPS CPUsstatic intH5T_MIPS_B64()\ingroup PDTMIPS 64-bit big-endian bitfield for SGI MIPS CPUsstatic intH5T_MIPS_B8()\ingroup PDTMIPS 8-bit big-endian bitfield for SGI MIPS CPUsstatic intH5T_MIPS_F32()\ingroup PDTMIPS 32-bit big-endian IEEE floating-point numbers for MIPS CPUsstatic intH5T_MIPS_F64()\ingroup PDTMIPS 64-bit big-endian IEEE floating-point numbers for MIPS CPUsstatic intH5T_MIPS_I16()\ingroup PDTMIPS 16-bit big-endian signed (2's complement) integers for SGI MIPS CPUsstatic intH5T_MIPS_I32()\ingroup PDTMIPS 32-bit big-endian signed (2's complement) integers for SGI MIPS CPUsstatic intH5T_MIPS_I64()\ingroup PDTMIPS 64-bit big-endian signed (2's complement) integers for SGI MIPS CPUsstatic intH5T_MIPS_I8()\ingroup PDTMIPS 8-bit big-endian signed (2's complement) integers for SGI MIPS CPUsstatic intH5T_MIPS_U16()\ingroup PDTMIPS 16-bit big-endian unsigned integers for SGI MIPS CPUsstatic intH5T_MIPS_U32()\ingroup PDTMIPS 32-bit big-endian unsigned integers for SGI MIPS CPUsstatic intH5T_MIPS_U64()\ingroup PDTMIPS 64-bit big-endian unsigned integers for SGI MIPS CPUsstatic intH5T_MIPS_U8()\ingroup PDTMIPS 8-bit big-endian unsigned integers for SGI MIPS CPUsstatic intH5T_NATIVE_B16()\ingroup PDTNAT HDF5 16-bit bitfield based on native typesstatic longH5T_NATIVE_B16_g()static voidH5T_NATIVE_B16_g(long setter)static intH5T_NATIVE_B32()\ingroup PDTNAT HDF5 32-bit bitfield based on native typesstatic longH5T_NATIVE_B32_g()static voidH5T_NATIVE_B32_g(long setter)static intH5T_NATIVE_B64()\ingroup PDTNAT HDF5 64-bit bitfield based on native typesstatic longH5T_NATIVE_B64_g()static voidH5T_NATIVE_B64_g(long setter)static intH5T_NATIVE_B8()\ingroup PDTNAT HDF5 8-bit bitfield based on native typesstatic longH5T_NATIVE_B8_g()static voidH5T_NATIVE_B8_g(long setter)static intH5T_NATIVE_CHAR()\ingroup PDTNAT C-style \c charstatic intH5T_NATIVE_DOUBLE()\ingroup PDTNAT C-style \Code{double}static longH5T_NATIVE_DOUBLE_g()static voidH5T_NATIVE_DOUBLE_g(long setter)static intH5T_NATIVE_FLOAT()\ingroup PDTNAT C-style \Code{float}static longH5T_NATIVE_FLOAT_g()static voidH5T_NATIVE_FLOAT_g(long setter)static intH5T_NATIVE_HADDR()\ingroup PDTNAT HDF5 address type based on native typesstatic longH5T_NATIVE_HADDR_g()static voidH5T_NATIVE_HADDR_g(long setter)static intH5T_NATIVE_HBOOL()\ingroup PDTNAT HDF5 Boolean type based on native typesstatic longH5T_NATIVE_HBOOL_g()static voidH5T_NATIVE_HBOOL_g(long setter)static intH5T_NATIVE_HERR()\ingroup PDTNAT HDF5 error code type based on native typesstatic longH5T_NATIVE_HERR_g()static voidH5T_NATIVE_HERR_g(long setter)static intH5T_NATIVE_HSIZE()\ingroup PDTNAT HDF5 size type based on native typesstatic longH5T_NATIVE_HSIZE_g()static voidH5T_NATIVE_HSIZE_g(long setter)static intH5T_NATIVE_HSSIZE()\ingroup PDTNAT HDF5 signed size type based on native typesstatic longH5T_NATIVE_HSSIZE_g()static voidH5T_NATIVE_HSSIZE_g(long setter)static intH5T_NATIVE_INT()\ingroup PDTNAT C-style \Code{int}static intH5T_NATIVE_INT_FAST16()\ingroup PDTC9xstatic longH5T_NATIVE_INT_FAST16_g()static voidH5T_NATIVE_INT_FAST16_g(long setter)static intH5T_NATIVE_INT_FAST32()\ingroup PDTC9xstatic longH5T_NATIVE_INT_FAST32_g()static voidH5T_NATIVE_INT_FAST32_g(long setter)static intH5T_NATIVE_INT_FAST64()\ingroup PDTC9xstatic longH5T_NATIVE_INT_FAST64_g()static voidH5T_NATIVE_INT_FAST64_g(long setter)static intH5T_NATIVE_INT_FAST8()\ingroup PDTC9xstatic longH5T_NATIVE_INT_FAST8_g()static voidH5T_NATIVE_INT_FAST8_g(long setter)static longH5T_NATIVE_INT_g()static voidH5T_NATIVE_INT_g(long setter)static intH5T_NATIVE_INT_LEAST16()\ingroup PDTC9xstatic longH5T_NATIVE_INT_LEAST16_g()static voidH5T_NATIVE_INT_LEAST16_g(long setter)static intH5T_NATIVE_INT_LEAST32()\ingroup PDTC9xstatic longH5T_NATIVE_INT_LEAST32_g()static voidH5T_NATIVE_INT_LEAST32_g(long setter)static intH5T_NATIVE_INT_LEAST64()\ingroup PDTC9xstatic longH5T_NATIVE_INT_LEAST64_g()static voidH5T_NATIVE_INT_LEAST64_g(long setter)static intH5T_NATIVE_INT_LEAST8()\ingroup PDTC9xstatic longH5T_NATIVE_INT_LEAST8_g()static voidH5T_NATIVE_INT_LEAST8_g(long setter)static intH5T_NATIVE_INT16()\ingroup PDTC9xstatic longH5T_NATIVE_INT16_g()static voidH5T_NATIVE_INT16_g(long setter)static intH5T_NATIVE_INT32()\ingroup PDTC9xstatic longH5T_NATIVE_INT32_g()static voidH5T_NATIVE_INT32_g(long setter)static intH5T_NATIVE_INT64()\ingroup PDTC9xstatic longH5T_NATIVE_INT64_g()static voidH5T_NATIVE_INT64_g(long setter)static intH5T_NATIVE_INT8()\ingroup PDTC9xstatic longH5T_NATIVE_INT8_g()static voidH5T_NATIVE_INT8_g(long setter)static intH5T_NATIVE_LDOUBLE()\ingroup PDTNAT C-style \Code{long double}static longH5T_NATIVE_LDOUBLE_g()static voidH5T_NATIVE_LDOUBLE_g(long setter)static intH5T_NATIVE_LLONG()\ingroup PDTNAT C-style \Code{long long}static longH5T_NATIVE_LLONG_g()static voidH5T_NATIVE_LLONG_g(long setter)static intH5T_NATIVE_LONG()\ingroup PDTNAT C-style \Code{long}static longH5T_NATIVE_LONG_g()static voidH5T_NATIVE_LONG_g(long setter)static intH5T_NATIVE_OPAQUE()\ingroup PDTNAT HDF5 opaque unit based on native typesstatic longH5T_NATIVE_OPAQUE_g()static voidH5T_NATIVE_OPAQUE_g(long setter)static intH5T_NATIVE_SCHAR()\ingroup PDTNAT C-style \Code{signed char}static longH5T_NATIVE_SCHAR_g()static voidH5T_NATIVE_SCHAR_g(long setter)static intH5T_NATIVE_SHORT()\ingroup PDTNAT C-style \Code{short}static longH5T_NATIVE_SHORT_g()static voidH5T_NATIVE_SHORT_g(long setter)static intH5T_NATIVE_UCHAR()\ingroup PDTNAT C-style \Code{unsigned char}static longH5T_NATIVE_UCHAR_g()static voidH5T_NATIVE_UCHAR_g(long setter)static intH5T_NATIVE_UINT()\ingroup PDTNAT C-style \Code{unsigned int}static intH5T_NATIVE_UINT_FAST16()\ingroup PDTC9xstatic longH5T_NATIVE_UINT_FAST16_g()static voidH5T_NATIVE_UINT_FAST16_g(long setter)static intH5T_NATIVE_UINT_FAST32()\ingroup PDTC9xstatic longH5T_NATIVE_UINT_FAST32_g()static voidH5T_NATIVE_UINT_FAST32_g(long setter)static intH5T_NATIVE_UINT_FAST64()\ingroup PDTC9xstatic longH5T_NATIVE_UINT_FAST64_g()static voidH5T_NATIVE_UINT_FAST64_g(long setter)static intH5T_NATIVE_UINT_FAST8()\ingroup PDTC9xstatic longH5T_NATIVE_UINT_FAST8_g()static voidH5T_NATIVE_UINT_FAST8_g(long setter)static longH5T_NATIVE_UINT_g()static voidH5T_NATIVE_UINT_g(long setter)static intH5T_NATIVE_UINT_LEAST16()\ingroup PDTC9xstatic longH5T_NATIVE_UINT_LEAST16_g()static voidH5T_NATIVE_UINT_LEAST16_g(long setter)static intH5T_NATIVE_UINT_LEAST32()\ingroup PDTC9xstatic longH5T_NATIVE_UINT_LEAST32_g()static voidH5T_NATIVE_UINT_LEAST32_g(long setter)static intH5T_NATIVE_UINT_LEAST64()\ingroup PDTC9xstatic longH5T_NATIVE_UINT_LEAST64_g()static voidH5T_NATIVE_UINT_LEAST64_g(long setter)static intH5T_NATIVE_UINT_LEAST8()\ingroup PDTC9xstatic longH5T_NATIVE_UINT_LEAST8_g()static voidH5T_NATIVE_UINT_LEAST8_g(long setter)static intH5T_NATIVE_UINT16()\ingroup PDTC9xstatic longH5T_NATIVE_UINT16_g()static voidH5T_NATIVE_UINT16_g(long setter)static intH5T_NATIVE_UINT32()\ingroup PDTC9xstatic longH5T_NATIVE_UINT32_g()static voidH5T_NATIVE_UINT32_g(long setter)static intH5T_NATIVE_UINT64()\ingroup PDTC9xstatic longH5T_NATIVE_UINT64_g()static voidH5T_NATIVE_UINT64_g(long setter)static intH5T_NATIVE_UINT8()\ingroup PDTC9xstatic longH5T_NATIVE_UINT8_g()static voidH5T_NATIVE_UINT8_g(long setter)static intH5T_NATIVE_ULLONG()\ingroup PDTNAT C-style \Code{unsigned long long}static longH5T_NATIVE_ULLONG_g()static voidH5T_NATIVE_ULLONG_g(long setter)static intH5T_NATIVE_ULONG()\ingroup PDTNAT C-style \Code{unsigned long}static longH5T_NATIVE_ULONG_g()static voidH5T_NATIVE_ULONG_g(long setter)static intH5T_NATIVE_USHORT()\ingroup PDTNAT C-style \Code{unsigned short}static longH5T_NATIVE_USHORT_g()static voidH5T_NATIVE_USHORT_g(long setter)static intH5T_STD_B16BE()\ingroup PDTSTD 16-bit big-endian bitfieldstatic longH5T_STD_B16BE_g()static voidH5T_STD_B16BE_g(long setter)static intH5T_STD_B16LE()\ingroup PDTSTD 16-bit little-endian bitfieldstatic longH5T_STD_B16LE_g()static voidH5T_STD_B16LE_g(long setter)static intH5T_STD_B32BE()\ingroup PDTSTD 32-bit big-endian bitfieldstatic longH5T_STD_B32BE_g()static voidH5T_STD_B32BE_g(long setter)static intH5T_STD_B32LE()\ingroup PDTSTD 32-bit little-endian bitfieldstatic longH5T_STD_B32LE_g()static voidH5T_STD_B32LE_g(long setter)static intH5T_STD_B64BE()\ingroup PDTSTD 64-bit big-endian bitfieldstatic longH5T_STD_B64BE_g()static voidH5T_STD_B64BE_g(long setter)static intH5T_STD_B64LE()\ingroup PDTSTD 64-bit little-endian bitfieldstatic longH5T_STD_B64LE_g()static voidH5T_STD_B64LE_g(long setter)static intH5T_STD_B8BE()\ingroup PDTSTD 8-bit big-endian bitfieldstatic longH5T_STD_B8BE_g()static voidH5T_STD_B8BE_g(long setter)static intH5T_STD_B8LE()\ingroup PDTSTD 8-bit little-endian bitfieldstatic longH5T_STD_B8LE_g()static voidH5T_STD_B8LE_g(long setter)static intH5T_STD_I16BE()\ingroup PDTSTD 16-bit big-endian signed integersstatic longH5T_STD_I16BE_g()static voidH5T_STD_I16BE_g(long setter)static intH5T_STD_I16LE()\ingroup PDTSTD 16-bit little-endian signed integersstatic longH5T_STD_I16LE_g()static voidH5T_STD_I16LE_g(long setter)static intH5T_STD_I32BE()\ingroup PDTSTD 32-bit big-endian signed integersstatic longH5T_STD_I32BE_g()static voidH5T_STD_I32BE_g(long setter)static intH5T_STD_I32LE()\ingroup PDTSTD 32-bit little-endian signed integersstatic longH5T_STD_I32LE_g()static voidH5T_STD_I32LE_g(long setter)static intH5T_STD_I64BE()\ingroup PDTSTD 64-bit big-endian signed integersstatic longH5T_STD_I64BE_g()static voidH5T_STD_I64BE_g(long setter)static intH5T_STD_I64LE()\ingroup PDTSTD 64-bit little-endian signed integersstatic longH5T_STD_I64LE_g()static voidH5T_STD_I64LE_g(long setter)static intH5T_STD_I8BE()\ingroup PDTSTD 8-bit big-endian signed integersstatic longH5T_STD_I8BE_g()static voidH5T_STD_I8BE_g(long setter)static intH5T_STD_I8LE()\ingroup PDTSTD 8-bit little-endian signed integersstatic longH5T_STD_I8LE_g()static voidH5T_STD_I8LE_g(long setter)static intH5T_STD_REF()\ingroup PDTSTD Generic referencestatic intH5T_STD_REF_DSETREG()\ingroup PDTSTD Dataset region referencestatic longH5T_STD_REF_DSETREG_g()static voidH5T_STD_REF_DSETREG_g(long setter)static longH5T_STD_REF_g()static voidH5T_STD_REF_g(long setter)static intH5T_STD_REF_OBJ()\ingroup PDTSTD Object referencestatic longH5T_STD_REF_OBJ_g()static voidH5T_STD_REF_OBJ_g(long setter)static intH5T_STD_U16BE()\ingroup PDTSTD 16-bit big-endian unsigned integersstatic longH5T_STD_U16BE_g()static voidH5T_STD_U16BE_g(long setter)static intH5T_STD_U16LE()\ingroup PDTSTD 16-bit little-endian unsigned integersstatic longH5T_STD_U16LE_g()static voidH5T_STD_U16LE_g(long setter)static intH5T_STD_U32BE()\ingroup PDTSTD 32-bit big-endian unsigned integersstatic longH5T_STD_U32BE_g()static voidH5T_STD_U32BE_g(long setter)static intH5T_STD_U32LE()\ingroup PDTSTD 32-bit little-endian unsigned integersstatic longH5T_STD_U32LE_g()static voidH5T_STD_U32LE_g(long setter)static intH5T_STD_U64BE()\ingroup PDTSTD 64-bit big-endian unsigned integersstatic longH5T_STD_U64BE_g()static voidH5T_STD_U64BE_g(long setter)static intH5T_STD_U64LE()\ingroup PDTSTD 64-bit little-endian unsigned integersstatic longH5T_STD_U64LE_g()static voidH5T_STD_U64LE_g(long setter)static intH5T_STD_U8BE()\ingroup PDTSTD 8-bit big-endian unsigned integersstatic longH5T_STD_U8BE_g()static voidH5T_STD_U8BE_g(long setter)static intH5T_STD_U8LE()\ingroup PDTSTD 8-bit little-endian unsigned integersstatic longH5T_STD_U8LE_g()static voidH5T_STD_U8LE_g(long setter)static intH5T_UNIX_D32BE()\ingroup PDTUNIXstatic longH5T_UNIX_D32BE_g()static voidH5T_UNIX_D32BE_g(long setter)static intH5T_UNIX_D32LE()\ingroup PDTUNIXstatic longH5T_UNIX_D32LE_g()static voidH5T_UNIX_D32LE_g(long setter)static intH5T_UNIX_D64BE()\ingroup PDTUNIXstatic longH5T_UNIX_D64BE_g()static voidH5T_UNIX_D64BE_g(long setter)static intH5T_UNIX_D64LE()\ingroup PDTUNIXstatic longH5T_UNIX_D64LE_g()static voidH5T_UNIX_D64LE_g(long setter)static intH5T_VARIABLE()Indicate that a string is variable length (null-terminated in C, instead of fixed length)static intH5T_VAX_F32()\ingroup PDTALPHA 32-bit VAX byte order floating-point numbers for OpenVMS on DEC Alpha CPUsstatic longH5T_VAX_F32_g()static voidH5T_VAX_F32_g(long setter)static intH5T_VAX_F64()\ingroup PDTALPHA 64-bit VAX byte order floating-point numbers for OpenVMS on DEC Alpha CPUsstatic longH5T_VAX_F64_g()static voidH5T_VAX_F64_g(long setter)static longH5Tarray_create2(long base_id, int ndims, long... dim)static longH5Tarray_create2(long base_id, int ndims, LongBuffer dim)static longH5Tarray_create2(long base_id, int ndims, LongPointer dim)\ingroup ARRAY \brief Creates an array datatype objectstatic intH5TBadd_records_from(long loc_id, String dset_name1, long start1, long nrecords, String dset_name2, long start2)static intH5TBadd_records_from(long loc_id, BytePointer dset_name1, long start1, long nrecords, BytePointer dset_name2, long start2)-------------------------------------------------------------------------- \ingroup H5TB \brief Add records from first table to second table \fg_loc_idstatic intH5TBAget_fill(long loc_id, String dset_name, long dset_id, byte[] dst_buf)static intH5TBAget_fill(long loc_id, String dset_name, long dset_id, ByteBuffer dst_buf)static intH5TBAget_fill(long loc_id, String dset_name, long dset_id, BytePointer dst_buf)static intH5TBAget_fill(long loc_id, BytePointer dset_name, long dset_id, byte[] dst_buf)static intH5TBAget_fill(long loc_id, BytePointer dset_name, long dset_id, ByteBuffer dst_buf)static intH5TBAget_fill(long loc_id, BytePointer dset_name, long dset_id, BytePointer dst_buf)-------------------------------------------------------------------------- \ingroup H5TB \brief Reads the table attribute fill values \fg_loc_idstatic intH5TBAget_title(long loc_id, byte[] table_title)static intH5TBAget_title(long loc_id, ByteBuffer table_title)static intH5TBAget_title(long loc_id, BytePointer table_title)-------------------------------------------------------------------------- \ingroup H5TB \brief Reads a table's title \fg_loc_idstatic intH5TBappend_records(long loc_id, String dset_name, long nrecords, long type_size, SizeTPointer field_offset, SizeTPointer dst_sizes, Pointer buf)static intH5TBappend_records(long loc_id, BytePointer dset_name, long nrecords, long type_size, SizeTPointer field_offset, SizeTPointer dst_sizes, Pointer buf)-------------------------------------------------------------------------- \ingroup H5TB \brief Adds records to the end of the table \fg_loc_idstatic intH5TBcombine_tables(long loc_id1, String dset_name1, long loc_id2, String dset_name2, String dset_name3)static intH5TBcombine_tables(long loc_id1, BytePointer dset_name1, long loc_id2, BytePointer dset_name2, BytePointer dset_name3)-------------------------------------------------------------------------- \ingroup H5TB \brief Combines records from two tables into a thirdstatic intH5TBdelete_field(long loc_id, String dset_name, String field_name)static intH5TBdelete_field(long loc_id, BytePointer dset_name, BytePointer field_name)-------------------------------------------------------------------------- \ingroup H5TB \brief Deletes a field from a table \fg_loc_idstatic intH5TBdelete_record(long loc_id, String dset_name, long start, long nrecords)static intH5TBdelete_record(long loc_id, BytePointer dset_name, long start, long nrecords)-------------------------------------------------------------------------- \ingroup H5TB \brief Delete records \fg_loc_idstatic intH5TBget_field_info(long loc_id, String dset_name, byte[] field_names, SizeTPointer field_sizes, SizeTPointer field_offsets, SizeTPointer type_size)static intH5TBget_field_info(long loc_id, String dset_name, ByteBuffer field_names, SizeTPointer field_sizes, SizeTPointer field_offsets, SizeTPointer type_size)static intH5TBget_field_info(long loc_id, String dset_name, BytePointer field_names, SizeTPointer field_sizes, SizeTPointer field_offsets, SizeTPointer type_size)static intH5TBget_field_info(long loc_id, BytePointer dset_name, byte[] field_names, SizeTPointer field_sizes, SizeTPointer field_offsets, SizeTPointer type_size)static intH5TBget_field_info(long loc_id, BytePointer dset_name, ByteBuffer field_names, SizeTPointer field_sizes, SizeTPointer field_offsets, SizeTPointer type_size)static intH5TBget_field_info(long loc_id, BytePointer dset_name, BytePointer field_names, SizeTPointer field_sizes, SizeTPointer field_offsets, SizeTPointer type_size)static intH5TBget_field_info(long loc_id, BytePointer dset_name, PointerPointer field_names, SizeTPointer field_sizes, SizeTPointer field_offsets, SizeTPointer type_size)-------------------------------------------------------------------------- \ingroup H5TB \brief Gets information about a table \fg_loc_idstatic intH5TBget_table_info(long loc_id, String dset_name, long[] nfields, long... nrecords)static intH5TBget_table_info(long loc_id, String dset_name, LongBuffer nfields, LongBuffer nrecords)static intH5TBget_table_info(long loc_id, String dset_name, LongPointer nfields, LongPointer nrecords)static intH5TBget_table_info(long loc_id, BytePointer dset_name, long[] nfields, long... nrecords)static intH5TBget_table_info(long loc_id, BytePointer dset_name, LongBuffer nfields, LongBuffer nrecords)static intH5TBget_table_info(long loc_id, BytePointer dset_name, LongPointer nfields, LongPointer nrecords)-------------------------------------------------------------------------- \ingroup H5TB \brief Gets the table dimensions \fg_loc_idstatic intH5TBinsert_field(long loc_id, String dset_name, String field_name, long field_type, long _position, Pointer fill_data, Pointer buf)static intH5TBinsert_field(long loc_id, BytePointer dset_name, BytePointer field_name, long field_type, long _position, Pointer fill_data, Pointer buf)-------------------------------------------------------------------------- \ingroup H5TB \brief Insert a new field into a table \fg_loc_idstatic intH5TBinsert_record(long loc_id, String dset_name, long start, long nrecords, long dst_size, SizeTPointer dst_offset, SizeTPointer dst_sizes, Pointer buf)static intH5TBinsert_record(long loc_id, BytePointer dset_name, long start, long nrecords, long dst_size, SizeTPointer dst_offset, SizeTPointer dst_sizes, Pointer buf)-------------------------------------------------------------------------- \ingroup H5TB \brief Insert records \fg_loc_idstatic intH5TBmake_table(String table_title, long loc_id, String dset_name, long nfields, long nrecords, long type_size, byte[] field_names, SizeTPointer field_offset, long[] field_types, long chunk_size, Pointer fill_data, int compress, Pointer buf)static intH5TBmake_table(String table_title, long loc_id, String dset_name, long nfields, long nrecords, long type_size, ByteBuffer field_names, SizeTPointer field_offset, LongBuffer field_types, long chunk_size, Pointer fill_data, int compress, Pointer buf)static intH5TBmake_table(String table_title, long loc_id, String dset_name, long nfields, long nrecords, long type_size, BytePointer field_names, SizeTPointer field_offset, LongPointer field_types, long chunk_size, Pointer fill_data, int compress, Pointer buf)static intH5TBmake_table(BytePointer table_title, long loc_id, BytePointer dset_name, long nfields, long nrecords, long type_size, byte[] field_names, SizeTPointer field_offset, long[] field_types, long chunk_size, Pointer fill_data, int compress, Pointer buf)static intH5TBmake_table(BytePointer table_title, long loc_id, BytePointer dset_name, long nfields, long nrecords, long type_size, ByteBuffer field_names, SizeTPointer field_offset, LongBuffer field_types, long chunk_size, Pointer fill_data, int compress, Pointer buf)static intH5TBmake_table(BytePointer table_title, long loc_id, BytePointer dset_name, long nfields, long nrecords, long type_size, BytePointer field_names, SizeTPointer field_offset, LongPointer field_types, long chunk_size, Pointer fill_data, int compress, Pointer buf)static intH5TBmake_table(BytePointer table_title, long loc_id, BytePointer dset_name, long nfields, long nrecords, long type_size, PointerPointer field_names, SizeTPointer field_offset, LongPointer field_types, long chunk_size, Pointer fill_data, int compress, Pointer buf)-------------------------------------------------------------------------- \ingroup H5TB \brief Creates and writes a tablestatic intH5TBread_fields_index(long loc_id, String dset_name, long nfields, int[] field_index, long start, long nrecords, long type_size, SizeTPointer field_offset, SizeTPointer dst_sizes, Pointer buf)static intH5TBread_fields_index(long loc_id, String dset_name, long nfields, IntBuffer field_index, long start, long nrecords, long type_size, SizeTPointer field_offset, SizeTPointer dst_sizes, Pointer buf)static intH5TBread_fields_index(long loc_id, String dset_name, long nfields, IntPointer field_index, long start, long nrecords, long type_size, SizeTPointer field_offset, SizeTPointer dst_sizes, Pointer buf)static intH5TBread_fields_index(long loc_id, BytePointer dset_name, long nfields, int[] field_index, long start, long nrecords, long type_size, SizeTPointer field_offset, SizeTPointer dst_sizes, Pointer buf)static intH5TBread_fields_index(long loc_id, BytePointer dset_name, long nfields, IntBuffer field_index, long start, long nrecords, long type_size, SizeTPointer field_offset, SizeTPointer dst_sizes, Pointer buf)static intH5TBread_fields_index(long loc_id, BytePointer dset_name, long nfields, IntPointer field_index, long start, long nrecords, long type_size, SizeTPointer field_offset, SizeTPointer dst_sizes, Pointer buf)-------------------------------------------------------------------------- \ingroup H5TB \brief Reads one or several fields.static intH5TBread_fields_name(long loc_id, String dset_name, String field_names, long start, long nrecords, long type_size, SizeTPointer field_offset, SizeTPointer dst_sizes, Pointer buf)static intH5TBread_fields_name(long loc_id, BytePointer dset_name, BytePointer field_names, long start, long nrecords, long type_size, SizeTPointer field_offset, SizeTPointer dst_sizes, Pointer buf)-------------------------------------------------------------------------- \ingroup H5TB \brief Reads one or several fields.static intH5TBread_records(long loc_id, String dset_name, long start, long nrecords, long type_size, SizeTPointer dst_offset, SizeTPointer dst_sizes, Pointer buf)static intH5TBread_records(long loc_id, BytePointer dset_name, long start, long nrecords, long type_size, SizeTPointer dst_offset, SizeTPointer dst_sizes, Pointer buf)-------------------------------------------------------------------------- \ingroup H5TB \brief Reads records \fg_loc_idstatic intH5TBread_table(long loc_id, String dset_name, long dst_size, SizeTPointer dst_offset, SizeTPointer dst_sizes, Pointer dst_buf)static intH5TBread_table(long loc_id, BytePointer dset_name, long dst_size, SizeTPointer dst_offset, SizeTPointer dst_sizes, Pointer dst_buf)-------------------------------------------------------------------------- \ingroup H5TB \brief Reads a table \fg_loc_idstatic intH5TBwrite_fields_index(long loc_id, String dset_name, long nfields, int[] field_index, long start, long nrecords, long type_size, SizeTPointer field_offset, SizeTPointer dst_sizes, Pointer buf)static intH5TBwrite_fields_index(long loc_id, String dset_name, long nfields, IntBuffer field_index, long start, long nrecords, long type_size, SizeTPointer field_offset, SizeTPointer dst_sizes, Pointer buf)static intH5TBwrite_fields_index(long loc_id, String dset_name, long nfields, IntPointer field_index, long start, long nrecords, long type_size, SizeTPointer field_offset, SizeTPointer dst_sizes, Pointer buf)static intH5TBwrite_fields_index(long loc_id, BytePointer dset_name, long nfields, int[] field_index, long start, long nrecords, long type_size, SizeTPointer field_offset, SizeTPointer dst_sizes, Pointer buf)static intH5TBwrite_fields_index(long loc_id, BytePointer dset_name, long nfields, IntBuffer field_index, long start, long nrecords, long type_size, SizeTPointer field_offset, SizeTPointer dst_sizes, Pointer buf)static intH5TBwrite_fields_index(long loc_id, BytePointer dset_name, long nfields, IntPointer field_index, long start, long nrecords, long type_size, SizeTPointer field_offset, SizeTPointer dst_sizes, Pointer buf)-------------------------------------------------------------------------- \ingroup H5TB \brief Overwrites fields \fg_loc_idstatic intH5TBwrite_fields_name(long loc_id, String dset_name, String field_names, long start, long nrecords, long type_size, SizeTPointer field_offset, SizeTPointer dst_sizes, Pointer buf)static intH5TBwrite_fields_name(long loc_id, BytePointer dset_name, BytePointer field_names, long start, long nrecords, long type_size, SizeTPointer field_offset, SizeTPointer dst_sizes, Pointer buf)-------------------------------------------------------------------------- \ingroup H5TB \brief Overwrites fields \fg_loc_idstatic intH5TBwrite_records(long loc_id, String dset_name, long start, long nrecords, long type_size, SizeTPointer field_offset, SizeTPointer dst_sizes, Pointer buf)static intH5TBwrite_records(long loc_id, BytePointer dset_name, long start, long nrecords, long type_size, SizeTPointer field_offset, SizeTPointer dst_sizes, Pointer buf)-------------------------------------------------------------------------- \ingroup H5TB \brief Overwrites records \fg_loc_idstatic intH5Tclose(long type_id)\ingroup H5T \brief Releases a datatype \type_idstatic intH5Tclose_async(String app_file, String app_func, int app_line, long type_id, long es_id)static intH5Tclose_async(BytePointer app_file, BytePointer app_func, int app_line, long type_id, long es_id)\ingroup H5T \brief Asynchronous version of H5Tclose().static intH5Tcommit_anon(long loc_id, long type_id, long tcpl_id, long tapl_id)\ingroup H5T \brief Commits a transient datatype to a file, creating a new named datatype, but does not link it into the file structure \fg_loc_id \type_id \tcpl_id \tapl_idstatic intH5Tcommit_async(String app_file, String app_func, int app_line, long loc_id, String name, long type_id, long lcpl_id, long tcpl_id, long tapl_id, long es_id)static intH5Tcommit_async(BytePointer app_file, BytePointer app_func, int app_line, long loc_id, BytePointer name, long type_id, long lcpl_id, long tcpl_id, long tapl_id, long es_id)\ingroup H5T \brief Asynchronous version of H5Tcommit2().static intH5Tcommit2(long loc_id, String name, long type_id, long lcpl_id, long tcpl_id, long tapl_id)static intH5Tcommit2(long loc_id, BytePointer name, long type_id, long lcpl_id, long tcpl_id, long tapl_id)\ingroup H5T \brief Commits a transient datatype, linking it into the file and creating a new committed datatype \fg_loc_idstatic intH5Tcommitted(long type_id)\ingroup H5T \brief Determines whether a datatype is a committed type or a transient type \type_idstatic intH5Tcompiler_conv(long src_id, long dst_id)\ingroup CONV \brief Check whether the libraryâs default conversion is hard conversion \type_id{src_id} of source datatype \type_id{dst_id} of destination datatypestatic intH5Tconvert(long src_id, long dst_id, long nelmts, Pointer buf, Pointer background, long plist_id)-------------------------------------------------------------------------- \ingroup CONV \brief Converts data from one specified datatype to another \type_id{src_id} of source datatype \type_id{dst_id} of destination datatypestatic longH5Tcopy(long type_id)\ingroup H5T \brief Copies an existing datatype.static longH5Tcreate(int type, long size)\ingroup H5T \brief Creates a new datatype.static longH5Tdecode(Pointer buf)\ingroup H5T \brief Decodes a binary object description of datatype and return a new object handlestatic intH5Tdetect_class(long type_id, int cls)\ingroup H5T \brief Determines whether a datatype contains any datatypes of the given datatype class \type_idstatic intH5Tencode(long obj_id, Pointer buf, SizeTPointer nalloc)\ingroup H5T \brief Encodes a datatype object description into a binary bufferstatic longH5Tenum_create(long base_id)\ingroup ENUM \brief Creates a new enumeration datatypestatic intH5Tenum_insert(long type, String name, Pointer value)static intH5Tenum_insert(long type, BytePointer name, Pointer value)\ingroup ENUM \brief Inserts a new enumeration datatype member \type_id{type}static intH5Tenum_nameof(long type, Pointer value, byte[] name, long size)static intH5Tenum_nameof(long type, Pointer value, ByteBuffer name, long size)static intH5Tenum_nameof(long type, Pointer value, BytePointer name, long size)\ingroup ENUM \brief Returns the symbol name corresponding to a specified member of an enumeration datatype \type_id{type}static intH5Tenum_valueof(long type, String name, Pointer value)static intH5Tenum_valueof(long type, BytePointer name, Pointer value)\ingroup ENUM \brief Returns the value corresponding to a specified member of an enumeration datatype \type_id{type}static intH5Tequal(long type1_id, long type2_id)\ingroup H5T \brief Determines whether two datatype identifiers refer to the same datatype \type_id{type1_id} \type_id{type2_id}static H5T_conv_tH5Tfind(long src_id, long dst_id, H5T_cdata_t pcdata)static H5T_conv_tH5Tfind(long src_id, long dst_id, PointerPointer pcdata)\ingroup CONV \brief Finds a conversion function \type_id{src_id} of source datatype \type_id{dst_id} of destination datatypestatic intH5Tflush(long type_id)\ingroup H5T \brief Flushes all buffers associated with a committed datatype to disk \type_idstatic intH5Tget_array_dims2(long type_id, long... dims)static intH5Tget_array_dims2(long type_id, LongBuffer dims)static intH5Tget_array_dims2(long type_id, LongPointer dims)\ingroup ARRAY \brief Retrieves sizes of array dimensions \type_idstatic intH5Tget_array_ndims(long type_id)\ingroup ARRAY \brief Returns the rank of an array datatype \type_idstatic intH5Tget_class(long type_id)\ingroup H5T \brief Returns a datatype class \type_idstatic longH5Tget_create_plist(long type_id)\ingroup H5T \brief Returns a copy of a datatype's creation property list \type_idstatic intH5Tget_cset(long type_id)\ingroup ATOM \brief Retrieves the character set type of a string datatype \type_idstatic longH5Tget_ebias(long type_id)\ingroup ATOM \brief Retrieves the exponent bias of a floating-point type \type_idstatic intH5Tget_fields(long type_id, SizeTPointer spos, SizeTPointer epos, SizeTPointer esize, SizeTPointer mpos, SizeTPointer msize)\ingroup ATOM \brief Retrieves floating point datatype bit field information \type_idstatic intH5Tget_inpad(long type_id)\ingroup ATOM \brief Retrieves the internal padding type for unused bits in floating-point datatypes \type_idstatic intH5Tget_member_class(long type_id, int membno)\ingroup COMPOUND \brief Returns datatype class of compound datatype member \type_idstatic intH5Tget_member_index(long type_id, String name)static intH5Tget_member_index(long type_id, BytePointer name)\ingroup COMPENUM \brief Retrieves the index of a compound or enumeration datatype member \type_idstatic BytePointerH5Tget_member_name(long type_id, int membno)\ingroup COMPENUM \brief Retrieves the name of a compound or enumeration datatype member \type_idstatic longH5Tget_member_offset(long type_id, int membno)\ingroup COMPOUND \brief Retrieves the offset of a field of a compound datatype \type_idstatic longH5Tget_member_type(long type_id, int membno)\ingroup COMPOUND \brief Returns the datatype of the specified member \type_idstatic intH5Tget_member_value(long type_id, int membno, Pointer value)\ingroup ENUM \brief Returns the value of an enumeration datatype member \type_idstatic longH5Tget_native_type(long type_id, int direction)\ingroup H5T \brief Returns the native datatype identifier of a specified datatype \type_idstatic intH5Tget_nmembers(long type_id)\ingroup COMPENUM \brief Retrieves the number of elements in a compound or enumeration datatype \type_idstatic intH5Tget_norm(long type_id)-------------------------------------------------------------------------- \ingroup ATOM \brief Retrieves mantissa normalization of a floating-point datatype \type_idstatic intH5Tget_offset(long type_id)\ingroup ATOM \brief Retrieves the bit offset of the first significant bit \type_idstatic intH5Tget_order(long type_id)\ingroup ATOM \brief Returns the byte order of an atomic datatype \type_idstatic intH5Tget_pad(long type_id, int[] lsb, int[] msb)static intH5Tget_pad(long type_id, IntBuffer lsb, IntBuffer msb)static intH5Tget_pad(long type_id, IntPointer lsb, IntPointer msb)\ingroup ATOM \brief Retrieves the padding type of the least and most-significant bit padding \type_idstatic longH5Tget_precision(long type_id)\ingroup ATOM \brief Returns the precision of an atomic datatype \type_idstatic intH5Tget_sign(long type_id)\ingroup ATOM \brief Retrieves the sign type for an integer type \type_idstatic longH5Tget_size(long type_id)\ingroup H5T \brief Returns the size of a datatype \type_idstatic intH5Tget_strpad(long type_id)\ingroup ATOM \brief Retrieves the type of padding used for a string datatype \type_idstatic longH5Tget_super(long type)\ingroup H5T \brief Returns the base datatype from which a datatype is derived \type_id{type}static BytePointerH5Tget_tag(long type)\ingroup OPAQUE \brief Gets the tag associated with an opaque datatype \type_id{type} of an opaque datatypestatic intH5Tinsert(long parent_id, String name, long offset, long member_id)static intH5Tinsert(long parent_id, BytePointer name, long offset, long member_id)\ingroup COMPOUND \brief Adds a new member to a compound datatype.static intH5Tis_variable_str(long type_id)\ingroup ATOM \brief Determines whether datatype is a variable-length string \type_idstatic intH5Tlock(long type_id)\ingroup H5T \brief Locks a datatype \type_idstatic longH5Topen_async(String app_file, String app_func, int app_line, long loc_id, String name, long tapl_id, long es_id)static longH5Topen_async(BytePointer app_file, BytePointer app_func, int app_line, long loc_id, BytePointer name, long tapl_id, long es_id)\ingroup H5T \brief Asynchronous version of H5Topen2().static longH5Topen2(long loc_id, String name, long tapl_id)static longH5Topen2(long loc_id, BytePointer name, long tapl_id)-------------------------------------------------------------------------- \ingroup H5T \brief Opens a committed (named) datatype \fgdta_loc_idstatic intH5Tpack(long type_id)\ingroup COMPOUND \brief Recursively removes padding from within a compound datatype \type_idstatic intH5Treclaim(long type_id, long space_id, long plist_id, Pointer buf)\ingroup VLEN \brief Reclaims the variable length (VL) datatype memory buffers \type_id \space_id \dxpl_id{plist_id} used to create the bufferstatic intH5Trefresh(long type_id)\ingroup H5T \brief Refreshes all buffers associated with a committed datatype \type_idstatic intH5Tregister(int pers, String name, long src_id, long dst_id, H5T_conv_t func)static intH5Tregister(int pers, BytePointer name, long src_id, long dst_id, H5T_conv_t func)\ingroup CONV \brief Registers a datatype conversion functionstatic intH5Tset_cset(long type_id, int cset)\ingroup ATOM \brief Sets character set to be used in a string or character datatype \type_idstatic intH5Tset_ebias(long type_id, long ebias)\ingroup ATOM \brief Sets the exponent bias of a floating-point type \type_idstatic intH5Tset_fields(long type_id, long spos, long epos, long esize, long mpos, long msize)\ingroup ATOM \brief Sets locations and sizes of floating point bit fields \type_idstatic intH5Tset_inpad(long type_id, int pad)\ingroup ATOM \brief Fills unused internal floating-point bits \type_idstatic intH5Tset_norm(long type_id, int norm)\ingroup ATOM \brief Sets the mantissa normalization of a floating-point datatype \type_idstatic intH5Tset_offset(long type_id, long offset)\ingroup ATOM \brief Sets the bit offset of the first significant bit \type_idstatic intH5Tset_order(long type_id, int order)\ingroup ATOM \brief Sets the byte order of a datatype \type_idstatic intH5Tset_pad(long type_id, int lsb, int msb)\ingroup ATOM \brief Sets the least and most-significant bits padding types \type_idstatic intH5Tset_precision(long type_id, long prec)\ingroup ATOM \brief Sets the precision of an atomic datatype \type_idstatic intH5Tset_sign(long type_id, int sign)\ingroup ATOM \brief Sets the sign property for an integer type \type_idstatic intH5Tset_size(long type_id, long size)\ingroup H5T \brief Sets size for a datatype.static intH5Tset_strpad(long type_id, int strpad)\ingroup ATOM \brief Defines the type of padding used for character strings \type_idstatic intH5Tset_tag(long type, String tag)static intH5Tset_tag(long type, BytePointer tag)\ingroup OPAQUE \brief Tags an opaque datatype \type_id{type} of an opaque datatypestatic intH5Tunregister(int pers, String name, long src_id, long dst_id, H5T_conv_t func)static intH5Tunregister(int pers, BytePointer name, long src_id, long dst_id, H5T_conv_t func)\ingroup CONV \brief Removes a conversion functionstatic longH5Tvlen_create(long base_id)\ingroup VLEN \brief Creates a new variable-length array datatype \type_id{base_id}, the element type of the datatype to createstatic intH5Zfilter_avail(int id)\ingroup H5Z \brief Determines whether a filter is availablestatic intH5Zget_filter_info(int filter, int[] filter_config_flags)static intH5Zget_filter_info(int filter, IntBuffer filter_config_flags)static intH5Zget_filter_info(int filter, IntPointer filter_config_flags)\ingroup H5Z \brief Retrieves information about a filterstatic intH5Zregister(Pointer cls)\ingroup H5Z \brief Registers a new filter with the HDF5 librarystatic intH5Zunregister(int id)\ingroup H5Z \brief Unregisters a filter.static intHADDR_UNDEF()static intHSIZE_UNDEF()
-
-
-
Field Detail
-
H5_DEFAULT_PLUGINDIR
public static final String H5_DEFAULT_PLUGINDIR
- See Also:
- Constant Field Values
-
H5_DEV_T_IS_SCALAR
public static final int H5_DEV_T_IS_SCALAR
- See Also:
- Constant Field Values
-
H5_EXAMPLESDIR
public static final String H5_EXAMPLESDIR
- See Also:
- Constant Field Values
-
H5_HAVE_ALARM
public static final int H5_HAVE_ALARM
- See Also:
- Constant Field Values
-
H5_HAVE_ARPA_INET_H
public static final int H5_HAVE_ARPA_INET_H
- See Also:
- Constant Field Values
-
H5_HAVE_ASPRINTF
public static final int H5_HAVE_ASPRINTF
- See Also:
- Constant Field Values
-
H5_HAVE_ATTRIBUTE
public static final int H5_HAVE_ATTRIBUTE
- See Also:
- Constant Field Values
-
H5_HAVE_CLOCK_GETTIME
public static final int H5_HAVE_CLOCK_GETTIME
- See Also:
- Constant Field Values
-
H5_HAVE_DIRENT_H
public static final int H5_HAVE_DIRENT_H
- See Also:
- Constant Field Values
-
H5_HAVE_DLFCN_H
public static final int H5_HAVE_DLFCN_H
- See Also:
- Constant Field Values
-
H5_HAVE_EMBEDDED_LIBINFO
public static final int H5_HAVE_EMBEDDED_LIBINFO
- See Also:
- Constant Field Values
-
H5_HAVE_FCNTL
public static final int H5_HAVE_FCNTL
- See Also:
- Constant Field Values
-
H5_HAVE_FEATURES_H
public static final int H5_HAVE_FEATURES_H
- See Also:
- Constant Field Values
-
H5_HAVE_FILTER_DEFLATE
public static final int H5_HAVE_FILTER_DEFLATE
- See Also:
- Constant Field Values
-
H5_HAVE_FLOCK
public static final int H5_HAVE_FLOCK
- See Also:
- Constant Field Values
-
H5_HAVE_FORK
public static final int H5_HAVE_FORK
- See Also:
- Constant Field Values
-
H5_HAVE_GETHOSTNAME
public static final int H5_HAVE_GETHOSTNAME
- See Also:
- Constant Field Values
-
H5_HAVE_GETPWUID
public static final int H5_HAVE_GETPWUID
- See Also:
- Constant Field Values
-
H5_HAVE_GETRUSAGE
public static final int H5_HAVE_GETRUSAGE
- See Also:
- Constant Field Values
-
H5_HAVE_GETTIMEOFDAY
public static final int H5_HAVE_GETTIMEOFDAY
- See Also:
- Constant Field Values
-
H5_HAVE_INTTYPES_H
public static final int H5_HAVE_INTTYPES_H
- See Also:
- Constant Field Values
-
H5_HAVE_IOCTL
public static final int H5_HAVE_IOCTL
- See Also:
- Constant Field Values
-
H5_HAVE_LIBDL
public static final int H5_HAVE_LIBDL
- See Also:
- Constant Field Values
-
H5_HAVE_LIBM
public static final int H5_HAVE_LIBM
- See Also:
- Constant Field Values
-
H5_HAVE_LIBZ
public static final int H5_HAVE_LIBZ
- See Also:
- Constant Field Values
-
H5_HAVE_LSTAT
public static final int H5_HAVE_LSTAT
- See Also:
- Constant Field Values
-
H5_HAVE_MEMORY_H
public static final int H5_HAVE_MEMORY_H
- See Also:
- Constant Field Values
-
H5_HAVE_NETDB_H
public static final int H5_HAVE_NETDB_H
- See Also:
- Constant Field Values
-
H5_HAVE_NETINET_IN_H
public static final int H5_HAVE_NETINET_IN_H
- See Also:
- Constant Field Values
-
H5_HAVE_PREADWRITE
public static final int H5_HAVE_PREADWRITE
- See Also:
- Constant Field Values
-
H5_HAVE_PWD_H
public static final int H5_HAVE_PWD_H
- See Also:
- Constant Field Values
-
H5_HAVE_RANDOM
public static final int H5_HAVE_RANDOM
- See Also:
- Constant Field Values
-
H5_HAVE_RAND_R
public static final int H5_HAVE_RAND_R
- See Also:
- Constant Field Values
-
H5_HAVE_SIGLONGJMP
public static final int H5_HAVE_SIGLONGJMP
- See Also:
- Constant Field Values
-
H5_HAVE_SIGPROCMASK
public static final int H5_HAVE_SIGPROCMASK
- See Also:
- Constant Field Values
-
H5_HAVE_SRANDOM
public static final int H5_HAVE_SRANDOM
- See Also:
- Constant Field Values
-
H5_HAVE_STAT_ST_BLOCKS
public static final int H5_HAVE_STAT_ST_BLOCKS
- See Also:
- Constant Field Values
-
H5_HAVE_STDINT_H
public static final int H5_HAVE_STDINT_H
- See Also:
- Constant Field Values
-
H5_HAVE_STDLIB_H
public static final int H5_HAVE_STDLIB_H
- See Also:
- Constant Field Values
-
H5_HAVE_STRCASESTR
public static final int H5_HAVE_STRCASESTR
- See Also:
- Constant Field Values
-
H5_HAVE_STRDUP
public static final int H5_HAVE_STRDUP
- See Also:
- Constant Field Values
-
H5_HAVE_STRINGS_H
public static final int H5_HAVE_STRINGS_H
- See Also:
- Constant Field Values
-
H5_HAVE_STRING_H
public static final int H5_HAVE_STRING_H
- See Also:
- Constant Field Values
-
H5_HAVE_SYMLINK
public static final int H5_HAVE_SYMLINK
- See Also:
- Constant Field Values
-
H5_HAVE_SYS_FILE_H
public static final int H5_HAVE_SYS_FILE_H
- See Also:
- Constant Field Values
-
H5_HAVE_SYS_IOCTL_H
public static final int H5_HAVE_SYS_IOCTL_H
- See Also:
- Constant Field Values
-
H5_HAVE_SYS_RESOURCE_H
public static final int H5_HAVE_SYS_RESOURCE_H
- See Also:
- Constant Field Values
-
H5_HAVE_SYS_SOCKET_H
public static final int H5_HAVE_SYS_SOCKET_H
- See Also:
- Constant Field Values
-
H5_HAVE_SYS_STAT_H
public static final int H5_HAVE_SYS_STAT_H
- See Also:
- Constant Field Values
-
H5_HAVE_SYS_TIME_H
public static final int H5_HAVE_SYS_TIME_H
- See Also:
- Constant Field Values
-
H5_HAVE_SYS_TYPES_H
public static final int H5_HAVE_SYS_TYPES_H
- See Also:
- Constant Field Values
-
H5_HAVE_TIMEZONE
public static final int H5_HAVE_TIMEZONE
- See Also:
- Constant Field Values
-
H5_HAVE_TIOCGETD
public static final int H5_HAVE_TIOCGETD
- See Also:
- Constant Field Values
-
H5_HAVE_TIOCGWINSZ
public static final int H5_HAVE_TIOCGWINSZ
- See Also:
- Constant Field Values
-
H5_HAVE_TMPFILE
public static final int H5_HAVE_TMPFILE
- See Also:
- Constant Field Values
-
H5_HAVE_TM_GMTOFF
public static final int H5_HAVE_TM_GMTOFF
- See Also:
- Constant Field Values
-
H5_HAVE_UNISTD_H
public static final int H5_HAVE_UNISTD_H
- See Also:
- Constant Field Values
-
H5_HAVE_VASPRINTF
public static final int H5_HAVE_VASPRINTF
- See Also:
- Constant Field Values
-
H5_HAVE_WAITPID
public static final int H5_HAVE_WAITPID
- See Also:
- Constant Field Values
-
H5_HAVE_ZLIB_H
public static final int H5_HAVE_ZLIB_H
- See Also:
- Constant Field Values
-
H5_IGNORE_DISABLED_FILE_LOCKS
public static final int H5_IGNORE_DISABLED_FILE_LOCKS
- See Also:
- Constant Field Values
-
H5_INCLUDE_HL
public static final int H5_INCLUDE_HL
- See Also:
- Constant Field Values
-
H5_LDOUBLE_TO_LLONG_ACCURATE
public static final int H5_LDOUBLE_TO_LLONG_ACCURATE
- See Also:
- Constant Field Values
-
H5_LLONG_TO_LDOUBLE_CORRECT
public static final int H5_LLONG_TO_LDOUBLE_CORRECT
- See Also:
- Constant Field Values
-
H5_LT_OBJDIR
public static final String H5_LT_OBJDIR
- See Also:
- Constant Field Values
-
H5_PACKAGE
public static final String H5_PACKAGE
- See Also:
- Constant Field Values
-
H5_PACKAGE_BUGREPORT
public static final String H5_PACKAGE_BUGREPORT
- See Also:
- Constant Field Values
-
H5_PACKAGE_NAME
public static final String H5_PACKAGE_NAME
- See Also:
- Constant Field Values
-
H5_PACKAGE_STRING
public static final String H5_PACKAGE_STRING
- See Also:
- Constant Field Values
-
H5_PACKAGE_TARNAME
public static final String H5_PACKAGE_TARNAME
- See Also:
- Constant Field Values
-
H5_PACKAGE_URL
public static final String H5_PACKAGE_URL
- See Also:
- Constant Field Values
-
H5_PACKAGE_VERSION
public static final String H5_PACKAGE_VERSION
- See Also:
- Constant Field Values
-
H5_SIZEOF_BOOL
public static final int H5_SIZEOF_BOOL
- See Also:
- Constant Field Values
-
H5_SIZEOF_CHAR
public static final int H5_SIZEOF_CHAR
- See Also:
- Constant Field Values
-
H5_SIZEOF_DOUBLE
public static final int H5_SIZEOF_DOUBLE
- See Also:
- Constant Field Values
-
H5_SIZEOF_FLOAT
public static final int H5_SIZEOF_FLOAT
- See Also:
- Constant Field Values
-
H5_SIZEOF_INT
public static final int H5_SIZEOF_INT
- See Also:
- Constant Field Values
-
H5_SIZEOF_INT16_T
public static final int H5_SIZEOF_INT16_T
- See Also:
- Constant Field Values
-
H5_SIZEOF_INT32_T
public static final int H5_SIZEOF_INT32_T
- See Also:
- Constant Field Values
-
H5_SIZEOF_INT64_T
public static final int H5_SIZEOF_INT64_T
- See Also:
- Constant Field Values
-
H5_SIZEOF_INT8_T
public static final int H5_SIZEOF_INT8_T
- See Also:
- Constant Field Values
-
H5_SIZEOF_INT_FAST16_T
public static final int H5_SIZEOF_INT_FAST16_T
- See Also:
- Constant Field Values
-
H5_SIZEOF_INT_FAST32_T
public static final int H5_SIZEOF_INT_FAST32_T
- See Also:
- Constant Field Values
-
H5_SIZEOF_INT_FAST64_T
public static final int H5_SIZEOF_INT_FAST64_T
- See Also:
- Constant Field Values
-
H5_SIZEOF_INT_FAST8_T
public static final int H5_SIZEOF_INT_FAST8_T
- See Also:
- Constant Field Values
-
H5_SIZEOF_INT_LEAST16_T
public static final int H5_SIZEOF_INT_LEAST16_T
- See Also:
- Constant Field Values
-
H5_SIZEOF_INT_LEAST32_T
public static final int H5_SIZEOF_INT_LEAST32_T
- See Also:
- Constant Field Values
-
H5_SIZEOF_INT_LEAST64_T
public static final int H5_SIZEOF_INT_LEAST64_T
- See Also:
- Constant Field Values
-
H5_SIZEOF_INT_LEAST8_T
public static final int H5_SIZEOF_INT_LEAST8_T
- See Also:
- Constant Field Values
-
H5_SIZEOF_LONG
public static final int H5_SIZEOF_LONG
- See Also:
- Constant Field Values
-
H5_SIZEOF_LONG_DOUBLE
public static final int H5_SIZEOF_LONG_DOUBLE
- See Also:
- Constant Field Values
-
H5_SIZEOF_LONG_LONG
public static final int H5_SIZEOF_LONG_LONG
- See Also:
- Constant Field Values
-
H5_SIZEOF_OFF_T
public static final int H5_SIZEOF_OFF_T
- See Also:
- Constant Field Values
-
H5_SIZEOF_PTRDIFF_T
public static final int H5_SIZEOF_PTRDIFF_T
- See Also:
- Constant Field Values
-
H5_SIZEOF_SHORT
public static final int H5_SIZEOF_SHORT
- See Also:
- Constant Field Values
-
H5_SIZEOF_SIZE_T
public static final int H5_SIZEOF_SIZE_T
- See Also:
- Constant Field Values
-
H5_SIZEOF_SSIZE_T
public static final int H5_SIZEOF_SSIZE_T
- See Also:
- Constant Field Values
-
H5_SIZEOF_TIME_T
public static final int H5_SIZEOF_TIME_T
- See Also:
- Constant Field Values
-
H5_SIZEOF_UINT16_T
public static final int H5_SIZEOF_UINT16_T
- See Also:
- Constant Field Values
-
H5_SIZEOF_UINT32_T
public static final int H5_SIZEOF_UINT32_T
- See Also:
- Constant Field Values
-
H5_SIZEOF_UINT64_T
public static final int H5_SIZEOF_UINT64_T
- See Also:
- Constant Field Values
-
H5_SIZEOF_UINT8_T
public static final int H5_SIZEOF_UINT8_T
- See Also:
- Constant Field Values
-
H5_SIZEOF_UINT_FAST16_T
public static final int H5_SIZEOF_UINT_FAST16_T
- See Also:
- Constant Field Values
-
H5_SIZEOF_UINT_FAST32_T
public static final int H5_SIZEOF_UINT_FAST32_T
- See Also:
- Constant Field Values
-
H5_SIZEOF_UINT_FAST64_T
public static final int H5_SIZEOF_UINT_FAST64_T
- See Also:
- Constant Field Values
-
H5_SIZEOF_UINT_FAST8_T
public static final int H5_SIZEOF_UINT_FAST8_T
- See Also:
- Constant Field Values
-
H5_SIZEOF_UINT_LEAST16_T
public static final int H5_SIZEOF_UINT_LEAST16_T
- See Also:
- Constant Field Values
-
H5_SIZEOF_UINT_LEAST32_T
public static final int H5_SIZEOF_UINT_LEAST32_T
- See Also:
- Constant Field Values
-
H5_SIZEOF_UINT_LEAST64_T
public static final int H5_SIZEOF_UINT_LEAST64_T
- See Also:
- Constant Field Values
-
H5_SIZEOF_UINT_LEAST8_T
public static final int H5_SIZEOF_UINT_LEAST8_T
- See Also:
- Constant Field Values
-
H5_SIZEOF_UNSIGNED
public static final int H5_SIZEOF_UNSIGNED
- See Also:
- Constant Field Values
-
H5_STDC_HEADERS
public static final int H5_STDC_HEADERS
- See Also:
- Constant Field Values
-
H5_TEST_EXPRESS_LEVEL_DEFAULT
public static final int H5_TEST_EXPRESS_LEVEL_DEFAULT
- See Also:
- Constant Field Values
-
H5_USE_114_API_DEFAULT
public static final int H5_USE_114_API_DEFAULT
- See Also:
- Constant Field Values
-
H5_USE_FILE_LOCKING
public static final int H5_USE_FILE_LOCKING
- See Also:
- Constant Field Values
-
H5_VERSION
public static final String H5_VERSION
- See Also:
- Constant Field Values
-
H5_WANT_DATA_ACCURACY
public static final int H5_WANT_DATA_ACCURACY
- See Also:
- Constant Field Values
-
H5_WANT_DCONV_EXCEPTION
public static final int H5_WANT_DCONV_EXCEPTION
- See Also:
- Constant Field Values
-
WORDS_BIGENDIAN
public static final int WORDS_BIGENDIAN
- See Also:
- Constant Field Values
-
H5_VERS_MAJOR
public static final int H5_VERS_MAJOR
For major interface/format changes- See Also:
- Constant Field Values
-
H5_VERS_MINOR
public static final int H5_VERS_MINOR
For minor interface/format changes- See Also:
- Constant Field Values
-
H5_VERS_RELEASE
public static final int H5_VERS_RELEASE
For tweaks, bug-fixes, or development- See Also:
- Constant Field Values
-
H5_VERS_SUBRELEASE
public static final String H5_VERS_SUBRELEASE
For pre-releases like \c snap0. Empty string for official releases.- See Also:
- Constant Field Values
-
H5_VERS_INFO
public static final String H5_VERS_INFO
Full version string- See Also:
- Constant Field Values
-
HDF5_DRIVER
public static final String HDF5_DRIVER
Used to specify the name of an HDF5 Virtual File Driver to use as the default file driver for file access. Setting this environment variable overrides the default file driver for File Access Property Lists.- See Also:
- Constant Field Values
-
HDF5_DRIVER_CONFIG
public static final String HDF5_DRIVER_CONFIG
Used to specify a configuration string for the HDF5 Virtual File Driver being used for file access.- See Also:
- Constant Field Values
-
HDF5_VOL_CONNECTOR
public static final String HDF5_VOL_CONNECTOR
Used to specify the name of an HDF5 Virtual Object Layer Connector to use as the default VOL connector for file access. Setting this environment variable overrides the default VOL connector for File Access Property Lists.- See Also:
- Constant Field Values
-
HDF5_PLUGIN_PATH
public static final String HDF5_PLUGIN_PATH
Used to specify a delimiter-separated (currently, ';' for Windows and ':' for other systems) list of paths that HDF5 should search when loading plugins.- See Also:
- Constant Field Values
-
HDF5_PLUGIN_PRELOAD
public static final String HDF5_PLUGIN_PRELOAD
Used to control the loading of HDF5 plugins at runtime. If this environment variable is set to the special string "::" (defined in H5PLpublic.h as H5PL_NO_PLUGIN), then dynamic loading of any HDF5 plugins will be disabled. No other values are valid for this environment variable.- See Also:
- Constant Field Values
-
HDF5_USE_FILE_LOCKING
public static final String HDF5_USE_FILE_LOCKING
Used to control whether HDF5 uses file locking when creating or opening a file. Valid values for this environment variable are as follows: "TRUE" or "1" - Request that file locks should be used "FALSE" or "0" - Request that file locks should NOT be used "BEST_EFFORT" - Request that file locks should be used and that any locking errors caused by file locking being disabled on the system should be ignored- See Also:
- Constant Field Values
-
HDF5_NOCLEANUP
public static final String HDF5_NOCLEANUP
Used to instruct HDF5 not to cleanup files created during testing.- See Also:
- Constant Field Values
-
H5_SIZEOF_HSIZE_T
public static final int H5_SIZEOF_HSIZE_T
The size of file objects. Used when negative values are needed to indicate errors. \internal Defined as a (minimum) 64-bit integer type. Use of hssize_t should be discouraged in new code.- See Also:
- Constant Field Values
-
H5_SIZEOF_HSSIZE_T
public static final int H5_SIZEOF_HSSIZE_T
- See Also:
- Constant Field Values
-
HSIZE_UNDEF
public static final int HSIZE_UNDEF
-
H5_SIZEOF_HADDR_T
public static final int H5_SIZEOF_HADDR_T
The address of an object in the file. \internal Defined as a (minimum) 64-bit unsigned integer type.- See Also:
- Constant Field Values
-
HADDR_UNDEF
public static final int HADDR_UNDEF
-
HADDR_MAX
public static final int HADDR_MAX
-
H5_ITER_UNKNOWN
public static final int H5_ITER_UNKNOWN
enum H5_iter_order_t- See Also:
- Constant Field Values
-
H5_ITER_INC
public static final int H5_ITER_INC
enum H5_iter_order_t- See Also:
- Constant Field Values
-
H5_ITER_DEC
public static final int H5_ITER_DEC
enum H5_iter_order_t- See Also:
- Constant Field Values
-
H5_ITER_NATIVE
public static final int H5_ITER_NATIVE
enum H5_iter_order_t- See Also:
- Constant Field Values
-
H5_ITER_N
public static final int H5_ITER_N
enum H5_iter_order_t- See Also:
- Constant Field Values
-
H5_ITER_ERROR
public static final int H5_ITER_ERROR
Error, stop iteration- See Also:
- Constant Field Values
-
H5_ITER_CONT
public static final int H5_ITER_CONT
Continue iteration- See Also:
- Constant Field Values
-
H5_ITER_STOP
public static final int H5_ITER_STOP
Stop iteration, short-circuit success- See Also:
- Constant Field Values
-
H5_INDEX_UNKNOWN
public static final int H5_INDEX_UNKNOWN
enum H5_index_t- See Also:
- Constant Field Values
-
H5_INDEX_NAME
public static final int H5_INDEX_NAME
enum H5_index_t- See Also:
- Constant Field Values
-
H5_INDEX_CRT_ORDER
public static final int H5_INDEX_CRT_ORDER
enum H5_index_t- See Also:
- Constant Field Values
-
H5_INDEX_N
public static final int H5_INDEX_N
enum H5_index_t- See Also:
- Constant Field Values
-
H5O_MAX_TOKEN_SIZE
public static final int H5O_MAX_TOKEN_SIZE
/** The maximum size allowed for tokens \details Tokens are unique and permanent identifiers that are used to reference HDF5 objects in a container. This allows for 128-bit tokens
- See Also:
- Constant Field Values
-
H5C_incr__off
public static final int H5C_incr__off
enum H5C_cache_incr_mode- See Also:
- Constant Field Values
-
H5C_incr__threshold
public static final int H5C_incr__threshold
enum H5C_cache_incr_mode- See Also:
- Constant Field Values
-
H5C_flash_incr__off
public static final int H5C_flash_incr__off
enum H5C_cache_flash_incr_mode- See Also:
- Constant Field Values
-
H5C_flash_incr__add_space
public static final int H5C_flash_incr__add_space
enum H5C_cache_flash_incr_mode- See Also:
- Constant Field Values
-
H5C_decr__off
public static final int H5C_decr__off
enum H5C_cache_decr_mode- See Also:
- Constant Field Values
-
H5C_decr__threshold
public static final int H5C_decr__threshold
enum H5C_cache_decr_mode- See Also:
- Constant Field Values
-
H5C_decr__age_out
public static final int H5C_decr__age_out
enum H5C_cache_decr_mode- See Also:
- Constant Field Values
-
H5C_decr__age_out_with_threshold
public static final int H5C_decr__age_out_with_threshold
enum H5C_cache_decr_mode- See Also:
- Constant Field Values
-
H5I_UNINIT
public static final int H5I_UNINIT
enum H5I_type_t- See Also:
- Constant Field Values
-
H5I_BADID
public static final int H5I_BADID
enum H5I_type_t- See Also:
- Constant Field Values
-
H5I_FILE
public static final int H5I_FILE
enum H5I_type_t- See Also:
- Constant Field Values
-
H5I_GROUP
public static final int H5I_GROUP
enum H5I_type_t- See Also:
- Constant Field Values
-
H5I_DATATYPE
public static final int H5I_DATATYPE
enum H5I_type_t- See Also:
- Constant Field Values
-
H5I_DATASPACE
public static final int H5I_DATASPACE
enum H5I_type_t- See Also:
- Constant Field Values
-
H5I_DATASET
public static final int H5I_DATASET
enum H5I_type_t- See Also:
- Constant Field Values
-
H5I_MAP
public static final int H5I_MAP
enum H5I_type_t- See Also:
- Constant Field Values
-
H5I_ATTR
public static final int H5I_ATTR
enum H5I_type_t- See Also:
- Constant Field Values
-
H5I_VFL
public static final int H5I_VFL
enum H5I_type_t- See Also:
- Constant Field Values
-
H5I_VOL
public static final int H5I_VOL
enum H5I_type_t- See Also:
- Constant Field Values
-
H5I_GENPROP_CLS
public static final int H5I_GENPROP_CLS
enum H5I_type_t- See Also:
- Constant Field Values
-
H5I_GENPROP_LST
public static final int H5I_GENPROP_LST
enum H5I_type_t- See Also:
- Constant Field Values
-
H5I_ERROR_CLASS
public static final int H5I_ERROR_CLASS
enum H5I_type_t- See Also:
- Constant Field Values
-
H5I_ERROR_MSG
public static final int H5I_ERROR_MSG
enum H5I_type_t- See Also:
- Constant Field Values
-
H5I_ERROR_STACK
public static final int H5I_ERROR_STACK
enum H5I_type_t- See Also:
- Constant Field Values
-
H5I_SPACE_SEL_ITER
public static final int H5I_SPACE_SEL_ITER
enum H5I_type_t- See Also:
- Constant Field Values
-
H5I_EVENTSET
public static final int H5I_EVENTSET
enum H5I_type_t- See Also:
- Constant Field Values
-
H5I_NTYPES
public static final int H5I_NTYPES
enum H5I_type_t- See Also:
- Constant Field Values
-
H5_SIZEOF_HID_T
public static final int H5_SIZEOF_HID_T
The size of identifiers- See Also:
- Constant Field Values
-
H5I_INVALID_HID
public static final int H5I_INVALID_HID
An invalid object ID. This is also negative for error return.- See Also:
- Constant Field Values
-
H5T_NO_CLASS
public static final int H5T_NO_CLASS
enum H5T_class_t- See Also:
- Constant Field Values
-
H5T_INTEGER
public static final int H5T_INTEGER
enum H5T_class_t- See Also:
- Constant Field Values
-
H5T_FLOAT
public static final int H5T_FLOAT
enum H5T_class_t- See Also:
- Constant Field Values
-
H5T_TIME
public static final int H5T_TIME
enum H5T_class_t- See Also:
- Constant Field Values
-
H5T_STRING
public static final int H5T_STRING
enum H5T_class_t- See Also:
- Constant Field Values
-
H5T_BITFIELD
public static final int H5T_BITFIELD
enum H5T_class_t- See Also:
- Constant Field Values
-
H5T_OPAQUE
public static final int H5T_OPAQUE
enum H5T_class_t- See Also:
- Constant Field Values
-
H5T_COMPOUND
public static final int H5T_COMPOUND
enum H5T_class_t- See Also:
- Constant Field Values
-
H5T_REFERENCE
public static final int H5T_REFERENCE
enum H5T_class_t- See Also:
- Constant Field Values
-
H5T_ENUM
public static final int H5T_ENUM
enum H5T_class_t- See Also:
- Constant Field Values
-
H5T_VLEN
public static final int H5T_VLEN
enum H5T_class_t- See Also:
- Constant Field Values
-
H5T_ARRAY
public static final int H5T_ARRAY
enum H5T_class_t- See Also:
- Constant Field Values
-
H5T_NCLASSES
public static final int H5T_NCLASSES
enum H5T_class_t- See Also:
- Constant Field Values
-
H5T_ORDER_ERROR
public static final int H5T_ORDER_ERROR
enum H5T_order_t- See Also:
- Constant Field Values
-
H5T_ORDER_LE
public static final int H5T_ORDER_LE
enum H5T_order_t- See Also:
- Constant Field Values
-
H5T_ORDER_BE
public static final int H5T_ORDER_BE
enum H5T_order_t- See Also:
- Constant Field Values
-
H5T_ORDER_VAX
public static final int H5T_ORDER_VAX
enum H5T_order_t- See Also:
- Constant Field Values
-
H5T_ORDER_MIXED
public static final int H5T_ORDER_MIXED
enum H5T_order_t- See Also:
- Constant Field Values
-
H5T_ORDER_NONE
public static final int H5T_ORDER_NONE
enum H5T_order_t- See Also:
- Constant Field Values
-
H5T_SGN_ERROR
public static final int H5T_SGN_ERROR
enum H5T_sign_t- See Also:
- Constant Field Values
-
H5T_SGN_NONE
public static final int H5T_SGN_NONE
enum H5T_sign_t- See Also:
- Constant Field Values
-
H5T_SGN_2
public static final int H5T_SGN_2
enum H5T_sign_t- See Also:
- Constant Field Values
-
H5T_NSGN
public static final int H5T_NSGN
enum H5T_sign_t- See Also:
- Constant Field Values
-
H5T_NORM_ERROR
public static final int H5T_NORM_ERROR
enum H5T_norm_t- See Also:
- Constant Field Values
-
H5T_NORM_IMPLIED
public static final int H5T_NORM_IMPLIED
enum H5T_norm_t- See Also:
- Constant Field Values
-
H5T_NORM_MSBSET
public static final int H5T_NORM_MSBSET
enum H5T_norm_t- See Also:
- Constant Field Values
-
H5T_NORM_NONE
public static final int H5T_NORM_NONE
enum H5T_norm_t- See Also:
- Constant Field Values
-
H5T_CSET_ERROR
public static final int H5T_CSET_ERROR
enum H5T_cset_t- See Also:
- Constant Field Values
-
H5T_CSET_ASCII
public static final int H5T_CSET_ASCII
enum H5T_cset_t- See Also:
- Constant Field Values
-
H5T_CSET_UTF8
public static final int H5T_CSET_UTF8
enum H5T_cset_t- See Also:
- Constant Field Values
-
H5T_CSET_RESERVED_2
public static final int H5T_CSET_RESERVED_2
enum H5T_cset_t- See Also:
- Constant Field Values
-
H5T_CSET_RESERVED_3
public static final int H5T_CSET_RESERVED_3
enum H5T_cset_t- See Also:
- Constant Field Values
-
H5T_CSET_RESERVED_4
public static final int H5T_CSET_RESERVED_4
enum H5T_cset_t- See Also:
- Constant Field Values
-
H5T_CSET_RESERVED_5
public static final int H5T_CSET_RESERVED_5
enum H5T_cset_t- See Also:
- Constant Field Values
-
H5T_CSET_RESERVED_6
public static final int H5T_CSET_RESERVED_6
enum H5T_cset_t- See Also:
- Constant Field Values
-
H5T_CSET_RESERVED_7
public static final int H5T_CSET_RESERVED_7
enum H5T_cset_t- See Also:
- Constant Field Values
-
H5T_CSET_RESERVED_8
public static final int H5T_CSET_RESERVED_8
enum H5T_cset_t- See Also:
- Constant Field Values
-
H5T_CSET_RESERVED_9
public static final int H5T_CSET_RESERVED_9
enum H5T_cset_t- See Also:
- Constant Field Values
-
H5T_CSET_RESERVED_10
public static final int H5T_CSET_RESERVED_10
enum H5T_cset_t- See Also:
- Constant Field Values
-
H5T_CSET_RESERVED_11
public static final int H5T_CSET_RESERVED_11
enum H5T_cset_t- See Also:
- Constant Field Values
-
H5T_CSET_RESERVED_12
public static final int H5T_CSET_RESERVED_12
enum H5T_cset_t- See Also:
- Constant Field Values
-
H5T_CSET_RESERVED_13
public static final int H5T_CSET_RESERVED_13
enum H5T_cset_t- See Also:
- Constant Field Values
-
H5T_CSET_RESERVED_14
public static final int H5T_CSET_RESERVED_14
enum H5T_cset_t- See Also:
- Constant Field Values
-
H5T_CSET_RESERVED_15
public static final int H5T_CSET_RESERVED_15
enum H5T_cset_t- See Also:
- Constant Field Values
-
H5T_NCSET
public static final int H5T_NCSET
- See Also:
- Constant Field Values
-
H5T_STR_ERROR
public static final int H5T_STR_ERROR
enum H5T_str_t- See Also:
- Constant Field Values
-
H5T_STR_NULLTERM
public static final int H5T_STR_NULLTERM
enum H5T_str_t- See Also:
- Constant Field Values
-
H5T_STR_NULLPAD
public static final int H5T_STR_NULLPAD
enum H5T_str_t- See Also:
- Constant Field Values
-
H5T_STR_SPACEPAD
public static final int H5T_STR_SPACEPAD
enum H5T_str_t- See Also:
- Constant Field Values
-
H5T_STR_RESERVED_3
public static final int H5T_STR_RESERVED_3
enum H5T_str_t- See Also:
- Constant Field Values
-
H5T_STR_RESERVED_4
public static final int H5T_STR_RESERVED_4
enum H5T_str_t- See Also:
- Constant Field Values
-
H5T_STR_RESERVED_5
public static final int H5T_STR_RESERVED_5
enum H5T_str_t- See Also:
- Constant Field Values
-
H5T_STR_RESERVED_6
public static final int H5T_STR_RESERVED_6
enum H5T_str_t- See Also:
- Constant Field Values
-
H5T_STR_RESERVED_7
public static final int H5T_STR_RESERVED_7
enum H5T_str_t- See Also:
- Constant Field Values
-
H5T_STR_RESERVED_8
public static final int H5T_STR_RESERVED_8
enum H5T_str_t- See Also:
- Constant Field Values
-
H5T_STR_RESERVED_9
public static final int H5T_STR_RESERVED_9
enum H5T_str_t- See Also:
- Constant Field Values
-
H5T_STR_RESERVED_10
public static final int H5T_STR_RESERVED_10
enum H5T_str_t- See Also:
- Constant Field Values
-
H5T_STR_RESERVED_11
public static final int H5T_STR_RESERVED_11
enum H5T_str_t- See Also:
- Constant Field Values
-
H5T_STR_RESERVED_12
public static final int H5T_STR_RESERVED_12
enum H5T_str_t- See Also:
- Constant Field Values
-
H5T_STR_RESERVED_13
public static final int H5T_STR_RESERVED_13
enum H5T_str_t- See Also:
- Constant Field Values
-
H5T_STR_RESERVED_14
public static final int H5T_STR_RESERVED_14
enum H5T_str_t- See Also:
- Constant Field Values
-
H5T_STR_RESERVED_15
public static final int H5T_STR_RESERVED_15
enum H5T_str_t- See Also:
- Constant Field Values
-
H5T_NSTR
public static final int H5T_NSTR
- See Also:
- Constant Field Values
-
H5T_PAD_ERROR
public static final int H5T_PAD_ERROR
enum H5T_pad_t- See Also:
- Constant Field Values
-
H5T_PAD_ZERO
public static final int H5T_PAD_ZERO
enum H5T_pad_t- See Also:
- Constant Field Values
-
H5T_PAD_ONE
public static final int H5T_PAD_ONE
enum H5T_pad_t- See Also:
- Constant Field Values
-
H5T_PAD_BACKGROUND
public static final int H5T_PAD_BACKGROUND
enum H5T_pad_t- See Also:
- Constant Field Values
-
H5T_NPAD
public static final int H5T_NPAD
enum H5T_pad_t- See Also:
- Constant Field Values
-
H5T_DIR_DEFAULT
public static final int H5T_DIR_DEFAULT
enum H5T_direction_t- See Also:
- Constant Field Values
-
H5T_DIR_ASCEND
public static final int H5T_DIR_ASCEND
enum H5T_direction_t- See Also:
- Constant Field Values
-
H5T_DIR_DESCEND
public static final int H5T_DIR_DESCEND
enum H5T_direction_t- See Also:
- Constant Field Values
-
H5T_CONV_EXCEPT_RANGE_HI
public static final int H5T_CONV_EXCEPT_RANGE_HI
enum H5T_conv_except_t- See Also:
- Constant Field Values
-
H5T_CONV_EXCEPT_RANGE_LOW
public static final int H5T_CONV_EXCEPT_RANGE_LOW
enum H5T_conv_except_t- See Also:
- Constant Field Values
-
H5T_CONV_EXCEPT_PRECISION
public static final int H5T_CONV_EXCEPT_PRECISION
enum H5T_conv_except_t- See Also:
- Constant Field Values
-
H5T_CONV_EXCEPT_TRUNCATE
public static final int H5T_CONV_EXCEPT_TRUNCATE
enum H5T_conv_except_t- See Also:
- Constant Field Values
-
H5T_CONV_EXCEPT_PINF
public static final int H5T_CONV_EXCEPT_PINF
enum H5T_conv_except_t- See Also:
- Constant Field Values
-
H5T_CONV_EXCEPT_NINF
public static final int H5T_CONV_EXCEPT_NINF
enum H5T_conv_except_t- See Also:
- Constant Field Values
-
H5T_CONV_EXCEPT_NAN
public static final int H5T_CONV_EXCEPT_NAN
enum H5T_conv_except_t- See Also:
- Constant Field Values
-
H5T_CONV_ABORT
public static final int H5T_CONV_ABORT
enum H5T_conv_ret_t- See Also:
- Constant Field Values
-
H5T_CONV_UNHANDLED
public static final int H5T_CONV_UNHANDLED
enum H5T_conv_ret_t- See Also:
- Constant Field Values
-
H5T_CONV_HANDLED
public static final int H5T_CONV_HANDLED
enum H5T_conv_ret_t- See Also:
- Constant Field Values
-
H5T_VARIABLE
public static final int H5T_VARIABLE
-
H5T_OPAQUE_TAG_MAX
public static final int H5T_OPAQUE_TAG_MAX
Maximum length of an opaque tag \internal This could be raised without too much difficulty- See Also:
- Constant Field Values
-
H5T_IEEE_F32BE
public static final int H5T_IEEE_F32BE
-
H5T_IEEE_F32LE
public static final int H5T_IEEE_F32LE
-
H5T_IEEE_F64BE
public static final int H5T_IEEE_F64BE
-
H5T_IEEE_F64LE
public static final int H5T_IEEE_F64LE
-
H5T_STD_I8BE
public static final int H5T_STD_I8BE
-
H5T_STD_I8LE
public static final int H5T_STD_I8LE
-
H5T_STD_I16BE
public static final int H5T_STD_I16BE
-
H5T_STD_I16LE
public static final int H5T_STD_I16LE
-
H5T_STD_I32BE
public static final int H5T_STD_I32BE
-
H5T_STD_I32LE
public static final int H5T_STD_I32LE
-
H5T_STD_I64BE
public static final int H5T_STD_I64BE
-
H5T_STD_I64LE
public static final int H5T_STD_I64LE
-
H5T_STD_U8BE
public static final int H5T_STD_U8BE
-
H5T_STD_U8LE
public static final int H5T_STD_U8LE
-
H5T_STD_U16BE
public static final int H5T_STD_U16BE
-
H5T_STD_U16LE
public static final int H5T_STD_U16LE
-
H5T_STD_U32BE
public static final int H5T_STD_U32BE
-
H5T_STD_U32LE
public static final int H5T_STD_U32LE
-
H5T_STD_U64BE
public static final int H5T_STD_U64BE
-
H5T_STD_U64LE
public static final int H5T_STD_U64LE
-
H5T_STD_B8BE
public static final int H5T_STD_B8BE
-
H5T_STD_B8LE
public static final int H5T_STD_B8LE
-
H5T_STD_B16BE
public static final int H5T_STD_B16BE
-
H5T_STD_B16LE
public static final int H5T_STD_B16LE
-
H5T_STD_B32BE
public static final int H5T_STD_B32BE
-
H5T_STD_B32LE
public static final int H5T_STD_B32LE
-
H5T_STD_B64BE
public static final int H5T_STD_B64BE
-
H5T_STD_B64LE
public static final int H5T_STD_B64LE
-
H5T_STD_REF_OBJ
public static final int H5T_STD_REF_OBJ
-
H5T_STD_REF_DSETREG
public static final int H5T_STD_REF_DSETREG
-
H5T_STD_REF
public static final int H5T_STD_REF
-
H5T_UNIX_D32BE
public static final int H5T_UNIX_D32BE
-
H5T_UNIX_D32LE
public static final int H5T_UNIX_D32LE
-
H5T_UNIX_D64BE
public static final int H5T_UNIX_D64BE
-
H5T_UNIX_D64LE
public static final int H5T_UNIX_D64LE
-
H5T_C_S1
public static final int H5T_C_S1
-
H5T_FORTRAN_S1
public static final int H5T_FORTRAN_S1
-
H5T_INTEL_I8
public static final int H5T_INTEL_I8
-
H5T_INTEL_I16
public static final int H5T_INTEL_I16
-
H5T_INTEL_I32
public static final int H5T_INTEL_I32
-
H5T_INTEL_I64
public static final int H5T_INTEL_I64
-
H5T_INTEL_U8
public static final int H5T_INTEL_U8
-
H5T_INTEL_U16
public static final int H5T_INTEL_U16
-
H5T_INTEL_U32
public static final int H5T_INTEL_U32
-
H5T_INTEL_U64
public static final int H5T_INTEL_U64
-
H5T_INTEL_B8
public static final int H5T_INTEL_B8
-
H5T_INTEL_B16
public static final int H5T_INTEL_B16
-
H5T_INTEL_B32
public static final int H5T_INTEL_B32
-
H5T_INTEL_B64
public static final int H5T_INTEL_B64
-
H5T_INTEL_F32
public static final int H5T_INTEL_F32
-
H5T_INTEL_F64
public static final int H5T_INTEL_F64
-
H5T_ALPHA_I8
public static final int H5T_ALPHA_I8
-
H5T_ALPHA_I16
public static final int H5T_ALPHA_I16
-
H5T_ALPHA_I32
public static final int H5T_ALPHA_I32
-
H5T_ALPHA_I64
public static final int H5T_ALPHA_I64
-
H5T_ALPHA_U8
public static final int H5T_ALPHA_U8
-
H5T_ALPHA_U16
public static final int H5T_ALPHA_U16
-
H5T_ALPHA_U32
public static final int H5T_ALPHA_U32
-
H5T_ALPHA_U64
public static final int H5T_ALPHA_U64
-
H5T_ALPHA_B8
public static final int H5T_ALPHA_B8
-
H5T_ALPHA_B16
public static final int H5T_ALPHA_B16
-
H5T_ALPHA_B32
public static final int H5T_ALPHA_B32
-
H5T_ALPHA_B64
public static final int H5T_ALPHA_B64
-
H5T_ALPHA_F32
public static final int H5T_ALPHA_F32
-
H5T_ALPHA_F64
public static final int H5T_ALPHA_F64
-
H5T_MIPS_I8
public static final int H5T_MIPS_I8
-
H5T_MIPS_I16
public static final int H5T_MIPS_I16
-
H5T_MIPS_I32
public static final int H5T_MIPS_I32
-
H5T_MIPS_I64
public static final int H5T_MIPS_I64
-
H5T_MIPS_U8
public static final int H5T_MIPS_U8
-
H5T_MIPS_U16
public static final int H5T_MIPS_U16
-
H5T_MIPS_U32
public static final int H5T_MIPS_U32
-
H5T_MIPS_U64
public static final int H5T_MIPS_U64
-
H5T_MIPS_B8
public static final int H5T_MIPS_B8
-
H5T_MIPS_B16
public static final int H5T_MIPS_B16
-
H5T_MIPS_B32
public static final int H5T_MIPS_B32
-
H5T_MIPS_B64
public static final int H5T_MIPS_B64
-
H5T_MIPS_F32
public static final int H5T_MIPS_F32
-
H5T_MIPS_F64
public static final int H5T_MIPS_F64
-
H5T_VAX_F32
public static final int H5T_VAX_F32
-
H5T_VAX_F64
public static final int H5T_VAX_F64
-
H5T_NATIVE_CHAR
public static final int H5T_NATIVE_CHAR
-
H5T_NATIVE_SCHAR
public static final int H5T_NATIVE_SCHAR
-
H5T_NATIVE_UCHAR
public static final int H5T_NATIVE_UCHAR
-
H5T_NATIVE_SHORT
public static final int H5T_NATIVE_SHORT
-
H5T_NATIVE_USHORT
public static final int H5T_NATIVE_USHORT
-
H5T_NATIVE_INT
public static final int H5T_NATIVE_INT
-
H5T_NATIVE_UINT
public static final int H5T_NATIVE_UINT
-
H5T_NATIVE_LONG
public static final int H5T_NATIVE_LONG
-
H5T_NATIVE_ULONG
public static final int H5T_NATIVE_ULONG
-
H5T_NATIVE_LLONG
public static final int H5T_NATIVE_LLONG
-
H5T_NATIVE_ULLONG
public static final int H5T_NATIVE_ULLONG
-
H5T_NATIVE_FLOAT
public static final int H5T_NATIVE_FLOAT
-
H5T_NATIVE_DOUBLE
public static final int H5T_NATIVE_DOUBLE
-
H5T_NATIVE_LDOUBLE
public static final int H5T_NATIVE_LDOUBLE
-
H5T_NATIVE_B8
public static final int H5T_NATIVE_B8
-
H5T_NATIVE_B16
public static final int H5T_NATIVE_B16
-
H5T_NATIVE_B32
public static final int H5T_NATIVE_B32
-
H5T_NATIVE_B64
public static final int H5T_NATIVE_B64
-
H5T_NATIVE_OPAQUE
public static final int H5T_NATIVE_OPAQUE
-
H5T_NATIVE_HADDR
public static final int H5T_NATIVE_HADDR
-
H5T_NATIVE_HSIZE
public static final int H5T_NATIVE_HSIZE
-
H5T_NATIVE_HSSIZE
public static final int H5T_NATIVE_HSSIZE
-
H5T_NATIVE_HERR
public static final int H5T_NATIVE_HERR
-
H5T_NATIVE_HBOOL
public static final int H5T_NATIVE_HBOOL
-
H5T_NATIVE_INT8
public static final int H5T_NATIVE_INT8
-
H5T_NATIVE_UINT8
public static final int H5T_NATIVE_UINT8
-
H5T_NATIVE_INT_LEAST8
public static final int H5T_NATIVE_INT_LEAST8
-
H5T_NATIVE_UINT_LEAST8
public static final int H5T_NATIVE_UINT_LEAST8
-
H5T_NATIVE_INT_FAST8
public static final int H5T_NATIVE_INT_FAST8
-
H5T_NATIVE_UINT_FAST8
public static final int H5T_NATIVE_UINT_FAST8
-
H5T_NATIVE_INT16
public static final int H5T_NATIVE_INT16
-
H5T_NATIVE_UINT16
public static final int H5T_NATIVE_UINT16
-
H5T_NATIVE_INT_LEAST16
public static final int H5T_NATIVE_INT_LEAST16
-
H5T_NATIVE_UINT_LEAST16
public static final int H5T_NATIVE_UINT_LEAST16
-
H5T_NATIVE_INT_FAST16
public static final int H5T_NATIVE_INT_FAST16
-
H5T_NATIVE_UINT_FAST16
public static final int H5T_NATIVE_UINT_FAST16
-
H5T_NATIVE_INT32
public static final int H5T_NATIVE_INT32
-
H5T_NATIVE_UINT32
public static final int H5T_NATIVE_UINT32
-
H5T_NATIVE_INT_LEAST32
public static final int H5T_NATIVE_INT_LEAST32
-
H5T_NATIVE_UINT_LEAST32
public static final int H5T_NATIVE_UINT_LEAST32
-
H5T_NATIVE_INT_FAST32
public static final int H5T_NATIVE_INT_FAST32
-
H5T_NATIVE_UINT_FAST32
public static final int H5T_NATIVE_UINT_FAST32
-
H5T_NATIVE_INT64
public static final int H5T_NATIVE_INT64
-
H5T_NATIVE_UINT64
public static final int H5T_NATIVE_UINT64
-
H5T_NATIVE_INT_LEAST64
public static final int H5T_NATIVE_INT_LEAST64
-
H5T_NATIVE_UINT_LEAST64
public static final int H5T_NATIVE_UINT_LEAST64
-
H5T_NATIVE_INT_FAST64
public static final int H5T_NATIVE_INT_FAST64
-
H5T_NATIVE_UINT_FAST64
public static final int H5T_NATIVE_UINT_FAST64
-
H5L_MAX_LINK_NAME_LEN
public static final int H5L_MAX_LINK_NAME_LEN
-
H5L_SAME_LOC
public static final int H5L_SAME_LOC
-
H5L_TYPE_ERROR
public static final int H5L_TYPE_ERROR
enum H5L_type_t- See Also:
- Constant Field Values
-
H5L_TYPE_HARD
public static final int H5L_TYPE_HARD
enum H5L_type_t- See Also:
- Constant Field Values
-
H5L_TYPE_SOFT
public static final int H5L_TYPE_SOFT
enum H5L_type_t- See Also:
- Constant Field Values
-
H5L_TYPE_EXTERNAL
public static final int H5L_TYPE_EXTERNAL
enum H5L_type_t- See Also:
- Constant Field Values
-
H5L_TYPE_MAX
public static final int H5L_TYPE_MAX
enum H5L_type_t- See Also:
- Constant Field Values
-
H5L_TYPE_BUILTIN_MAX
public static final int H5L_TYPE_BUILTIN_MAX
\brief Maximum value link value for "built-in" link types- See Also:
- Constant Field Values
-
H5L_TYPE_UD_MIN
public static final int H5L_TYPE_UD_MIN
\brief Link ids at or above this value are "user-defined" link types.- See Also:
- Constant Field Values
-
H5L_TYPE_UD_MAX
public static final int H5L_TYPE_UD_MAX
\brief Maximum link id value for "user-defined" link types.- See Also:
- Constant Field Values
-
H5O_COPY_SHALLOW_HIERARCHY_FLAG
public static final int H5O_COPY_SHALLOW_HIERARCHY_FLAG
Copy only immediate members- See Also:
- Constant Field Values
-
H5O_COPY_EXPAND_SOFT_LINK_FLAG
public static final int H5O_COPY_EXPAND_SOFT_LINK_FLAG
Expand soft links into new objects- See Also:
- Constant Field Values
-
H5O_COPY_EXPAND_EXT_LINK_FLAG
public static final int H5O_COPY_EXPAND_EXT_LINK_FLAG
Expand external links into new objects- See Also:
- Constant Field Values
-
H5O_COPY_EXPAND_REFERENCE_FLAG
public static final int H5O_COPY_EXPAND_REFERENCE_FLAG
Copy objects that are pointed by references- See Also:
- Constant Field Values
-
H5O_COPY_WITHOUT_ATTR_FLAG
public static final int H5O_COPY_WITHOUT_ATTR_FLAG
Copy object without copying attributes- See Also:
- Constant Field Values
-
H5O_COPY_PRESERVE_NULL_FLAG
public static final int H5O_COPY_PRESERVE_NULL_FLAG
Copy NULL messages (empty space)- See Also:
- Constant Field Values
-
H5O_COPY_MERGE_COMMITTED_DTYPE_FLAG
public static final int H5O_COPY_MERGE_COMMITTED_DTYPE_FLAG
Merge committed datatypes in dest file- See Also:
- Constant Field Values
-
H5O_COPY_ALL
public static final int H5O_COPY_ALL
All object copying flags (for internal checking)- See Also:
- Constant Field Values
-
H5O_SHMESG_NONE_FLAG
public static final int H5O_SHMESG_NONE_FLAG
No shared messages- See Also:
- Constant Field Values
-
H5O_SHMESG_SDSPACE_FLAG
public static final int H5O_SHMESG_SDSPACE_FLAG
-
H5O_SHMESG_DTYPE_FLAG
public static final int H5O_SHMESG_DTYPE_FLAG
-
H5O_SHMESG_FILL_FLAG
public static final int H5O_SHMESG_FILL_FLAG
-
H5O_SHMESG_PLINE_FLAG
public static final int H5O_SHMESG_PLINE_FLAG
-
H5O_SHMESG_ATTR_FLAG
public static final int H5O_SHMESG_ATTR_FLAG
-
H5O_SHMESG_ALL_FLAG
public static final int H5O_SHMESG_ALL_FLAG
-
H5O_HDR_CHUNK0_SIZE
public static final int H5O_HDR_CHUNK0_SIZE
2-bit field indicating # of bytes to store the size of chunk 0's data- See Also:
- Constant Field Values
-
H5O_HDR_ATTR_CRT_ORDER_TRACKED
public static final int H5O_HDR_ATTR_CRT_ORDER_TRACKED
Attribute creation order is tracked- See Also:
- Constant Field Values
-
H5O_HDR_ATTR_CRT_ORDER_INDEXED
public static final int H5O_HDR_ATTR_CRT_ORDER_INDEXED
Attribute creation order has index- See Also:
- Constant Field Values
-
H5O_HDR_ATTR_STORE_PHASE_CHANGE
public static final int H5O_HDR_ATTR_STORE_PHASE_CHANGE
Non-default attribute storage phase change values stored- See Also:
- Constant Field Values
-
H5O_HDR_STORE_TIMES
public static final int H5O_HDR_STORE_TIMES
Store access, modification, change & birth times for object- See Also:
- Constant Field Values
-
H5O_HDR_ALL_FLAGS
public static final int H5O_HDR_ALL_FLAGS
- See Also:
- Constant Field Values
-
H5O_SHMESG_MAX_NINDEXES
public static final int H5O_SHMESG_MAX_NINDEXES
- See Also:
- Constant Field Values
-
H5O_SHMESG_MAX_LIST_SIZE
public static final int H5O_SHMESG_MAX_LIST_SIZE
- See Also:
- Constant Field Values
-
H5O_INFO_BASIC
public static final int H5O_INFO_BASIC
Fill in the fileno, addr, type, and rc fields- See Also:
- Constant Field Values
-
H5O_INFO_TIME
public static final int H5O_INFO_TIME
Fill in the atime, mtime, ctime, and btime fields- See Also:
- Constant Field Values
-
H5O_INFO_NUM_ATTRS
public static final int H5O_INFO_NUM_ATTRS
Fill in the num_attrs field- See Also:
- Constant Field Values
-
H5O_INFO_ALL
public static final int H5O_INFO_ALL
- See Also:
- Constant Field Values
-
H5O_NATIVE_INFO_HDR
public static final int H5O_NATIVE_INFO_HDR
Fill in the hdr field- See Also:
- Constant Field Values
-
H5O_NATIVE_INFO_META_SIZE
public static final int H5O_NATIVE_INFO_META_SIZE
Fill in the meta_size field- See Also:
- Constant Field Values
-
H5O_NATIVE_INFO_ALL
public static final int H5O_NATIVE_INFO_ALL
- See Also:
- Constant Field Values
-
H5O_TYPE_UNKNOWN
public static final int H5O_TYPE_UNKNOWN
enum H5O_type_t- See Also:
- Constant Field Values
-
H5O_TYPE_GROUP
public static final int H5O_TYPE_GROUP
enum H5O_type_t- See Also:
- Constant Field Values
-
H5O_TYPE_DATASET
public static final int H5O_TYPE_DATASET
enum H5O_type_t- See Also:
- Constant Field Values
-
H5O_TYPE_NAMED_DATATYPE
public static final int H5O_TYPE_NAMED_DATATYPE
enum H5O_type_t- See Also:
- Constant Field Values
-
H5O_TYPE_MAP
public static final int H5O_TYPE_MAP
enum H5O_type_t- See Also:
- Constant Field Values
-
H5O_TYPE_NTYPES
public static final int H5O_TYPE_NTYPES
enum H5O_type_t- See Also:
- Constant Field Values
-
H5O_MCDT_SEARCH_ERROR
public static final int H5O_MCDT_SEARCH_ERROR
enum H5O_mcdt_search_ret_t- See Also:
- Constant Field Values
-
H5O_MCDT_SEARCH_CONT
public static final int H5O_MCDT_SEARCH_CONT
enum H5O_mcdt_search_ret_t- See Also:
- Constant Field Values
-
H5O_MCDT_SEARCH_STOP
public static final int H5O_MCDT_SEARCH_STOP
enum H5O_mcdt_search_ret_t- See Also:
- Constant Field Values
-
H5Z_FILTER_ERROR
public static final int H5Z_FILTER_ERROR
no filter- See Also:
- Constant Field Values
-
H5Z_FILTER_NONE
public static final int H5Z_FILTER_NONE
reserved indefinitely- See Also:
- Constant Field Values
-
H5Z_FILTER_DEFLATE
public static final int H5Z_FILTER_DEFLATE
deflation like gzip- See Also:
- Constant Field Values
-
H5Z_FILTER_SHUFFLE
public static final int H5Z_FILTER_SHUFFLE
shuffle the data- See Also:
- Constant Field Values
-
H5Z_FILTER_FLETCHER32
public static final int H5Z_FILTER_FLETCHER32
fletcher32 checksum of EDC- See Also:
- Constant Field Values
-
H5Z_FILTER_SZIP
public static final int H5Z_FILTER_SZIP
szip compression- See Also:
- Constant Field Values
-
H5Z_FILTER_NBIT
public static final int H5Z_FILTER_NBIT
nbit compression- See Also:
- Constant Field Values
-
H5Z_FILTER_SCALEOFFSET
public static final int H5Z_FILTER_SCALEOFFSET
scale+offset compression- See Also:
- Constant Field Values
-
H5Z_FILTER_RESERVED
public static final int H5Z_FILTER_RESERVED
filter ids below this value are reserved for library use- See Also:
- Constant Field Values
-
H5Z_FILTER_MAX
public static final int H5Z_FILTER_MAX
maximum filter id- See Also:
- Constant Field Values
-
H5Z_FILTER_ALL
public static final int H5Z_FILTER_ALL
Symbol to remove all filters in H5Premove_filter()- See Also:
- Constant Field Values
-
H5Z_MAX_NFILTERS
public static final int H5Z_MAX_NFILTERS
Maximum number of filters allowed in a pipeline \internal (should probably be allowed to be an unlimited amount, but currently each filter uses a bit in a 32-bit field, so the format would have to be changed to accommodate that)- See Also:
- Constant Field Values
-
H5Z_FLAG_DEFMASK
public static final int H5Z_FLAG_DEFMASK
definition flag mask- See Also:
- Constant Field Values
-
H5Z_FLAG_MANDATORY
public static final int H5Z_FLAG_MANDATORY
filter is mandatory- See Also:
- Constant Field Values
-
H5Z_FLAG_OPTIONAL
public static final int H5Z_FLAG_OPTIONAL
filter is optional- See Also:
- Constant Field Values
-
H5Z_FLAG_INVMASK
public static final int H5Z_FLAG_INVMASK
invocation flag mask- See Also:
- Constant Field Values
-
H5Z_FLAG_REVERSE
public static final int H5Z_FLAG_REVERSE
reverse direction; read- See Also:
- Constant Field Values
-
H5Z_FLAG_SKIP_EDC
public static final int H5Z_FLAG_SKIP_EDC
skip EDC filters for read- See Also:
- Constant Field Values
-
H5_SZIP_ALLOW_K13_OPTION_MASK
public static final int H5_SZIP_ALLOW_K13_OPTION_MASK
\ingroup SZIP- See Also:
- Constant Field Values
-
H5_SZIP_CHIP_OPTION_MASK
public static final int H5_SZIP_CHIP_OPTION_MASK
\ingroup SZIP- See Also:
- Constant Field Values
-
H5_SZIP_EC_OPTION_MASK
public static final int H5_SZIP_EC_OPTION_MASK
\ingroup SZIP- See Also:
- Constant Field Values
-
H5_SZIP_NN_OPTION_MASK
public static final int H5_SZIP_NN_OPTION_MASK
\ingroup SZIP- See Also:
- Constant Field Values
-
H5_SZIP_MAX_PIXELS_PER_BLOCK
public static final int H5_SZIP_MAX_PIXELS_PER_BLOCK
\ingroup SZIP- See Also:
- Constant Field Values
-
H5Z_SHUFFLE_USER_NPARMS
public static final int H5Z_SHUFFLE_USER_NPARMS
\ingroup SHUFFLE Number of parameters that users can set for the shuffle filter- See Also:
- Constant Field Values
-
H5Z_SHUFFLE_TOTAL_NPARMS
public static final int H5Z_SHUFFLE_TOTAL_NPARMS
\ingroup SHUFFLE Total number of parameters for the shuffle filter- See Also:
- Constant Field Values
-
H5Z_SZIP_USER_NPARMS
public static final int H5Z_SZIP_USER_NPARMS
\ingroup SZIP Number of parameters that users can set for SZIP- See Also:
- Constant Field Values
-
H5Z_SZIP_TOTAL_NPARMS
public static final int H5Z_SZIP_TOTAL_NPARMS
\ingroup SZIP Total number of parameters for SZIP filter- See Also:
- Constant Field Values
-
H5Z_SZIP_PARM_MASK
public static final int H5Z_SZIP_PARM_MASK
\ingroup SZIP "User" parameter for option mask- See Also:
- Constant Field Values
-
H5Z_SZIP_PARM_PPB
public static final int H5Z_SZIP_PARM_PPB
\ingroup SZIP "User" parameter for pixels-per-block- See Also:
- Constant Field Values
-
H5Z_SZIP_PARM_BPP
public static final int H5Z_SZIP_PARM_BPP
\ingroup SZIP "Local" parameter for bits-per-pixel- See Also:
- Constant Field Values
-
H5Z_SZIP_PARM_PPS
public static final int H5Z_SZIP_PARM_PPS
\ingroup SZIP "Local" parameter for pixels-per-scanline- See Also:
- Constant Field Values
-
H5Z_NBIT_USER_NPARMS
public static final int H5Z_NBIT_USER_NPARMS
\ingroup NBIT Number of parameters that users can set for the N-bit filter- See Also:
- Constant Field Values
-
H5Z_SCALEOFFSET_USER_NPARMS
public static final int H5Z_SCALEOFFSET_USER_NPARMS
\ingroup SCALEOFFSET Number of parameters that users can set for the scale-offset filter- See Also:
- Constant Field Values
-
H5Z_SO_INT_MINBITS_DEFAULT
public static final int H5Z_SO_INT_MINBITS_DEFAULT
\ingroup SCALEOFFSET- See Also:
- Constant Field Values
-
H5Z_SO_FLOAT_DSCALE
public static final int H5Z_SO_FLOAT_DSCALE
enum H5Z_SO_scale_type_t- See Also:
- Constant Field Values
-
H5Z_SO_FLOAT_ESCALE
public static final int H5Z_SO_FLOAT_ESCALE
enum H5Z_SO_scale_type_t- See Also:
- Constant Field Values
-
H5Z_SO_INT
public static final int H5Z_SO_INT
enum H5Z_SO_scale_type_t- See Also:
- Constant Field Values
-
H5Z_ERROR_EDC
public static final int H5Z_ERROR_EDC
enum H5Z_EDC_t- See Also:
- Constant Field Values
-
H5Z_DISABLE_EDC
public static final int H5Z_DISABLE_EDC
enum H5Z_EDC_t- See Also:
- Constant Field Values
-
H5Z_ENABLE_EDC
public static final int H5Z_ENABLE_EDC
enum H5Z_EDC_t- See Also:
- Constant Field Values
-
H5Z_NO_EDC
public static final int H5Z_NO_EDC
enum H5Z_EDC_t- See Also:
- Constant Field Values
-
H5Z_FILTER_CONFIG_ENCODE_ENABLED
public static final int H5Z_FILTER_CONFIG_ENCODE_ENABLED
- See Also:
- Constant Field Values
-
H5Z_FILTER_CONFIG_DECODE_ENABLED
public static final int H5Z_FILTER_CONFIG_DECODE_ENABLED
- See Also:
- Constant Field Values
-
H5Z_CB_ERROR
public static final int H5Z_CB_ERROR
enum H5Z_cb_return_t- See Also:
- Constant Field Values
-
H5Z_CB_FAIL
public static final int H5Z_CB_FAIL
enum H5Z_cb_return_t- See Also:
- Constant Field Values
-
H5Z_CB_CONT
public static final int H5Z_CB_CONT
enum H5Z_cb_return_t- See Also:
- Constant Field Values
-
H5Z_CB_NO
public static final int H5Z_CB_NO
enum H5Z_cb_return_t- See Also:
- Constant Field Values
-
H5AC__CURR_CACHE_CONFIG_VERSION
public static final int H5AC__CURR_CACHE_CONFIG_VERSION
structure H5AC_cache_config_t H5AC_cache_config_t is a public structure intended for use in public APIs. At least in its initial incarnation, it is basically a copy of struct H5C_auto_size_ctl_t, minus the report_fcn field, and plus the dirty_bytes_threshold field. The report_fcn field is omitted, as including it would require us to make H5C_t structure public. The dirty_bytes_threshold field does not appear in H5C_auto_size_ctl_t, as synchronization between caches on different processes is handled at the H5AC level, not at the level of H5C. Note however that there is considerable interaction between this value and the other fields in this structure. Similarly, the open_trace_file, close_trace_file, and trace_file_name fields do not appear in H5C_auto_size_ctl_t, as most trace file issues are handled at the H5AC level. The one exception is storage of the pointer to the trace file, which is handled by H5C. The structure is in H5ACpublic.h as we may wish to allow different configuration options for metadata and raw data caches. The fields of the structure are discussed individually below: version: Integer field containing the version number of this version of the H5AC_cache_config_t structure. Any instance of H5AC_cache_config_t passed to the cache must have a known version number, or an error will be flagged. rpt_fcn_enabled: Boolean field used to enable and disable the default reporting function. This function is invoked every time the automatic cache resize code is run, and reports on its activities. This is a debugging function, and should normally be turned off. open_trace_file: Boolean field indicating whether the trace_file_name field should be used to open a trace file for the cache. *** DEPRECATED *** Use H5Fstart/stop logging functions instead The trace file is a debugging feature that allow the capture of top level metadata cache requests for purposes of debugging and/or optimization. This field should normally be set to FALSE, as trace file collection imposes considerable overhead. This field should only be set to TRUE when the trace_file_name contains the full path of the desired trace file, and either there is no open trace file on the cache, or the close_trace_file field is also TRUE. close_trace_file: Boolean field indicating whether the current trace file (if any) should be closed. *** DEPRECATED *** Use H5Fstart/stop logging functions instead See the above comments on the open_trace_file field. This field should be set to FALSE unless there is an open trace file on the cache that you wish to close. trace_file_name: Full path of the trace file to be opened if the open_trace_file field is TRUE. *** DEPRECATED *** Use H5Fstart/stop logging functions instead In the parallel case, an ascii representation of the mpi rank of the process will be appended to the file name to yield a unique trace file name for each process. The length of the path must not exceed H5AC__MAX_TRACE_FILE_NAME_LEN characters. evictions_enabled: Boolean field used to either report the current evictions enabled status of the cache, or to set the cache's evictions enabled status. In general, the metadata cache should always be allowed to evict entries. However, in some cases it is advantageous to disable evictions briefly, and thereby postpone metadata writes. However, this must be done with care, as the cache can grow quickly. If you do this, re-enable evictions as soon as possible and monitor cache size. At present, evictions can only be disabled if automatic cache resizing is also disabled (that is, ( incr_mode == H5C_incr__off ) && ( decr_mode == H5C_decr__off )). There is no logical reason why this should be so, but it simplifies implementation and testing, and I can't think of any reason why it would be desirable. If you can think of one, I'll revisit the issue. set_initial_size: Boolean flag indicating whether the size of the initial size of the cache is to be set to the value given in the initial_size field. If set_initial_size is FALSE, the initial_size field is ignored. initial_size: If enabled, this field contain the size the cache is to be set to upon receipt of this structure. Needless to say, initial_size must lie in the closed interval [min_size, max_size]. min_clean_fraction: double in the range 0 to 1 indicating the fraction of the cache that is to be kept clean. This field is only used in parallel mode. Typical values are 0.1 to 0.5. max_size: Maximum size to which the cache can be adjusted. The supplied value must fall in the closed interval [MIN_MAX_CACHE_SIZE, MAX_MAX_CACHE_SIZE]. Also, max_size must be greater than or equal to min_size. min_size: Minimum size to which the cache can be adjusted. The supplied value must fall in the closed interval [H5C__MIN_MAX_CACHE_SIZE, H5C__MAX_MAX_CACHE_SIZE]. Also, min_size must be less than or equal to max_size. epoch_length: Number of accesses on the cache over which to collect hit rate stats before running the automatic cache resize code, if it is enabled. At the end of an epoch, we discard prior hit rate data and start collecting afresh. The epoch_length must lie in the closed interval [H5C__MIN_AR_EPOCH_LENGTH, H5C__MAX_AR_EPOCH_LENGTH]. Cache size increase control fields: incr_mode: Instance of the H5C_cache_incr_mode enumerated type whose value indicates how we determine whether the cache size should be increased. At present there are two possible values: H5C_incr__off: Don't attempt to increase the size of the cache automatically. When this increment mode is selected, the remaining fields in the cache size increase section ar ignored. H5C_incr__threshold: Attempt to increase the size of the cache whenever the average hit rate over the last epoch drops below the value supplied in the lower_hr_threshold field. Note that this attempt will fail if the cache is already at its maximum size, or if the cache is not already using all available space. Note that you must set decr_mode to H5C_incr__off if you disable metadata cache entry evictions. lower_hr_threshold: Lower hit rate threshold. If the increment mode (incr_mode) is H5C_incr__threshold and the hit rate drops below the value supplied in this field in an epoch, increment the cache size by size_increment. Note that cache size may not be incremented above max_size, and that the increment may be further restricted by the max_increment field if it is enabled. When enabled, this field must contain a value in the range [0.0, 1.0]. Depending on the incr_mode selected, it may also have to be less than upper_hr_threshold. increment: Double containing the multiplier used to derive the new cache size from the old if a cache size increment is triggered. The increment must be greater than 1.0, and should not exceed 2.0. The new cache size is obtained my multiplying the current max cache size by the increment, and then clamping to max_size and to stay within the max_increment as necessary. apply_max_increment: Boolean flag indicating whether the max_increment field should be used to limit the maximum cache size increment. max_increment: If enabled by the apply_max_increment field described above, this field contains the maximum number of bytes by which the cache size can be increased in a single re-size. flash_incr_mode: Instance of the H5C_cache_flash_incr_mode enumerated type whose value indicates whether and by which algorithm we should make flash increases in the size of the cache to accommodate insertion of large entries and large increases in the size of a single entry. The addition of the flash increment mode was occasioned by performance problems that appear when a local heap is increased to a size in excess of the current cache size. While the existing re-size code dealt with this eventually, performance was very bad for the remainder of the epoch. At present, there are two possible values for the flash_incr_mode: H5C_flash_incr__off: Don't perform flash increases in the size of the cache. H5C_flash_incr__add_space: Let x be either the size of a newly newly inserted entry, or the number of bytes by which the size of an existing entry has been increased. If x > flash_threshold * current max cache size, increase the current maximum cache size by x * flash_multiple less any free space in the cache, and star a new epoch. For now at least, pay no attention to the maximum increment. In both of the above cases, the flash increment pays no attention to the maximum increment (at least in this first incarnation), but DOES stay within max_size. With a little thought, it should be obvious that the above flash cache size increase algorithm is not sufficient for all circumstances -- for example, suppose the user round robins through (1/flash_threshold) +1 groups, adding one data set to each on each pass. Then all will increase in size at about the same time, requiring the max cache size to at least double to maintain acceptable performance, however the above flash increment algorithm will not be triggered. Hopefully, the add space algorithms detailed above will be sufficient for the performance problems encountered to date. However, we should expect to revisit the issue. flash_multiple: Double containing the multiple described above in the H5C_flash_incr__add_space section of the discussion of the flash_incr_mode section. This field is ignored unless flash_incr_mode is H5C_flash_incr__add_space. flash_threshold: Double containing the factor by which current max cache size is multiplied to obtain the size threshold for the add_space flash increment algorithm. The field is ignored unless flash_incr_mode is H5C_flash_incr__add_space. Cache size decrease control fields: decr_mode: Instance of the H5C_cache_decr_mode enumerated type whose value indicates how we determine whether the cache size should be decreased. At present there are four possibilities. H5C_decr__off: Don't attempt to decrease the size of the cache automatically. When this increment mode is selected, the remaining fields in the cache size decrease section are ignored. H5C_decr__threshold: Attempt to decrease the size of the cache whenever the average hit rate over the last epoch rises above the value supplied in the upper_hr_threshold field. H5C_decr__age_out: At the end of each epoch, search the cache for entries that have not been accessed for at least the number of epochs specified in the epochs_before_eviction field, and evict these entries. Conceptually, the maximum cache size is then decreased to match the new actual cache size. However, this reduction may be modified by the min_size, the max_decrement, and/or the empty_reserve. H5C_decr__age_out_with_threshold: Same as age_out, but we only attempt to reduce the cache size when the hit rate observed over the last epoch exceeds the value provided in the upper_hr_threshold field. Note that you must set decr_mode to H5C_decr__off if you disable metadata cache entry evictions. upper_hr_threshold: Upper hit rate threshold. The use of this field varies according to the current decr_mode: H5C_decr__off or H5C_decr__age_out: The value of this field is ignored. H5C_decr__threshold: If the hit rate exceeds this threshold in any epoch, attempt to decrement the cache size by size_decrement. Note that cache size may not be decremented below min_size. Note also that if the upper_threshold is 1.0, the cache size will never be reduced. H5C_decr__age_out_with_threshold: If the hit rate exceeds this threshold in any epoch, attempt to reduce the cache size by evicting entries that have not been accessed for more than the specified number of epochs. decrement: This field is only used when the decr_mode is H5C_decr__threshold. The field is a double containing the multiplier used to derive the new cache size from the old if a cache size decrement is triggered. The decrement must be in the range 0.0 (in which case the cache will try to contract to its minimum size) to 1.0 (in which case the cache will never shrink). apply_max_decrement: Boolean flag used to determine whether decrements in cache size are to be limited by the max_decrement field. max_decrement: Maximum number of bytes by which the cache size can be decreased in a single re-size. Note that decrements may also be restricted by the min_size of the cache, and (in age out modes) by the empty_reserve field. epochs_before_eviction: Integer field used in H5C_decr__age_out and H5C_decr__age_out_with_threshold decrement modes. This field contains the number of epochs an entry must remain unaccessed before it is evicted in an attempt to reduce the cache size. If applicable, this field must lie in the range [1, H5C__MAX_EPOCH_MARKERS]. apply_empty_reserve: Boolean field controlling whether the empty_reserve field is to be used in computing the new cache size when the decr_mode is H5C_decr__age_out or H5C_decr__age_out_with_threshold. empty_reserve: To avoid a constant racheting down of cache size by small amounts in the H5C_decr__age_out and H5C_decr__age_out_with_threshold modes, this field allows one to require that any cache size reductions leave the specified fraction of unused space in the cache. The value of this field must be in the range [0.0, 1.0]. I would expect typical values to be in the range of 0.01 to 0.1. Parallel Configuration Fields: In PHDF5, all operations that modify metadata must be executed collectively. We used to think that this was enough to ensure consistency across the metadata caches, but since we allow processes to read metadata individually, the order of dirty entries in the LRU list can vary across processes, which can result in inconsistencies between the caches. PHDF5 uses several strategies to prevent such inconsistencies in metadata, all of which use the fact that the same stream of dirty metadata is seen by all processes for purposes of synchronization. This is done by having each process count the number of bytes of dirty metadata generated, and then running a "sync point" whenever this count exceeds a user specified threshold (see dirty_bytes_threshold below). The current metadata write strategy is indicated by the metadata_write_strategy field. The possible values of this field, along with the associated metadata write strategies are discussed below. dirty_bytes_threshold: Threshold of dirty byte creation used to synchronize updates between caches. (See above for outline and motivation.) This value MUST be consistent across all processes accessing the file. This field is ignored unless HDF5 has been compiled for parallel. metadata_write_strategy: Integer field containing a code indicating the desired metadata write strategy. The valid values of this field are enumerated and discussed below: H5AC_METADATA_WRITE_STRATEGY__PROCESS_0_ONLY: When metadata_write_strategy is set to this value, only process zero is allowed to write dirty metadata to disk. All other processes must retain dirty metadata until they are informed at a sync point that the dirty metadata in question has been written to disk. When the sync point is reached (or when there is a user generated flush), process zero flushes sufficient entries to bring it into compliance with its min clean size (or flushes all dirty entries in the case of a user generated flush), broad casts the list of entries just cleaned to all the other processes, and then exits the sync point. Upon receipt of the broadcast, the other processes mark the indicated entries as clean, and leave the sync point as well. H5AC_METADATA_WRITE_STRATEGY__DISTRIBUTED: In the distributed metadata write strategy, process zero still makes the decisions as to what entries should be flushed, but the actual flushes are distributed across the processes in the computation to the extent possible. In this strategy, when a sync point is triggered (either by dirty metadata creation or manual flush), all processes enter a barrier. On the other side of the barrier, process 0 constructs an ordered list of the entries to be flushed, and then broadcasts this list to the caches in all the processes. All processes then scan the list of entries to be flushed, flushing some, and marking the rest as clean. The algorithm for this purpose ensures that each entry in the list is flushed exactly once, and all are marked clean in each cache. Note that in the case of a flush of the cache, no message passing is necessary, as all processes have the same list of dirty entries, and all of these entries must be flushed. Thus in this case it is sufficient for each process to sort its list of dirty entries after leaving the initial barrier, and use this list as if it had been received from process zero. To avoid possible messages from the past/future, all caches must wait until all caches are done before leaving the sync point.- See Also:
- Constant Field Values
-
H5AC__MAX_TRACE_FILE_NAME_LEN
public static final int H5AC__MAX_TRACE_FILE_NAME_LEN
- See Also:
- Constant Field Values
-
H5AC_METADATA_WRITE_STRATEGY__PROCESS_0_ONLY
public static final int H5AC_METADATA_WRITE_STRATEGY__PROCESS_0_ONLY
- See Also:
- Constant Field Values
-
H5AC_METADATA_WRITE_STRATEGY__DISTRIBUTED
public static final int H5AC_METADATA_WRITE_STRATEGY__DISTRIBUTED
- See Also:
- Constant Field Values
-
H5AC__CURR_CACHE_IMAGE_CONFIG_VERSION
public static final int H5AC__CURR_CACHE_IMAGE_CONFIG_VERSION
- See Also:
- Constant Field Values
-
H5AC__CACHE_IMAGE__ENTRY_AGEOUT__NONE
public static final int H5AC__CACHE_IMAGE__ENTRY_AGEOUT__NONE
- See Also:
- Constant Field Values
-
H5AC__CACHE_IMAGE__ENTRY_AGEOUT__MAX
public static final int H5AC__CACHE_IMAGE__ENTRY_AGEOUT__MAX
- See Also:
- Constant Field Values
-
H5D_CHUNK_CACHE_NSLOTS_DEFAULT
public static final int H5D_CHUNK_CACHE_NSLOTS_DEFAULT
-
H5D_CHUNK_CACHE_NBYTES_DEFAULT
public static final int H5D_CHUNK_CACHE_NBYTES_DEFAULT
-
H5D_CHUNK_CACHE_W0_DEFAULT
public static final double H5D_CHUNK_CACHE_W0_DEFAULT
- See Also:
- Constant Field Values
-
H5D_CHUNK_DONT_FILTER_PARTIAL_CHUNKS
public static final int H5D_CHUNK_DONT_FILTER_PARTIAL_CHUNKS
Bit flags for the H5Pset_chunk_opts() and H5Pget_chunk_opts()- See Also:
- Constant Field Values
-
H5D_LAYOUT_ERROR
public static final int H5D_LAYOUT_ERROR
enum H5D_layout_t- See Also:
- Constant Field Values
-
H5D_COMPACT
public static final int H5D_COMPACT
enum H5D_layout_t- See Also:
- Constant Field Values
-
H5D_CONTIGUOUS
public static final int H5D_CONTIGUOUS
enum H5D_layout_t- See Also:
- Constant Field Values
-
H5D_CHUNKED
public static final int H5D_CHUNKED
enum H5D_layout_t- See Also:
- Constant Field Values
-
H5D_VIRTUAL
public static final int H5D_VIRTUAL
enum H5D_layout_t- See Also:
- Constant Field Values
-
H5D_NLAYOUTS
public static final int H5D_NLAYOUTS
enum H5D_layout_t- See Also:
- Constant Field Values
-
H5D_CHUNK_IDX_BTREE
public static final int H5D_CHUNK_IDX_BTREE
enum H5D_chunk_index_t- See Also:
- Constant Field Values
-
H5D_CHUNK_IDX_SINGLE
public static final int H5D_CHUNK_IDX_SINGLE
enum H5D_chunk_index_t- See Also:
- Constant Field Values
-
H5D_CHUNK_IDX_NONE
public static final int H5D_CHUNK_IDX_NONE
enum H5D_chunk_index_t- See Also:
- Constant Field Values
-
H5D_CHUNK_IDX_FARRAY
public static final int H5D_CHUNK_IDX_FARRAY
enum H5D_chunk_index_t- See Also:
- Constant Field Values
-
H5D_CHUNK_IDX_EARRAY
public static final int H5D_CHUNK_IDX_EARRAY
enum H5D_chunk_index_t- See Also:
- Constant Field Values
-
H5D_CHUNK_IDX_BT2
public static final int H5D_CHUNK_IDX_BT2
enum H5D_chunk_index_t- See Also:
- Constant Field Values
-
H5D_CHUNK_IDX_NTYPES
public static final int H5D_CHUNK_IDX_NTYPES
enum H5D_chunk_index_t- See Also:
- Constant Field Values
-
H5D_ALLOC_TIME_ERROR
public static final int H5D_ALLOC_TIME_ERROR
enum H5D_alloc_time_t- See Also:
- Constant Field Values
-
H5D_ALLOC_TIME_DEFAULT
public static final int H5D_ALLOC_TIME_DEFAULT
enum H5D_alloc_time_t- See Also:
- Constant Field Values
-
H5D_ALLOC_TIME_EARLY
public static final int H5D_ALLOC_TIME_EARLY
enum H5D_alloc_time_t- See Also:
- Constant Field Values
-
H5D_ALLOC_TIME_LATE
public static final int H5D_ALLOC_TIME_LATE
enum H5D_alloc_time_t- See Also:
- Constant Field Values
-
H5D_ALLOC_TIME_INCR
public static final int H5D_ALLOC_TIME_INCR
enum H5D_alloc_time_t- See Also:
- Constant Field Values
-
H5D_SPACE_STATUS_ERROR
public static final int H5D_SPACE_STATUS_ERROR
enum H5D_space_status_t- See Also:
- Constant Field Values
-
H5D_SPACE_STATUS_NOT_ALLOCATED
public static final int H5D_SPACE_STATUS_NOT_ALLOCATED
enum H5D_space_status_t- See Also:
- Constant Field Values
-
H5D_SPACE_STATUS_PART_ALLOCATED
public static final int H5D_SPACE_STATUS_PART_ALLOCATED
enum H5D_space_status_t- See Also:
- Constant Field Values
-
H5D_SPACE_STATUS_ALLOCATED
public static final int H5D_SPACE_STATUS_ALLOCATED
enum H5D_space_status_t- See Also:
- Constant Field Values
-
H5D_FILL_TIME_ERROR
public static final int H5D_FILL_TIME_ERROR
enum H5D_fill_time_t- See Also:
- Constant Field Values
-
H5D_FILL_TIME_ALLOC
public static final int H5D_FILL_TIME_ALLOC
enum H5D_fill_time_t- See Also:
- Constant Field Values
-
H5D_FILL_TIME_NEVER
public static final int H5D_FILL_TIME_NEVER
enum H5D_fill_time_t- See Also:
- Constant Field Values
-
H5D_FILL_TIME_IFSET
public static final int H5D_FILL_TIME_IFSET
enum H5D_fill_time_t- See Also:
- Constant Field Values
-
H5D_FILL_VALUE_ERROR
public static final int H5D_FILL_VALUE_ERROR
enum H5D_fill_value_t- See Also:
- Constant Field Values
-
H5D_FILL_VALUE_UNDEFINED
public static final int H5D_FILL_VALUE_UNDEFINED
enum H5D_fill_value_t- See Also:
- Constant Field Values
-
H5D_FILL_VALUE_DEFAULT
public static final int H5D_FILL_VALUE_DEFAULT
enum H5D_fill_value_t- See Also:
- Constant Field Values
-
H5D_FILL_VALUE_USER_DEFINED
public static final int H5D_FILL_VALUE_USER_DEFINED
enum H5D_fill_value_t- See Also:
- Constant Field Values
-
H5D_VDS_ERROR
public static final int H5D_VDS_ERROR
enum H5D_vds_view_t- See Also:
- Constant Field Values
-
H5D_VDS_FIRST_MISSING
public static final int H5D_VDS_FIRST_MISSING
enum H5D_vds_view_t- See Also:
- Constant Field Values
-
H5D_VDS_LAST_AVAILABLE
public static final int H5D_VDS_LAST_AVAILABLE
enum H5D_vds_view_t- See Also:
- Constant Field Values
-
H5E_DEFAULT
public static final int H5E_DEFAULT
-
H5E_MAJOR
public static final int H5E_MAJOR
enum H5E_type_t- See Also:
- Constant Field Values
-
H5E_MINOR
public static final int H5E_MINOR
enum H5E_type_t- See Also:
- Constant Field Values
-
H5E_WALK_UPWARD
public static final int H5E_WALK_UPWARD
enum H5E_direction_t- See Also:
- Constant Field Values
-
H5E_WALK_DOWNWARD
public static final int H5E_WALK_DOWNWARD
enum H5E_direction_t- See Also:
- Constant Field Values
-
H5F_ACC_RDONLY
public static final int H5F_ACC_RDONLY
-
H5F_ACC_RDWR
public static final int H5F_ACC_RDWR
-
H5F_ACC_TRUNC
public static final int H5F_ACC_TRUNC
-
H5F_ACC_EXCL
public static final int H5F_ACC_EXCL
-
H5F_ACC_CREAT
public static final int H5F_ACC_CREAT
-
H5F_ACC_SWMR_WRITE
public static final int H5F_ACC_SWMR_WRITE
-
H5F_ACC_SWMR_READ
public static final int H5F_ACC_SWMR_READ
-
H5F_ACC_DEFAULT
public static final int H5F_ACC_DEFAULT
-
H5F_OBJ_FILE
public static final int H5F_OBJ_FILE
File objects- See Also:
- Constant Field Values
-
H5F_OBJ_DATASET
public static final int H5F_OBJ_DATASET
Dataset objects- See Also:
- Constant Field Values
-
H5F_OBJ_GROUP
public static final int H5F_OBJ_GROUP
Group objects- See Also:
- Constant Field Values
-
H5F_OBJ_DATATYPE
public static final int H5F_OBJ_DATATYPE
Named datatype objects- See Also:
- Constant Field Values
-
H5F_OBJ_ATTR
public static final int H5F_OBJ_ATTR
Attribute objects- See Also:
- Constant Field Values
-
H5F_OBJ_ALL
public static final int H5F_OBJ_ALL
- See Also:
- Constant Field Values
-
H5F_OBJ_LOCAL
public static final int H5F_OBJ_LOCAL
Restrict search to objects opened through current file ID \ (as opposed to objects opened through any file ID accessing this file)- See Also:
- Constant Field Values
-
H5F_FAMILY_DEFAULT
public static final int H5F_FAMILY_DEFAULT
-
H5F_SCOPE_LOCAL
public static final int H5F_SCOPE_LOCAL
enum H5F_scope_t- See Also:
- Constant Field Values
-
H5F_SCOPE_GLOBAL
public static final int H5F_SCOPE_GLOBAL
enum H5F_scope_t- See Also:
- Constant Field Values
-
H5F_UNLIMITED
public static final int H5F_UNLIMITED
-
H5F_CLOSE_DEFAULT
public static final int H5F_CLOSE_DEFAULT
enum H5F_close_degree_t- See Also:
- Constant Field Values
-
H5F_CLOSE_WEAK
public static final int H5F_CLOSE_WEAK
enum H5F_close_degree_t- See Also:
- Constant Field Values
-
H5F_CLOSE_SEMI
public static final int H5F_CLOSE_SEMI
enum H5F_close_degree_t- See Also:
- Constant Field Values
-
H5F_CLOSE_STRONG
public static final int H5F_CLOSE_STRONG
enum H5F_close_degree_t- See Also:
- Constant Field Values
-
H5FD_MEM_NOLIST
public static final int H5FD_MEM_NOLIST
enum H5F_mem_t- See Also:
- Constant Field Values
-
H5FD_MEM_DEFAULT
public static final int H5FD_MEM_DEFAULT
enum H5F_mem_t- See Also:
- Constant Field Values
-
H5FD_MEM_SUPER
public static final int H5FD_MEM_SUPER
enum H5F_mem_t- See Also:
- Constant Field Values
-
H5FD_MEM_BTREE
public static final int H5FD_MEM_BTREE
enum H5F_mem_t- See Also:
- Constant Field Values
-
H5FD_MEM_DRAW
public static final int H5FD_MEM_DRAW
enum H5F_mem_t- See Also:
- Constant Field Values
-
H5FD_MEM_GHEAP
public static final int H5FD_MEM_GHEAP
enum H5F_mem_t- See Also:
- Constant Field Values
-
H5FD_MEM_LHEAP
public static final int H5FD_MEM_LHEAP
enum H5F_mem_t- See Also:
- Constant Field Values
-
H5FD_MEM_OHDR
public static final int H5FD_MEM_OHDR
enum H5F_mem_t- See Also:
- Constant Field Values
-
H5FD_MEM_NTYPES
public static final int H5FD_MEM_NTYPES
enum H5F_mem_t- See Also:
- Constant Field Values
-
H5F_LIBVER_ERROR
public static final int H5F_LIBVER_ERROR
enum H5F_libver_t- See Also:
- Constant Field Values
-
H5F_LIBVER_EARLIEST
public static final int H5F_LIBVER_EARLIEST
enum H5F_libver_t- See Also:
- Constant Field Values
-
H5F_LIBVER_V18
public static final int H5F_LIBVER_V18
enum H5F_libver_t- See Also:
- Constant Field Values
-
H5F_LIBVER_V110
public static final int H5F_LIBVER_V110
enum H5F_libver_t- See Also:
- Constant Field Values
-
H5F_LIBVER_V112
public static final int H5F_LIBVER_V112
enum H5F_libver_t- See Also:
- Constant Field Values
-
H5F_LIBVER_V114
public static final int H5F_LIBVER_V114
enum H5F_libver_t- See Also:
- Constant Field Values
-
H5F_LIBVER_NBOUNDS
public static final int H5F_LIBVER_NBOUNDS
enum H5F_libver_t- See Also:
- Constant Field Values
-
H5F_LIBVER_LATEST
public static final int H5F_LIBVER_LATEST
- See Also:
- Constant Field Values
-
H5F_FSPACE_STRATEGY_FSM_AGGR
public static final int H5F_FSPACE_STRATEGY_FSM_AGGR
enum H5F_fspace_strategy_t- See Also:
- Constant Field Values
-
H5F_FSPACE_STRATEGY_PAGE
public static final int H5F_FSPACE_STRATEGY_PAGE
enum H5F_fspace_strategy_t- See Also:
- Constant Field Values
-
H5F_FSPACE_STRATEGY_AGGR
public static final int H5F_FSPACE_STRATEGY_AGGR
enum H5F_fspace_strategy_t- See Also:
- Constant Field Values
-
H5F_FSPACE_STRATEGY_NONE
public static final int H5F_FSPACE_STRATEGY_NONE
enum H5F_fspace_strategy_t- See Also:
- Constant Field Values
-
H5F_FSPACE_STRATEGY_NTYPES
public static final int H5F_FSPACE_STRATEGY_NTYPES
enum H5F_fspace_strategy_t- See Also:
- Constant Field Values
-
H5F_FILE_SPACE_DEFAULT
public static final int H5F_FILE_SPACE_DEFAULT
Deprecated.enum H5F_file_space_type_t- See Also:
- Constant Field Values
-
H5F_FILE_SPACE_ALL_PERSIST
public static final int H5F_FILE_SPACE_ALL_PERSIST
Deprecated.enum H5F_file_space_type_t- See Also:
- Constant Field Values
-
H5F_FILE_SPACE_ALL
public static final int H5F_FILE_SPACE_ALL
Deprecated.enum H5F_file_space_type_t- See Also:
- Constant Field Values
-
H5F_FILE_SPACE_AGGR_VFD
public static final int H5F_FILE_SPACE_AGGR_VFD
Deprecated.enum H5F_file_space_type_t- See Also:
- Constant Field Values
-
H5F_FILE_SPACE_VFD
public static final int H5F_FILE_SPACE_VFD
Deprecated.enum H5F_file_space_type_t- See Also:
- Constant Field Values
-
H5F_FILE_SPACE_NTYPES
public static final int H5F_FILE_SPACE_NTYPES
Deprecated.enum H5F_file_space_type_t- See Also:
- Constant Field Values
-
H5F_NUM_METADATA_READ_RETRY_TYPES
public static final int H5F_NUM_METADATA_READ_RETRY_TYPES
- See Also:
- Constant Field Values
-
H5FD_VFD_DEFAULT
public static final int H5FD_VFD_DEFAULT
- See Also:
- Constant Field Values
-
H5_VFD_INVALID
public static final int H5_VFD_INVALID
-
H5_VFD_SEC2
public static final int H5_VFD_SEC2
-
H5_VFD_CORE
public static final int H5_VFD_CORE
-
H5_VFD_LOG
public static final int H5_VFD_LOG
-
H5_VFD_FAMILY
public static final int H5_VFD_FAMILY
-
H5_VFD_MULTI
public static final int H5_VFD_MULTI
-
H5_VFD_STDIO
public static final int H5_VFD_STDIO
-
H5_VFD_SPLITTER
public static final int H5_VFD_SPLITTER
-
H5_VFD_MPIO
public static final int H5_VFD_MPIO
-
H5_VFD_DIRECT
public static final int H5_VFD_DIRECT
-
H5_VFD_MIRROR
public static final int H5_VFD_MIRROR
-
H5_VFD_HDFS
public static final int H5_VFD_HDFS
-
H5_VFD_ROS3
public static final int H5_VFD_ROS3
-
H5_VFD_SUBFILING
public static final int H5_VFD_SUBFILING
-
H5_VFD_IOC
public static final int H5_VFD_IOC
-
H5_VFD_ONION
public static final int H5_VFD_ONION
-
H5_VFD_RESERVED
public static final int H5_VFD_RESERVED
- See Also:
- Constant Field Values
-
H5_VFD_MAX
public static final int H5_VFD_MAX
- See Also:
- Constant Field Values
-
H5FD_FEAT_AGGREGATE_METADATA
public static final int H5FD_FEAT_AGGREGATE_METADATA
- See Also:
- Constant Field Values
-
H5FD_FEAT_ACCUMULATE_METADATA_WRITE
public static final int H5FD_FEAT_ACCUMULATE_METADATA_WRITE
- See Also:
- Constant Field Values
-
H5FD_FEAT_ACCUMULATE_METADATA_READ
public static final int H5FD_FEAT_ACCUMULATE_METADATA_READ
- See Also:
- Constant Field Values
-
H5FD_FEAT_ACCUMULATE_METADATA
public static final int H5FD_FEAT_ACCUMULATE_METADATA
- See Also:
- Constant Field Values
-
H5FD_FEAT_DATA_SIEVE
public static final int H5FD_FEAT_DATA_SIEVE
- See Also:
- Constant Field Values
-
H5FD_FEAT_AGGREGATE_SMALLDATA
public static final int H5FD_FEAT_AGGREGATE_SMALLDATA
- See Also:
- Constant Field Values
-
H5FD_FEAT_IGNORE_DRVRINFO
public static final int H5FD_FEAT_IGNORE_DRVRINFO
- See Also:
- Constant Field Values
-
H5FD_FEAT_DIRTY_DRVRINFO_LOAD
public static final int H5FD_FEAT_DIRTY_DRVRINFO_LOAD
- See Also:
- Constant Field Values
-
H5FD_FEAT_POSIX_COMPAT_HANDLE
public static final int H5FD_FEAT_POSIX_COMPAT_HANDLE
- See Also:
- Constant Field Values
-
H5FD_FEAT_HAS_MPI
public static final int H5FD_FEAT_HAS_MPI
- See Also:
- Constant Field Values
-
H5FD_FEAT_ALLOCATE_EARLY
public static final int H5FD_FEAT_ALLOCATE_EARLY
- See Also:
- Constant Field Values
-
H5FD_FEAT_ALLOW_FILE_IMAGE
public static final int H5FD_FEAT_ALLOW_FILE_IMAGE
- See Also:
- Constant Field Values
-
H5FD_FEAT_CAN_USE_FILE_IMAGE_CALLBACKS
public static final int H5FD_FEAT_CAN_USE_FILE_IMAGE_CALLBACKS
- See Also:
- Constant Field Values
-
H5FD_FEAT_SUPPORTS_SWMR_IO
public static final int H5FD_FEAT_SUPPORTS_SWMR_IO
- See Also:
- Constant Field Values
-
H5FD_FEAT_USE_ALLOC_SIZE
public static final int H5FD_FEAT_USE_ALLOC_SIZE
- See Also:
- Constant Field Values
-
H5FD_FEAT_PAGED_AGGR
public static final int H5FD_FEAT_PAGED_AGGR
- See Also:
- Constant Field Values
-
H5FD_FEAT_DEFAULT_VFD_COMPATIBLE
public static final int H5FD_FEAT_DEFAULT_VFD_COMPATIBLE
- See Also:
- Constant Field Values
-
H5FD_FEAT_MEMMANAGE
public static final int H5FD_FEAT_MEMMANAGE
- See Also:
- Constant Field Values
-
H5FD_CTL_OPC_RESERVED
public static final int H5FD_CTL_OPC_RESERVED
- See Also:
- Constant Field Values
-
H5FD_CTL_OPC_EXPER_MIN
public static final int H5FD_CTL_OPC_EXPER_MIN
- See Also:
- Constant Field Values
-
H5FD_CTL_OPC_EXPER_MAX
public static final int H5FD_CTL_OPC_EXPER_MAX
- See Also:
- Constant Field Values
-
H5FD_CTL_INVALID_OPCODE
public static final int H5FD_CTL_INVALID_OPCODE
- See Also:
- Constant Field Values
-
H5FD_CTL_TEST_OPCODE
public static final int H5FD_CTL_TEST_OPCODE
- See Also:
- Constant Field Values
-
H5FD_CTL_GET_MPI_COMMUNICATOR_OPCODE
public static final int H5FD_CTL_GET_MPI_COMMUNICATOR_OPCODE
- See Also:
- Constant Field Values
-
H5FD_CTL_GET_MPI_RANK_OPCODE
public static final int H5FD_CTL_GET_MPI_RANK_OPCODE
- See Also:
- Constant Field Values
-
H5FD_CTL_GET_MPI_SIZE_OPCODE
public static final int H5FD_CTL_GET_MPI_SIZE_OPCODE
- See Also:
- Constant Field Values
-
H5FD_CTL_MEM_ALLOC
public static final int H5FD_CTL_MEM_ALLOC
- See Also:
- Constant Field Values
-
H5FD_CTL_MEM_FREE
public static final int H5FD_CTL_MEM_FREE
- See Also:
- Constant Field Values
-
H5FD_CTL_MEM_COPY
public static final int H5FD_CTL_MEM_COPY
- See Also:
- Constant Field Values
-
H5FD_CTL_GET_MPI_FILE_SYNC_OPCODE
public static final int H5FD_CTL_GET_MPI_FILE_SYNC_OPCODE
- See Also:
- Constant Field Values
-
H5FD_CTL_FAIL_IF_UNKNOWN_FLAG
public static final int H5FD_CTL_FAIL_IF_UNKNOWN_FLAG
- See Also:
- Constant Field Values
-
H5FD_CTL_ROUTE_TO_TERMINAL_VFD_FLAG
public static final int H5FD_CTL_ROUTE_TO_TERMINAL_VFD_FLAG
- See Also:
- Constant Field Values
-
H5FD_FILE_IMAGE_OP_NO_OP
public static final int H5FD_FILE_IMAGE_OP_NO_OP
enum H5FD_file_image_op_t- See Also:
- Constant Field Values
-
H5FD_FILE_IMAGE_OP_PROPERTY_LIST_SET
public static final int H5FD_FILE_IMAGE_OP_PROPERTY_LIST_SET
enum H5FD_file_image_op_t- See Also:
- Constant Field Values
-
H5FD_FILE_IMAGE_OP_PROPERTY_LIST_COPY
public static final int H5FD_FILE_IMAGE_OP_PROPERTY_LIST_COPY
enum H5FD_file_image_op_t- See Also:
- Constant Field Values
-
H5FD_FILE_IMAGE_OP_PROPERTY_LIST_GET
public static final int H5FD_FILE_IMAGE_OP_PROPERTY_LIST_GET
enum H5FD_file_image_op_t- See Also:
- Constant Field Values
-
H5FD_FILE_IMAGE_OP_PROPERTY_LIST_CLOSE
public static final int H5FD_FILE_IMAGE_OP_PROPERTY_LIST_CLOSE
enum H5FD_file_image_op_t- See Also:
- Constant Field Values
-
H5FD_FILE_IMAGE_OP_FILE_OPEN
public static final int H5FD_FILE_IMAGE_OP_FILE_OPEN
enum H5FD_file_image_op_t- See Also:
- Constant Field Values
-
H5FD_FILE_IMAGE_OP_FILE_RESIZE
public static final int H5FD_FILE_IMAGE_OP_FILE_RESIZE
enum H5FD_file_image_op_t- See Also:
- Constant Field Values
-
H5FD_FILE_IMAGE_OP_FILE_CLOSE
public static final int H5FD_FILE_IMAGE_OP_FILE_CLOSE
enum H5FD_file_image_op_t- See Also:
- Constant Field Values
-
H5G_STORAGE_TYPE_UNKNOWN
public static final int H5G_STORAGE_TYPE_UNKNOWN
enum H5G_storage_type_t- See Also:
- Constant Field Values
-
H5G_STORAGE_TYPE_SYMBOL_TABLE
public static final int H5G_STORAGE_TYPE_SYMBOL_TABLE
enum H5G_storage_type_t- See Also:
- Constant Field Values
-
H5G_STORAGE_TYPE_COMPACT
public static final int H5G_STORAGE_TYPE_COMPACT
enum H5G_storage_type_t- See Also:
- Constant Field Values
-
H5G_STORAGE_TYPE_DENSE
public static final int H5G_STORAGE_TYPE_DENSE
enum H5G_storage_type_t- See Also:
- Constant Field Values
-
H5P_ROOT
public static final int H5P_ROOT
-
H5P_OBJECT_CREATE
public static final int H5P_OBJECT_CREATE
-
H5P_FILE_CREATE
public static final int H5P_FILE_CREATE
-
H5P_FILE_ACCESS
public static final int H5P_FILE_ACCESS
-
H5P_DATASET_CREATE
public static final int H5P_DATASET_CREATE
-
H5P_DATASET_ACCESS
public static final int H5P_DATASET_ACCESS
-
H5P_DATASET_XFER
public static final int H5P_DATASET_XFER
-
H5P_FILE_MOUNT
public static final int H5P_FILE_MOUNT
-
H5P_GROUP_CREATE
public static final int H5P_GROUP_CREATE
-
H5P_GROUP_ACCESS
public static final int H5P_GROUP_ACCESS
-
H5P_DATATYPE_CREATE
public static final int H5P_DATATYPE_CREATE
-
H5P_DATATYPE_ACCESS
public static final int H5P_DATATYPE_ACCESS
-
H5P_MAP_CREATE
public static final int H5P_MAP_CREATE
-
H5P_MAP_ACCESS
public static final int H5P_MAP_ACCESS
-
H5P_STRING_CREATE
public static final int H5P_STRING_CREATE
-
H5P_ATTRIBUTE_CREATE
public static final int H5P_ATTRIBUTE_CREATE
-
H5P_ATTRIBUTE_ACCESS
public static final int H5P_ATTRIBUTE_ACCESS
-
H5P_OBJECT_COPY
public static final int H5P_OBJECT_COPY
-
H5P_LINK_CREATE
public static final int H5P_LINK_CREATE
-
H5P_LINK_ACCESS
public static final int H5P_LINK_ACCESS
-
H5P_VOL_INITIALIZE
public static final int H5P_VOL_INITIALIZE
-
H5P_REFERENCE_ACCESS
public static final int H5P_REFERENCE_ACCESS
-
H5P_FILE_CREATE_DEFAULT
public static final int H5P_FILE_CREATE_DEFAULT
-
H5P_FILE_ACCESS_DEFAULT
public static final int H5P_FILE_ACCESS_DEFAULT
-
H5P_DATASET_CREATE_DEFAULT
public static final int H5P_DATASET_CREATE_DEFAULT
-
H5P_DATASET_ACCESS_DEFAULT
public static final int H5P_DATASET_ACCESS_DEFAULT
-
H5P_DATASET_XFER_DEFAULT
public static final int H5P_DATASET_XFER_DEFAULT
-
H5P_FILE_MOUNT_DEFAULT
public static final int H5P_FILE_MOUNT_DEFAULT
-
H5P_GROUP_CREATE_DEFAULT
public static final int H5P_GROUP_CREATE_DEFAULT
-
H5P_GROUP_ACCESS_DEFAULT
public static final int H5P_GROUP_ACCESS_DEFAULT
-
H5P_DATATYPE_CREATE_DEFAULT
public static final int H5P_DATATYPE_CREATE_DEFAULT
-
H5P_DATATYPE_ACCESS_DEFAULT
public static final int H5P_DATATYPE_ACCESS_DEFAULT
-
H5P_MAP_CREATE_DEFAULT
public static final int H5P_MAP_CREATE_DEFAULT
-
H5P_MAP_ACCESS_DEFAULT
public static final int H5P_MAP_ACCESS_DEFAULT
-
H5P_ATTRIBUTE_CREATE_DEFAULT
public static final int H5P_ATTRIBUTE_CREATE_DEFAULT
-
H5P_ATTRIBUTE_ACCESS_DEFAULT
public static final int H5P_ATTRIBUTE_ACCESS_DEFAULT
-
H5P_OBJECT_COPY_DEFAULT
public static final int H5P_OBJECT_COPY_DEFAULT
-
H5P_LINK_CREATE_DEFAULT
public static final int H5P_LINK_CREATE_DEFAULT
-
H5P_LINK_ACCESS_DEFAULT
public static final int H5P_LINK_ACCESS_DEFAULT
-
H5P_VOL_INITIALIZE_DEFAULT
public static final int H5P_VOL_INITIALIZE_DEFAULT
-
H5P_REFERENCE_ACCESS_DEFAULT
public static final int H5P_REFERENCE_ACCESS_DEFAULT
-
H5P_CRT_ORDER_TRACKED
public static final int H5P_CRT_ORDER_TRACKED
- See Also:
- Constant Field Values
-
H5P_CRT_ORDER_INDEXED
public static final int H5P_CRT_ORDER_INDEXED
- See Also:
- Constant Field Values
-
H5P_DEFAULT
public static final int H5P_DEFAULT
-
H5D_MPIO_NO_CHUNK_OPTIMIZATION
public static final int H5D_MPIO_NO_CHUNK_OPTIMIZATION
enum H5D_mpio_actual_chunk_opt_mode_t- See Also:
- Constant Field Values
-
H5D_MPIO_LINK_CHUNK
public static final int H5D_MPIO_LINK_CHUNK
enum H5D_mpio_actual_chunk_opt_mode_t- See Also:
- Constant Field Values
-
H5D_MPIO_MULTI_CHUNK
public static final int H5D_MPIO_MULTI_CHUNK
enum H5D_mpio_actual_chunk_opt_mode_t- See Also:
- Constant Field Values
-
H5D_MPIO_NO_COLLECTIVE
public static final int H5D_MPIO_NO_COLLECTIVE
enum H5D_mpio_actual_io_mode_t- See Also:
- Constant Field Values
-
H5D_MPIO_CHUNK_INDEPENDENT
public static final int H5D_MPIO_CHUNK_INDEPENDENT
enum H5D_mpio_actual_io_mode_t- See Also:
- Constant Field Values
-
H5D_MPIO_CHUNK_COLLECTIVE
public static final int H5D_MPIO_CHUNK_COLLECTIVE
enum H5D_mpio_actual_io_mode_t- See Also:
- Constant Field Values
-
H5D_MPIO_CHUNK_MIXED
public static final int H5D_MPIO_CHUNK_MIXED
enum H5D_mpio_actual_io_mode_t- See Also:
- Constant Field Values
-
H5D_MPIO_CONTIGUOUS_COLLECTIVE
public static final int H5D_MPIO_CONTIGUOUS_COLLECTIVE
enum H5D_mpio_actual_io_mode_t- See Also:
- Constant Field Values
-
H5D_MPIO_COLLECTIVE
public static final int H5D_MPIO_COLLECTIVE
enum H5D_mpio_no_collective_cause_t- See Also:
- Constant Field Values
-
H5D_MPIO_SET_INDEPENDENT
public static final int H5D_MPIO_SET_INDEPENDENT
enum H5D_mpio_no_collective_cause_t- See Also:
- Constant Field Values
-
H5D_MPIO_DATATYPE_CONVERSION
public static final int H5D_MPIO_DATATYPE_CONVERSION
enum H5D_mpio_no_collective_cause_t- See Also:
- Constant Field Values
-
H5D_MPIO_DATA_TRANSFORMS
public static final int H5D_MPIO_DATA_TRANSFORMS
enum H5D_mpio_no_collective_cause_t- See Also:
- Constant Field Values
-
H5D_MPIO_MPI_OPT_TYPES_ENV_VAR_DISABLED
public static final int H5D_MPIO_MPI_OPT_TYPES_ENV_VAR_DISABLED
enum H5D_mpio_no_collective_cause_t- See Also:
- Constant Field Values
-
H5D_MPIO_NOT_SIMPLE_OR_SCALAR_DATASPACES
public static final int H5D_MPIO_NOT_SIMPLE_OR_SCALAR_DATASPACES
enum H5D_mpio_no_collective_cause_t- See Also:
- Constant Field Values
-
H5D_MPIO_NOT_CONTIGUOUS_OR_CHUNKED_DATASET
public static final int H5D_MPIO_NOT_CONTIGUOUS_OR_CHUNKED_DATASET
enum H5D_mpio_no_collective_cause_t- See Also:
- Constant Field Values
-
H5D_MPIO_PARALLEL_FILTERED_WRITES_DISABLED
public static final int H5D_MPIO_PARALLEL_FILTERED_WRITES_DISABLED
enum H5D_mpio_no_collective_cause_t- See Also:
- Constant Field Values
-
H5D_MPIO_ERROR_WHILE_CHECKING_COLLECTIVE_POSSIBLE
public static final int H5D_MPIO_ERROR_WHILE_CHECKING_COLLECTIVE_POSSIBLE
enum H5D_mpio_no_collective_cause_t- See Also:
- Constant Field Values
-
H5D_MPIO_NO_COLLECTIVE_MAX_CAUSE
public static final int H5D_MPIO_NO_COLLECTIVE_MAX_CAUSE
enum H5D_mpio_no_collective_cause_t- See Also:
- Constant Field Values
-
H5PL_NO_PLUGIN
public static final String H5PL_NO_PLUGIN
- See Also:
- Constant Field Values
-
H5PL_TYPE_ERROR
public static final int H5PL_TYPE_ERROR
enum H5PL_type_t- See Also:
- Constant Field Values
-
H5PL_TYPE_FILTER
public static final int H5PL_TYPE_FILTER
enum H5PL_type_t- See Also:
- Constant Field Values
-
H5PL_TYPE_VOL
public static final int H5PL_TYPE_VOL
enum H5PL_type_t- See Also:
- Constant Field Values
-
H5PL_TYPE_VFD
public static final int H5PL_TYPE_VFD
enum H5PL_type_t- See Also:
- Constant Field Values
-
H5PL_TYPE_NONE
public static final int H5PL_TYPE_NONE
enum H5PL_type_t- See Also:
- Constant Field Values
-
H5PL_FILTER_PLUGIN
public static final int H5PL_FILTER_PLUGIN
- See Also:
- Constant Field Values
-
H5PL_VOL_PLUGIN
public static final int H5PL_VOL_PLUGIN
- See Also:
- Constant Field Values
-
H5PL_VFD_PLUGIN
public static final int H5PL_VFD_PLUGIN
- See Also:
- Constant Field Values
-
H5PL_ALL_PLUGIN
public static final int H5PL_ALL_PLUGIN
- See Also:
- Constant Field Values
-
H5R_OBJ_REF_BUF_SIZE
public static final int H5R_OBJ_REF_BUF_SIZE
-
H5R_DSET_REG_REF_BUF_SIZE
public static final int H5R_DSET_REG_REF_BUF_SIZE
-
H5R_REF_BUF_SIZE
public static final int H5R_REF_BUF_SIZE
Default reference buffer size. \internal Note! Be careful with the sizes of the references because they should really depend on the run-time values in the file.- See Also:
- Constant Field Values
-
H5R_BADTYPE
public static final int H5R_BADTYPE
enum H5R_type_t- See Also:
- Constant Field Values
-
H5R_OBJECT1
public static final int H5R_OBJECT1
enum H5R_type_t- See Also:
- Constant Field Values
-
H5R_DATASET_REGION1
public static final int H5R_DATASET_REGION1
enum H5R_type_t- See Also:
- Constant Field Values
-
H5R_OBJECT2
public static final int H5R_OBJECT2
enum H5R_type_t- See Also:
- Constant Field Values
-
H5R_DATASET_REGION2
public static final int H5R_DATASET_REGION2
enum H5R_type_t- See Also:
- Constant Field Values
-
H5R_ATTR
public static final int H5R_ATTR
enum H5R_type_t- See Also:
- Constant Field Values
-
H5R_MAXTYPE
public static final int H5R_MAXTYPE
enum H5R_type_t- See Also:
- Constant Field Values
-
H5R_OBJECT
public static final int H5R_OBJECT
\endcond- See Also:
- Constant Field Values
-
H5R_DATASET_REGION
public static final int H5R_DATASET_REGION
- See Also:
- Constant Field Values
-
H5S_ALL
public static final int H5S_ALL
-
H5S_BLOCK
public static final int H5S_BLOCK
- See Also:
- Constant Field Values
-
H5S_PLIST
public static final int H5S_PLIST
- See Also:
- Constant Field Values
-
H5S_UNLIMITED
public static final int H5S_UNLIMITED
Value for 'unlimited' dimensions
-
H5S_MAX_RANK
public static final int H5S_MAX_RANK
The maximum dataspace rank or number of dimensions- See Also:
- Constant Field Values
-
H5S_SEL_ITER_GET_SEQ_LIST_SORTED
public static final int H5S_SEL_ITER_GET_SEQ_LIST_SORTED
Retrieve elements from iterator in increasing offset order, for \ each call to retrieve sequences. Currently, this only applies to \ point selections, as hyperslab selections are always returned in \ increasing offset order. Note that the order is only increasing \ for each call to H5Sget_seq_list(), the next set of sequences \ could start with an earlier offset than the previous one. \- See Also:
- Constant Field Values
-
H5S_SEL_ITER_SHARE_WITH_DATASPACE
public static final int H5S_SEL_ITER_SHARE_WITH_DATASPACE
Don't copy the dataspace selection when creating the selection \ iterator. This can improve performance of creating the iterator, \ but the dataspace \Bold{MUST NOT} be modified or closed until the \ selection iterator is closed or the iterator's behavior will be \ undefined. \- See Also:
- Constant Field Values
-
H5S_NO_CLASS
public static final int H5S_NO_CLASS
enum H5S_class_t- See Also:
- Constant Field Values
-
H5S_SCALAR
public static final int H5S_SCALAR
enum H5S_class_t- See Also:
- Constant Field Values
-
H5S_SIMPLE
public static final int H5S_SIMPLE
enum H5S_class_t- See Also:
- Constant Field Values
-
H5S_NULL
public static final int H5S_NULL
enum H5S_class_t- See Also:
- Constant Field Values
-
H5S_SELECT_NOOP
public static final int H5S_SELECT_NOOP
enum H5S_seloper_t- See Also:
- Constant Field Values
-
H5S_SELECT_SET
public static final int H5S_SELECT_SET
enum H5S_seloper_t- See Also:
- Constant Field Values
-
H5S_SELECT_OR
public static final int H5S_SELECT_OR
enum H5S_seloper_t- See Also:
- Constant Field Values
-
H5S_SELECT_AND
public static final int H5S_SELECT_AND
enum H5S_seloper_t- See Also:
- Constant Field Values
-
H5S_SELECT_XOR
public static final int H5S_SELECT_XOR
enum H5S_seloper_t- See Also:
- Constant Field Values
-
H5S_SELECT_NOTB
public static final int H5S_SELECT_NOTB
enum H5S_seloper_t- See Also:
- Constant Field Values
-
H5S_SELECT_NOTA
public static final int H5S_SELECT_NOTA
enum H5S_seloper_t- See Also:
- Constant Field Values
-
H5S_SELECT_APPEND
public static final int H5S_SELECT_APPEND
enum H5S_seloper_t- See Also:
- Constant Field Values
-
H5S_SELECT_PREPEND
public static final int H5S_SELECT_PREPEND
enum H5S_seloper_t- See Also:
- Constant Field Values
-
H5S_SELECT_INVALID
public static final int H5S_SELECT_INVALID
enum H5S_seloper_t- See Also:
- Constant Field Values
-
H5S_SEL_ERROR
public static final int H5S_SEL_ERROR
enum H5S_sel_type- See Also:
- Constant Field Values
-
H5S_SEL_NONE
public static final int H5S_SEL_NONE
enum H5S_sel_type- See Also:
- Constant Field Values
-
H5S_SEL_POINTS
public static final int H5S_SEL_POINTS
enum H5S_sel_type- See Also:
- Constant Field Values
-
H5S_SEL_HYPERSLABS
public static final int H5S_SEL_HYPERSLABS
enum H5S_sel_type- See Also:
- Constant Field Values
-
H5S_SEL_ALL
public static final int H5S_SEL_ALL
enum H5S_sel_type- See Also:
- Constant Field Values
-
H5S_SEL_N
public static final int H5S_SEL_N
enum H5S_sel_type- See Also:
- Constant Field Values
-
H5FD_CORE
public static final int H5FD_CORE
-
H5FD_CORE_VALUE
public static final int H5FD_CORE_VALUE
-
H5FD_DIRECT
public static final int H5FD_DIRECT
- See Also:
- Constant Field Values
-
H5FD_DIRECT_VALUE
public static final int H5FD_DIRECT_VALUE
-
H5FD_FAMILY
public static final int H5FD_FAMILY
-
H5FD_FAMILY_VALUE
public static final int H5FD_FAMILY_VALUE
-
H5FD_LOG
public static final int H5FD_LOG
-
H5FD_LOG_VALUE
public static final int H5FD_LOG_VALUE
-
H5FD_LOG_TRUNCATE
public static final int H5FD_LOG_TRUNCATE
- See Also:
- Constant Field Values
-
H5FD_LOG_META_IO
public static final int H5FD_LOG_META_IO
- See Also:
- Constant Field Values
-
H5FD_LOG_LOC_READ
public static final int H5FD_LOG_LOC_READ
- See Also:
- Constant Field Values
-
H5FD_LOG_LOC_WRITE
public static final int H5FD_LOG_LOC_WRITE
- See Also:
- Constant Field Values
-
H5FD_LOG_LOC_SEEK
public static final int H5FD_LOG_LOC_SEEK
- See Also:
- Constant Field Values
-
H5FD_LOG_LOC_IO
public static final int H5FD_LOG_LOC_IO
- See Also:
- Constant Field Values
-
H5FD_LOG_FILE_READ
public static final int H5FD_LOG_FILE_READ
- See Also:
- Constant Field Values
-
H5FD_LOG_FILE_WRITE
public static final int H5FD_LOG_FILE_WRITE
- See Also:
- Constant Field Values
-
H5FD_LOG_FILE_IO
public static final int H5FD_LOG_FILE_IO
- See Also:
- Constant Field Values
-
H5FD_LOG_FLAVOR
public static final int H5FD_LOG_FLAVOR
- See Also:
- Constant Field Values
-
H5FD_LOG_NUM_READ
public static final int H5FD_LOG_NUM_READ
- See Also:
- Constant Field Values
-
H5FD_LOG_NUM_WRITE
public static final int H5FD_LOG_NUM_WRITE
- See Also:
- Constant Field Values
-
H5FD_LOG_NUM_SEEK
public static final int H5FD_LOG_NUM_SEEK
- See Also:
- Constant Field Values
-
H5FD_LOG_NUM_TRUNCATE
public static final int H5FD_LOG_NUM_TRUNCATE
- See Also:
- Constant Field Values
-
H5FD_LOG_NUM_IO
public static final int H5FD_LOG_NUM_IO
- See Also:
- Constant Field Values
-
H5FD_LOG_TIME_OPEN
public static final int H5FD_LOG_TIME_OPEN
- See Also:
- Constant Field Values
-
H5FD_LOG_TIME_STAT
public static final int H5FD_LOG_TIME_STAT
- See Also:
- Constant Field Values
-
H5FD_LOG_TIME_READ
public static final int H5FD_LOG_TIME_READ
- See Also:
- Constant Field Values
-
H5FD_LOG_TIME_WRITE
public static final int H5FD_LOG_TIME_WRITE
- See Also:
- Constant Field Values
-
H5FD_LOG_TIME_SEEK
public static final int H5FD_LOG_TIME_SEEK
- See Also:
- Constant Field Values
-
H5FD_LOG_TIME_TRUNCATE
public static final int H5FD_LOG_TIME_TRUNCATE
- See Also:
- Constant Field Values
-
H5FD_LOG_TIME_CLOSE
public static final int H5FD_LOG_TIME_CLOSE
- See Also:
- Constant Field Values
-
H5FD_LOG_TIME_IO
public static final int H5FD_LOG_TIME_IO
- See Also:
- Constant Field Values
-
H5FD_LOG_ALLOC
public static final int H5FD_LOG_ALLOC
- See Also:
- Constant Field Values
-
H5FD_LOG_FREE
public static final int H5FD_LOG_FREE
- See Also:
- Constant Field Values
-
H5FD_LOG_ALL
public static final int H5FD_LOG_ALL
- See Also:
- Constant Field Values
-
H5D_ONE_LINK_CHUNK_IO_THRESHOLD
public static final int H5D_ONE_LINK_CHUNK_IO_THRESHOLD
Macros for One linked collective IO case.- See Also:
- Constant Field Values
-
H5D_MULTI_CHUNK_IO_COL_THRESHOLD
public static final int H5D_MULTI_CHUNK_IO_COL_THRESHOLD
Macros for multi-chunk collective IO case.- See Also:
- Constant Field Values
-
H5FD_MPIO_INDEPENDENT
public static final int H5FD_MPIO_INDEPENDENT
enum H5FD_mpio_xfer_t- See Also:
- Constant Field Values
-
H5FD_MPIO_COLLECTIVE
public static final int H5FD_MPIO_COLLECTIVE
enum H5FD_mpio_xfer_t- See Also:
- Constant Field Values
-
H5FD_MPIO_CHUNK_DEFAULT
public static final int H5FD_MPIO_CHUNK_DEFAULT
enum H5FD_mpio_chunk_opt_t- See Also:
- Constant Field Values
-
H5FD_MPIO_CHUNK_ONE_IO
public static final int H5FD_MPIO_CHUNK_ONE_IO
enum H5FD_mpio_chunk_opt_t- See Also:
- Constant Field Values
-
H5FD_MPIO_CHUNK_MULTI_IO
public static final int H5FD_MPIO_CHUNK_MULTI_IO
enum H5FD_mpio_chunk_opt_t- See Also:
- Constant Field Values
-
H5FD_MPIO_COLLECTIVE_IO
public static final int H5FD_MPIO_COLLECTIVE_IO
enum H5FD_mpio_collective_opt_t- See Also:
- Constant Field Values
-
H5FD_MPIO_INDIVIDUAL_IO
public static final int H5FD_MPIO_INDIVIDUAL_IO
enum H5FD_mpio_collective_opt_t- See Also:
- Constant Field Values
-
H5FD_MULTI
public static final int H5FD_MULTI
-
H5FD_SEC2
public static final int H5FD_SEC2
-
H5FD_SEC2_VALUE
public static final int H5FD_SEC2_VALUE
-
H5FD_STDIO
public static final int H5FD_STDIO
-
DIMENSION_SCALE_CLASS
public static final String DIMENSION_SCALE_CLASS
- See Also:
- Constant Field Values
-
DIMENSION_LIST
public static final String DIMENSION_LIST
- See Also:
- Constant Field Values
-
REFERENCE_LIST
public static final String REFERENCE_LIST
- See Also:
- Constant Field Values
-
DIMENSION_LABELS
public static final String DIMENSION_LABELS
- See Also:
- Constant Field Values
-
H5LT_FILE_IMAGE_OPEN_RW
public static final int H5LT_FILE_IMAGE_OPEN_RW
- See Also:
- Constant Field Values
-
H5LT_FILE_IMAGE_DONT_COPY
public static final int H5LT_FILE_IMAGE_DONT_COPY
- See Also:
- Constant Field Values
-
H5LT_FILE_IMAGE_DONT_RELEASE
public static final int H5LT_FILE_IMAGE_DONT_RELEASE
- See Also:
- Constant Field Values
-
H5LT_FILE_IMAGE_ALL
public static final int H5LT_FILE_IMAGE_ALL
- See Also:
- Constant Field Values
-
H5LT_LANG_ERR
public static final int H5LT_LANG_ERR
enum H5LT_lang_t- See Also:
- Constant Field Values
-
H5LT_DDL
public static final int H5LT_DDL
enum H5LT_lang_t- See Also:
- Constant Field Values
-
H5LT_C
public static final int H5LT_C
enum H5LT_lang_t- See Also:
- Constant Field Values
-
H5LT_FORTRAN
public static final int H5LT_FORTRAN
enum H5LT_lang_t- See Also:
- Constant Field Values
-
H5LT_NO_LANG
public static final int H5LT_NO_LANG
enum H5LT_lang_t- See Also:
- Constant Field Values
-
H5FD_CLASS_VERSION
public static final int H5FD_CLASS_VERSION
- See Also:
- Constant Field Values
-
H5FD_MEM_FHEAP_HDR
public static final int H5FD_MEM_FHEAP_HDR
- See Also:
- Constant Field Values
-
H5FD_MEM_FHEAP_IBLOCK
public static final int H5FD_MEM_FHEAP_IBLOCK
- See Also:
- Constant Field Values
-
H5FD_MEM_FHEAP_DBLOCK
public static final int H5FD_MEM_FHEAP_DBLOCK
- See Also:
- Constant Field Values
-
H5FD_MEM_FHEAP_HUGE_OBJ
public static final int H5FD_MEM_FHEAP_HUGE_OBJ
- See Also:
- Constant Field Values
-
H5FD_MEM_FSPACE_HDR
public static final int H5FD_MEM_FSPACE_HDR
- See Also:
- Constant Field Values
-
H5FD_MEM_FSPACE_SINFO
public static final int H5FD_MEM_FSPACE_SINFO
- See Also:
- Constant Field Values
-
H5FD_MEM_SOHM_TABLE
public static final int H5FD_MEM_SOHM_TABLE
- See Also:
- Constant Field Values
-
H5FD_MEM_SOHM_INDEX
public static final int H5FD_MEM_SOHM_INDEX
- See Also:
- Constant Field Values
-
H5FD_MEM_EARRAY_HDR
public static final int H5FD_MEM_EARRAY_HDR
- See Also:
- Constant Field Values
-
H5FD_MEM_EARRAY_IBLOCK
public static final int H5FD_MEM_EARRAY_IBLOCK
- See Also:
- Constant Field Values
-
H5FD_MEM_EARRAY_SBLOCK
public static final int H5FD_MEM_EARRAY_SBLOCK
- See Also:
- Constant Field Values
-
H5FD_MEM_EARRAY_DBLOCK
public static final int H5FD_MEM_EARRAY_DBLOCK
- See Also:
- Constant Field Values
-
H5FD_MEM_EARRAY_DBLK_PAGE
public static final int H5FD_MEM_EARRAY_DBLK_PAGE
- See Also:
- Constant Field Values
-
H5FD_MEM_FARRAY_HDR
public static final int H5FD_MEM_FARRAY_HDR
- See Also:
- Constant Field Values
-
H5FD_MEM_FARRAY_DBLOCK
public static final int H5FD_MEM_FARRAY_DBLOCK
- See Also:
- Constant Field Values
-
H5FD_MEM_FARRAY_DBLK_PAGE
public static final int H5FD_MEM_FARRAY_DBLK_PAGE
- See Also:
- Constant Field Values
-
H5L_LINK_CLASS_T_VERS
public static final int H5L_LINK_CLASS_T_VERS
\brief Current version of the H5L_class_t struct- See Also:
- Constant Field Values
-
H5T_CONV_INIT
public static final int H5T_CONV_INIT
enum H5T_cmd_t- See Also:
- Constant Field Values
-
H5T_CONV_CONV
public static final int H5T_CONV_CONV
enum H5T_cmd_t- See Also:
- Constant Field Values
-
H5T_CONV_FREE
public static final int H5T_CONV_FREE
enum H5T_cmd_t- See Also:
- Constant Field Values
-
H5T_BKG_NO
public static final int H5T_BKG_NO
enum H5T_bkg_t- See Also:
- Constant Field Values
-
H5T_BKG_TEMP
public static final int H5T_BKG_TEMP
enum H5T_bkg_t- See Also:
- Constant Field Values
-
H5T_BKG_YES
public static final int H5T_BKG_YES
enum H5T_bkg_t- See Also:
- Constant Field Values
-
H5T_PERS_DONTCARE
public static final int H5T_PERS_DONTCARE
enum H5T_pers_t- See Also:
- Constant Field Values
-
H5T_PERS_HARD
public static final int H5T_PERS_HARD
enum H5T_pers_t- See Also:
- Constant Field Values
-
H5T_PERS_SOFT
public static final int H5T_PERS_SOFT
enum H5T_pers_t- See Also:
- Constant Field Values
-
H5Z_CLASS_T_VERS
public static final int H5Z_CLASS_T_VERS
Current version of the H5Z_class_t struct- See Also:
- Constant Field Values
-
H5O_VERSION_1
public static final int H5O_VERSION_1
- See Also:
- Constant Field Values
-
H5O_VERSION_2
public static final int H5O_VERSION_2
- See Also:
- Constant Field Values
-
-
Method Detail
-
HSIZE_UNDEF
@MemberGetter public static int HSIZE_UNDEF()
-
HADDR_UNDEF
@MemberGetter public static int HADDR_UNDEF()
-
H5open
@Cast("herr_t") public static int H5open()
\ingroup H5 \brief Initializes the HDF5 library- Returns:
- \herr_t \details H5open() initializes the HDF5 library. \details When the HDF5 library is used in a C application, the library is automatically initialized when the first HDf5 function call is issued. If one finds that an HDF5 library function is failing inexplicably, H5open() can be called first. It is safe to call H5open() before an application issues any other function calls to the HDF5 library as there are no damaging side effects in calling it more than once.
-
H5atclose
@Cast("herr_t") public static int H5atclose(H5_atclose_func_t func, Pointer ctx)
\ingroup H5 \brief Registers a callback for the library to invoke when it's closing.- Parameters:
func- [in] The function pointer to invokectx- [in] Context to pass to \p func when invoked- Returns:
- \herr_t \details H5atclose() registers a callback that the HDF5 library will invoke when closing. The full capabilities of the HDF5 library are available to callbacks invoked through this mechanism, library shutdown will only begin in earnest when all callbacks have been invoked and have returned. Registered callbacks are invoked in LIFO order, similar to the Standard C 'atexit' routine. For example, if 'func1' is registered, then 'func2', when the library is closing 'func2' will be invoked first, then 'func1'. The \p ctx pointer will be passed to \p func when it's invoked. NULL is allowed for \p ctx. If the HDF5 library is initialized and closed more than once, the \p func callback must be registered within each open/close cycle.
- Since:
- 1.14.0
-
H5close
@Cast("herr_t") public static int H5close()
\ingroup H5 \brief Flushes all data to disk, closes all open objects, and releases memory- Returns:
- \herr_t \details H5close() flushes all data to disk, closes all open HDF5 objects, and cleans up all memory used by the HDF5 library. This function is generally called when the application calls exit(), but may be called earlier in the event of an emergency shutdown or out of a desire to free all resources used by the HDF5 library.
-
H5dont_atexit
@Cast("herr_t") public static int H5dont_atexit()
\ingroup H5 \brief Instructs library not to install atexit() cleanup routine- Returns:
- \herr_t \details H5dont_atexit() indicates to the library that an atexit() cleanup routine should not be installed. The major purpose for using this function is in situations where the library is dynamically linked into an application and is un-linked from the application before exit() gets called. In those situations, a routine installed with atexit() would jump to a routine which was no longer in memory, causing errors. \attention In order to be effective, this routine \Emph{must} be called before any other HDF5 function calls, and must be called each time the library is loaded/linked into the application (the first time and after it's been un-loaded).
-
H5garbage_collect
@Cast("herr_t") public static int H5garbage_collect()
\ingroup H5 \brief Garbage collects on all free-lists of all types- Returns:
- \herr_t \details H5garbage_collect() walks through all garbage collection routines of the library, freeing any unused memory. It is not required that H5garbage_collect() be called at any particular time; it is only necessary in certain situations where the application has performed actions that cause the library to allocate many objects. The application should call H5garbage_collect() if it eventually releases those objects and wants to reduce the memory used by the library from the peak usage required. \note The library automatically garbage collects all the free lists when the application ends.
-
H5set_free_list_limits
@Cast("herr_t") public static int H5set_free_list_limits(int reg_global_lim, int reg_list_lim, int arr_global_lim, int arr_list_lim, int blk_global_lim, int blk_list_lim)
\ingroup H5 \brief Sets free-list size limits- Parameters:
reg_global_lim- [in] The cumulative limit, in bytes, on memory used for all regular free lists (Default: 1MB)reg_list_lim- [in] The limit, in bytes, on memory used for each regular free list (Default: 64KB)arr_global_lim- [in] The cumulative limit, in bytes, on memory used for all array free lists (Default: 4MB)arr_list_lim- [in] The limit, in bytes, on memory used for each array free list (Default: 256KB)blk_global_lim- [in] The cumulative limit, in bytes, on memory used for all block free lists and, separately, for all factory free lists (Default: 16MB)blk_list_lim- [in] The limit, in bytes, on memory used for each block or factory free list (Default: 1MB)- Returns:
- \herr_t \details H5set_free_list_limits() sets size limits on all types of free lists. The HDF5 library uses free lists internally to manage memory. The types of free lists used are as follows: \li Regular free lists manage memory for single internal data structures. \li Array free lists manage memory for arrays of internal data structures. \li Block free lists manage memory for arbitrarily-sized blocks of bytes. \li Factory free lists manage memory for fixed-size blocks of bytes. The parameters specify global and per-list limits; for example, \p reg_global_limit and \p reg_list_limit limit the accumulated size of all regular free lists and the size of each individual regular free list, respectively. Therefore, if an application sets a 1Mb limit on each of the global lists, up to 4Mb of total storage might be allocated, 1Mb for each of the regular, array, block, and factory type lists. The settings specified for block free lists are duplicated for factory free lists. Therefore, increasing the global limit on block free lists by x bytes will increase the potential free list memory usage by 2x bytes. Using a value of -1 for a limit means that no limit is set for the specified type of free list.
- Since:
- 1.6.0
-
H5get_free_list_sizes
@Cast("herr_t") public static int H5get_free_list_sizes(@Cast("size_t*") SizeTPointer reg_size, @Cast("size_t*") SizeTPointer arr_size, @Cast("size_t*") SizeTPointer blk_size, @Cast("size_t*") SizeTPointer fac_size)
\ingroup H5 \brief Gets the current size of the free lists used to manage memory- Parameters:
reg_size- [out] The current size of all "regular" free list memory usedarr_size- [out] The current size of all "array" free list memory usedblk_size- [out] The current size of all "block" free list memory usedfac_size- [out] The current size of all "factory" free list memory used- Returns:
- \herr_t \details H5get_free_list_sizes() obtains the current size of the different kinds of free lists that the library uses to manage memory. The free list sizes can be set with H5set_free_list_limits() and garbage collected with H5garbage_collect(). These lists are global for the entire library.
- Since:
- 1.10.7
-
H5get_libversion
@Cast("herr_t") public static int H5get_libversion(@Cast("unsigned*") IntPointer majnum, @Cast("unsigned*") IntPointer minnum, @Cast("unsigned*") IntPointer relnum)
\ingroup H5 \brief Returns the HDF library release number- Parameters:
majnum- [out] The major version number of the libraryminnum- [out] The minor version number of the libraryrelnum- [out] The release version number of the library- Returns:
- \herr_t \details H5get_libversion() retrieves the major, minor, and release numbers of the version of the HDF5 library which is linked to the application.
-
H5get_libversion
@Cast("herr_t") public static int H5get_libversion(@Cast("unsigned*") IntBuffer majnum, @Cast("unsigned*") IntBuffer minnum, @Cast("unsigned*") IntBuffer relnum)
-
H5get_libversion
@Cast("herr_t") public static int H5get_libversion(@Cast("unsigned*") int[] majnum, @Cast("unsigned*") int[] minnum, @Cast("unsigned*") int[] relnum)
-
H5check_version
@Cast("herr_t") public static int H5check_version(@Cast("unsigned") int majnum, @Cast("unsigned") int minnum, @Cast("unsigned") int relnum)
\ingroup H5 \brief Verifies that HDF5 library versions are consistent- Parameters:
majnum- [in] HDF5 library major version numberminnum- [in] HDF5 library minor version numberrelnum- [in] HDF5 library release number- Returns:
- \herr_t
\details H5check_version() verifies that the version of the HDF5 library
with which an application was compiled, as indicated by the passed
parameters, matches the version of the HDF5 library against which
the application is currently linked.
\p majnum is the major version number of the HDF library with which
the application was compiled, \p minnum is the minor version
number, and \p relnum is the release number. Consider the following
example:
An official HDF5 release is labelled as follows:
HDF5 Release \Code{\
-
H5is_library_terminating
@Cast("herr_t") public static int H5is_library_terminating(@Cast("hbool_t*") BoolPointer is_terminating)
\ingroup H5 \brief Checks whether the HDF5 library is closing.- Parameters:
is_terminating- [out] Flag indicating whether library is shutting down- Returns:
- \herr_t \details H5is_library_terminating() queries whether the HDF5 library is in the process of shutting down. The \p is_terminating flag will only be set to TRUE after shutdown starts, it will be FALSE before the library has been initialized, while the library is initialized, and after it has been closed. The value of \p is_terminating is undefined if this routine fails.
- Since:
- 1.14.0
-
H5is_library_terminating
@Cast("herr_t") public static int H5is_library_terminating(@Cast("hbool_t*") boolean[] is_terminating)
-
H5is_library_threadsafe
@Cast("herr_t") public static int H5is_library_threadsafe(@Cast("hbool_t*") BoolPointer is_ts)
\ingroup H5 \brief Determines whether the HDF5 library was built with the thread-safety feature enabled- Parameters:
is_ts- [out] Boolean value indicating whether the library was built with thread-safety enabled- Returns:
- \herr_t \details The HDF5 library, although not internally multi-threaded, can be built with a thread-safety feature enabled that protects internal data structures with a mutex. In certain circumstances, it may be useful to determine, at run-time, whether the linked HDF5 library was built with the thread-safety feature enabled.
-
H5is_library_threadsafe
@Cast("herr_t") public static int H5is_library_threadsafe(@Cast("hbool_t*") boolean[] is_ts)
-
H5free_memory
@Cast("herr_t") public static int H5free_memory(Pointer mem)
\ingroup H5 \brief Frees memory allocated by the HDF5 library- Parameters:
mem- [in] Buffer to be freed. Can be NULL- Returns:
- \herr_t \details H5free_memory() frees memory that has been allocated by the caller with H5allocate_memory() or by the HDF5 library on behalf of the caller. H5Tget_member_name() provides an example of memory allocation on behalf of the caller: The function returns a buffer containing the name of a compound datatype member. It is the callerâs responsibility to eventually free that buffer with H5free_memory(). \attention It is especially important to use this function to free memory allocated by the library on Windows. The C standard library is implemented in dynamic link libraries (DLLs) known as the C run-time (CRT). Each version of Visual Studio comes with two CRT DLLs (debug and release) and allocating and freeing across DLL boundaries can cause resource leaks and subtle bugs due to heap corruption.\n Only use this function to free memory allocated by the HDF5 Library. It will generally not be safe to use this function to free memory allocated by any other means.\n Even when using this function, it is still best to ensure that all components of a C application are built with the same version of Visual Studio and build (debug or release) and thus linked against the same CRT.
- Since:
- 1.8.13
-
H5allocate_memory
public static Pointer H5allocate_memory(@Cast("size_t") long size, @Cast("hbool_t") boolean clear)
\ingroup H5 \brief Frees memory allocated by the HDF5 library- Parameters:
size- [in] The size in bytes of the buffer to be allocatedclear- [in] Flag whether the new buffer is to be initialized with 0- Returns:
- On success, returns pointer to newly allocated buffer or returns NULL if size is 0 (zero).\n Returns NULL on failure. \details H5allocate_memory() allocates a memory buffer of size bytes that will later be freed internally by the HDF5 library. The boolean \p clear parameter specifies whether the buffer should be initialized. If clear is \c TRUE, all bits in the buffer are to be set to 0 (zero); if clear is \c FALSE, the buffer will not be initialized. This function is intended to have the semantics of malloc() and calloc(). However, unlike malloc() and calloc() which allow for a "special" pointer to be returned instead of NULL, this function always returns NULL on failure or when size is set to 0 (zero). \note At this time, the only intended use for this function is to allocate memory that will be returned to the library as a data buffer from a third-party filter. \attention To avoid heap corruption, allocated memory should be freed using the same library that initially allocated it. In most cases, the HDF5 API uses resources that are allocated and freed either entirely by the user or entirely by the library, so this is not a problem. In rare cases, however, HDF5 API calls will free memory that the user allocated. This function allows the user to safely allocate this memory.\n It is particularly important to use this function to allocate memory in Microsoft Windows environments. In Windows, the C standard library is implemented in dynamic link libraries (DLLs) known as the C run-time (CRT). Each version of Visual Studio comes with multiple versions of the CRT DLLs (debug, release, et cetera) and allocating and freeing memory across DLL boundaries can cause resource leaks and subtle bugs due to heap corruption.\n Even when using this function, it is best where possible to ensure that all components of a C application are built with the same version of Visual Studio and configuration (Debug or Release), and thus linked against the same CRT.\n Use this function only to allocate memory inside third-party HDF5 filters. It will generally not be safe to use this function to allocate memory for any other purpose.
- Since:
- 1.8.15
-
H5resize_memory
public static Pointer H5resize_memory(Pointer mem, @Cast("size_t") long size)
\ingroup H5 \brief Resizes and, if required, re-allocates memory that will later be freed internally by the HDF5 library- Parameters:
mem- [in] Pointer to a buffer to be resized. May be NULLsize- [in] New size of the buffer, in bytes- Returns:
- On success, returns pointer to resized or reallocated buffer
or returns NULL if size is 0 (zero).\n
Returns NULL on failure.
\details H5resize_memory() takes a pointer to an existing buffer and resizes
the buffer to match the value in \p size. If necessary, the buffer
is reallocated. If \p size is 0, the buffer is released.
The input buffer must either be NULL or have been allocated by
H5allocate_memory() since the input buffer may be freed by the
library.
For certain behaviors, the pointer \p mem may be passed in as NULL.
This function is intended to have the semantics of realloc():
Unlike realloc(), which allows for a "special pointer to be returned instead of NULL, this function always returns NULL on failure or when size is 0 (zero). \note At this time, the only intended use for this function is to resize or reallocate memory that will be returned to the library (and eventually to the user) as a data buffer from a third-party HDF5 filter. \attention To avoid heap corruption, allocated memory should be freed using the same library that initially allocated it. In most cases, the HDF5 API uses resources that are allocated and freed either entirely by the user or entirely by the library, so this is not a problem. In rare cases, however, HDF5 API calls will free memory that the user allocated. This function allows the user to safely allocate this memory.\n It is particularly important to use this function to resize memory on Microsoft Windows systems. In Windows, the C standard library is implemented in dynamic link libraries (DLLs) known as the C run-time (CRT). Each version of Visual Studio comes with multiple versions of the CRT DLLs (debug, release, et cetera) and allocating and freeing memory across DLL boundaries can cause resource leaks and subtle bugs due to heap corruption.\n Even when using this function, it is still best to ensure that all components of a C application are built with the same version of Visual Studio and the same configuration (Debug or Release), and thus linked against the same CRT.\n Only use this function to resize memory inside third-party HDF5 filters. It will generally not be safe to use this function to resize memory for any other purpose.\Code{H5resize_memory(buffer, size)} Resizes buffer. Returns pointer to resized buffer. \Code{H5resize_memory(NULL, size)} Allocates memory using HDF5 Library allocator. Returns pointer to new buffer \Code{H5resize_memory(buffer, 0)} Frees memory using HDF5 Library allocator. Returns NULL. \Code{H5resize_memory(NULL, 0)} Returns NULL (undefined in C standard). - Since:
- 1.8.15
-
H5Iregister
@Cast("hid_t") public static long H5Iregister(@Cast("H5I_type_t") int type, @Const Pointer object)
\ingroup H5IUD \brief Registers an object under a type and returns an ID for it- Parameters:
type- [in] The identifier of the type of the new IDobject- [in] Pointer to object for which a new ID is created- Returns:
- \hid_t{object} \details H5Iregister() creates and returns a new ID for an object. \details The \p type parameter is the identifier for the ID type to which this new ID will belong. This identifier must have been created by a call to H5Iregister_type(). \details The \p object parameter is a pointer to the memory which the new ID will be a reference to. This pointer will be stored by the library and returned via a call to H5Iobject_verify().
-
H5Iobject_verify
public static Pointer H5Iobject_verify(@Cast("hid_t") long id, @Cast("H5I_type_t") int type)
\ingroup H5IUD \brief Returns the object referenced by an ID- Parameters:
id- [in] ID to be dereferencedtype- [in] The identifier type- Returns:
- Pointer to the object referenced by \p id on success, NULL on failure. \details H5Iobject_verify() returns a pointer to the memory referenced by id after verifying that \p id is of type \p type. This function is analogous to dereferencing a pointer in C with type checking. \note H5Iobject_verify() does not change the ID it is called on in any way (as opposed to H5Iremove_verify(), which removes the ID from its typeâs hash table).
- See Also:
H5Iregister()
-
H5Iremove_verify
public static Pointer H5Iremove_verify(@Cast("hid_t") long id, @Cast("H5I_type_t") int type)
\ingroup H5IUD \brief Removes an ID from its type- Parameters:
id- [in] The ID to be removed from its typetype- [in] The identifier type- Returns:
- Returns a pointer to the memory referred to by \p id on success, NULL on failure. \details H5Iremove_verify() first ensures that \p id belongs to \p type. If so, it removes \p id from its type and returns the pointer to the memory it referred to. This pointer is the same pointer that was placed in storage by H5Iregister(). If id does not belong to \p type, then NULL is returned. The \p id parameter is the ID which is to be removed from its type. The \p type parameter is the identifier for the ID type which \p id is supposed to belong to. This identifier must have been created by a call to H5Iregister_type(). \note This function does NOT deallocate the memory that \p id refers to. The pointer returned by H5Iregister() must be deallocated by the user to avoid memory leaks.
-
H5Iget_type
@Cast("H5I_type_t") public static int H5Iget_type(@Cast("hid_t") long id)
\ingroup H5I \brief Retrieves the type of an object \obj_id{id}- Returns:
- Returns the object type if successful; otherwise #H5I_BADID. \details H5Iget_type() retrieves the type of the object identified by \p id. If no valid type can be determined or the identifier submitted is invalid, the function returns #H5I_BADID. This function is of particular use in determining the type of object closing function (H5Dclose(), H5Gclose(), etc.) to call after a call to H5Rdereference(). \note Note that this function returns only the type of object that \p id would identify if it were valid; it does not determine whether \p id is valid identifier. Validity can be determined with a call to H5Iis_valid().
-
H5Iget_file_id
@Cast("hid_t") public static long H5Iget_file_id(@Cast("hid_t") long id)
\ingroup H5I \brief Retrieves an identifier for the file containing the specified object \obj_id{id}- Returns:
- \hid_t{file} \details H5Iget_file_id() returns the identifier of the file associated with the object referenced by \p id. \note Note that the HDF5 library permits an application to close a file while objects within the file remain open. If the file containing the object \p id is still open, H5Iget_file_id() will retrieve the existing file identifier. If there is no existing file identifier for the file, i.e., the file has been closed, H5Iget_file_id() will reopen the file and return a new file identifier. In either case, the file identifier must eventually be released using H5Fclose().
- Since:
- 1.6.3
-
H5Iget_name
@Cast("ssize_t") public static long H5Iget_name(@Cast("hid_t") long id, @Cast("char*") BytePointer name, @Cast("size_t") long size)
\ingroup H5I \brief Retrieves a name of an object based on the object identifier \obj_id{id}- Parameters:
name- [out] A buffer for thename associated with the identifiersize- [in] The size of the \p name buffer; usually the size of the name in bytes plus 1 for a NULL terminator- Returns:
- ssize_t \details H5Iget_name() retrieves a name for the object identified by \p id. \details Up to size characters of the name are returned in \p name; additional characters, if any, are not returned to the user application. If the length of the name, which determines the required value of \p size, is unknown, a preliminary H5Iget_name() call can be made. The return value of this call will be the size in bytes of the object name. That value, plus 1 for a NULL terminator, is then assigned to size for a second H5Iget_name() call, which will retrieve the actual name. If the object identified by \p id is an attribute, as determined via H5Iget_type(), H5Iget_name() retrieves the name of the object to which that attribute is attached. To retrieve the name of the attribute itself, use H5Aget_name(). If there is no name associated with the object identifier or if the name is NULL, H5Iget_name() returns 0 (zero). \note Note that an object in an HDF5 file may have multiple paths if there are multiple links pointing to it. This function may return any one of these paths. When possible, H5Iget_name() returns the path with which the object was opened.
- Since:
- 1.6.0
-
H5Iget_name
@Cast("ssize_t") public static long H5Iget_name(@Cast("hid_t") long id, @Cast("char*") ByteBuffer name, @Cast("size_t") long size)
-
H5Iget_name
@Cast("ssize_t") public static long H5Iget_name(@Cast("hid_t") long id, @Cast("char*") byte[] name, @Cast("size_t") long size)
-
H5Iinc_ref
public static int H5Iinc_ref(@Cast("hid_t") long id)
\ingroup H5I \brief Increments the reference count for an object \obj_id{id}- Returns:
- Returns a non-negative reference count of the object ID after incrementing it if successful; otherwise a negative value is returned. \details H5Iinc_ref() increments the reference count of the object identified by \p id. The reference count for an object ID is attached to the information about an object in memory and has no relation to the number of links to an object on disk. The reference count for a newly created object will be 1. Reference counts for objects may be explicitly modified with this function or with H5Idec_ref(). When an object ID's reference count reaches zero, the object will be closed. Calling an object ID's \c close function decrements the reference count for the ID which normally closes the object, but if the reference count for the ID has been incremented with this function, the object will only be closed when the reference count reaches zero with further calls to H5Idec_ref() or the object ID's \c close function. If the object ID was created by a collective parallel call (such as H5Dcreate(), H5Gopen(), etc.), the reference count should be modified by all the processes which have copies of the ID. Generally this means that group, dataset, attribute, file and named datatype IDs should be modified by all the processes and that all other types of IDs are safe to modify by individual processes. This function is of particular value when an application is maintaining multiple copies of an object ID. The object ID can be incremented when a copy is made. Each copy of the ID can then be safely closed or decremented and the HDF5 object will be closed when the reference count for that that object drops to zero.
- Since:
- 1.6.2
-
H5Idec_ref
public static int H5Idec_ref(@Cast("hid_t") long id)
\ingroup H5I \brief Decrements the reference count for an object \obj_id{id}- Returns:
- Returns a non-negative reference count of the object ID after decrementing it, if successful; otherwise a negative value is returned. \details H5Idec_ref() decrements the reference count of the object identified by \p id. The reference count for an object ID is attached to the information about an object in memory and has no relation to the number of links to an object on disk. The reference count for a newly created object will be 1. Reference counts for objects may be explicitly modified with this function or with H5Iinc_ref(). When an object identifierâs reference count reaches zero, the object will be closed. Calling an object identifierâs \c close function decrements the reference count for the identifier which normally closes the object, but if the reference count for the identifier has been incremented with H5Iinc_ref(), the object will only be closed when the reference count reaches zero with further calls to this function or the object identifierâs \c close function. If the object ID was created by a collective parallel call (such as H5Dcreate(), H5Gopen(), etc.), the reference count should be modified by all the processes which have copies of the ID. Generally this means that group, dataset, attribute, file and named datatype IDs should be modified by all the processes and that all other types of IDs are safe to modify by individual processes. This function is of particular value when an application is maintaining multiple copies of an object ID. The object ID can be incremented when a copy is made. Each copy of the ID can then be safely closed or decremented and the HDF5 object will be closed when the reference count for that that object drops to zero.
- Since:
- 1.6.2
-
H5Iget_ref
public static int H5Iget_ref(@Cast("hid_t") long id)
\ingroup H5I \brief Retrieves the reference count for an object \obj_id{id}- Returns:
- Returns a non-negative current reference count of the object identifier if successful; otherwise a negative value is returned. \details H5Iget_ref() retrieves the reference count of the object identified by \p id. The reference count for an object identifier is attached to the information about an object in memory and has no relation to the number of links to an object on disk. The function H5Iis_valid() is used to determine whether a specific object identifier is valid.
- Since:
- 1.6.2
-
H5Iregister_type
@Cast("H5I_type_t") public static int H5Iregister_type(@Cast("size_t") long hash_size, @Cast("unsigned") int reserved, H5I_free_t free_func)
\ingroup H5IUD \brief Creates and returns a new ID type- Parameters:
hash_size- [in] Minimum hash table size (in entries) used to store IDs for the new typereserved- [in] Number of reserved IDs for the new typefree_func- [in] Function used to deallocate space for a single ID- Returns:
- Returns the type identifier on success, negative on failure. \details H5Iregister_type() allocates space for a new ID type and returns an identifier for it. The \p hash_size parameter indicates the minimum size of the hash table used to store IDs in the new type. The \p reserved parameter indicates the number of IDs in this new type to be reserved. Reserved IDs are valid IDs which are not associated with any storage within the library. The \p free_func parameter is a function pointer to a function which returns an herr_t and accepts a \c void*. The purpose of this function is to deallocate memory for a single ID. It will be called by H5Iclear_type() and H5Idestroy_type() on each ID. This function is NOT called by H5Iremove_verify(). The \c void* will be the same pointer which was passed in to the H5Iregister() function. The \p free_func function should return 0 on success and -1 on failure.
-
H5Iclear_type
@Cast("herr_t") public static int H5Iclear_type(@Cast("H5I_type_t") int type, @Cast("hbool_t") boolean force)
\ingroup H5IUD \brief Deletes all identifiers of the given type- Parameters:
type- [in] Identifier of identifier type which is to be cleared of identifiersforce- [in] Whether or not to force deletion of all identifiers- Returns:
- \herr_t \details H5Iclear_type() deletes all identifiers of the type identified by the argument \p type. The identifier type's free function is first called on all of these identifiers to free their memory, then they are removed from the type. If the \p force flag is set to false, only those identifiers whose reference counts are equal to 1 will be deleted, and all other identifiers will be entirely unchanged. If the force flag is true, all identifiers of this type will be deleted.
-
H5Idestroy_type
@Cast("herr_t") public static int H5Idestroy_type(@Cast("H5I_type_t") int type)
\ingroup H5IUD \brief Removes an identifier type and all identifiers within that type- Parameters:
type- [in] Identifier of identifier type which is to be destroyed- Returns:
- \herr_t \details H5Idestroy_type deletes an entire identifier type \p type. All identifiers of this type are destroyed and no new identifiers of this type can be registered. The typeâs free function is called on all of the identifiers which are deleted by this function, freeing their memory. In addition, all memory used by this typeâs hash table is freed. Since the H5I_type_t values of destroyed identifier types are reused when new types are registered, it is a good idea to set the variable holding the value of the destroyed type to #H5I_UNINIT.
-
H5Iinc_type_ref
public static int H5Iinc_type_ref(@Cast("H5I_type_t") int type)
\ingroup H5IUD \brief Increments the reference count on an ID type- Parameters:
type- [in] The identifier of the type whose reference count is to be incremented- Returns:
- Returns the current reference count on success, negative on failure. \details H5Iinc_type_ref() increments the reference count on an ID type. The reference count is used by the library to indicate when an ID type can be destroyed. The type parameter is the identifier for the ID type whose reference count is to be incremented. This identifier must have been created by a call to H5Iregister_type().
-
H5Idec_type_ref
public static int H5Idec_type_ref(@Cast("H5I_type_t") int type)
\ingroup H5IUD \brief Decrements the reference count on an identifier type- Parameters:
type- [in] The identifier of the type whose reference count is to be decremented- Returns:
- Returns the current reference count on success, negative on failure. \details H5Idec_type_ref() decrements the reference count on an identifier type. The reference count is used by the library to indicate when an identifier type can be destroyed. If the reference count reaches zero, this function will destroy it. The type parameter is the identifier for the identifier type whose reference count is to be decremented. This identifier must have been created by a call to H5Iregister_type().
-
H5Iget_type_ref
public static int H5Iget_type_ref(@Cast("H5I_type_t") int type)
\ingroup H5IUD \brief Retrieves the reference count on an ID type- Parameters:
type- [in] The identifier of the type whose reference count is to be retrieved- Returns:
- Returns the current reference count on success, negative on failure. \details H5Iget_type_ref() retrieves the reference count on an ID type. The reference count is used by the library to indicate when an ID type can be destroyed. The type parameter is the identifier for the ID type whose reference count is to be retrieved. This identifier must have been created by a call to H5Iregister_type().
-
H5Isearch
public static Pointer H5Isearch(@Cast("H5I_type_t") int type, H5I_search_func_t func, Pointer key)
\ingroup H5IUD \brief Finds the memory referred to by an ID within the given ID type such that some criterion is satisfied- Parameters:
type- [in] The identifier of the type to be searchedfunc- [in] The function defining the search criteriakey- [in] A key for the search function- Returns:
- Returns a pointer to the object which satisfies the search function on success, NULL on failure. \details H5Isearch() searches through a given ID type to find an object that satisfies the criteria defined by \p func. If such an object is found, the pointer to the memory containing this object is returned. Otherwise, NULL is returned. To do this, \p func is called on every member of type \p type. The first member to satisfy \p func is returned. The \p type parameter is the identifier for the ID type which is to be searched. This identifier must have been created by a call to H5Iregister_type(). The parameter \p func is a function pointer to a function which takes three parameters. The first parameter is a \c void* and will be a pointer to the object to be tested. This is the same object that was placed in storage using H5Iregister(). The second parameter is a hid_t and is the ID of the object to be tested. The last parameter is a \c void*. This is the \p key parameter and can be used however the user finds helpful, or it can be ignored if it is not needed. \p func returns 0 if the object it is testing does not pass its criteria. A non-zero value should be returned if the object does pass its criteria. H5I_search_func_t is defined in H5Ipublic.h and is shown below. \snippet this H5I_search_func_t_snip The \p key parameter will be passed to the search function as a parameter. It can be used to further define the search at run-time.
-
H5Iiterate
@Cast("herr_t") public static int H5Iiterate(@Cast("H5I_type_t") int type, H5I_iterate_func_t op, Pointer op_data)
\ingroup H5IUD \brief Calls a callback for each member of the identifier type specified- Parameters:
type- [in] The identifier typeop- [in] The callback functionop_data- [in,out] The data for the callback function- Returns:
- The last value returned by \p op \details H5Iiterate() calls the callback function \p op for each member of the identifier type \p type. The callback function type for \p op, H5I_iterate_func_t, is defined in H5Ipublic.h as: \snippet this H5I_iterate_func_t_snip \p op takes as parameters the identifier and a pass through of \p op_data, and returns an herr_t. A positive return from op will cause the iteration to stop and H5Iiterate() will return the value returned by \p op. A negative return from \p op will cause the iteration to stop and H5Iiterate() will return failure. A zero return from \p op will allow iteration to continue, as long as there are other identifiers remaining in type.
- Since:
- 1.12.0
-
H5Inmembers
@Cast("herr_t") public static int H5Inmembers(@Cast("H5I_type_t") int type, @Cast("hsize_t*") LongPointer num_members)
\ingroup H5IUD \brief Returns the number of identifiers in a given identifier type- Parameters:
type- [in] The identifier typenum_members- [out] Number of identifiers of the specified identifier type- Returns:
- \herr_t \details H5Inmembers() returns the number of identifiers of the identifier type specified in \p type. The number of identifiers is returned in \p num_members. If no identifiers of this type have been registered, the type does not exist, or it has been destroyed, \p num_members is returned with the value 0.
-
H5Inmembers
@Cast("herr_t") public static int H5Inmembers(@Cast("H5I_type_t") int type, @Cast("hsize_t*") LongBuffer num_members)
-
H5Inmembers
@Cast("herr_t") public static int H5Inmembers(@Cast("H5I_type_t") int type, @Cast("hsize_t*") long... num_members)
-
H5Itype_exists
@Cast("htri_t") public static int H5Itype_exists(@Cast("H5I_type_t") int type)
\ingroup H5IUD \brief Determines whether an identifier type is registered- Parameters:
type- [in] Identifier type- Returns:
- \htri_t \details H5Itype_exists() determines whether the given identifier type, \p type, is registered with the library.
- Since:
- 1.8.0
-
H5Iis_valid
@Cast("htri_t") public static int H5Iis_valid(@Cast("hid_t") long id)
\ingroup H5I \brief Determines whether an identifier is valid \obj_id{id}- Returns:
- \htri_t \details H5Iis_valid() determines whether the identifier \p id is valid. \details Valid identifiers are those that have been obtained by an application and can still be used to access the original target. Examples of invalid identifiers include: \li Out of range values: negative, for example \li Previously-valid identifiers that have been released: for example, a dataset identifier for which the dataset has been closed H5Iis_valid() can be used with any type of identifier: object identifier, property list identifier, attribute identifier, error message identifier, etc. When necessary, a call to H5Iget_type() can determine the type of the object that \p id identifies.
- Since:
- 1.8.3
-
H5T_VARIABLE
@MemberGetter public static int H5T_VARIABLE()
Indicate that a string is variable length (null-terminated in C, instead of fixed length)
-
H5T_IEEE_F32BE
@MemberGetter public static int H5T_IEEE_F32BE()
\ingroup PDTIEEE 32-bit big-endian IEEE floating-point numbers
-
H5T_IEEE_F32LE
@MemberGetter public static int H5T_IEEE_F32LE()
\ingroup PDTIEEE 32-bit little-endian IEEE floating-point numbers
-
H5T_IEEE_F64BE
@MemberGetter public static int H5T_IEEE_F64BE()
\ingroup PDTIEEE 64-bit big-endian IEEE floating-point numbers
-
H5T_IEEE_F64LE
@MemberGetter public static int H5T_IEEE_F64LE()
\ingroup PDTIEEE 64-bit little-endian IEEE floating-point numbers
-
H5T_IEEE_F32BE_g
@Cast("hid_t") public static long H5T_IEEE_F32BE_g()
-
H5T_IEEE_F32BE_g
public static void H5T_IEEE_F32BE_g(long setter)
-
H5T_IEEE_F32LE_g
@Cast("hid_t") public static long H5T_IEEE_F32LE_g()
-
H5T_IEEE_F32LE_g
public static void H5T_IEEE_F32LE_g(long setter)
-
H5T_IEEE_F64BE_g
@Cast("hid_t") public static long H5T_IEEE_F64BE_g()
-
H5T_IEEE_F64BE_g
public static void H5T_IEEE_F64BE_g(long setter)
-
H5T_IEEE_F64LE_g
@Cast("hid_t") public static long H5T_IEEE_F64LE_g()
-
H5T_IEEE_F64LE_g
public static void H5T_IEEE_F64LE_g(long setter)
-
H5T_STD_I8BE
@MemberGetter public static int H5T_STD_I8BE()
\ingroup PDTSTD 8-bit big-endian signed integers
-
H5T_STD_I8LE
@MemberGetter public static int H5T_STD_I8LE()
\ingroup PDTSTD 8-bit little-endian signed integers
-
H5T_STD_I16BE
@MemberGetter public static int H5T_STD_I16BE()
\ingroup PDTSTD 16-bit big-endian signed integers
-
H5T_STD_I16LE
@MemberGetter public static int H5T_STD_I16LE()
\ingroup PDTSTD 16-bit little-endian signed integers
-
H5T_STD_I32BE
@MemberGetter public static int H5T_STD_I32BE()
\ingroup PDTSTD 32-bit big-endian signed integers
-
H5T_STD_I32LE
@MemberGetter public static int H5T_STD_I32LE()
\ingroup PDTSTD 32-bit little-endian signed integers
-
H5T_STD_I64BE
@MemberGetter public static int H5T_STD_I64BE()
\ingroup PDTSTD 64-bit big-endian signed integers
-
H5T_STD_I64LE
@MemberGetter public static int H5T_STD_I64LE()
\ingroup PDTSTD 64-bit little-endian signed integers
-
H5T_STD_U8BE
@MemberGetter public static int H5T_STD_U8BE()
\ingroup PDTSTD 8-bit big-endian unsigned integers
-
H5T_STD_U8LE
@MemberGetter public static int H5T_STD_U8LE()
\ingroup PDTSTD 8-bit little-endian unsigned integers
-
H5T_STD_U16BE
@MemberGetter public static int H5T_STD_U16BE()
\ingroup PDTSTD 16-bit big-endian unsigned integers
-
H5T_STD_U16LE
@MemberGetter public static int H5T_STD_U16LE()
\ingroup PDTSTD 16-bit little-endian unsigned integers
-
H5T_STD_U32BE
@MemberGetter public static int H5T_STD_U32BE()
\ingroup PDTSTD 32-bit big-endian unsigned integers
-
H5T_STD_U32LE
@MemberGetter public static int H5T_STD_U32LE()
\ingroup PDTSTD 32-bit little-endian unsigned integers
-
H5T_STD_U64BE
@MemberGetter public static int H5T_STD_U64BE()
\ingroup PDTSTD 64-bit big-endian unsigned integers
-
H5T_STD_U64LE
@MemberGetter public static int H5T_STD_U64LE()
\ingroup PDTSTD 64-bit little-endian unsigned integers
-
H5T_STD_B8BE
@MemberGetter public static int H5T_STD_B8BE()
\ingroup PDTSTD 8-bit big-endian bitfield
-
H5T_STD_B8LE
@MemberGetter public static int H5T_STD_B8LE()
\ingroup PDTSTD 8-bit little-endian bitfield
-
H5T_STD_B16BE
@MemberGetter public static int H5T_STD_B16BE()
\ingroup PDTSTD 16-bit big-endian bitfield
-
H5T_STD_B16LE
@MemberGetter public static int H5T_STD_B16LE()
\ingroup PDTSTD 16-bit little-endian bitfield
-
H5T_STD_B32BE
@MemberGetter public static int H5T_STD_B32BE()
\ingroup PDTSTD 32-bit big-endian bitfield
-
H5T_STD_B32LE
@MemberGetter public static int H5T_STD_B32LE()
\ingroup PDTSTD 32-bit little-endian bitfield
-
H5T_STD_B64BE
@MemberGetter public static int H5T_STD_B64BE()
\ingroup PDTSTD 64-bit big-endian bitfield
-
H5T_STD_B64LE
@MemberGetter public static int H5T_STD_B64LE()
\ingroup PDTSTD 64-bit little-endian bitfield
-
H5T_STD_REF_OBJ
@MemberGetter public static int H5T_STD_REF_OBJ()
\ingroup PDTSTD Object reference
-
H5T_STD_REF_DSETREG
@MemberGetter public static int H5T_STD_REF_DSETREG()
\ingroup PDTSTD Dataset region reference
-
H5T_STD_REF
@MemberGetter public static int H5T_STD_REF()
\ingroup PDTSTD Generic reference
-
H5T_STD_I8BE_g
@Cast("hid_t") public static long H5T_STD_I8BE_g()
-
H5T_STD_I8BE_g
public static void H5T_STD_I8BE_g(long setter)
-
H5T_STD_I8LE_g
@Cast("hid_t") public static long H5T_STD_I8LE_g()
-
H5T_STD_I8LE_g
public static void H5T_STD_I8LE_g(long setter)
-
H5T_STD_I16BE_g
@Cast("hid_t") public static long H5T_STD_I16BE_g()
-
H5T_STD_I16BE_g
public static void H5T_STD_I16BE_g(long setter)
-
H5T_STD_I16LE_g
@Cast("hid_t") public static long H5T_STD_I16LE_g()
-
H5T_STD_I16LE_g
public static void H5T_STD_I16LE_g(long setter)
-
H5T_STD_I32BE_g
@Cast("hid_t") public static long H5T_STD_I32BE_g()
-
H5T_STD_I32BE_g
public static void H5T_STD_I32BE_g(long setter)
-
H5T_STD_I32LE_g
@Cast("hid_t") public static long H5T_STD_I32LE_g()
-
H5T_STD_I32LE_g
public static void H5T_STD_I32LE_g(long setter)
-
H5T_STD_I64BE_g
@Cast("hid_t") public static long H5T_STD_I64BE_g()
-
H5T_STD_I64BE_g
public static void H5T_STD_I64BE_g(long setter)
-
H5T_STD_I64LE_g
@Cast("hid_t") public static long H5T_STD_I64LE_g()
-
H5T_STD_I64LE_g
public static void H5T_STD_I64LE_g(long setter)
-
H5T_STD_U8BE_g
@Cast("hid_t") public static long H5T_STD_U8BE_g()
-
H5T_STD_U8BE_g
public static void H5T_STD_U8BE_g(long setter)
-
H5T_STD_U8LE_g
@Cast("hid_t") public static long H5T_STD_U8LE_g()
-
H5T_STD_U8LE_g
public static void H5T_STD_U8LE_g(long setter)
-
H5T_STD_U16BE_g
@Cast("hid_t") public static long H5T_STD_U16BE_g()
-
H5T_STD_U16BE_g
public static void H5T_STD_U16BE_g(long setter)
-
H5T_STD_U16LE_g
@Cast("hid_t") public static long H5T_STD_U16LE_g()
-
H5T_STD_U16LE_g
public static void H5T_STD_U16LE_g(long setter)
-
H5T_STD_U32BE_g
@Cast("hid_t") public static long H5T_STD_U32BE_g()
-
H5T_STD_U32BE_g
public static void H5T_STD_U32BE_g(long setter)
-
H5T_STD_U32LE_g
@Cast("hid_t") public static long H5T_STD_U32LE_g()
-
H5T_STD_U32LE_g
public static void H5T_STD_U32LE_g(long setter)
-
H5T_STD_U64BE_g
@Cast("hid_t") public static long H5T_STD_U64BE_g()
-
H5T_STD_U64BE_g
public static void H5T_STD_U64BE_g(long setter)
-
H5T_STD_U64LE_g
@Cast("hid_t") public static long H5T_STD_U64LE_g()
-
H5T_STD_U64LE_g
public static void H5T_STD_U64LE_g(long setter)
-
H5T_STD_B8BE_g
@Cast("hid_t") public static long H5T_STD_B8BE_g()
-
H5T_STD_B8BE_g
public static void H5T_STD_B8BE_g(long setter)
-
H5T_STD_B8LE_g
@Cast("hid_t") public static long H5T_STD_B8LE_g()
-
H5T_STD_B8LE_g
public static void H5T_STD_B8LE_g(long setter)
-
H5T_STD_B16BE_g
@Cast("hid_t") public static long H5T_STD_B16BE_g()
-
H5T_STD_B16BE_g
public static void H5T_STD_B16BE_g(long setter)
-
H5T_STD_B16LE_g
@Cast("hid_t") public static long H5T_STD_B16LE_g()
-
H5T_STD_B16LE_g
public static void H5T_STD_B16LE_g(long setter)
-
H5T_STD_B32BE_g
@Cast("hid_t") public static long H5T_STD_B32BE_g()
-
H5T_STD_B32BE_g
public static void H5T_STD_B32BE_g(long setter)
-
H5T_STD_B32LE_g
@Cast("hid_t") public static long H5T_STD_B32LE_g()
-
H5T_STD_B32LE_g
public static void H5T_STD_B32LE_g(long setter)
-
H5T_STD_B64BE_g
@Cast("hid_t") public static long H5T_STD_B64BE_g()
-
H5T_STD_B64BE_g
public static void H5T_STD_B64BE_g(long setter)
-
H5T_STD_B64LE_g
@Cast("hid_t") public static long H5T_STD_B64LE_g()
-
H5T_STD_B64LE_g
public static void H5T_STD_B64LE_g(long setter)
-
H5T_STD_REF_OBJ_g
@Cast("hid_t") public static long H5T_STD_REF_OBJ_g()
-
H5T_STD_REF_OBJ_g
public static void H5T_STD_REF_OBJ_g(long setter)
-
H5T_STD_REF_DSETREG_g
@Cast("hid_t") public static long H5T_STD_REF_DSETREG_g()
-
H5T_STD_REF_DSETREG_g
public static void H5T_STD_REF_DSETREG_g(long setter)
-
H5T_STD_REF_g
@Cast("hid_t") public static long H5T_STD_REF_g()
-
H5T_STD_REF_g
public static void H5T_STD_REF_g(long setter)
-
H5T_UNIX_D32BE
@MemberGetter public static int H5T_UNIX_D32BE()
\ingroup PDTUNIX
-
H5T_UNIX_D32LE
@MemberGetter public static int H5T_UNIX_D32LE()
\ingroup PDTUNIX
-
H5T_UNIX_D64BE
@MemberGetter public static int H5T_UNIX_D64BE()
\ingroup PDTUNIX
-
H5T_UNIX_D64LE
@MemberGetter public static int H5T_UNIX_D64LE()
\ingroup PDTUNIX
-
H5T_UNIX_D32BE_g
@Cast("hid_t") public static long H5T_UNIX_D32BE_g()
-
H5T_UNIX_D32BE_g
public static void H5T_UNIX_D32BE_g(long setter)
-
H5T_UNIX_D32LE_g
@Cast("hid_t") public static long H5T_UNIX_D32LE_g()
-
H5T_UNIX_D32LE_g
public static void H5T_UNIX_D32LE_g(long setter)
-
H5T_UNIX_D64BE_g
@Cast("hid_t") public static long H5T_UNIX_D64BE_g()
-
H5T_UNIX_D64BE_g
public static void H5T_UNIX_D64BE_g(long setter)
-
H5T_UNIX_D64LE_g
@Cast("hid_t") public static long H5T_UNIX_D64LE_g()
-
H5T_UNIX_D64LE_g
public static void H5T_UNIX_D64LE_g(long setter)
-
H5T_C_S1
@MemberGetter public static int H5T_C_S1()
\ingroup PDTS String datatype in C (size defined in bytes rather than in bits)
-
H5T_C_S1_g
@Cast("hid_t") public static long H5T_C_S1_g()
-
H5T_C_S1_g
public static void H5T_C_S1_g(long setter)
-
H5T_FORTRAN_S1
@MemberGetter public static int H5T_FORTRAN_S1()
\ingroup PDTS String datatype in Fortran (as defined for the HDF5 C library)
-
H5T_FORTRAN_S1_g
@Cast("hid_t") public static long H5T_FORTRAN_S1_g()
-
H5T_FORTRAN_S1_g
public static void H5T_FORTRAN_S1_g(long setter)
-
H5T_INTEL_I8
@MemberGetter public static int H5T_INTEL_I8()
\ingroup PDTX86 8-bit little-endian signed (2's complement) integers for Intel CPUs
-
H5T_INTEL_I16
@MemberGetter public static int H5T_INTEL_I16()
\ingroup PDTX86 16-bit little-endian signed (2's complement) integers for Intel CPUs
-
H5T_INTEL_I32
@MemberGetter public static int H5T_INTEL_I32()
\ingroup PDTX86 32-bit little-endian signed (2's complement) integers for Intel CPUs
-
H5T_INTEL_I64
@MemberGetter public static int H5T_INTEL_I64()
\ingroup PDTX86 64-bit little-endian signed (2's complement) integers for Intel CPUs
-
H5T_INTEL_U8
@MemberGetter public static int H5T_INTEL_U8()
\ingroup PDTX86 8-bit little-endian unsigned integers for Intel CPUs
-
H5T_INTEL_U16
@MemberGetter public static int H5T_INTEL_U16()
\ingroup PDTX86 16-bit little-endian unsigned integers for Intel CPUs
-
H5T_INTEL_U32
@MemberGetter public static int H5T_INTEL_U32()
\ingroup PDTX86 32-bit little-endian unsigned integers for Intel CPUs
-
H5T_INTEL_U64
@MemberGetter public static int H5T_INTEL_U64()
\ingroup PDTX86 64-bit little-endian unsigned integers for Intel CPUs
-
H5T_INTEL_B8
@MemberGetter public static int H5T_INTEL_B8()
\ingroup PDTX86 8-bit little-endian bitfield for Intel CPUs
-
H5T_INTEL_B16
@MemberGetter public static int H5T_INTEL_B16()
\ingroup PDTX86 16-bit little-endian bitfield for Intel CPUs
-
H5T_INTEL_B32
@MemberGetter public static int H5T_INTEL_B32()
\ingroup PDTX86 32-bit little-endian bitfield for Intel CPUs
-
H5T_INTEL_B64
@MemberGetter public static int H5T_INTEL_B64()
\ingroup PDTX86 64-bit little-endian bitfield for Intel CPUs
-
H5T_INTEL_F32
@MemberGetter public static int H5T_INTEL_F32()
\ingroup PDTX86 32-bit little-endian IEEE floating-point numbers for Intel CPUs
-
H5T_INTEL_F64
@MemberGetter public static int H5T_INTEL_F64()
\ingroup PDTX86 64-bit little-endian IEEE floating-point numbers for Intel CPUs
-
H5T_ALPHA_I8
@MemberGetter public static int H5T_ALPHA_I8()
\ingroup PDTALPHA 8-bit little-endian signed (2's complement) integers for DEC Alpha CPUs
-
H5T_ALPHA_I16
@MemberGetter public static int H5T_ALPHA_I16()
\ingroup PDTALPHA 16-bit little-endian signed (2's complement) integers for DEC Alpha CPUs
-
H5T_ALPHA_I32
@MemberGetter public static int H5T_ALPHA_I32()
\ingroup PDTALPHA 32-bit little-endian signed (2's complement) integers for DEC Alpha CPUs
-
H5T_ALPHA_I64
@MemberGetter public static int H5T_ALPHA_I64()
\ingroup PDTALPHA 64-bit little-endian signed (2's complement) integers for DEC Alpha CPUs
-
H5T_ALPHA_U8
@MemberGetter public static int H5T_ALPHA_U8()
\ingroup PDTALPHA 8-bit little-endian unsigned integers for DEC Alpha CPUs
-
H5T_ALPHA_U16
@MemberGetter public static int H5T_ALPHA_U16()
\ingroup PDTALPHA 16-bit little-endian unsigned integers for DEC Alpha CPUs
-
H5T_ALPHA_U32
@MemberGetter public static int H5T_ALPHA_U32()
\ingroup PDTALPHA 32-bit little-endian unsigned integers for DEC Alpha CPUs
-
H5T_ALPHA_U64
@MemberGetter public static int H5T_ALPHA_U64()
\ingroup PDTALPHA 64-bit little-endian unsigned integers for DEC Alpha CPUs
-
H5T_ALPHA_B8
@MemberGetter public static int H5T_ALPHA_B8()
\ingroup PDTALPHA 8-bit little-endian bitfield for DEC Alpha CPUs
-
H5T_ALPHA_B16
@MemberGetter public static int H5T_ALPHA_B16()
\ingroup PDTALPHA 16-bit little-endian bitfield for DEC Alpha CPUs
-
H5T_ALPHA_B32
@MemberGetter public static int H5T_ALPHA_B32()
\ingroup PDTALPHA 32-bit little-endian bitfield for DEC Alpha CPUs
-
H5T_ALPHA_B64
@MemberGetter public static int H5T_ALPHA_B64()
\ingroup PDTALPHA 64-bit little-endian bitfield for DEC Alpha CPUs
-
H5T_ALPHA_F32
@MemberGetter public static int H5T_ALPHA_F32()
\ingroup PDTALPHA 32-bit little-endian IEEE floating-point numbers for DEC Alpha CPUs
-
H5T_ALPHA_F64
@MemberGetter public static int H5T_ALPHA_F64()
\ingroup PDTALPHA 64-bit little-endian IEEE floating-point numbers for DEC Alpha CPUs
-
H5T_MIPS_I8
@MemberGetter public static int H5T_MIPS_I8()
\ingroup PDTMIPS 8-bit big-endian signed (2's complement) integers for SGI MIPS CPUs
-
H5T_MIPS_I16
@MemberGetter public static int H5T_MIPS_I16()
\ingroup PDTMIPS 16-bit big-endian signed (2's complement) integers for SGI MIPS CPUs
-
H5T_MIPS_I32
@MemberGetter public static int H5T_MIPS_I32()
\ingroup PDTMIPS 32-bit big-endian signed (2's complement) integers for SGI MIPS CPUs
-
H5T_MIPS_I64
@MemberGetter public static int H5T_MIPS_I64()
\ingroup PDTMIPS 64-bit big-endian signed (2's complement) integers for SGI MIPS CPUs
-
H5T_MIPS_U8
@MemberGetter public static int H5T_MIPS_U8()
\ingroup PDTMIPS 8-bit big-endian unsigned integers for SGI MIPS CPUs
-
H5T_MIPS_U16
@MemberGetter public static int H5T_MIPS_U16()
\ingroup PDTMIPS 16-bit big-endian unsigned integers for SGI MIPS CPUs
-
H5T_MIPS_U32
@MemberGetter public static int H5T_MIPS_U32()
\ingroup PDTMIPS 32-bit big-endian unsigned integers for SGI MIPS CPUs
-
H5T_MIPS_U64
@MemberGetter public static int H5T_MIPS_U64()
\ingroup PDTMIPS 64-bit big-endian unsigned integers for SGI MIPS CPUs
-
H5T_MIPS_B8
@MemberGetter public static int H5T_MIPS_B8()
\ingroup PDTMIPS 8-bit big-endian bitfield for SGI MIPS CPUs
-
H5T_MIPS_B16
@MemberGetter public static int H5T_MIPS_B16()
\ingroup PDTMIPS 16-bit big-endian bitfield for SGI MIPS CPUs
-
H5T_MIPS_B32
@MemberGetter public static int H5T_MIPS_B32()
\ingroup PDTMIPS 32-bit big-endian bitfield for SGI MIPS CPUs
-
H5T_MIPS_B64
@MemberGetter public static int H5T_MIPS_B64()
\ingroup PDTMIPS 64-bit big-endian bitfield for SGI MIPS CPUs
-
H5T_MIPS_F32
@MemberGetter public static int H5T_MIPS_F32()
\ingroup PDTMIPS 32-bit big-endian IEEE floating-point numbers for MIPS CPUs
-
H5T_MIPS_F64
@MemberGetter public static int H5T_MIPS_F64()
\ingroup PDTMIPS 64-bit big-endian IEEE floating-point numbers for MIPS CPUs
-
H5T_VAX_F32
@MemberGetter public static int H5T_VAX_F32()
\ingroup PDTALPHA 32-bit VAX byte order floating-point numbers for OpenVMS on DEC Alpha CPUs
-
H5T_VAX_F64
@MemberGetter public static int H5T_VAX_F64()
\ingroup PDTALPHA 64-bit VAX byte order floating-point numbers for OpenVMS on DEC Alpha CPUs
-
H5T_VAX_F32_g
@Cast("hid_t") public static long H5T_VAX_F32_g()
-
H5T_VAX_F32_g
public static void H5T_VAX_F32_g(long setter)
-
H5T_VAX_F64_g
@Cast("hid_t") public static long H5T_VAX_F64_g()
-
H5T_VAX_F64_g
public static void H5T_VAX_F64_g(long setter)
-
H5T_NATIVE_CHAR
@MemberGetter public static int H5T_NATIVE_CHAR()
\ingroup PDTNAT C-style \c char
-
H5T_NATIVE_SCHAR
@MemberGetter public static int H5T_NATIVE_SCHAR()
\ingroup PDTNAT C-style \Code{signed char}
-
H5T_NATIVE_UCHAR
@MemberGetter public static int H5T_NATIVE_UCHAR()
\ingroup PDTNAT C-style \Code{unsigned char}
-
H5T_NATIVE_SHORT
@MemberGetter public static int H5T_NATIVE_SHORT()
\ingroup PDTNAT C-style \Code{short}
-
H5T_NATIVE_USHORT
@MemberGetter public static int H5T_NATIVE_USHORT()
\ingroup PDTNAT C-style \Code{unsigned short}
-
H5T_NATIVE_INT
@MemberGetter public static int H5T_NATIVE_INT()
\ingroup PDTNAT C-style \Code{int}
-
H5T_NATIVE_UINT
@MemberGetter public static int H5T_NATIVE_UINT()
\ingroup PDTNAT C-style \Code{unsigned int}
-
H5T_NATIVE_LONG
@MemberGetter public static int H5T_NATIVE_LONG()
\ingroup PDTNAT C-style \Code{long}
-
H5T_NATIVE_ULONG
@MemberGetter public static int H5T_NATIVE_ULONG()
\ingroup PDTNAT C-style \Code{unsigned long}
-
H5T_NATIVE_LLONG
@MemberGetter public static int H5T_NATIVE_LLONG()
\ingroup PDTNAT C-style \Code{long long}
-
H5T_NATIVE_ULLONG
@MemberGetter public static int H5T_NATIVE_ULLONG()
\ingroup PDTNAT C-style \Code{unsigned long long}
-
H5T_NATIVE_FLOAT
@MemberGetter public static int H5T_NATIVE_FLOAT()
\ingroup PDTNAT C-style \Code{float}
-
H5T_NATIVE_DOUBLE
@MemberGetter public static int H5T_NATIVE_DOUBLE()
\ingroup PDTNAT C-style \Code{double}
-
H5T_NATIVE_LDOUBLE
@MemberGetter public static int H5T_NATIVE_LDOUBLE()
\ingroup PDTNAT C-style \Code{long double}
-
H5T_NATIVE_B8
@MemberGetter public static int H5T_NATIVE_B8()
\ingroup PDTNAT HDF5 8-bit bitfield based on native types
-
H5T_NATIVE_B16
@MemberGetter public static int H5T_NATIVE_B16()
\ingroup PDTNAT HDF5 16-bit bitfield based on native types
-
H5T_NATIVE_B32
@MemberGetter public static int H5T_NATIVE_B32()
\ingroup PDTNAT HDF5 32-bit bitfield based on native types
-
H5T_NATIVE_B64
@MemberGetter public static int H5T_NATIVE_B64()
\ingroup PDTNAT HDF5 64-bit bitfield based on native types
-
H5T_NATIVE_OPAQUE
@MemberGetter public static int H5T_NATIVE_OPAQUE()
\ingroup PDTNAT HDF5 opaque unit based on native types
-
H5T_NATIVE_HADDR
@MemberGetter public static int H5T_NATIVE_HADDR()
\ingroup PDTNAT HDF5 address type based on native types
-
H5T_NATIVE_HSIZE
@MemberGetter public static int H5T_NATIVE_HSIZE()
\ingroup PDTNAT HDF5 size type based on native types
-
H5T_NATIVE_HSSIZE
@MemberGetter public static int H5T_NATIVE_HSSIZE()
\ingroup PDTNAT HDF5 signed size type based on native types
-
H5T_NATIVE_HERR
@MemberGetter public static int H5T_NATIVE_HERR()
\ingroup PDTNAT HDF5 error code type based on native types
-
H5T_NATIVE_HBOOL
@MemberGetter public static int H5T_NATIVE_HBOOL()
\ingroup PDTNAT HDF5 Boolean type based on native types
-
H5T_NATIVE_SCHAR_g
@Cast("hid_t") public static long H5T_NATIVE_SCHAR_g()
-
H5T_NATIVE_SCHAR_g
public static void H5T_NATIVE_SCHAR_g(long setter)
-
H5T_NATIVE_UCHAR_g
@Cast("hid_t") public static long H5T_NATIVE_UCHAR_g()
-
H5T_NATIVE_UCHAR_g
public static void H5T_NATIVE_UCHAR_g(long setter)
-
H5T_NATIVE_SHORT_g
@Cast("hid_t") public static long H5T_NATIVE_SHORT_g()
-
H5T_NATIVE_SHORT_g
public static void H5T_NATIVE_SHORT_g(long setter)
-
H5T_NATIVE_USHORT_g
@Cast("hid_t") public static long H5T_NATIVE_USHORT_g()
-
H5T_NATIVE_USHORT_g
public static void H5T_NATIVE_USHORT_g(long setter)
-
H5T_NATIVE_INT_g
@Cast("hid_t") public static long H5T_NATIVE_INT_g()
-
H5T_NATIVE_INT_g
public static void H5T_NATIVE_INT_g(long setter)
-
H5T_NATIVE_UINT_g
@Cast("hid_t") public static long H5T_NATIVE_UINT_g()
-
H5T_NATIVE_UINT_g
public static void H5T_NATIVE_UINT_g(long setter)
-
H5T_NATIVE_LONG_g
@Cast("hid_t") public static long H5T_NATIVE_LONG_g()
-
H5T_NATIVE_LONG_g
public static void H5T_NATIVE_LONG_g(long setter)
-
H5T_NATIVE_ULONG_g
@Cast("hid_t") public static long H5T_NATIVE_ULONG_g()
-
H5T_NATIVE_ULONG_g
public static void H5T_NATIVE_ULONG_g(long setter)
-
H5T_NATIVE_LLONG_g
@Cast("hid_t") public static long H5T_NATIVE_LLONG_g()
-
H5T_NATIVE_LLONG_g
public static void H5T_NATIVE_LLONG_g(long setter)
-
H5T_NATIVE_ULLONG_g
@Cast("hid_t") public static long H5T_NATIVE_ULLONG_g()
-
H5T_NATIVE_ULLONG_g
public static void H5T_NATIVE_ULLONG_g(long setter)
-
H5T_NATIVE_FLOAT_g
@Cast("hid_t") public static long H5T_NATIVE_FLOAT_g()
-
H5T_NATIVE_FLOAT_g
public static void H5T_NATIVE_FLOAT_g(long setter)
-
H5T_NATIVE_DOUBLE_g
@Cast("hid_t") public static long H5T_NATIVE_DOUBLE_g()
-
H5T_NATIVE_DOUBLE_g
public static void H5T_NATIVE_DOUBLE_g(long setter)
-
H5T_NATIVE_LDOUBLE_g
@Cast("hid_t") public static long H5T_NATIVE_LDOUBLE_g()
-
H5T_NATIVE_LDOUBLE_g
public static void H5T_NATIVE_LDOUBLE_g(long setter)
-
H5T_NATIVE_B8_g
@Cast("hid_t") public static long H5T_NATIVE_B8_g()
-
H5T_NATIVE_B8_g
public static void H5T_NATIVE_B8_g(long setter)
-
H5T_NATIVE_B16_g
@Cast("hid_t") public static long H5T_NATIVE_B16_g()
-
H5T_NATIVE_B16_g
public static void H5T_NATIVE_B16_g(long setter)
-
H5T_NATIVE_B32_g
@Cast("hid_t") public static long H5T_NATIVE_B32_g()
-
H5T_NATIVE_B32_g
public static void H5T_NATIVE_B32_g(long setter)
-
H5T_NATIVE_B64_g
@Cast("hid_t") public static long H5T_NATIVE_B64_g()
-
H5T_NATIVE_B64_g
public static void H5T_NATIVE_B64_g(long setter)
-
H5T_NATIVE_OPAQUE_g
@Cast("hid_t") public static long H5T_NATIVE_OPAQUE_g()
-
H5T_NATIVE_OPAQUE_g
public static void H5T_NATIVE_OPAQUE_g(long setter)
-
H5T_NATIVE_HADDR_g
@Cast("hid_t") public static long H5T_NATIVE_HADDR_g()
-
H5T_NATIVE_HADDR_g
public static void H5T_NATIVE_HADDR_g(long setter)
-
H5T_NATIVE_HSIZE_g
@Cast("hid_t") public static long H5T_NATIVE_HSIZE_g()
-
H5T_NATIVE_HSIZE_g
public static void H5T_NATIVE_HSIZE_g(long setter)
-
H5T_NATIVE_HSSIZE_g
@Cast("hid_t") public static long H5T_NATIVE_HSSIZE_g()
-
H5T_NATIVE_HSSIZE_g
public static void H5T_NATIVE_HSSIZE_g(long setter)
-
H5T_NATIVE_HERR_g
@Cast("hid_t") public static long H5T_NATIVE_HERR_g()
-
H5T_NATIVE_HERR_g
public static void H5T_NATIVE_HERR_g(long setter)
-
H5T_NATIVE_HBOOL_g
@Cast("hid_t") public static long H5T_NATIVE_HBOOL_g()
-
H5T_NATIVE_HBOOL_g
public static void H5T_NATIVE_HBOOL_g(long setter)
-
H5T_NATIVE_INT8
@MemberGetter public static int H5T_NATIVE_INT8()
\ingroup PDTC9x
-
H5T_NATIVE_UINT8
@MemberGetter public static int H5T_NATIVE_UINT8()
\ingroup PDTC9x
-
H5T_NATIVE_INT_LEAST8
@MemberGetter public static int H5T_NATIVE_INT_LEAST8()
\ingroup PDTC9x
-
H5T_NATIVE_UINT_LEAST8
@MemberGetter public static int H5T_NATIVE_UINT_LEAST8()
\ingroup PDTC9x
-
H5T_NATIVE_INT_FAST8
@MemberGetter public static int H5T_NATIVE_INT_FAST8()
\ingroup PDTC9x
-
H5T_NATIVE_UINT_FAST8
@MemberGetter public static int H5T_NATIVE_UINT_FAST8()
\ingroup PDTC9x
-
H5T_NATIVE_INT8_g
@Cast("hid_t") public static long H5T_NATIVE_INT8_g()
-
H5T_NATIVE_INT8_g
public static void H5T_NATIVE_INT8_g(long setter)
-
H5T_NATIVE_UINT8_g
@Cast("hid_t") public static long H5T_NATIVE_UINT8_g()
-
H5T_NATIVE_UINT8_g
public static void H5T_NATIVE_UINT8_g(long setter)
-
H5T_NATIVE_INT_LEAST8_g
@Cast("hid_t") public static long H5T_NATIVE_INT_LEAST8_g()
-
H5T_NATIVE_INT_LEAST8_g
public static void H5T_NATIVE_INT_LEAST8_g(long setter)
-
H5T_NATIVE_UINT_LEAST8_g
@Cast("hid_t") public static long H5T_NATIVE_UINT_LEAST8_g()
-
H5T_NATIVE_UINT_LEAST8_g
public static void H5T_NATIVE_UINT_LEAST8_g(long setter)
-
H5T_NATIVE_INT_FAST8_g
@Cast("hid_t") public static long H5T_NATIVE_INT_FAST8_g()
-
H5T_NATIVE_INT_FAST8_g
public static void H5T_NATIVE_INT_FAST8_g(long setter)
-
H5T_NATIVE_UINT_FAST8_g
@Cast("hid_t") public static long H5T_NATIVE_UINT_FAST8_g()
-
H5T_NATIVE_UINT_FAST8_g
public static void H5T_NATIVE_UINT_FAST8_g(long setter)
-
H5T_NATIVE_INT16
@MemberGetter public static int H5T_NATIVE_INT16()
\ingroup PDTC9x
-
H5T_NATIVE_UINT16
@MemberGetter public static int H5T_NATIVE_UINT16()
\ingroup PDTC9x
-
H5T_NATIVE_INT_LEAST16
@MemberGetter public static int H5T_NATIVE_INT_LEAST16()
\ingroup PDTC9x
-
H5T_NATIVE_UINT_LEAST16
@MemberGetter public static int H5T_NATIVE_UINT_LEAST16()
\ingroup PDTC9x
-
H5T_NATIVE_INT_FAST16
@MemberGetter public static int H5T_NATIVE_INT_FAST16()
\ingroup PDTC9x
-
H5T_NATIVE_UINT_FAST16
@MemberGetter public static int H5T_NATIVE_UINT_FAST16()
\ingroup PDTC9x
-
H5T_NATIVE_INT16_g
@Cast("hid_t") public static long H5T_NATIVE_INT16_g()
-
H5T_NATIVE_INT16_g
public static void H5T_NATIVE_INT16_g(long setter)
-
H5T_NATIVE_UINT16_g
@Cast("hid_t") public static long H5T_NATIVE_UINT16_g()
-
H5T_NATIVE_UINT16_g
public static void H5T_NATIVE_UINT16_g(long setter)
-
H5T_NATIVE_INT_LEAST16_g
@Cast("hid_t") public static long H5T_NATIVE_INT_LEAST16_g()
-
H5T_NATIVE_INT_LEAST16_g
public static void H5T_NATIVE_INT_LEAST16_g(long setter)
-
H5T_NATIVE_UINT_LEAST16_g
@Cast("hid_t") public static long H5T_NATIVE_UINT_LEAST16_g()
-
H5T_NATIVE_UINT_LEAST16_g
public static void H5T_NATIVE_UINT_LEAST16_g(long setter)
-
H5T_NATIVE_INT_FAST16_g
@Cast("hid_t") public static long H5T_NATIVE_INT_FAST16_g()
-
H5T_NATIVE_INT_FAST16_g
public static void H5T_NATIVE_INT_FAST16_g(long setter)
-
H5T_NATIVE_UINT_FAST16_g
@Cast("hid_t") public static long H5T_NATIVE_UINT_FAST16_g()
-
H5T_NATIVE_UINT_FAST16_g
public static void H5T_NATIVE_UINT_FAST16_g(long setter)
-
H5T_NATIVE_INT32
@MemberGetter public static int H5T_NATIVE_INT32()
\ingroup PDTC9x
-
H5T_NATIVE_UINT32
@MemberGetter public static int H5T_NATIVE_UINT32()
\ingroup PDTC9x
-
H5T_NATIVE_INT_LEAST32
@MemberGetter public static int H5T_NATIVE_INT_LEAST32()
\ingroup PDTC9x
-
H5T_NATIVE_UINT_LEAST32
@MemberGetter public static int H5T_NATIVE_UINT_LEAST32()
\ingroup PDTC9x
-
H5T_NATIVE_INT_FAST32
@MemberGetter public static int H5T_NATIVE_INT_FAST32()
\ingroup PDTC9x
-
H5T_NATIVE_UINT_FAST32
@MemberGetter public static int H5T_NATIVE_UINT_FAST32()
\ingroup PDTC9x
-
H5T_NATIVE_INT32_g
@Cast("hid_t") public static long H5T_NATIVE_INT32_g()
-
H5T_NATIVE_INT32_g
public static void H5T_NATIVE_INT32_g(long setter)
-
H5T_NATIVE_UINT32_g
@Cast("hid_t") public static long H5T_NATIVE_UINT32_g()
-
H5T_NATIVE_UINT32_g
public static void H5T_NATIVE_UINT32_g(long setter)
-
H5T_NATIVE_INT_LEAST32_g
@Cast("hid_t") public static long H5T_NATIVE_INT_LEAST32_g()
-
H5T_NATIVE_INT_LEAST32_g
public static void H5T_NATIVE_INT_LEAST32_g(long setter)
-
H5T_NATIVE_UINT_LEAST32_g
@Cast("hid_t") public static long H5T_NATIVE_UINT_LEAST32_g()
-
H5T_NATIVE_UINT_LEAST32_g
public static void H5T_NATIVE_UINT_LEAST32_g(long setter)
-
H5T_NATIVE_INT_FAST32_g
@Cast("hid_t") public static long H5T_NATIVE_INT_FAST32_g()
-
H5T_NATIVE_INT_FAST32_g
public static void H5T_NATIVE_INT_FAST32_g(long setter)
-
H5T_NATIVE_UINT_FAST32_g
@Cast("hid_t") public static long H5T_NATIVE_UINT_FAST32_g()
-
H5T_NATIVE_UINT_FAST32_g
public static void H5T_NATIVE_UINT_FAST32_g(long setter)
-
H5T_NATIVE_INT64
@MemberGetter public static int H5T_NATIVE_INT64()
\ingroup PDTC9x
-
H5T_NATIVE_UINT64
@MemberGetter public static int H5T_NATIVE_UINT64()
\ingroup PDTC9x
-
H5T_NATIVE_INT_LEAST64
@MemberGetter public static int H5T_NATIVE_INT_LEAST64()
\ingroup PDTC9x
-
H5T_NATIVE_UINT_LEAST64
@MemberGetter public static int H5T_NATIVE_UINT_LEAST64()
\ingroup PDTC9x
-
H5T_NATIVE_INT_FAST64
@MemberGetter public static int H5T_NATIVE_INT_FAST64()
\ingroup PDTC9x
-
H5T_NATIVE_UINT_FAST64
@MemberGetter public static int H5T_NATIVE_UINT_FAST64()
\ingroup PDTC9x
-
H5T_NATIVE_INT64_g
@Cast("hid_t") public static long H5T_NATIVE_INT64_g()
-
H5T_NATIVE_INT64_g
public static void H5T_NATIVE_INT64_g(long setter)
-
H5T_NATIVE_UINT64_g
@Cast("hid_t") public static long H5T_NATIVE_UINT64_g()
-
H5T_NATIVE_UINT64_g
public static void H5T_NATIVE_UINT64_g(long setter)
-
H5T_NATIVE_INT_LEAST64_g
@Cast("hid_t") public static long H5T_NATIVE_INT_LEAST64_g()
-
H5T_NATIVE_INT_LEAST64_g
public static void H5T_NATIVE_INT_LEAST64_g(long setter)
-
H5T_NATIVE_UINT_LEAST64_g
@Cast("hid_t") public static long H5T_NATIVE_UINT_LEAST64_g()
-
H5T_NATIVE_UINT_LEAST64_g
public static void H5T_NATIVE_UINT_LEAST64_g(long setter)
-
H5T_NATIVE_INT_FAST64_g
@Cast("hid_t") public static long H5T_NATIVE_INT_FAST64_g()
-
H5T_NATIVE_INT_FAST64_g
public static void H5T_NATIVE_INT_FAST64_g(long setter)
-
H5T_NATIVE_UINT_FAST64_g
@Cast("hid_t") public static long H5T_NATIVE_UINT_FAST64_g()
-
H5T_NATIVE_UINT_FAST64_g
public static void H5T_NATIVE_UINT_FAST64_g(long setter)
-
H5Tcreate
@Cast("hid_t") public static long H5Tcreate(@Cast("H5T_class_t") int type, @Cast("size_t") long size)
\ingroup H5T \brief Creates a new datatype.- Parameters:
type- [in] Class of datatype to createsize- [in] Size, in bytes, of the datatype being created- Returns:
- \hid_t{datatype} \details H5Tcreate() creates a new datatype of the specified class with the specified number of bytes. This function is used only with the following datatype classes: - #H5T_COMPOUND - #H5T_OPAQUE - #H5T_ENUM - #H5T_STRING Other datatypes, including integer and floating-point datatypes, are typically created by using H5Tcopy() to copy and modify a predefined datatype. When creating a variable-length string datatype, \p size must be #H5T_VARIABLE; see \ref_vlen_strings. When creating a fixed-length string datatype, \p size will be the length of the string in bytes. The length of the string in characters will depend on i the encoding used; see #H5Pset_char_encoding. ENUMs created with this function have a signed native integer base datatype. Use H5Tenum_create() if a different integer base datatype is required. The datatype identifier returned from this function should be released with H5Tclose or resource leaks will result.
- Since:
- 1.2.0
- See Also:
H5Tclose()
-
H5Tcopy
@Cast("hid_t") public static long H5Tcopy(@Cast("hid_t") long type_id)
\ingroup H5T \brief Copies an existing datatype. \type_id- Returns:
- \hid_t{datatype} \details H5Tcopy() makes a copy of an existing datatype. The returned type is always transient and unlocked. The \p type_id argument can be either a datatype identifier, a predefined datatype (defined in H5Tpublic.h), or a dataset identifier. If \p type_id is a dataset identifier, this function returns a transient, modifiable datatype which is a copy of the dataset's datatype. The returned datatype identifier should be released with H5Tclose() to prevent resource leak.
-
H5Tclose
@Cast("herr_t") public static int H5Tclose(@Cast("hid_t") long type_id)
\ingroup H5T \brief Releases a datatype \type_id- Returns:
- \herr_t \details H5Tclose() releases the datatype \p dtype_id. Further access through this datatype identifier is illegal. Failure to release a datatype with this call will result in resource leaks.
-
H5Tclose_async
@Cast("herr_t") public static int H5Tclose_async(@Cast("const char*") BytePointer app_file, @Cast("const char*") BytePointer app_func, @Cast("unsigned") int app_line, @Cast("hid_t") long type_id, @Cast("hid_t") long es_id)
\ingroup H5T \brief Asynchronous version of H5Tclose().
-
H5Tclose_async
@Cast("herr_t") public static int H5Tclose_async(String app_file, String app_func, @Cast("unsigned") int app_line, @Cast("hid_t") long type_id, @Cast("hid_t") long es_id)
-
H5Tequal
@Cast("htri_t") public static int H5Tequal(@Cast("hid_t") long type1_id, @Cast("hid_t") long type2_id)
\ingroup H5T \brief Determines whether two datatype identifiers refer to the same datatype \type_id{type1_id} \type_id{type2_id}- Returns:
- \htri_t \details H5Tequal() determines whether two datatype identifiers refer to the same datatype.
- Since:
- 1.6 or earlier
-
H5Tlock
@Cast("herr_t") public static int H5Tlock(@Cast("hid_t") long type_id)
\ingroup H5T \brief Locks a datatype \type_id- Returns:
- \herr_t \details H5Tlock() locks the datatype specified by the dtype_id identifier, making it read-only and 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.
-
H5Tcommit2
@Cast("herr_t") public static int H5Tcommit2(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer name, @Cast("hid_t") long type_id, @Cast("hid_t") long lcpl_id, @Cast("hid_t") long tcpl_id, @Cast("hid_t") long tapl_id)
\ingroup H5T \brief Commits a transient datatype, linking it into the file and creating a new committed datatype \fg_loc_id- Parameters:
name- [in] Name given to committed datatype \type_id Identifier of datatype to be committed and, upon functionâs return, identifier for the committed datatype \lcpl_id \tcpl_id \tapl_id- Returns:
- \herr_t \details H5Tcommit2() saves a transient datatype as an immutable committed datatype in a file. The datatype specified by \p dtype_id is committed to the file with the name name at the location specified by \p loc_id and with the datatype creation and access property lists \p tcpl_id and \p tapl_id, respectively. \p loc_id may be a file identifier, or a group identifier within that file. \p name may be either an absolute path in the file or a relative path from \p loc_id naming the newly-commited datatype. The link creation property list, \p lcpl_id, governs creation of the link(s) by which the new committed datatype is accessed and the creation of any intermediate groups that may be missing. Once committed, this datatype may be used to define the datatype of any other dataset or attribute in the file. This function will not accept a datatype that cannot actually hold information. This currently includes compound datatypes with no fields and enumerated datatypes with no members. Committed datatypes are sometimes referred to as named datatypes.
- Since:
- 1.8.0
-
H5Tcommit2
@Cast("herr_t") public static int H5Tcommit2(@Cast("hid_t") long loc_id, String name, @Cast("hid_t") long type_id, @Cast("hid_t") long lcpl_id, @Cast("hid_t") long tcpl_id, @Cast("hid_t") long tapl_id)
-
H5Tcommit_async
@Cast("herr_t") public static int H5Tcommit_async(@Cast("const char*") BytePointer app_file, @Cast("const char*") BytePointer app_func, @Cast("unsigned") int app_line, @Cast("hid_t") long loc_id, @Cast("const char*") BytePointer name, @Cast("hid_t") long type_id, @Cast("hid_t") long lcpl_id, @Cast("hid_t") long tcpl_id, @Cast("hid_t") long tapl_id, @Cast("hid_t") long es_id)
\ingroup H5T \brief Asynchronous version of H5Tcommit2().
-
H5Tcommit_async
@Cast("herr_t") public static int H5Tcommit_async(String app_file, String app_func, @Cast("unsigned") int app_line, @Cast("hid_t") long loc_id, String name, @Cast("hid_t") long type_id, @Cast("hid_t") long lcpl_id, @Cast("hid_t") long tcpl_id, @Cast("hid_t") long tapl_id, @Cast("hid_t") long es_id)
-
H5Topen2
@Cast("hid_t") public static long H5Topen2(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer name, @Cast("hid_t") long tapl_id)
-------------------------------------------------------------------------- \ingroup H5T \brief Opens a committed (named) datatype \fgdta_loc_id- Parameters:
name- [in] Name of the datatype to open \tapl_id- Returns:
- \hid_t{datatype} \details H5Topen2() opens a committed datatype at the location specified by \p loc_id and returns an identifier for the datatype. \p loc_id is either a file or group identifier. The identifier should eventually be closed by calling H5Tclose() to release resources. The committed datatype is opened with the datatype access property list tapl_id.
- Since:
- 1.8.0
-
H5Topen2
@Cast("hid_t") public static long H5Topen2(@Cast("hid_t") long loc_id, String name, @Cast("hid_t") long tapl_id)
-
H5Topen_async
@Cast("hid_t") public static long H5Topen_async(@Cast("const char*") BytePointer app_file, @Cast("const char*") BytePointer app_func, @Cast("unsigned") int app_line, @Cast("hid_t") long loc_id, @Cast("const char*") BytePointer name, @Cast("hid_t") long tapl_id, @Cast("hid_t") long es_id)
\ingroup H5T \brief Asynchronous version of H5Topen2().
-
H5Topen_async
@Cast("hid_t") public static long H5Topen_async(String app_file, String app_func, @Cast("unsigned") int app_line, @Cast("hid_t") long loc_id, String name, @Cast("hid_t") long tapl_id, @Cast("hid_t") long es_id)
-
H5Tcommit_anon
@Cast("herr_t") public static int H5Tcommit_anon(@Cast("hid_t") long loc_id, @Cast("hid_t") long type_id, @Cast("hid_t") long tcpl_id, @Cast("hid_t") long tapl_id)
\ingroup H5T \brief Commits a transient datatype to a file, creating a new named datatype, but does not link it into the file structure \fg_loc_id \type_id \tcpl_id \tapl_id- Returns:
- \herr_t \details H5Tcommit_anon() commits a transient datatype (not immutable) to a file, turning it into a named datatype with the specified creation and property lists. With default property lists, #H5P_DEFAULT, H5Tcommit_anon() provides similar functionality to that of H5Tcommit(), with the differences described below. #H5P_DEFAULT can be passed in for the datatype creation property list identifier, \p tcpl_id. The datatype access property list identifier, \p tapl_id, is provided for future functionality and is not used at this time. This parameter should always be passed as the value #H5P_DEFAULT. Note that H5Tcommit_anon() does not link this newly-committed datatype into the file. After the H5Tcommit_anon() call, the datatype identifier \p type_id must be linked into the HDF5 file structure with H5Olink() or it will be deleted from the file when the file is closed. The differences between this function and H5Tcommit() are as follows: \li H5Tcommit_anon() explicitly includes property lists, which provides for greater control of the creation process and of the properties of the new named datatype. H5Tcommit() always uses default properties. \li H5Tcommit_anon() neither provides the new named datatypeâs name nor links it into the HDF5 file structure; those actions must be performed separately through a call to H5Olink(), which offers greater control over linking. This function will not accept a datatype that cannot actually hold data. This currently includes compound datatypes with no fields and enumerated datatypes with no members.
- Since:
- 1.2.0
-
H5Tget_create_plist
@Cast("hid_t") public static long H5Tget_create_plist(@Cast("hid_t") long type_id)
\ingroup H5T \brief Returns a copy of a datatype's creation property list \type_id- Returns:
- \hid_t{datatype creation property list} \details H5Tget_create_plist() returns a property list identifier for the datatype creation property list associated with the datatype specified by \p type_id. The creation property list identifier should be released with H5Pclose() to prevent memory leaks.
- Since:
- 1.8.0
-
H5Tcommitted
@Cast("htri_t") public static int H5Tcommitted(@Cast("hid_t") long type_id)
\ingroup H5T \brief Determines whether a datatype is a committed type or a transient type \type_id- Returns:
- \htri_t \details H5Tcommitted() queries a type to determine whether the type specified by the \p dtype_id identifier is a committed (formerly known as a \Emph{named}) type or a transient type. If this function returns a positive value, then the type is committed (that is, it has been committed, perhaps by some other application). Datasets which return committed datatypes with H5Dget_type() are able to share the datatype with other datasets in the same file.
- Since:
- 1.6 or earlier
-
H5Tencode
@Cast("herr_t") public static int H5Tencode(@Cast("hid_t") long obj_id, Pointer buf, @Cast("size_t*") SizeTPointer nalloc)
\ingroup H5T \brief Encodes a datatype object description into a binary buffer- Parameters:
obj_id- [in] Identifier of the object to be encodedbuf- [in,out] Buffer for the object to be encoded into.nalloc- [in,out] IN: The size of the allocated buffer OUT: The size of the buffer needed- Returns:
- \herr_t \details H5Tencode() Given datatype identifier, H5Tencode() converts a datatype description into binary form in a buffer. Using this binary form in the buffer, a datatype object can be reconstructed using H5Tdecode() to return a new object handle (\ref hid_t) for this datatype. If the provided buffer is NULL, only the size of buffer needed is returned through \p nalloc. A preliminary H5Tencode() call can be made to find out the size of the buffer needed. This value is returned as \p nalloc. That value can then be assigned to \p nalloc for a second H5Tencode() call, which will retrieve the actual encoded object. If the library finds that \p nalloc is not big enough for the object, it simply returns the size of the buffer needed through \p nalloc without encoding the provided buffer.
- Since:
- 1.2.0
-
H5Tdecode
@Cast("hid_t") public static long H5Tdecode(@Const Pointer buf)
\ingroup H5T \brief Decodes a binary object description of datatype and return a new object handle- Parameters:
buf- [in] Buffer for the datatype object to be decoded- Returns:
- \hid_t{datatype} \details H5Tdecode() Given an object description of datatype in binary in a buffer, H5Tdecode() reconstructs the HDF5 datatype object and returns a new object handle for it. The binary description of the object is encoded by H5Tencode(). User is responsible for passing in the right buffer. The datatype identifier returned by this function can be released with H5Tclose() when the identifier is no longer needed so that resource leaks will not develop.
-
H5Tflush
@Cast("herr_t") public static int H5Tflush(@Cast("hid_t") long type_id)
\ingroup H5T \brief Flushes all buffers associated with a committed datatype to disk \type_id- Returns:
- \herr_t \details H5Tflush() causes all buffers associated with a committed datatype \p type_id to be immediately flushed to disk without removing the data from the cache. HDF5 does not possess full control over buffering. H5Tflush() flushes the internal HDF5 buffers and then asks the operating system (the OS) to flush the system buffers for the open files. After that, the OS is responsible for ensuring that the data is actually flushed to disk.
- Since:
- 1.10.0 C function introduced with this release.
- See Also:
H5Drefresh() H5Tflush() H5Grefresh() H5Oflush() H5Orefresh() H5Tflush() H5Trefresh() H5Fstart_swmr_write() H5Pget_append_flush() H5Pget_object_flush_cb() H5Pset_append_flush() H5Pset_object_flush_cb()
-
H5Trefresh
@Cast("herr_t") public static int H5Trefresh(@Cast("hid_t") long type_id)
\ingroup H5T \brief Refreshes all buffers associated with a committed datatype \type_id- Returns:
- \herr_t \details H5Trefresh() causes all buffers associated with a committed datatype to be cleared and immediately re-loaded with updated contents from disk. This function essentially closes the datatype, evicts all metadata associated with it from the cache, and then re-opens the datatype. The reopened datatype is automatically re-registered with the same identifier.
- Since:
- 1.2.0
-
H5Tinsert
@Cast("herr_t") public static int H5Tinsert(@Cast("hid_t") long parent_id, @Cast("const char*") BytePointer name, @Cast("size_t") long offset, @Cast("hid_t") long member_id)
\ingroup COMPOUND \brief Adds a new member to a compound datatype. \type_id{parent_id}- Parameters:
name- [in] Name of the field to insertoffset- [in] Offset in memory structure of the field to insertmember_id- [in] Datatype identifier of the field to insert- Returns:
- \herr_t \details H5Tinsert() adds another member to the compound datatype, specified \p type_id. The new member has a \p name which must be unique within the compound datatype. The \p offset argument defines the start of the member in an instance of the compound datatype, and \p member_id is the datatype identifier of the new member. \note Members of a compound datatype do not have to be atomic datatypes; a compound datatype can have a member which is a compound datatype.
- Since:
- 1.2.0
-
H5Tinsert
@Cast("herr_t") public static int H5Tinsert(@Cast("hid_t") long parent_id, String name, @Cast("size_t") long offset, @Cast("hid_t") long member_id)
-
H5Tpack
@Cast("herr_t") public static int H5Tpack(@Cast("hid_t") long type_id)
\ingroup COMPOUND \brief Recursively removes padding from within a compound datatype \type_id- Returns:
- \herr_t \details H5Tpack() recursively removes padding from within a compound datatype to make it more efficient (space-wise) to store that data.
- Since:
- 1.2.0
-
H5Tenum_create
@Cast("hid_t") public static long H5Tenum_create(@Cast("hid_t") long base_id)
\ingroup ENUM \brief Creates a new enumeration datatype- Parameters:
base_id- [in] Datatype identifier for the base datatype. Must be an integer datatype- Returns:
- \hid_t{enumeration datatype} \details H5Tenum_create() creates a new enumeration datatype based on the specified base datatype, dtype_id, which must be an integer datatype. If a particular architecture datatype is required, a little endian or big endian datatype for example, use a native datatype as the base datatype and use H5Tconvert() on values as they are read from or written to a dataset.
- Since:
- 1.2.0
-
H5Tenum_insert
@Cast("herr_t") public static int H5Tenum_insert(@Cast("hid_t") long type, @Cast("const char*") BytePointer name, @Const Pointer value)
\ingroup ENUM \brief Inserts a new enumeration datatype member \type_id{type}- Parameters:
name- [in] Name of the new membervalue- [in] Pointer to the value of the new member- Returns:
- \herr_t \details H5Tenum_insert() inserts a new enumeration datatype member into an enumeration datatype. \p type_id is the datatype identifier for the enumeration datatype, \p name is the name of the new member, and \p value points to the value of the new member. \p name and \p value must both be unique within \p dtype_id. \p value points to data which must be of the integer base datatype used when the enumeration datatype was created. If a particular architecture datatype is required, a little endian or big endian datatype for example, use a native datatype as the base datatype and use H5Tconvert() on values as they are read from or written to a dataset.
- Since:
- 1.2.0
-
H5Tenum_insert
@Cast("herr_t") public static int H5Tenum_insert(@Cast("hid_t") long type, String name, @Const Pointer value)
-
H5Tenum_nameof
@Cast("herr_t") public static int H5Tenum_nameof(@Cast("hid_t") long type, @Const Pointer value, @Cast("char*") BytePointer name, @Cast("size_t") long size)
\ingroup ENUM \brief Returns the symbol name corresponding to a specified member of an enumeration datatype \type_id{type}- Parameters:
value- [in] Value of the enumeration datatypename- [out] Buffer for output of the symbol namesize- [in] Anticipated size of the symbol name, in bytes- Returns:
- Returns a non-negative value if successful. Otherwise returns a negative value \details H5Tenum_nameof() finds the symbol name that corresponds to the specified \p value of the enumeration datatype \p type. At most \p size characters of the symbol \p name are copied into the \p name buffer. If the entire symbol name and null terminator do not fit in the name buffer, then as many characters as possible are copied (not null terminated) and the function fails.
- Since:
- 1.2.0
-
H5Tenum_nameof
@Cast("herr_t") public static int H5Tenum_nameof(@Cast("hid_t") long type, @Const Pointer value, @Cast("char*") ByteBuffer name, @Cast("size_t") long size)
-
H5Tenum_nameof
@Cast("herr_t") public static int H5Tenum_nameof(@Cast("hid_t") long type, @Const Pointer value, @Cast("char*") byte[] name, @Cast("size_t") long size)
-
H5Tenum_valueof
@Cast("herr_t") public static int H5Tenum_valueof(@Cast("hid_t") long type, @Cast("const char*") BytePointer name, Pointer value)
\ingroup ENUM \brief Returns the value corresponding to a specified member of an enumeration datatype \type_id{type}- Parameters:
name- [in] Symbol name of the enumeration datatypevalue- [out] Buffer for the value of the enumeration datatype- Returns:
- \herr_t \details H5Tenum_valueof() finds the value that corresponds to the specified name of the enumeration datatype \p dtype_id. Values returned in \p value will be of the enumerated typeâs base type, that is, the datatype used by H5Tenum_create() when the enumerated type was created. The \p value buffer must be at least large enough to hold a value of that base type. If the size is unknown, you can determine it with H5Tget_size().
- Since:
- 1.2.0
-
H5Tenum_valueof
@Cast("herr_t") public static int H5Tenum_valueof(@Cast("hid_t") long type, String name, Pointer value)
-
H5Tvlen_create
@Cast("hid_t") public static long H5Tvlen_create(@Cast("hid_t") long base_id)
\ingroup VLEN \brief Creates a new variable-length array datatype \type_id{base_id}, the element type of the datatype to create- Returns:
- \hid_t{variable-length datatype} \details H5Tvlen_create() creates a new one-dimensional array datatype of variable-length (VL) with the base datatype \p base_id. This one-dimensional array often represents a data sequence of the base datatype, such as characters for character sequences or vertex coordinates for polygon lists. The base type specified for the VL datatype can be any HDF5 datatype, including another VL datatype, a compound datatype, or an atomic datatype. When necessary, use H5Tget_super() to determine the base type of the VL datatype. The datatype identifier returned from this function should be released with H5Tclose() or resource leaks will result. Under certain circumstances, H5Dvlen_reclaim() must also be used. \attention H5Tvlen_create() cannot be used to create a variable-length string datatype. H5Tvlen_create() called with a string or character base type creates a variable-length sequence of strings (a variable-length, 1-dimensional array), with each element of the array being of the string or character base type.\n To create a variable-length string datatype, see \ref_vlen_strings.
-
H5Tarray_create2
@Cast("hid_t") public static long H5Tarray_create2(@Cast("hid_t") long base_id, @Cast("unsigned") int ndims, @Cast("const hsize_t*") LongPointer dim)
\ingroup ARRAY \brief Creates an array datatype object- Parameters:
base_id- [in] Datatype identifier for the array base datatypendims- [in] Rank of the arraydim- [in] Size of each array dimension- Returns:
- \hid_t{array datatype} \details H5Tarray_create2() creates a new array datatype object.\n\n \p base_id is the datatype of every element of the array, i.e., of the number at each position in the array. \p ndims is the number of dimensions and the size of each dimension is specified in the array \p dim. The value of \p rank is currently limited to #H5S_MAX_RANK and must be greater than 0 (zero). All dimension sizes specified in \p dim must be greater than 0 (zero).
- Since:
- 1.8.0
-
H5Tarray_create2
@Cast("hid_t") public static long H5Tarray_create2(@Cast("hid_t") long base_id, @Cast("unsigned") int ndims, @Cast("const hsize_t*") LongBuffer dim)
-
H5Tarray_create2
@Cast("hid_t") public static long H5Tarray_create2(@Cast("hid_t") long base_id, @Cast("unsigned") int ndims, @Cast("const hsize_t*") long... dim)
-
H5Tget_array_ndims
public static int H5Tget_array_ndims(@Cast("hid_t") long type_id)
\ingroup ARRAY \brief Returns the rank of an array datatype \type_id- Returns:
- Returns the rank of the array if successful; otherwise returns a negative value. \details H5Tget_array_ndims() returns the rank, i.e., the number of dimensions, of an array datatype object.
- Since:
- 1.2.0
-
H5Tget_array_dims2
public static int H5Tget_array_dims2(@Cast("hid_t") long type_id, @Cast("hsize_t*") LongPointer dims)
\ingroup ARRAY \brief Retrieves sizes of array dimensions \type_id- Parameters:
dims- [out] Sizes of array dimensions- Returns:
- Returns the non-negative number of dimensions of the array type if successful; otherwise returns a negative value. \details H5Tget_array_dims2() returns the sizes of the dimensions of the specified array datatype object in the array \p dims.
- Since:
- 1.2.0
-
H5Tget_array_dims2
public static int H5Tget_array_dims2(@Cast("hid_t") long type_id, @Cast("hsize_t*") LongBuffer dims)
-
H5Tget_array_dims2
public static int H5Tget_array_dims2(@Cast("hid_t") long type_id, @Cast("hsize_t*") long... dims)
-
H5Tset_tag
@Cast("herr_t") public static int H5Tset_tag(@Cast("hid_t") long type, @Cast("const char*") BytePointer tag)
\ingroup OPAQUE \brief Tags an opaque datatype \type_id{type} of an opaque datatype- Parameters:
tag- [in] Descriptive ASCII string with which the opaque datatype is to be tagged- Returns:
- \herr_t \details H5Tset_tag() tags an opaque datatype \p type with a descriptive ASCII identifier, \p tag. \p tag is intended to provide a concise description; the maximum size is hard-coded in the HDF5 library as 256 bytes (#H5T_OPAQUE_TAG_MAX).
-
H5Tget_tag
@Cast("char*") public static BytePointer H5Tget_tag(@Cast("hid_t") long type)
\ingroup OPAQUE \brief Gets the tag associated with an opaque datatype \type_id{type} of an opaque datatype- Returns:
- Returns a pointer to an allocated string if successful; otherwise returns NULL. \details H5Tget_tag() returns the tag associated with the opaque datatype \p type. \attention The tag is returned via a pointer to an allocated string, which the caller must free.
-
H5Tget_super
@Cast("hid_t") public static long H5Tget_super(@Cast("hid_t") long type)
\ingroup H5T \brief Returns the base datatype from which a datatype is derived \type_id{type}- Returns:
- \hid_t{datatype} \details H5Tget_super() returns the base datatype from which the datatype \p type_id is derived. In the case of an enumeration type, the return value is an integer type. The datatype identifier returned by this function must be released with H5Tclose() when the identifier is no longer needed so that resource leaks will not develop.
-
H5Tget_class
@Cast("H5T_class_t") public static int H5Tget_class(@Cast("hid_t") long type_id)
\ingroup H5T \brief Returns a datatype class \type_id- Returns:
- Returns the datatype class if successful; otherwise #H5T_NO_CLASS. \details H5Tget_class() returns the class of the datatype \p type_id. Valid class identifiers, as defined in H5Tpublic.h, are: \snippet this H5T_class_t_snip \note The library returns #H5T_STRING for both fixed-length and variable-length strings. \note Unsupported datatype: The time datatype class, #H5T_TIME, is not supported. If #H5T_TIME is used, the resulting data will be readable and modifiable only on the originating computing platform; it will not be portable to other platforms.
-
H5Tdetect_class
@Cast("htri_t") public static int H5Tdetect_class(@Cast("hid_t") long type_id, @Cast("H5T_class_t") int cls)
\ingroup H5T \brief Determines whether a datatype contains any datatypes of the given datatype class \type_id- Parameters:
cls- [in] Datatype class- Returns:
- \htri_t \details H5Tdetect_class() determines whether the datatype specified in \p type_id contains any datatypes of the datatype class specified in \p dtype_class. This function is useful primarily in recursively examining all the fields and/or base types of compound, array, and variable-length datatypes. Valid class identifiers, as defined in H5Tpublic.h, are: \snippet this H5T_class_t_snip
- Since:
- 1.6.0
-
H5Tget_size
@Cast("size_t") public static long H5Tget_size(@Cast("hid_t") long type_id)
\ingroup H5T \brief Returns the size of a datatype \type_id- Returns:
- Returns the size of the datatype in bytes if successful; otherwise, returns 0. \details H5Tget_size() returns the size of a datatype in bytes. \li For atomic datatypes, array datatypes, compound datatypes, and other datatypes of a constant size, the returned value is the size of the actual datatype in bytes. \li For variable-length string datatypes the returned value is the size of the pointer to the actual string, or \c sizeof(\c char \c *). This function does not return the size of actual variable-length string data. \li For variable-length sequence datatypes (see H5Tvlen_create()), the returned value is the size of the \p hvl_t struct, or \c sizeof(\p hvl_t). The \p hvl_t struct contains a pointer to the actual data and a size value. This function does not return the size of actual variable-length sequence data.
- Since:
- 1.2.0
- See Also:
H5Tset_size()
-
H5Tget_order
@Cast("H5T_order_t") public static int H5Tget_order(@Cast("hid_t") long type_id)
\ingroup ATOM \brief Returns the byte order of an atomic datatype \type_id- Returns:
- Returns a byte order constant if successful; otherwise returns #H5T_ORDER_ERROR (-1) \details H5Tget_order() returns the byte order of an atomic datatype. Possible return values are: \snippet this H5T_order_t_snip Members of a compound datatype need not have the same byte order. If members of a compound datatype have more than one of little endian, big endian, or VAX byte order, H5Tget_order() will return #H5T_ORDER_MIXED for the compound datatype. A byte order of #H5T_ORDER_NONE will, however, be ignored; for example, if one or more members of a compound datatype have byte order #H5T_ORDER_NONE but all other members have byte order #H5T_ORDER_LE, H5Tget_order() will return #H5T_ORDER_LE for the compound datatype.
- Since:
- 1.2.0
-
H5Tget_precision
@Cast("size_t") public static long H5Tget_precision(@Cast("hid_t") long type_id)
\ingroup ATOM \brief Returns the precision of an atomic datatype \type_id- Returns:
- Returns the number of significant bits if successful; otherwise 0 \details H5Tget_precision() returns the precision of an atomic datatype (for example, integer or float) or a datatype whose base (parent) type is an atomic type (for example, array, enum and variable length). The precision is the number of significant bits which, unless padding is present, is 8 times larger than the value returned by H5Tget_size().
- Since:
- 1.2.0
-
H5Tget_offset
public static int H5Tget_offset(@Cast("hid_t") long type_id)
\ingroup ATOM \brief Retrieves the bit offset of the first significant bit \type_id- Returns:
- Returns an offset value if successful; otherwise returns a
negative value.
\details H5Tget_offset() retrieves the bit offset of the first significant
bit. 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 laid out in memory as (from small byte address toward
larger byte addresses):
{.unparsed} 0: [ pad] [0x11] [0x22] [ pad] 1: [ pad] [0x22] [0x11] [ pad] 2: [0x11] [ pad] [ pad] [0x22] 3: [0x22] [ pad] [ pad] [0x11] - Since:
- 1.2.0
-
H5Tget_pad
@Cast("herr_t") public static int H5Tget_pad(@Cast("hid_t") long type_id, @Cast("H5T_pad_t*") IntPointer lsb, @Cast("H5T_pad_t*") IntPointer msb)
\ingroup ATOM \brief Retrieves the padding type of the least and most-significant bit padding \type_id- Parameters:
lsb- [out] Buffer for the least-significant bit padding typemsb- [out] Buffer for the most-significant bit padding type- Returns:
- \herr_t \details H5Tget_pad() retrieves the padding type of the least and most-significant bit padding. Valid padding types are: \snippet this H5T_pad_t_snip
- Since:
- 1.2.0
-
H5Tget_pad
@Cast("herr_t") public static int H5Tget_pad(@Cast("hid_t") long type_id, @Cast("H5T_pad_t*") IntBuffer lsb, @Cast("H5T_pad_t*") IntBuffer msb)
-
H5Tget_pad
@Cast("herr_t") public static int H5Tget_pad(@Cast("hid_t") long type_id, @Cast("H5T_pad_t*") int[] lsb, @Cast("H5T_pad_t*") int[] msb)
-
H5Tget_sign
@Cast("H5T_sign_t") public static int H5Tget_sign(@Cast("hid_t") long type_id)
\ingroup ATOM \brief Retrieves the sign type for an integer type \type_id- Returns:
- Returns a valid sign type if successful; otherwise #H5T_SGN_ERROR (-1) \details H5Tget_sign() retrieves the sign type for an integer type. Valid types are: \snippet this H5T_sign_t_snip
- Since:
- 1.2.0
-
H5Tget_fields
@Cast("herr_t") public static int H5Tget_fields(@Cast("hid_t") long type_id, @Cast("size_t*") SizeTPointer spos, @Cast("size_t*") SizeTPointer epos, @Cast("size_t*") SizeTPointer esize, @Cast("size_t*") SizeTPointer mpos, @Cast("size_t*") SizeTPointer msize)
\ingroup ATOM \brief Retrieves floating point datatype bit field information \type_id- Parameters:
spos- [out] Pointer to location to return floating-point sign bitepos- [out] Pointer to location to return exponent bit-positionesize- [out] Pointer to location to return size of exponent in bitsmpos- [out] Pointer to location to return mantissa bit-positionmsize- [out] Pointer to location to return size of mantissa in bits- Returns:
- \herr_t \details H5Tget_fields() retrieves information about the locations of the various bit fields of a floating point datatype. The field positions are bit positions in the significant region of the datatype. Bits are numbered with the least significant bit number zero. Any (or even all) of the arguments can be null pointers.
- Since:
- 1.2.0
-
H5Tget_ebias
@Cast("size_t") public static long H5Tget_ebias(@Cast("hid_t") long type_id)
\ingroup ATOM \brief Retrieves the exponent bias of a floating-point type \type_id- Returns:
- Returns the bias if successful and 0, otherwise. \details H5Tget_ebias() retrieves the exponent bias of a floating-point type.
- Since:
- 1.2.0
-
H5Tget_norm
@Cast("H5T_norm_t") public static int H5Tget_norm(@Cast("hid_t") long type_id)
-------------------------------------------------------------------------- \ingroup ATOM \brief Retrieves mantissa normalization of a floating-point datatype \type_id- Returns:
- Returns a valid normalization type if successful; otherwise returns #H5T_NORM_ERROR (-1) \details H5Tget_norm() retrieves the mantissa normalization of a floating-point datatype. Valid normalization types are: \snippet this H5T_norm_t_snip
- Since:
- 1.2.0
-
H5Tget_inpad
@Cast("H5T_pad_t") public static int H5Tget_inpad(@Cast("hid_t") long type_id)
\ingroup ATOM \brief Retrieves the internal padding type for unused bits in floating-point datatypes \type_id- Returns:
- Returns a valid padding type if successful; otherwise returns #H5T_PAD_ERROR (-1). \details H5Tget_inpad() retrieves the internal padding type for unused bits in floating-point datatypes. Valid padding types are: \snippet this H5T_pad_t_snip
- Since:
- 1.2.0
-
H5Tget_strpad
@Cast("H5T_str_t") public static int H5Tget_strpad(@Cast("hid_t") long type_id)
\ingroup ATOM \brief Retrieves the type of padding used for a string datatype \type_id- Returns:
- Returns a valid string of the padding if successful; otherwise returns #H5T_STR_ERROR (-1) \details H5Tget_strpad() retrieves the type of padding used for a string datatype. The string padding type is set with H5Tset_strpad(). Possible values returned are: \str_pad_type
- Since:
- 1.2.0
-
H5Tget_nmembers
public static int H5Tget_nmembers(@Cast("hid_t") long type_id)
\ingroup COMPENUM \brief Retrieves the number of elements in a compound or enumeration datatype \type_id- Returns:
- Returns the number of elements if successful; otherwise returns a negative value. \details H5Tget_nmembers() retrieves the number of fields in a compound datatype or the number of members of an enumeration datatype.
- Since:
- 1.2.0
-
H5Tget_member_name
@Cast("char*") public static BytePointer H5Tget_member_name(@Cast("hid_t") long type_id, @Cast("unsigned") int membno)
\ingroup COMPENUM \brief Retrieves the name of a compound or enumeration datatype member \type_id- Parameters:
membno- [in] Zero-based index of the field or element- Returns:
- Returns a valid pointer to a string allocated with malloc() if successful; otherwise returns NULL. \details H5Tget_member_name() retrieves the name of a field of a compound datatype or an element of an enumeration datatype. The index of the target field or element is specified in \p member_no. Compound datatype fields and enumeration datatype elements are stored in no particular order with index values of 0 through N-1, where N is the value returned by H5Tget_nmembers(). The HDF5 library allocates a buffer to receive the name of the field. The caller must subsequently free the buffer with H5free_memory().
- Since:
- 1.2.0
-
H5Tget_member_index
public static int H5Tget_member_index(@Cast("hid_t") long type_id, @Cast("const char*") BytePointer name)
\ingroup COMPENUM \brief Retrieves the index of a compound or enumeration datatype member \type_id- Parameters:
name- [in] Name of the field or member- Returns:
- \herr_t \details H5Tget_member_index() retrieves the index of a field of a compound datatype or an element of an enumeration datatype. The name of the target field or element is specified by \p name. Fields are stored in no particular order with index values of 0 through N-1, where N is the value returned by H5Tget_nmembers() .
- Since:
- 1.2.0
-
H5Tget_member_index
public static int H5Tget_member_index(@Cast("hid_t") long type_id, String name)
-
H5Tget_member_offset
@Cast("size_t") public static long H5Tget_member_offset(@Cast("hid_t") long type_id, @Cast("unsigned") int membno)
\ingroup COMPOUND \brief Retrieves the offset of a field of a compound datatype \type_id- Parameters:
membno- [in] Zero-based index of the field or element- Returns:
- Returns the byte offset of the field if successful; otherwise returns 0 (zero). \details H5Tget_member_offset() retrieves the byte offset of the beginning of a field within a compound datatype with respect to the beginning of the compound datatype datum. Note that zero is a valid offset and that this function will fail only if a call to H5Tget_member_class() fails with the same arguments.
- Since:
- 1.2.0
-
H5Tget_member_class
@Cast("H5T_class_t") public static int H5Tget_member_class(@Cast("hid_t") long type_id, @Cast("unsigned") int membno)
\ingroup COMPOUND \brief Returns datatype class of compound datatype member \type_id- Parameters:
membno- [in] Zero-based index of the field or element- Returns:
- Returns the datatype class, a non-negative value, if successful; otherwise returns a negative value. \details Given a compound datatype, \p dtype_id, H5Tget_member_class() returns the datatype class of the member specified by \p member_no. Valid class identifiers, as defined in H5Tpublic.h, are: \snippet this H5T_class_t_snip
- Since:
- 1.2.0
-
H5Tget_member_type
@Cast("hid_t") public static long H5Tget_member_type(@Cast("hid_t") long type_id, @Cast("unsigned") int membno)
\ingroup COMPOUND \brief Returns the datatype of the specified member \type_id- Parameters:
membno- [in] Zero-based index of the field or element- Returns:
- Returns the identifier of a copy of the datatype of the field if successful; otherwise returns a negative value. \details H5Tget_member_type() returns the datatype of the specified member. The caller should invoke H5Tclose() to release resources associated with the type.
- Since:
- 1.2.0
-
H5Tget_member_value
@Cast("herr_t") public static int H5Tget_member_value(@Cast("hid_t") long type_id, @Cast("unsigned") int membno, Pointer value)
\ingroup ENUM \brief Returns the value of an enumeration datatype member \type_id- Parameters:
membno- [in] Number of the enumeration datatype membervalue- [out] Buffer for the value of the enumeration datatype member- Returns:
- \herr_t \details H5Tget_member_value() returns the value of the enumeration datatype member \p member_no. The member value is returned in a user-supplied buffer pointed to by \p value. Values returned in \p value will be of the enumerated typeâs base type, that is, the datatype used by H5Tenum_create() when the enumerated type was created. The value buffer must be at least large enough to hold a value of that base type. If the size is unknown, you can determine it with H5Tget_size().
- Since:
- 1.2.0
-
H5Tget_cset
@Cast("H5T_cset_t") public static int H5Tget_cset(@Cast("hid_t") long type_id)
\ingroup ATOM \brief Retrieves the character set type of a string datatype \type_id- Returns:
- Returns a valid character set type if successful; otherwise #H5T_CSET_ERROR (-1). \details H5Tget_cset() retrieves the character set type of a string datatype. Valid character set types are: \csets
- Since:
- 1.2.0
-
H5Tis_variable_str
@Cast("htri_t") public static int H5Tis_variable_str(@Cast("hid_t") long type_id)
\ingroup ATOM \brief Determines whether datatype is a variable-length string \type_id- Returns:
- Returns: \li a positive value if the specified datatype is a variable-length string \li 0 if the specified datatype is not a variable-length string \li a negative value when the function fails \details H5Tis_variable_str() determines whether the datatype identified by \p dtype_id is a variable-length string. This function can be used to distinguish between fixed and variable-length string datatypes.
- Since:
- 1.6.0
-
H5Tget_native_type
@Cast("hid_t") public static long H5Tget_native_type(@Cast("hid_t") long type_id, @Cast("H5T_direction_t") int direction)
\ingroup H5T \brief Returns the native datatype identifier of a specified datatype \type_id- Parameters:
direction- [in] Direction of search- Returns:
- \hid_t{native datatype} \details H5Tget_native_type() returns the equivalent native datatype identifier for the datatype specified by \p type_id. H5Tget_native_type() is 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. This function can be used for the following purposes: \li To determine the native datatype of an atomic datatype \li To determine the base datatype of an array, enumerated, or variable-length datatype \li To determine the native atomic datatypes of the individual components of a compound datatype For example, if \p type_id is a compound datatype, the returned datatype identifier will be for a similar compound datatype with each element converted to the corresponding native datatype; nested compound datatypes will be unwound. If \p type_id is an array, the returned datatype identifier will be for the native datatype of a single array element. H5Tget_native_type() selects the first matching native datatype from the following list: \li #H5T_NATIVE_CHAR \li #H5T_NATIVE_SHORT \li #H5T_NATIVE_INT \li #H5T_NATIVE_LONG \li #H5T_NATIVE_LLONG \li #H5T_NATIVE_UCHAR \li #H5T_NATIVE_USHORT \li #H5T_NATIVE_UINT \li #H5T_NATIVE_ULONG \li #H5T_NATIVE_ULLONG \li #H5T_NATIVE_FLOAT \li #H5T_NATIVE_DOUBLE \li #H5T_NATIVE_LDOUBLE \li #H5T_NATIVE_B8 \li #H5T_NATIVE_B16 \li #H5T_NATIVE_B32 \li #H5T_NATIVE_B64 The direction parameter indicates the order in which the library searches for a native datatype match. Valid values for direction are as follows: \snippet this H5T_direction_t_snip H5Tget_native_type() is designed primarily for use with integer, floating point, and bitfield datatypes. String, time, opaque, and reference datatypes are returned as a copy of dtype_id. See above for compound, array, enumerated, and variable-length datatypes. The identifier returned by H5Tget_native_type() should eventually be closed by calling H5Tclose() to release resources. \note Please note that a datatype is actually an object identifier or handle returned from opening the datatype. It is not persistent and its value can be different from one HDF5 session to the next. \note H5Tequal() can be used to compare datatypes. \note HDF5 High Level APIs that may also be of interest are: H5LTdtype_to_text() creates a text description of a datatype. H5LTtext_to_dtype() creates an HDF5 datatype given a text description.
- Since:
- 1.6.0
-
H5Tset_size
@Cast("herr_t") public static int H5Tset_size(@Cast("hid_t") long type_id, @Cast("size_t") long size)
\ingroup H5T \brief Sets size for a datatype. \type_id- Parameters:
size- [in] New datatype size is bytes or #H5T_VARIABLE- Returns:
- \herr_t \details H5Tset_size() sets the total size, \p size, in bytes, for a datatype. \p size must have a positive value, unless it is passed in as #H5T_VARIABLE and the datatype is a string datatype. \li Numeric datatypes: If the datatype is atomic and the size is decreased so that significant bits of the datatype extend beyond the edge of the new size, then the offset property of the datatype is decreased toward zero. If the offset becomes zero and the significant bits of the datatype still hang over the edge of the new size, then the number of significant bits is decreased. \li String or character datatypes: The size set for a string datatype should include space for the null-terminator character, otherwise it will not be stored on (or retrieved from) disk. Adjusting the size of a string automatically sets the precision to \p 8*size. \li Variable-length string datatypes: If \p dtype_id is a variable-length string, size must normally be set to #H5T_VARIABLE. See \ref_vlen_strings. \li Compound datatypes: This function may be used to increase or decrease the size of a compound datatype, but the function will fail if the new size is too small to accommodate all member fields. \li Ineligible datatypes: This function cannot be used with enumerated datatypes (#H5T_ENUM), array datatypes (#H5T_ARRAY), variable-length array datatypes (#H5T_VLEN), or reference datatypes (#H5T_REFERENCE).
- Since:
- 1.2.0
- See Also:
H5Tget_size()
-
H5Tset_order
@Cast("herr_t") public static int H5Tset_order(@Cast("hid_t") long type_id, @Cast("H5T_order_t") int order)
\ingroup ATOM \brief Sets the byte order of a datatype \type_id- Parameters:
order- [in] Byte order constant- Returns:
- \herr_t \details H5Tset_order() sets the byte order of a datatype.\n Byte order can currently be set to any of the following: \snippet this H5T_order_t_snip #H5T_ORDER_MIXED (3) is a valid value for order only when returned by the function H5Tget_order(); it cannot be set with H5Tset_order(). #H5T_ORDER_NONE (4) is a valid value for order, but it has no effect. It is valid only for fixed-length strings and object and region references and specifies âno particular order.â The byte order of a derived datatype is initially the same as that of the parent type, but can be changed with H5Tset_order(). This function cannot be used with a datatype after it has been committed. \note Special considerations: \li ENUM datatypes: Byte order must be set before any member on an ENUM is defined. \li Compound datatypes: Byte order is set individually on each member of a compound datatype; members of a compound datatype need not have the same byte order. \li Opaque datatypes: Byte order can be set but has no effect.
- Since:
- 1.2.0
-
H5Tset_precision
@Cast("herr_t") public static int H5Tset_precision(@Cast("hid_t") long type_id, @Cast("size_t") long prec)
\ingroup ATOM \brief Sets the precision of an atomic datatype \type_id- Parameters:
prec- [in] Number of bits of precision for datatype- Returns:
- \herr_t \details H5Tset_precision() sets the precision of an atomic datatype. The precision is the number of significant bits which, unless padding is present, is 8 times larger than the value returned by H5Tget_size(). If the precision is increased then the offset is decreased and then the size is increased to insure that significant bits do not "hang over" the edge of the datatype. Changing the precision of an #H5T_STRING automatically changes the size as well. The precision must be a multiple of 8. When decreasing the precision of a floating point type, set the locations and sizes of the sign, mantissa, and exponent fields first.
- Since:
- 1.2.0
-
H5Tset_offset
@Cast("herr_t") public static int H5Tset_offset(@Cast("hid_t") long type_id, @Cast("size_t") long offset)
\ingroup ATOM \brief Sets the bit offset of the first significant bit \type_id- Parameters:
offset- [in] Offset of first significant bit- Returns:
- \herr_t
\details H5Tset_offset() sets the bit offset of the first significant
bit. 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 laid out in memory as (from small
byte address toward larger byte addresses):
If the offset is incremented then the total size is incremented also if necessary to prevent significant bits of the value from hanging over the edge of the datatype. The offset of an #H5T_STRING cannot be set to anything but zero.{.unparsed} 0: [ pad] [0x11] [0x22] [ pad] 1: [ pad] [0x22] [0x11] [ pad] 2: [0x11] [ pad] [ pad] [0x22] 3: [0x22] [ pad] [ pad] [0x11] - Since:
- 1.2.0
-
H5Tset_pad
@Cast("herr_t") public static int H5Tset_pad(@Cast("hid_t") long type_id, @Cast("H5T_pad_t") int lsb, @Cast("H5T_pad_t") int msb)
\ingroup ATOM \brief Sets the least and most-significant bits padding types \type_id- Parameters:
lsb- [in] Padding type for least-significant bitsmsb- [in] Padding type for most-significant bits- Returns:
- \herr_t \details H5Tset_pad() sets the least and most-significant bits padding types. Available values are: \padding_type
- Since:
- 1.2.0
-
H5Tset_sign
@Cast("herr_t") public static int H5Tset_sign(@Cast("hid_t") long type_id, @Cast("H5T_sign_t") int sign)
\ingroup ATOM \brief Sets the sign property for an integer type \type_id- Parameters:
sign- [in] Sign type- Returns:
- \herr_t \details H5Tset_sign() sets the sign property for an integer type: \sign_prop
- Since:
- 1.2.0
-
H5Tset_fields
@Cast("herr_t") public static int H5Tset_fields(@Cast("hid_t") long type_id, @Cast("size_t") long spos, @Cast("size_t") long epos, @Cast("size_t") long esize, @Cast("size_t") long mpos, @Cast("size_t") long msize)
\ingroup ATOM \brief Sets locations and sizes of floating point bit fields \type_id- Parameters:
spos- [in] Sign position, i.e., the bit offset of the floating-point sign bitepos- [in] Exponent bit positionesize- [in] Size of exponent in bitsmpos- [in] Mantissa bit positionmsize- [in] Size of mantissa in bits- Returns:
- \herr_t \details H5Tset_fields() sets the locations and sizes of the various floating-point bit fields. The field positions are bit positions in the significant region of the datatype. Bits are numbered with the least significant bit number zero. Fields are not allowed to extend beyond the number of bits of precision, nor are they allowed to overlap with one another.
- Since:
- 1.2.0
-
H5Tset_ebias
@Cast("herr_t") public static int H5Tset_ebias(@Cast("hid_t") long type_id, @Cast("size_t") long ebias)
\ingroup ATOM \brief Sets the exponent bias of a floating-point type \type_id- Parameters:
ebias- [in] Exponent bias value- Returns:
- \herr_t \details H5Tset_ebias() sets the exponent bias of a floating-point type.
- Since:
- 1.2.0
-
H5Tset_norm
@Cast("herr_t") public static int H5Tset_norm(@Cast("hid_t") long type_id, @Cast("H5T_norm_t") int norm)
\ingroup ATOM \brief Sets the mantissa normalization of a floating-point datatype \type_id- Parameters:
norm- [in] Mantissa normalization type- Returns:
- \herr_t \details H5Tset_norm() sets the mantissa normalization of a floating-point datatype. Valid normalization types are: \snippet this H5T_norm_t_snip
- Since:
- 1.2.0
-
H5Tset_inpad
@Cast("herr_t") public static int H5Tset_inpad(@Cast("hid_t") long type_id, @Cast("H5T_pad_t") int pad)
\ingroup ATOM \brief Fills unused internal floating-point bits \type_id- Parameters:
pad- [in] Padding type- Returns:
- \herr_t \details H5Tset_inpad() If any internal bits of a floating point-type are unused (that is, those significant bits which are not part of the sign, exponent, or mantissa), then H5Tset_inpad() will be filled according to the value of the padding value property inpad. Valid padding types are: \snippet this H5T_pad_t_snip
- Since:
- 1.2.0
-
H5Tset_cset
@Cast("herr_t") public static int H5Tset_cset(@Cast("hid_t") long type_id, @Cast("H5T_cset_t") int cset)
\ingroup ATOM \brief Sets character set to be used in a string or character datatype \type_id- Parameters:
cset- [in] Character set type- Returns:
- \herr_t \details H5Tset_cset() sets the character set to be used in a dataset with a string or character datatype. Valid values for cset include the following: \csets For example, if the character set for the datatype \p type_id is set to #H5T_CSET_UTF8, string or character data of datatype dtype_id will be encoded using the UTF-8 Unicode character set. ASCII and UTF-8 Unicode are the only currently supported character encodings. Extended ASCII encodings (for example, ISO 8859) are not supported. This encoding policy is not enforced by the HDF5 library. Using encodings other than ASCII and UTF-8 can lead to compatibility and usability problems. Note that H5Tset_cset() sets the character set for a character or string datatype while H5Pset_char_encoding() sets the character set used for an HDF5 link or attribute name.
- Since:
- 1.2.0
-
H5Tset_strpad
@Cast("herr_t") public static int H5Tset_strpad(@Cast("hid_t") long type_id, @Cast("H5T_str_t") int strpad)
\ingroup ATOM \brief Defines the type of padding used for character strings \type_id- Parameters:
strpad- [in] String padding type- Returns:
- \herr_t \details H5Tset_strpad() defines the type of padding used for a string datatype. The method used to store character strings differs with the programming language. C usually null terminates strings while Fortran left-justifies and space-pads strings. Valid values of \p strpad are as follows: \str_pad_type When converting from a longer string to a shorter string, the behavior is as follows. If the shorter string is #H5T_STR_NULLPAD or #H5T_STR_SPACEPAD, then the string is simply truncated. If the short string is #H5T_STR_NULLTERM, it is truncated and a null terminator is appended. When converting from a shorter string to a longer string, the longer string is padded on the end by appending nulls or spaces.
- Since:
- 1.2.0
-
H5Tconvert
@Cast("herr_t") public static int H5Tconvert(@Cast("hid_t") long src_id, @Cast("hid_t") long dst_id, @Cast("size_t") long nelmts, Pointer buf, Pointer background, @Cast("hid_t") long plist_id)
-------------------------------------------------------------------------- \ingroup CONV \brief Converts data from one specified datatype to another \type_id{src_id} of source datatype \type_id{dst_id} of destination datatype- Parameters:
nelmts- [in] Size of array \p bufbuf- [in,out] Array containing pre- and post-conversion valuesbackground- [in] Optional background buffer \dxpl_id{plist_id}- Returns:
- \herr_t \details H5Tconvert() converts \p nelmts elements from a source datatype, specified by \p src_id, to a destination datatype, \p dst_id. The source elements are packed in \p buf and on return the destination elements will be packed in \p buf. That is, the conversion is performed in place. The optional background buffer is for use with compound datatypes. It is an array of \p nelmts values for the destination datatype which can then be merged with the converted values to recreate the compound datatype. For instance, background might be an array of structs with the \c a and \c b fields already initialized and the conversion of buf supplies the \c c and \c d field values. The parameter \p plist_id contains the dataset transfer property list identifier which is passed to the conversion functions. As of Release 1.2, this parameter is only used to pass along the variable-length datatype custom allocation information. \note H5Tconvert() will not resize the buffer \p buf; it must be large enough to hold the larger of the input and output data.
-
H5Treclaim
@Cast("herr_t") public static int H5Treclaim(@Cast("hid_t") long type_id, @Cast("hid_t") long space_id, @Cast("hid_t") long plist_id, Pointer buf)
\ingroup VLEN \brief Reclaims the variable length (VL) datatype memory buffers \type_id \space_id \dxpl_id{plist_id} used to create the buffer- Parameters:
buf- [in] Pointer to the buffer to be reclaimed- Returns:
- \herr_t \details H5Treclaim() reclaims memory buffers created to store VL datatypes. It only frees the variable length data in the selection defined in the dataspace specified by \p space_id. The dataset transfer property list \p plist_id is required to find the correct allocation and/or free methods for the variable-length data in the buffer.
- Since:
- 1.12.0
-
H5L_MAX_LINK_NAME_LEN
@MemberGetter public static int H5L_MAX_LINK_NAME_LEN()
\brief Maximum length of a link's name The maximum length of a link's name is encoded in a 32-bit unsigned integer.
-
H5L_SAME_LOC
@MemberGetter public static int H5L_SAME_LOC()
\brief Macro to indicate operation occurs on same location
-
H5Lmove
@Cast("herr_t") public static int H5Lmove(@Cast("hid_t") long src_loc, @Cast("const char*") BytePointer src_name, @Cast("hid_t") long dst_loc, @Cast("const char*") BytePointer dst_name, @Cast("hid_t") long lcpl_id, @Cast("hid_t") long lapl_id)
\ingroup H5L \brief Moves a link within an HDF5 file \fgdta_loc_id{src_loc}- Parameters:
src_name- [in] Original link name \fgdta_loc_id{dst_loc}dst_name- [in] New link name \lcpl_id \lapl_id- Returns:
- \herr_t \details H5Lmove() moves a link within an HDF5 file. The original link, \p src_name, is removed from \p src_loc and the new link, \p dst_name, is inserted at dst_loc. This change is accomplished as an atomic operation. \p src_loc and \p src_name identify the original link. \p src_loc is the original location identifier; \p src_name is the path to the link and is interpreted relative to \p src_loc. \p dst_loc and \p dst_name identify the new link. \p dst_loc is either a file or group identifier; \p dst_name is the path to the link and is interpreted relative to \p dst_loc. \p lcpl_id and \p lapl_id are the link creation and link access property lists, respectively, associated with the new link, \p dst_name. Through these property lists, several properties are available to govern the behavior of H5Lmove(). The property controlling creation of missing intermediate groups is set in the link creation property list with H5Pset_create_intermediate_group(); H5Lmove() ignores any other properties in the link creation property list. Properties controlling character encoding, link traversals, and external link prefixes are set in the link access property list with H5Pset_char_encoding(), H5Pset_nlinks(), and H5Pset_elink_prefix(), respectively. \note Note that H5Lmove() does not modify the value of the link; the new link points to the same object as the original link pointed to. Furthermore, if the object pointed to by the original link was already open with a valid object identifier, that identifier will remain valid after the call to H5Lmove(). \attention Exercise care in moving links as it is possible to render data in a file inaccessible with H5Lmove(). If the link being moved is on the only path leading to an HDF5 object, that object may become permanently inaccessible in the file.
- Since:
- 1.8.0 -------------------------------------------------------------------------
-
H5Lmove
@Cast("herr_t") public static int H5Lmove(@Cast("hid_t") long src_loc, String src_name, @Cast("hid_t") long dst_loc, String dst_name, @Cast("hid_t") long lcpl_id, @Cast("hid_t") long lapl_id)
-
H5Lcopy
@Cast("herr_t") public static int H5Lcopy(@Cast("hid_t") long src_loc, @Cast("const char*") BytePointer src_name, @Cast("hid_t") long dst_loc, @Cast("const char*") BytePointer dst_name, @Cast("hid_t") long lcpl_id, @Cast("hid_t") long lapl_id)
\ingroup H5L \brief Creates an identical copy of a link with the same creation time and target. The new link can have a different name and be in a different location than the original. \fgdt_loc_id{src_loc}- Parameters:
src_name- [in] Name of the link to be copied \fgdt_loc_id{dst_loc}dst_name- [in] Name to be assigned to the new copy \lcpl_id \lapl_id- Returns:
- \herr_t \details H5Lcopy() copies the link specified by \p src_name from the location specified by \p src_loc_id to the location specified by \p dst_loc_id. The new copy of the link is created with the name \p dst_name. If \p dst_loc_id is a file identifier, \p dst_name will be interpreted relative to that fileâs root group. The new link is created with the creation and access property lists specified by \p lcpl_id and \p lapl_id. The interpretation of \p lcpl_id is limited in the manner described in the next paragraph. H5Lcopy() retains the creation time and the target of the original link. However, since the link may be renamed, the character encoding is that specified in \p lcpl_id rather than that of the original link. Other link creation properties are ignored. If the link is a soft link, also known as a symbolic link, its target is interpreted relative to the location of the copy. Several properties are available to govern the behavior of H5Lcopy(). These properties are set in the link creation and access property lists, \p lcpl_id and \p lapl_id, respectively. The property controlling creation of missing intermediate groups is set in the link creation property list with H5Pset_create_intermediate_group(); this function ignores any other properties in the link creation property list. Properties controlling character encoding, link traversals, and external link prefixes are set in the link access property list with H5Pset_char_encoding(), H5Pset_nlinks(), and H5Pset_elink_prefix(). \note H5Lcopy() does not affect the object that the link points to. \attention H5Lcopy() cannot copy hard links across files as a hard link is not valid without a target object; to copy objects from one file to another, see H5Ocopy().
- Since:
- 1.8.0
- See Also:
H5Ocopy()
-
H5Lcopy
@Cast("herr_t") public static int H5Lcopy(@Cast("hid_t") long src_loc, String src_name, @Cast("hid_t") long dst_loc, String dst_name, @Cast("hid_t") long lcpl_id, @Cast("hid_t") long lapl_id)
-
H5Lcreate_hard
@Cast("herr_t") public static int H5Lcreate_hard(@Cast("hid_t") long cur_loc, @Cast("const char*") BytePointer cur_name, @Cast("hid_t") long dst_loc, @Cast("const char*") BytePointer dst_name, @Cast("hid_t") long lcpl_id, @Cast("hid_t") long lapl_id)
\ingroup H5L \brief Creates a hard link to an object \fgdta_loc_id{cur_loc}- Parameters:
cur_name- [in] Name of the target object, which must already exist \fgdta_loc_id{dst_loc}dst_name- [in] The name of the new link \lcpl_id \lapl_id- Returns:
- \herr_t \details H5Lcreate_hard() creates a new hard link to a pre-existing object in an HDF5 file. \p cur_loc and \p cur_name specify the location and name, respectively, of the target object, i.e., the object that the new hard link points to. \p dst_loc and \p dst_name specify the location and name, respectively, of the new hard link. \p cur_name and \p dst_name are interpreted relative to \p cur_loc and \p dst_loc, respectively. If \p cur_loc and \p dst_loc are the same location, the HDF5 macro #H5L_SAME_LOC can be used for either parameter (but not both). \p lcpl_id and \p lapl_id are the link creation and access property lists associated with the new link. \note Hard and soft links are for use only if the target object is in the current file. If the desired target object is in a different file from the new link, an external link may be created with H5Lcreate_external(). \note The HDF5 library keeps a count of all hard links pointing to an object; if the hard link count reaches zero (0), the object will be deleted from the file. Creating new hard links to an object will prevent it from being deleted if other links are removed. The library maintains no similar count for soft links and they can dangle. \note The new link may be one of many that point to that object.
- Since:
- 1.8.0
-
H5Lcreate_hard
@Cast("herr_t") public static int H5Lcreate_hard(@Cast("hid_t") long cur_loc, String cur_name, @Cast("hid_t") long dst_loc, String dst_name, @Cast("hid_t") long lcpl_id, @Cast("hid_t") long lapl_id)
-
H5Lcreate_hard_async
@Cast("herr_t") public static int H5Lcreate_hard_async(@Cast("const char*") BytePointer app_file, @Cast("const char*") BytePointer app_func, @Cast("unsigned") int app_line, @Cast("hid_t") long cur_loc_id, @Cast("const char*") BytePointer cur_name, @Cast("hid_t") long new_loc_id, @Cast("const char*") BytePointer new_name, @Cast("hid_t") long lcpl_id, @Cast("hid_t") long lapl_id, @Cast("hid_t") long es_id)
-------------------------------------------------------------------------- \ingroup ASYNC \async_variant_of{H5Lcreate_hard}
-
H5Lcreate_hard_async
@Cast("herr_t") public static int H5Lcreate_hard_async(String app_file, String app_func, @Cast("unsigned") int app_line, @Cast("hid_t") long cur_loc_id, String cur_name, @Cast("hid_t") long new_loc_id, String new_name, @Cast("hid_t") long lcpl_id, @Cast("hid_t") long lapl_id, @Cast("hid_t") long es_id)
-
H5Lcreate_soft
@Cast("herr_t") public static int H5Lcreate_soft(@Cast("const char*") BytePointer link_target, @Cast("hid_t") long link_loc_id, @Cast("const char*") BytePointer link_name, @Cast("hid_t") long lcpl_id, @Cast("hid_t") long lapl_id)
\ingroup H5L \brief Creates a soft link- Parameters:
link_target- [in] An HDF5 path name \fgdta_loc_id{link_loc_id}link_name- [in] The name of the new link \lcpl_id \lapl_id- Returns:
- \herr_t \details H5Lcreate_soft() creates a new soft link to an object in an HDF5 file. \p link_target specifies the HDF5 path name the soft link contains. \p link_target can be an arbitrary HDF5 path name and is interpreted only at lookup time. This path may be absolute in the file or relative to \p link_loc_id. \p link_loc_id and \p link_name specify the location and name, respectively, of the new soft link. \p link_name is interpreted relative to \p link_loc_id and must contain only the name of the soft link; \p link_name may not contain any additional path elements. If \p link_loc_id is a group identifier, the object pointed to by \p link_name will be accessed as a member of that group. If \p link_loc_id is a file identifier, the object will be accessed as a member of the file's root group. \p lcpl_id and \p lapl_id are the link creation and access property lists associated with the new link. For instance, if target_path is \c ./foo, \p link_loc_id specifies \c ./x/y/bar, and the name of the new link is \c new_link, then a subsequent request for \c ./x/y/bar/new_link will return same the object as would be found at \c ./foo. \note H5Lcreate_soft() is for use only if the target object is in the current file. If the desired target object is in a different file from the new link, use H5Lcreate_external() to create an external link. \note Soft links and external links are also known as symbolic links as they use a name to point to an object; hard links employ an objectâs address in the file. \note Unlike hard links, a soft link in an HDF5 file is allowed to dangle, meaning that the target object need not exist at the time that the link is created. \note The HDF5 library does not keep a count of soft links as it does of hard links. \note The new link may be one of many that point to that object.
- Since:
- 1.8.0
-
H5Lcreate_soft
@Cast("herr_t") public static int H5Lcreate_soft(String link_target, @Cast("hid_t") long link_loc_id, String link_name, @Cast("hid_t") long lcpl_id, @Cast("hid_t") long lapl_id)
-
H5Lcreate_soft_async
@Cast("herr_t") public static int H5Lcreate_soft_async(@Cast("const char*") BytePointer app_file, @Cast("const char*") BytePointer app_func, @Cast("unsigned") int app_line, @Cast("const char*") BytePointer link_target, @Cast("hid_t") long link_loc_id, @Cast("const char*") BytePointer link_name, @Cast("hid_t") long lcpl_id, @Cast("hid_t") long lapl_id, @Cast("hid_t") long es_id)
-------------------------------------------------------------------------- \ingroup ASYNC \async_variant_of{H5Lcreate_soft}
-
H5Lcreate_soft_async
@Cast("herr_t") public static int H5Lcreate_soft_async(String app_file, String app_func, @Cast("unsigned") int app_line, String link_target, @Cast("hid_t") long link_loc_id, String link_name, @Cast("hid_t") long lcpl_id, @Cast("hid_t") long lapl_id, @Cast("hid_t") long es_id)
-
H5Ldelete
@Cast("herr_t") public static int H5Ldelete(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer name, @Cast("hid_t") long lapl_id)
\ingroup H5L \brief Removes a link from a group \fgdta_loc_id- Parameters:
name- [in] Name of the link to delete \lapl_id- Returns:
- \herr_t \details H5Ldelete() removes the link specified by \p name from the location \p loc_id. If the link being removed is a hard link, H5Ldelete() also decrements the link count for the object to which name points. Unless there is a duplicate hard link in that group, this action removes the object to which name points from the group that previously contained it. Object headers keep track of how many hard links refer to an object; when the hard link count, also referred to as the reference count, reaches zero, the object can be removed from the file. The file space associated will then be released, i.e., identified in memory as freespace. Objects which are open are not removed until all identifiers to the object are closed. \attention Exercise caution in the use of H5Ldelete(); if the link being removed is on the only path leading to an HDF5 object, that object may become permanently inaccessible in the file.
- Since:
- 1.8.0
-
H5Ldelete
@Cast("herr_t") public static int H5Ldelete(@Cast("hid_t") long loc_id, String name, @Cast("hid_t") long lapl_id)
-
H5Ldelete_async
@Cast("herr_t") public static int H5Ldelete_async(@Cast("const char*") BytePointer app_file, @Cast("const char*") BytePointer app_func, @Cast("unsigned") int app_line, @Cast("hid_t") long loc_id, @Cast("const char*") BytePointer name, @Cast("hid_t") long lapl_id, @Cast("hid_t") long es_id)
-------------------------------------------------------------------------- \ingroup ASYNC \async_variant_of{H5Ldelete}
-
H5Ldelete_async
@Cast("herr_t") public static int H5Ldelete_async(String app_file, String app_func, @Cast("unsigned") int app_line, @Cast("hid_t") long loc_id, String name, @Cast("hid_t") long lapl_id, @Cast("hid_t") long es_id)
-
H5Ldelete_by_idx
@Cast("herr_t") public static int H5Ldelete_by_idx(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer group_name, @Cast("H5_index_t") int idx_type, @Cast("H5_iter_order_t") int order, @Cast("hsize_t") long n, @Cast("hid_t") long lapl_id)
\ingroup H5L \brief Removes the \Emph{n}-th link in a group \fgdta_loc_id- Parameters:
group_name- [in] Name of subject groupidx_type- [in] Index or field which determines the orderorder- [in] Order within field or indexn- [in] Link for which to retrieve information \lapl_id- Returns:
- \herr_t \details H5Ldelete_by_idx() removes the \Emph{n}-th link in a group according to the specified order, \p order, in the specified index, \p index. If \p loc_id specifies the group in which the link resides, \p group_name can be a dot (\c .).
- Since:
- 1.8.0
- See Also:
H5Ldelete()
-
H5Ldelete_by_idx
@Cast("herr_t") public static int H5Ldelete_by_idx(@Cast("hid_t") long loc_id, String group_name, @Cast("H5_index_t") int idx_type, @Cast("H5_iter_order_t") int order, @Cast("hsize_t") long n, @Cast("hid_t") long lapl_id)
-
H5Ldelete_by_idx_async
@Cast("herr_t") public static int H5Ldelete_by_idx_async(@Cast("const char*") BytePointer app_file, @Cast("const char*") BytePointer app_func, @Cast("unsigned") int app_line, @Cast("hid_t") long loc_id, @Cast("const char*") BytePointer group_name, @Cast("H5_index_t") int idx_type, @Cast("H5_iter_order_t") int order, @Cast("hsize_t") long n, @Cast("hid_t") long lapl_id, @Cast("hid_t") long es_id)
-------------------------------------------------------------------------- \ingroup ASYNC \async_variant_of{H5Ldelete_by_idx}
-
H5Ldelete_by_idx_async
@Cast("herr_t") public static int H5Ldelete_by_idx_async(String app_file, String app_func, @Cast("unsigned") int app_line, @Cast("hid_t") long loc_id, String group_name, @Cast("H5_index_t") int idx_type, @Cast("H5_iter_order_t") int order, @Cast("hsize_t") long n, @Cast("hid_t") long lapl_id, @Cast("hid_t") long es_id)
-
H5Lget_val
@Cast("herr_t") public static int H5Lget_val(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer name, Pointer buf, @Cast("size_t") long size, @Cast("hid_t") long lapl_id)
\ingroup H5L \brief Returns the value of a link \fgdta_loc_id- Parameters:
name- [in] Link namebuf- [out] The buffer to hold the link valuesize- [in] Maximum number of bytes of link value to be returned \lapl_id- Returns:
- \herr_t \details H5Lget_val() returns the value of link \p name. For smbolic links, this is the path to which the link points, including the null terminator. For external and user-defined links, it is the link buffer. \p size is the size of \p buf and should be the size of the link value being returned. This size value can be determined through a call to H5Lget_info(); it is returned in the \c val_size field of the \ref H5L_info_t \c struct. If \p size is smaller than the size of the returned value, then the string stored in \p buf will be truncated to \p size bytes. For soft links, this means that the value will not be null terminated. In the case of external links, the target file and object names are extracted from \p buf by calling H5Lunpack_elink_val(). The link class of link \p name can be determined with a call to H5Lget_info(). \p lapl_id specifies the link access property list associated with the link \p name. In the general case, when default link access properties are acceptable, this can be passed in as #H5P_DEFAULT. An example of a situation that requires a non-default link access property list is when the link is an external link; an external link may require that a link prefix be set in a link access property list (see H5Pset_elink_prefix()). This function should be used only after H5Lget_info() has been called to verify that \p name is a symbolic link. This can be determined from the \c link_type field of the \ref H5L_info_t \c struct. \note This function will fail if called on a hard link.
- Since:
- 1.8.0
- See Also:
H5Lget_val_by_idx()
-
H5Lget_val
@Cast("herr_t") public static int H5Lget_val(@Cast("hid_t") long loc_id, String name, Pointer buf, @Cast("size_t") long size, @Cast("hid_t") long lapl_id)
-
H5Lget_val_by_idx
@Cast("herr_t") public static int H5Lget_val_by_idx(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer group_name, @Cast("H5_index_t") int idx_type, @Cast("H5_iter_order_t") int order, @Cast("hsize_t") long n, Pointer buf, @Cast("size_t") long size, @Cast("hid_t") long lapl_id)
\ingroup H5L \brief Retrieves value of the \Emph{n}-th link in a group, according to the order within an index \fgdta_loc_id- Parameters:
group_name- [in] Group nameidx_type- [in] Type of indexorder- [in] Order within field or indexn- [in] Link position for which to retrieve informationbuf- [out] The buffer to hold the link valuesize- [in] Maximum number of bytes of link value to be returned \lapl_id- Returns:
- \herr_t \details H5Lget_val_by_idx() retrieves the value of the \Emph{n}-th link in a group, according to the specified order, \p order, within an index, \p index. For soft links, the value is an HDF5 path name. For external links, this is a compound value containing file and path name information; to use this external link information, it must first be decoded with H5Lunpack_elink_val() For user-defined links, this value will be described in the definition of the user-defined link type. \p loc_id specifies the location identifier of the group specified by \p group_name. \p group_name specifies the group in which the link exists. If \p loc_id already specifies the group in which the link exists, \p group_name must be a dot (\c .). The size in bytes of link_val is specified in \p size. The size value can be determined through a call to H5Lget_info_by_idx(); it is returned in the \c val_size field of the \ref H5L_info_t \c struct. If size is smaller than the size of the returned value, then the string stored in link_val will be truncated to size bytes. For soft links, this means that the value will not be null terminated. If the type of the link is unknown or uncertain, H5Lget_val_by_idx() should be called only after the type has been determined via a call to H5Lget_info_by_idx(). \note This function will fail if called on a hard link.
- Since:
- 1.8.0
- See Also:
H5Lget_val()
-
H5Lget_val_by_idx
@Cast("herr_t") public static int H5Lget_val_by_idx(@Cast("hid_t") long loc_id, String group_name, @Cast("H5_index_t") int idx_type, @Cast("H5_iter_order_t") int order, @Cast("hsize_t") long n, Pointer buf, @Cast("size_t") long size, @Cast("hid_t") long lapl_id)
-
H5Lexists
@Cast("htri_t") public static int H5Lexists(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer name, @Cast("hid_t") long lapl_id)
\ingroup H5L \brief Determines whether a link with the specified name exists in a group \fgdta_loc_id- Parameters:
name- [in] Link name \lapl_id- Returns:
- \herr_t
\details H5Lexists() allows an application to determine whether the link \p
name exists in the location specified by \p loc_id. The link may be
of any type; only the presence of a link with that name is checked.
Note that H5Lexists() verifies only that the target link exists. If
name includes either a relative path or an absolute path to the
target link, intermediate steps along the path must be verified
before the existence of the target link can be safely checked. If
the path is not verified, and an intermediate element of the path
does not exist, H5Lexists() will fail. The example in the next
paragraph illustrates one step-by-step method for verifying the
existence of a link with a relative or absolute path.
\Bold{Example:} Use the following steps to verify the existence of
the link \c datasetD in the \c group group1/group2/softlink_to_group3/,
where \c group1 is a member of the group specified by \c loc_id:
1. First use H5Lexists() to verify that \c group1 exists.
2. If \c group1 exists, use H5Lexists() again, this time with name
set to \c group1/group2, to verify that \c group2 exists.
3. If \c group2 exists, use H5Lexists() with name set to
\c group1/group2/softlink_to_group3 to verify that
\c softlink_to_group3 exists.
4. If \c softlink_to_group3 exists, you can now safely use
H5Lexists() with \c name set to
\c group1/group2/softlink_to_group3/datasetD to verify that the
target link, \c datasetD, exists.
If the link to be verified is specified with an absolute path, the
same approach should be used, but starting with the first link in
the fileâs root group. For instance, if \c datasetD were in
\c /group1/group2/softlink_to_group3, the first call to H5Lexists()
would have name set to \c /group1.
Note that this is an outline and does not include all necessary
details. Depending on circumstances, for example, you may need to
verify that an intermediate link points to a group and that a soft
link points to an existing target.
\note The behavior of H5Lexists() was changed in the 1.10 release in the
case where the root group, \c "/", is the name of the link. This
change is described below:
- Let \c file denote a valid HDF5 file identifier, and let \c lapl denote a valid link access property list identifier. A call to H5Lexists() with arguments \c file, \c "/", and \c lapl returns a positive value; in other words, \Code{H5Lexists(file, "/", lapl)} returns a positive value. In the HDF5 1.8 release, this function returns 0.
- Let \c root denote a valid HDF5 group identifier that refers to the root group of an HDF5 file, and let \c lapl denote a valid link access property list identifier. A call to H5Lexists() with arguments c root, \c "/", and \c lapl returns a positive value; in other words, \Code{H5Lexists(root, "/", lapl)} returns a positive value. In the HDF5 1.8 release, this function returns 0.
- Since:
- 1.8.0
-
H5Lexists
@Cast("htri_t") public static int H5Lexists(@Cast("hid_t") long loc_id, String name, @Cast("hid_t") long lapl_id)
-
H5Lexists_async
@Cast("herr_t") public static int H5Lexists_async(@Cast("const char*") BytePointer app_file, @Cast("const char*") BytePointer app_func, @Cast("unsigned") int app_line, @Cast("hid_t") long loc_id, @Cast("const char*") BytePointer name, @Cast("hbool_t*") BoolPointer exists, @Cast("hid_t") long lapl_id, @Cast("hid_t") long es_id)
-------------------------------------------------------------------------- \ingroup ASYNC \async_variant_of{H5Lexists}
-
H5Lexists_async
@Cast("herr_t") public static int H5Lexists_async(String app_file, String app_func, @Cast("unsigned") int app_line, @Cast("hid_t") long loc_id, String name, @Cast("hbool_t*") boolean[] exists, @Cast("hid_t") long lapl_id, @Cast("hid_t") long es_id)
-
H5Lget_info2
@Cast("herr_t") public static int H5Lget_info2(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer name, H5L_info2_t linfo, @Cast("hid_t") long lapl_id)
\ingroup H5L \brief Returns information about a link \fgdta_loc_id- Parameters:
name- [in] Link namelinfo- [out] Buffer in which link information is returned \lapl_id- Returns:
- \herr_t \details H5Lget_info2() returns information about the specified link through the \p linfo argument. The location identifier, \p loc_id, specifies the location of the link. A link name, \p name, interpreted relative to \p loc_id, specifies the link being queried. \p lapl_id is the link access property list associated with the link name. In the general case, when default link access properties are acceptable, this can be passed in as #H5P_DEFAULT. An example of a situation that requires a non-default link access property list is when the link is an external link; an external link may require that a link prefix be set in a link access property list (see H5Pset_elink_prefix()). H5Lget_info2() returns information about name in the data structure H5L_info2_t, which is described below and defined in H5Lpublic.h. This structure is returned in the buffer \p linfo. \snippet this H5L_info2_t_snip In the above struct, \c type specifies the link class. Valid values include the following: \link_types There will be additional valid values if user-defined links have been registered. \p corder specifies the linkâs creation order position while \p corder_valid indicates whether the value in corder is valid. If \p corder_valid is \c TRUE, the value in \p corder is known to be valid; if \p corder_valid is \c FALSE, the value in \p corder is presumed to be invalid; \p corder starts at zero (0) and is incremented by one (1) as new links are created. But higher-numbered entries are not adjusted when a lower-numbered link is deleted; the deleted link's creation order position is simply left vacant. In such situations, the value of \p corder for the last link created will be larger than the number of links remaining in the group. \p cset specifies the character set in which the link name is encoded. Valid values include the following: \csets This value is set with #H5Pset_char_encoding. \c token is the location that a hard link points to, and \c val_size is the size of a soft link or user defined link value. H5O_token_t is used in the VOL layer. It is defined in H5public.h as: \snippet H5public.h H5O_token_t_snip If the link is a symbolic link, \c val_size will be the length of the link value, e.g., the length of the HDF5 path name with a null terminator.
- Since:
- 1.12.0
-
H5Lget_info2
@Cast("herr_t") public static int H5Lget_info2(@Cast("hid_t") long loc_id, String name, H5L_info2_t linfo, @Cast("hid_t") long lapl_id)
-
H5Lget_info_by_idx2
@Cast("herr_t") public static int H5Lget_info_by_idx2(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer group_name, @Cast("H5_index_t") int idx_type, @Cast("H5_iter_order_t") int order, @Cast("hsize_t") long n, H5L_info2_t linfo, @Cast("hid_t") long lapl_id)
\ingroup H5L \brief Retrieves metadata for a link in a group, according to the order within a field or index \loc_id- Parameters:
group_name- [in] Group name \idx_type \ordern- [in] Link position for which to retrieve informationlinfo- [out] Buffer in which link information is returned \lapl_id- Returns:
- \herr_t \details H5get_info_by_idx2() returns the metadata for a link in a group according to a specified field or index and a specified order. The link for which information is to be returned is specified by \p idx_type, \p order, and \p n as follows: - \p idx_type specifies the field by which the links in \p group_name are ordered. The links may be indexed on this field, in which case operations seeking specific links are likely to complete more quickly. - \p order specifies the order in which the links are to be referenced for the purposes of this function. - \p n specifies the position of the subject link. Note that this count is zero-based; 0 (zero) indicates that the function will return the value of the first link; if \p n is 5, the function will return the value of the sixth link; etc. For example, assume that \p idx_type, \p order, and \p n are #H5_INDEX_NAME, #H5_ITER_DEC, and 5, respectively. #H5_INDEX_NAME indicates that the links are accessed in lexicographic order by their names. #H5_ITER_DEC specifies that the list be traversed in reverse order, or in decremented order. And 5 specifies that this call to the function will return the metadata for the 6th link (\c n + 1) from the end. See H5Literate2() for a list of valid values and further discussion regarding \p idx_type and \p order. If \p loc_id specifies the group in which the link resides, \p group_name can be a dot (\c .).
- Since:
- 1.12.0
- See Also:
H5Lget_info2()
-
H5Lget_info_by_idx2
@Cast("herr_t") public static int H5Lget_info_by_idx2(@Cast("hid_t") long loc_id, String group_name, @Cast("H5_index_t") int idx_type, @Cast("H5_iter_order_t") int order, @Cast("hsize_t") long n, H5L_info2_t linfo, @Cast("hid_t") long lapl_id)
-
H5Lget_name_by_idx
@Cast("ssize_t") public static long H5Lget_name_by_idx(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer group_name, @Cast("H5_index_t") int idx_type, @Cast("H5_iter_order_t") int order, @Cast("hsize_t") long n, @Cast("char*") BytePointer name, @Cast("size_t") long size, @Cast("hid_t") long lapl_id)
\ingroup H5L \brief Retrieves name of the \Emph{n}-th link in a group, according to the order within a specified field or index \loc_id- Parameters:
group_name- [in] Group name \idx_type \ordern- [in] Link position for which to retrieve informationname- [out] Buffer in which link name is returnedsize- [in] Size in bytes of \p name \lapl_id- Returns:
- Returns the size of the link name if successful; otherwise returns a negative value. \details H5get_name_by_idx() retrieves the name of the \Emph{n}-th link in a group, according to the specified order, \p order, within a specified field or index, \p idx_type. \p idx_type specifies the index that is used. Valid values include the following: \indexes \p order specifies the order in which objects are inspected along the index specified in \p idx_type. Valid values include the following: \orders If \p loc_id specifies the group in which the link resides, \p group_name can be a dot (\c .). The size in bytes of name is specified in \p size. If \p size is unknown, it can be determined via an initial H5Lget_name_by_idx() call with name set to NULL; the function's return value will be the size of the name. \note Please note that in order for the specified index to correspond to the creation order index, \p order must be set to #H5_ITER_INC or #H5_ITER_DEC when calling H5Lget_name_by_idx(). \note The index \p n passed to H5Lget_name_by_idx() is the index of the link within the link table, sorted according to \p order and \p idx_type. If order is #H5_ITER_NATIVE, then the link table is not sorted, and it does not matter what \p idx_type is. Specifying #H5_ITER_NATIVE does not guarantee any particular order, only that it remains consistent.
- Since:
- 1.8.0
-
H5Lget_name_by_idx
@Cast("ssize_t") public static long H5Lget_name_by_idx(@Cast("hid_t") long loc_id, String group_name, @Cast("H5_index_t") int idx_type, @Cast("H5_iter_order_t") int order, @Cast("hsize_t") long n, @Cast("char*") ByteBuffer name, @Cast("size_t") long size, @Cast("hid_t") long lapl_id)
-
H5Lget_name_by_idx
@Cast("ssize_t") public static long H5Lget_name_by_idx(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer group_name, @Cast("H5_index_t") int idx_type, @Cast("H5_iter_order_t") int order, @Cast("hsize_t") long n, @Cast("char*") byte[] name, @Cast("size_t") long size, @Cast("hid_t") long lapl_id)
-
H5Lget_name_by_idx
@Cast("ssize_t") public static long H5Lget_name_by_idx(@Cast("hid_t") long loc_id, String group_name, @Cast("H5_index_t") int idx_type, @Cast("H5_iter_order_t") int order, @Cast("hsize_t") long n, @Cast("char*") BytePointer name, @Cast("size_t") long size, @Cast("hid_t") long lapl_id)
-
H5Lget_name_by_idx
@Cast("ssize_t") public static long H5Lget_name_by_idx(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer group_name, @Cast("H5_index_t") int idx_type, @Cast("H5_iter_order_t") int order, @Cast("hsize_t") long n, @Cast("char*") ByteBuffer name, @Cast("size_t") long size, @Cast("hid_t") long lapl_id)
-
H5Lget_name_by_idx
@Cast("ssize_t") public static long H5Lget_name_by_idx(@Cast("hid_t") long loc_id, String group_name, @Cast("H5_index_t") int idx_type, @Cast("H5_iter_order_t") int order, @Cast("hsize_t") long n, @Cast("char*") byte[] name, @Cast("size_t") long size, @Cast("hid_t") long lapl_id)
-
H5Literate2
@Cast("herr_t") public static int H5Literate2(@Cast("hid_t") long grp_id, @Cast("H5_index_t") int idx_type, @Cast("H5_iter_order_t") int order, @Cast("hsize_t*") LongPointer idx, H5L_iterate2_t op, Pointer op_data)
\ingroup TRAV \brief Iterates over links in a group, with user callback routine, according to the order within an index. \group_id{grp_id} \idx_type \order- Parameters:
idx- [in,out] Pointer to an iteration index to allow continuing a previous iteration \op \op_data- Returns:
- \success{The return value of the first operator that returns non-zero, or zero if all members were processed with no operator returning non-zero.}
- Since:
- 1.12.0
-
H5Literate2
@Cast("herr_t") public static int H5Literate2(@Cast("hid_t") long grp_id, @Cast("H5_index_t") int idx_type, @Cast("H5_iter_order_t") int order, @Cast("hsize_t*") LongBuffer idx, H5L_iterate2_t op, Pointer op_data)
-
H5Literate2
@Cast("herr_t") public static int H5Literate2(@Cast("hid_t") long grp_id, @Cast("H5_index_t") int idx_type, @Cast("H5_iter_order_t") int order, @Cast("hsize_t*") long[] idx, H5L_iterate2_t op, Pointer op_data)
-
H5Literate_async
@Cast("herr_t") public static int H5Literate_async(@Cast("const char*") BytePointer app_file, @Cast("const char*") BytePointer app_func, @Cast("unsigned") int app_line, @Cast("hid_t") long group_id, @Cast("H5_index_t") int idx_type, @Cast("H5_iter_order_t") int order, @Cast("hsize_t*") LongPointer idx_p, H5L_iterate2_t op, Pointer op_data, @Cast("hid_t") long es_id)
-------------------------------------------------------------------------- \ingroup ASYNC \warning The returned value of the callback routine op will not be set in the return value for H5Literate_async(), so the \p herr_t value should not be used for determining the return state of the callback routine. \async_variant_of{H5Literate}
-
H5Literate_async
@Cast("herr_t") public static int H5Literate_async(String app_file, String app_func, @Cast("unsigned") int app_line, @Cast("hid_t") long group_id, @Cast("H5_index_t") int idx_type, @Cast("H5_iter_order_t") int order, @Cast("hsize_t*") LongBuffer idx_p, H5L_iterate2_t op, Pointer op_data, @Cast("hid_t") long es_id)
-
H5Literate_async
@Cast("herr_t") public static int H5Literate_async(@Cast("const char*") BytePointer app_file, @Cast("const char*") BytePointer app_func, @Cast("unsigned") int app_line, @Cast("hid_t") long group_id, @Cast("H5_index_t") int idx_type, @Cast("H5_iter_order_t") int order, @Cast("hsize_t*") long[] idx_p, H5L_iterate2_t op, Pointer op_data, @Cast("hid_t") long es_id)
-
H5Literate_async
@Cast("herr_t") public static int H5Literate_async(String app_file, String app_func, @Cast("unsigned") int app_line, @Cast("hid_t") long group_id, @Cast("H5_index_t") int idx_type, @Cast("H5_iter_order_t") int order, @Cast("hsize_t*") LongPointer idx_p, H5L_iterate2_t op, Pointer op_data, @Cast("hid_t") long es_id)
-
H5Literate_async
@Cast("herr_t") public static int H5Literate_async(@Cast("const char*") BytePointer app_file, @Cast("const char*") BytePointer app_func, @Cast("unsigned") int app_line, @Cast("hid_t") long group_id, @Cast("H5_index_t") int idx_type, @Cast("H5_iter_order_t") int order, @Cast("hsize_t*") LongBuffer idx_p, H5L_iterate2_t op, Pointer op_data, @Cast("hid_t") long es_id)
-
H5Literate_async
@Cast("herr_t") public static int H5Literate_async(String app_file, String app_func, @Cast("unsigned") int app_line, @Cast("hid_t") long group_id, @Cast("H5_index_t") int idx_type, @Cast("H5_iter_order_t") int order, @Cast("hsize_t*") long[] idx_p, H5L_iterate2_t op, Pointer op_data, @Cast("hid_t") long es_id)
-
H5Literate_by_name2
@Cast("herr_t") public static int H5Literate_by_name2(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer group_name, @Cast("H5_index_t") int idx_type, @Cast("H5_iter_order_t") int order, @Cast("hsize_t*") LongPointer idx, H5L_iterate2_t op, Pointer op_data, @Cast("hid_t") long lapl_id)
\ingroup TRAV \brief Iterates through links in a group \loc_id- Parameters:
group_name- [in] Group name \idx_type \orderidx- [in,out] iteration position at which to start (\Emph{IN}) or position at which an interrupted iteration may be restarted (\Emph{OUT}) \op \op_data \lapl_id- Returns:
- \success{The return value of the first operator that returns non-zero, or zero if all members were processed with no operator returning non-zero.}
- Since:
- 1.12.0
-
H5Literate_by_name2
@Cast("herr_t") public static int H5Literate_by_name2(@Cast("hid_t") long loc_id, String group_name, @Cast("H5_index_t") int idx_type, @Cast("H5_iter_order_t") int order, @Cast("hsize_t*") LongBuffer idx, H5L_iterate2_t op, Pointer op_data, @Cast("hid_t") long lapl_id)
-
H5Literate_by_name2
@Cast("herr_t") public static int H5Literate_by_name2(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer group_name, @Cast("H5_index_t") int idx_type, @Cast("H5_iter_order_t") int order, @Cast("hsize_t*") long[] idx, H5L_iterate2_t op, Pointer op_data, @Cast("hid_t") long lapl_id)
-
H5Literate_by_name2
@Cast("herr_t") public static int H5Literate_by_name2(@Cast("hid_t") long loc_id, String group_name, @Cast("H5_index_t") int idx_type, @Cast("H5_iter_order_t") int order, @Cast("hsize_t*") LongPointer idx, H5L_iterate2_t op, Pointer op_data, @Cast("hid_t") long lapl_id)
-
H5Literate_by_name2
@Cast("herr_t") public static int H5Literate_by_name2(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer group_name, @Cast("H5_index_t") int idx_type, @Cast("H5_iter_order_t") int order, @Cast("hsize_t*") LongBuffer idx, H5L_iterate2_t op, Pointer op_data, @Cast("hid_t") long lapl_id)
-
H5Literate_by_name2
@Cast("herr_t") public static int H5Literate_by_name2(@Cast("hid_t") long loc_id, String group_name, @Cast("H5_index_t") int idx_type, @Cast("H5_iter_order_t") int order, @Cast("hsize_t*") long[] idx, H5L_iterate2_t op, Pointer op_data, @Cast("hid_t") long lapl_id)
-
H5Lvisit2
@Cast("herr_t") public static int H5Lvisit2(@Cast("hid_t") long grp_id, @Cast("H5_index_t") int idx_type, @Cast("H5_iter_order_t") int order, H5L_iterate2_t op, Pointer op_data)
\ingroup TRAV \brief Recursively visits all links starting from a specified group \group_id{grp_id} \idx_type \order \op \op_data- Returns:
- \success{The return value of the first operator that returns non-zero, or zero if all members were processed with no operator returning non-zero.}
- Since:
- 1.12.0
- See Also:
H5Literate()
-
H5Lvisit_by_name2
@Cast("herr_t") public static int H5Lvisit_by_name2(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer group_name, @Cast("H5_index_t") int idx_type, @Cast("H5_iter_order_t") int order, H5L_iterate2_t op, Pointer op_data, @Cast("hid_t") long lapl_id)
\ingroup TRAV \brief Recursively visits all links starting from a specified group \loc_id- Parameters:
group_name- [in] Group name \idx_type \order \op \op_data \lapl_id- Returns:
- \herr_t \details H5Lvisit_by_name2() is a recursive iteration function to visit all links in and below a group in an HDF5 file, thus providing a mechanism for an application to perform a common set of operations across all of those links or a dynamically selected subset. For non-recursive iteration across the members of a group, see H5Literate2(). The group serving as the root of the iteration is specified by the \p loc_id / \p group_name parameter pair. \p loc_id specifies a file or group; group_name specifies either a group in the file (with an absolute name based in the fileâs root group) or a group relative to \p loc_id. If \p loc_id fully specifies the group that is to serve as the root of the iteration, group_name should be '.' (a dot). (Note that when \p loc_id fully specifies the the group that is to serve as the root of the iteration, the user may wish to consider using H5Lvisit2() instead of H5Lvisit_by_name2().) Two parameters are used to establish the iteration: \p idx_type and \p order. \p idx_type specifies the index to be used. If the links have not been indexed by the index type, they will first be sorted by that index then the iteration will begin; if the links have been so indexed, the sorting step will be unnecessary, so the iteration may begin more quickly. Valid values include the following: \indexes Note that the index type passed in \p idx_type is a best effort setting. If the application passes in a value indicating iteration in creation order and a group is encountered that was not tracked in creation order, that group will be iterated over in lexicographic order by name, or name order. (Name order is the native order used by the HDF5 library and is always available.) \p order specifies the order in which objects are to be inspected along the index specified in \p idx_type. Valid values include the following: \orders The \p op callback function, the related \ref H5L_info2_t \c struct, and the effect that the callback function's return value has on the application are described in H5Lvisit2(). The H5Lvisit_by_name2() \p op_data parameter is a user-defined pointer to the data required to process links in the course of the iteration. This pointer is passed back to each step of the iteration in the callback function's \p op_data parameter. \p lapl_id is a link access property list. In the general case, when default link access properties are acceptable, this can be passed in as #H5P_DEFAULT. An example of a situation that requires a non-default link access property list is when the link is an external link; an external link may require that a link prefix be set in a link access property list (see H5Pset_elink_prefix()). H5Lvisit_by_name2() and H5Ovisit_by_name2() are companion functions: one for examining and operating on links; the other for examining and operating on the objects that those links point to. Both functions ensure that by the time the function completes successfully, every link or object below the specified point in the file has been presented to the application for whatever processing the application requires.
- Since:
- 1.12.0
-
H5Lvisit_by_name2
@Cast("herr_t") public static int H5Lvisit_by_name2(@Cast("hid_t") long loc_id, String group_name, @Cast("H5_index_t") int idx_type, @Cast("H5_iter_order_t") int order, H5L_iterate2_t op, Pointer op_data, @Cast("hid_t") long lapl_id)
-
H5Lcreate_ud
@Cast("herr_t") public static int H5Lcreate_ud(@Cast("hid_t") long link_loc_id, @Cast("const char*") BytePointer link_name, @Cast("H5L_type_t") int link_type, @Const Pointer udata, @Cast("size_t") long udata_size, @Cast("hid_t") long lcpl_id, @Cast("hid_t") long lapl_id)
\ingroup H5L \brief Creates a link of a user-defined type \loc_id{link_loc_id}- Parameters:
link_name- [in] Link namelink_type- [in] User-defined link classudata- [in] User-supplied link informationudata_size- [in] Size of udata buffer \lcpl_id \lapl_id- Returns:
- \herr_t \details H5Lcreate_ud() creates a link of user-defined type \p link_type named \p link_name at the location specified in \p link_loc_id with user-specified data \p udata. \p link_name is interpreted relative to \p link_loc_id. Valid values for the link class of the new link, \p link_type, include #H5L_TYPE_EXTERNAL and any user-defined link classes that have been registered with the library. See H5Lregister() for further information. The format of the information pointed to by \p udata is defined by the user. \p udata_size specifies the size of the \p udata buffer. \p udata may be NULL if \p udata_size is zero (0). The property lists specified by \p lcpl_id and \p lapl_id specify properties used to create and access the link. \note The external link type, #H5L_TYPE_EXTERNAL, included in the HDF5 library distribution, is implemented as a user-defined link type. This was done, in part, to provide a model for the implementation of other user-defined links.
- Since:
- 1.8.0
-
H5Lcreate_ud
@Cast("herr_t") public static int H5Lcreate_ud(@Cast("hid_t") long link_loc_id, String link_name, @Cast("H5L_type_t") int link_type, @Const Pointer udata, @Cast("size_t") long udata_size, @Cast("hid_t") long lcpl_id, @Cast("hid_t") long lapl_id)
-
H5Lis_registered
@Cast("htri_t") public static int H5Lis_registered(@Cast("H5L_type_t") int id)
\ingroup H5LA \brief Determines whether a class of user-defined links is registered- Parameters:
id- [in] User-defined link class identifier- Returns:
- \htri_t \details H5Lis_registered() tests whether a user-defined link class is currently registered, either by the HDF5 library or by the user through the use of H5Lregister(). \note A link class must be registered to create new links of that type or to traverse existing links of that type.
- Since:
- 1.8.0
-
H5Lunpack_elink_val
@Cast("herr_t") public static int H5Lunpack_elink_val(@Const Pointer ext_linkval, @Cast("size_t") long link_size, @Cast("unsigned*") IntPointer flags, @Cast("const char**") PointerPointer filename, @Cast("const char**") PointerPointer obj_path)
\ingroup H5L \brief Decodes external link information- Parameters:
ext_linkval- [in] Buffer containing external link informationlink_size- [in] Size, in bytes, of the \p ext_linkval bufferflags- [out] External link flags, packed as a bitmap (\Emph{Reserved as a bitmap for flags; no flags are currently defined, so the only valid value * is 0.})filename- [out] Returned filename @param obj_path [out] Returned object path, relative to \p filename- Returns:
- \herr_t
\details H5Lunpack_elink_val() decodes the external link information
returned by H5Lget_val() in the \p ext_linkval buffer.
\p ext_linkval should be the buffer set by H5Lget_val() and will
consist of two NULL-terminated strings, the filename and object
path, one after the other.
Given this buffer, H5Lunpack_elink_val() creates pointers to the
filename and object path within the buffer and returns them in
\p filename and \p obj_path, unless they are passed in as NULL.
H5Lunpack_elink_val() requires that \p ext_linkval contain a
concatenated pair of null-terminated strings, so use of this
function on a string that is not an external link \p udata buffer
may result in a segmentation fault. This failure can be avoided by
adhering to the following procedure:
- Call H5Lget_info() to get the link type and the size of the link value.
- Verify that the link is an external link, i.e., that its link type is #H5L_TYPE_EXTERNAL.
- Call H5Lget_val() to get the link value.
- Call H5Lunpack_elink_val() to unpack that value.
- Since:
- 1.8.0
-
H5Lunpack_elink_val
@Cast("herr_t") public static int H5Lunpack_elink_val(@Const Pointer ext_linkval, @Cast("size_t") long link_size, @Cast("unsigned*") IntPointer flags, @Cast("const char**") @ByPtrPtr BytePointer filename, @Cast("const char**") @ByPtrPtr BytePointer obj_path)
-
H5Lunpack_elink_val
@Cast("herr_t") public static int H5Lunpack_elink_val(@Const Pointer ext_linkval, @Cast("size_t") long link_size, @Cast("unsigned*") IntBuffer flags, @Cast("const char**") @ByPtrPtr ByteBuffer filename, @Cast("const char**") @ByPtrPtr ByteBuffer obj_path)
-
H5Lunpack_elink_val
@Cast("herr_t") public static int H5Lunpack_elink_val(@Const Pointer ext_linkval, @Cast("size_t") long link_size, @Cast("unsigned*") int[] flags, @Cast("const char**") @ByPtrPtr byte[] filename, @Cast("const char**") @ByPtrPtr byte[] obj_path)
-
H5Lcreate_external
@Cast("herr_t") public static int H5Lcreate_external(@Cast("const char*") BytePointer file_name, @Cast("const char*") BytePointer obj_name, @Cast("hid_t") long link_loc_id, @Cast("const char*") BytePointer link_name, @Cast("hid_t") long lcpl_id, @Cast("hid_t") long lapl_id)
\ingroup H5L \brief Creates an external link, a soft link to an object in a different file.- Parameters:
file_name- [in] Name of the target file containing the target object.obj_name- [in] Path within the target file to the target object \fgdt_loc_id{link_loc_id}link_name- [in] Name of the new link, relative to \p link_loc_id \lcpl_id \lapl_id- Returns:
- \herr_t \details H5Lcreate_external() creates a new external link. An external link is a soft link to an object in a different HDF5 file from the location of the link, i.e., to an external object. \p file_name identifies the target file containing the target object; \p obj_name specifies the path of the target object within that file. \p obj_name must be an absolute pathname in \p file_name, i.e., it must start at the target fileâs root group, but it is not interpreted until an application attempts to traverse it. \p link_loc_id and \p link_name specify the location and name, respectively, of the new link. \p link_name is interpreted relative to \p link_loc_id. \p lcpl_id is the link creation property list used in creating the new link. \p lapl_id is the link access property list used in traversing the new link. Note that an external file opened by the traversal of an external link is always opened with the weak file close degree property setting, #H5F_CLOSE_WEAK (see H5Pset_fclose_degree()); any file close degree property setting in \p lapl_id is ignored. An external link behaves similarly to a soft link, and like a soft link in an HDF5 file, it may dangle: the target file and object need not exist at the time that the external link is created. When the external link \p link_name is accessed, the library will search for the target file \p file_name as described below: - If \p file_name is a relative pathname, the following steps are performed: - The library will get the prefix(es) set in the environment variable \c HDF5_EXT_PREFIX and will try to prepend each prefix to \p file_name to form a new \p file_name. - If the new \p file_name does not exist or if \c HDF5_EXT_PREFIX is not set, the library will get the prefix set via H5Pset_elink_prefix() and prepend it to \p file_name to form a new \p file_name. - If the new \p file_name does not exist or no prefix is being set by H5Pset_elink_prefix(), then the path of the file associated with \p link_loc_id is obtained. This path can be the absolute path or the current working directory plus the relative path of that file when it is created/opened. The library will prepend this path to \p file_name to form a new \p file_name. - If the new \p file_name does not exist, then the library will look for \p file_name and will return failure/success accordingly. - If \p file_name is an absolute pathname, the library will first try to find \p file_name. If \p file_name does not exist, \p file_name is stripped of directory paths to form a new \p file_name. The search for the new \p file_name then follows the same steps as described above for a relative pathname. See examples below illustrating how target_file_name is stripped to form a new \p file_name. Note that \p file_name is considered to be an absolute pathname when the following condition is true: - For Unix, the first character of \p file_name is a slash (\c /). For example, consider a \p file_name of \c /tmp/A.h5. If that target file does not exist, the new \p file_name after stripping will be \c A.h5. - For Windows, there are 6 cases: -# \p file_name is an absolute drive with absolute pathname. For example, consider a \p file_name of \c /tmp/A.h5. If that target file does not exist, the new \p file_name after stripping will be \c A.h5. -# \p file_name is an absolute pathname without specifying drive name. For example, consider a \p file_name of \c /tmp/A.h5. If that target file does not exist, the new \p file_name after stripping will be \c A.h5. -# \p file_name is an absolute drive with relative pathname. For example, consider a \p file_name of \c /tmp/A.h5. If that target file does not exist, the new \p file_name after stripping will be \c tmp\A.h5. -# \p file_name is in UNC (Uniform Naming Convention) format with server name, share name, and pathname. For example, consider a \p file_name of \c /tmp/A.h5. If that target file does not exist, the new \p file_name after stripping will be \c A.h5. -# \p file_name is in Long UNC (Uniform Naming Convention) format with server name, share name, and pathname. For example, consider a \p file_name of \c /tmp/A.h5. If that target file does not exist, the new \p file_name after stripping will be \c A.h5. -# \p file_name is in Long UNC (Uniform Naming Convention) format with an absolute drive and an absolute pathname. For example, consider a \p file_name of \c /tmp/A.h5. If that target file does not exist, the new \p file_name after stripping will be \c A.h5. The library opens target file \p file_name with the file access property list that is set via H5Pset_elink_fapl() when the external link link_name is accessed. If no such property list is set, the library uses the file access property list associated with the file of \p link_loc_id to open the target file. If an application requires additional control over file access flags or the file access property list, see H5Pset_elink_cb(); this function enables the use of an external link callback function as described in H5L_elink_traverse_t(). \attention A file close degree property setting (H5Pset_fclose_degree()) in the external link file access property list or in the external link callback function will be ignored. A file opened by means of traversing an external link is always opened with the weak file close degree property setting, #H5F_CLOSE_WEAK .
- Since:
- 1.8.0
-
H5Lcreate_external
@Cast("herr_t") public static int H5Lcreate_external(String file_name, String obj_name, @Cast("hid_t") long link_loc_id, String link_name, @Cast("hid_t") long lcpl_id, @Cast("hid_t") long lapl_id)
-
H5O_SHMESG_SDSPACE_FLAG
@MemberGetter public static int H5O_SHMESG_SDSPACE_FLAG()
Simple Dataspace Message.
-
H5O_SHMESG_DTYPE_FLAG
@MemberGetter public static int H5O_SHMESG_DTYPE_FLAG()
Datatype Message.
-
H5O_SHMESG_FILL_FLAG
@MemberGetter public static int H5O_SHMESG_FILL_FLAG()
Fill Value Message.
-
H5O_SHMESG_PLINE_FLAG
@MemberGetter public static int H5O_SHMESG_PLINE_FLAG()
Filter pipeline message.
-
H5O_SHMESG_ATTR_FLAG
@MemberGetter public static int H5O_SHMESG_ATTR_FLAG()
Attribute Message.
-
H5Oopen
@Cast("hid_t") public static long H5Oopen(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer name, @Cast("hid_t") long lapl_id)
------------------------------------------------------------------------- \ingroup H5O \brief Opens an object in an HDF5 file by location identifier and path name. \fgdta_loc_obj_id{loc_id}- Parameters:
name- [in] Path to the object; relative to \p loc_id \lapl_id- Returns:
- \hid_tv{object} \details H5Oopen() opens a group, dataset, or committed (named) datatype specified by a location, \p loc_id, and a path name, \p name, in an HDF5 file. This function opens the object in the same manner as H5Gopen(), H5Topen(), and H5Dopen(). However, H5Oopen() does not require the type of object to be known beforehand. This can be useful with user-defined links, for instance, when only a path may be known. H5Oopen() cannot be used to open a dataspace, attribute, property list, or file. Once an object of unknown type has been opened with H5Oopen(), the type of that object can be determined by means of an H5Iget_type() call. \p loc_id may be a file, group, dataset, named datatype, or attribute. If an attribute is specified for \p loc_id then the object where the attribute is attached will be accessed. \p name must be the path to that object relative to \p loc_id. \p lapl_id is the link access property list associated with the link pointing to the object. If default link access properties are appropriate, this can be passed in as #H5P_DEFAULT. When it is no longer needed, the opened object should be closed with H5Oclose(), H5Gclose(), H5Tclose(), or H5Dclose().
- Since:
- 1.8.0
-
H5Oopen
@Cast("hid_t") public static long H5Oopen(@Cast("hid_t") long loc_id, String name, @Cast("hid_t") long lapl_id)
-
H5Oopen_async
@Cast("hid_t") public static long H5Oopen_async(@Cast("const char*") BytePointer app_file, @Cast("const char*") BytePointer app_func, @Cast("unsigned") int app_line, @Cast("hid_t") long loc_id, @Cast("const char*") BytePointer name, @Cast("hid_t") long lapl_id, @Cast("hid_t") long es_id)
-------------------------------------------------------------------------- \ingroup ASYNC \async_variant_of{H5Oopen}
-
H5Oopen_async
@Cast("hid_t") public static long H5Oopen_async(String app_file, String app_func, @Cast("unsigned") int app_line, @Cast("hid_t") long loc_id, String name, @Cast("hid_t") long lapl_id, @Cast("hid_t") long es_id)
-
H5Oopen_by_token
@Cast("hid_t") public static long H5Oopen_by_token(@Cast("hid_t") long loc_id, @ByVal H5O_token_t token)
------------------------------------------------------------------------- \ingroup H5O \brief Opens an object in an HDF5 file using its VOL independent token \fgdta_loc_obj_id{loc_id}- Parameters:
token- [in] Object token- Returns:
- \hid_ti{object} \details H5Oopen_by_token() opens an object specified by the object identifier, \p loc_id and object token, \p token.
- Since:
- 1.12.0
-
H5Oopen_by_idx
@Cast("hid_t") public static long H5Oopen_by_idx(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer group_name, @Cast("H5_index_t") int idx_type, @Cast("H5_iter_order_t") int order, @Cast("hsize_t") long n, @Cast("hid_t") long lapl_id)
------------------------------------------------------------------------- \ingroup H5O \brief Opens the nth object in a group \fgdta_loc_obj_id{loc_id}- Parameters:
group_name- [in] Name of group, relative to \p loc_id, in which object is located \idx_type \ordern- [in] Object to open \lapl_id- Returns:
- \hid_tv{object} \details H5Oopen_by_idx() opens the nth object in the group specified by \p loc_id and \p group_name. \p loc_id specifies a location identifier. \p group_name specifies the group relative to \p loc_id in which the object can be found. If \p loc_id fully specifies the group in which the object resides, \p group_name can be a dot (.). The specific object to be opened within the group is specified by the three parameters: \p idx_type, \p order and \p n. \p idx_type specifies the type of index by which objects are ordered. Valid index types include the following: \indexes \p order specifies the order in which the objects are to be referenced for the purposes of this function. Valid orders include the following: \orders Note that for #H5_ITER_NATIVE, rather than implying a particular order, it instructs the HDF5 library to iterate through the objects in the fastest available order, i.e., in a natural order. \p n specifies the position of the object within the index. Note that this count is zero-based; 0 (zero) indicates that the function will return the value of the first object; if \p n is 5, the function will return the value of the sixth object; etc. \p lapl_id specifies the link access property list to be used in accessing the object. An object opened with this function should be closed when it is no longer needed so that resource leaks will not develop. H5Oclose() can be used to close groups, datasets, or committed datatypes.
- Since:
- 1.8.0
-
H5Oopen_by_idx
@Cast("hid_t") public static long H5Oopen_by_idx(@Cast("hid_t") long loc_id, String group_name, @Cast("H5_index_t") int idx_type, @Cast("H5_iter_order_t") int order, @Cast("hsize_t") long n, @Cast("hid_t") long lapl_id)
-
H5Oopen_by_idx_async
@Cast("hid_t") public static long H5Oopen_by_idx_async(@Cast("const char*") BytePointer app_file, @Cast("const char*") BytePointer app_func, @Cast("unsigned") int app_line, @Cast("hid_t") long loc_id, @Cast("const char*") BytePointer group_name, @Cast("H5_index_t") int idx_type, @Cast("H5_iter_order_t") int order, @Cast("hsize_t") long n, @Cast("hid_t") long lapl_id, @Cast("hid_t") long es_id)
-------------------------------------------------------------------------- \ingroup ASYNC \async_variant_of{H5Oopen_by_idx}
-
H5Oopen_by_idx_async
@Cast("hid_t") public static long H5Oopen_by_idx_async(String app_file, String app_func, @Cast("unsigned") int app_line, @Cast("hid_t") long loc_id, String group_name, @Cast("H5_index_t") int idx_type, @Cast("H5_iter_order_t") int order, @Cast("hsize_t") long n, @Cast("hid_t") long lapl_id, @Cast("hid_t") long es_id)
-
H5Oexists_by_name
@Cast("htri_t") public static int H5Oexists_by_name(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer name, @Cast("hid_t") long lapl_id)
------------------------------------------------------------------------- \ingroup H5O \brief Determines whether a link resolves to an actual object. \fgdta_loc_obj_id{loc_id}- Parameters:
name- [in] The name of the link to check \lapl_id- Returns:
- Returns a positive value if the object pointed to by the \p loc_id and \p name combination exists.
- Since:
- 1.8.5
-
H5Oexists_by_name
@Cast("htri_t") public static int H5Oexists_by_name(@Cast("hid_t") long loc_id, String name, @Cast("hid_t") long lapl_id)
-
H5Oget_info3
@Cast("herr_t") public static int H5Oget_info3(@Cast("hid_t") long loc_id, H5O_info2_t oinfo, @Cast("unsigned") int fields)
------------------------------------------------------------------------- \ingroup H5O \brief Retrieves the metadata for an object specified by an identifier \fgdta_loc_obj_id{loc_id}- Parameters:
oinfo- [out] Buffer in which to return object informationfields- [in] Flags specifying the fields to include in \p oinfo- Returns:
- \herr_t \details H5Oget_info3() specifies an object by its identifier, \p loc_id , and retrieves the metadata describing that object in \p oinfo. The \p fields parameter contains flags to determine which fields will be filled in the H5O_info2_t \c struct returned in \p oinfo. These flags are defined in the H5Opublic.h file: \obj_info_fields \par Example An example snippet from examples/h5_attribute.c: \par \snippet h5_attribute.c H5Oget_info3_snip \note If you are iterating through a lot of different objects to retrieve information via the H5Oget_info() family of routines, you may see memory building up. This can be due to memory allocation for metadata such as object headers and messages when the iterated objects are put into the metadata cache. \note If the memory buildup is not desirable, you can configure a smaller cache via H5Fset_mdc_config() or set the file access property list via H5Pset_mdc_config(). A smaller sized cache will force metadata entries to be evicted from the cache, thus freeing the memory associated with the entries.
- Since:
- 1.12.0
-
H5Oget_info_by_name3
@Cast("herr_t") public static int H5Oget_info_by_name3(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer name, H5O_info2_t oinfo, @Cast("unsigned") int fields, @Cast("hid_t") long lapl_id)
------------------------------------------------------------------------- \ingroup H5O \brief Retrieves the metadata for an object, identifying the object by location and relative name \fgdta_loc_obj_id{loc_id}- Parameters:
name- [in] Name of object, relative to \p loc_idoinfo- [out] Buffer in which to return object informationfields- [in] Flags specifying the fields to include in \p oinfo \lapl_id- Returns:
- \herr_t \details H5Oget_info_by_name3() specifies an objectâs location and name, \p loc_id and \p name, respectively, and retrieves the metadata describing that object in \p oinfo, an H5O_info2_t struct. The \p fields parameter contains flags to determine which fields will be filled in the H5O_info2_t \c struct returned in \p oinfo. These flags are defined in the H5Opublic.h file: \obj_info_fields The link access property list, \c lapl_id, is not currently used; it should be passed in as #H5P_DEFAULT. \par Example An example snippet from test/vol.c: \snippet vol.c H5Oget_info_by_name3_snip
- Since:
- 1.12.0
-
H5Oget_info_by_name3
@Cast("herr_t") public static int H5Oget_info_by_name3(@Cast("hid_t") long loc_id, String name, H5O_info2_t oinfo, @Cast("unsigned") int fields, @Cast("hid_t") long lapl_id)
-
H5Oget_info_by_name_async
@Cast("herr_t") public static int H5Oget_info_by_name_async(@Cast("const char*") BytePointer app_file, @Cast("const char*") BytePointer app_func, @Cast("unsigned") int app_line, @Cast("hid_t") long loc_id, @Cast("const char*") BytePointer name, H5O_info2_t oinfo, @Cast("unsigned") int fields, @Cast("hid_t") long lapl_id, @Cast("hid_t") long es_id)
-------------------------------------------------------------------------- \ingroup ASYNC \async_variant_of{H5Oget_info_by_name}
-
H5Oget_info_by_name_async
@Cast("herr_t") public static int H5Oget_info_by_name_async(String app_file, String app_func, @Cast("unsigned") int app_line, @Cast("hid_t") long loc_id, String name, H5O_info2_t oinfo, @Cast("unsigned") int fields, @Cast("hid_t") long lapl_id, @Cast("hid_t") long es_id)
-
H5Oget_info_by_idx3
@Cast("herr_t") public static int H5Oget_info_by_idx3(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer group_name, @Cast("H5_index_t") int idx_type, @Cast("H5_iter_order_t") int order, @Cast("hsize_t") long n, H5O_info2_t oinfo, @Cast("unsigned") int fields, @Cast("hid_t") long lapl_id)
------------------------------------------------------------------------- \ingroup H5O \brief Retrieves the metadata for an object, identifying the object by an index position \fgdta_loc_obj_id{loc_id}- Parameters:
group_name- [in] Name of group in which object is located \idx_type \ordern- [in] Position within the indexoinfo- [out] Buffer in which to return object informationfields- [in] Flags specifying the fields to include in \p oinfo \lapl_id- Returns:
- \herr_t \details H5Oget_info_by_idx3() retrieves the metadata describing an object in the \c struct \p oinfo, as specified by the location, \p loc_id, group name, \p group_name, the index by which objects in that group are tracked, \p idx_type, the order by which the index is to be traversed, \p order, and an objectâs position \p n within that index. If \p loc_id fully specifies the group in which the object resides, \p group_name can be a dot (\c .). The \p fields parameter contains flags to determine which fields will be filled in the H5O_info2_t \c struct returned in \p oinfo. These flags are defined in the H5Opublic.h file: \obj_info_fields The link access property list, \c lapl_id, is not currently used; it should be passed in as #H5P_DEFAULT. \par Example An example snippet from test/titerate.c: \snippet titerate.c H5Oget_info_by_idx3_snip
- Since:
- 1.12.0
-
H5Oget_info_by_idx3
@Cast("herr_t") public static int H5Oget_info_by_idx3(@Cast("hid_t") long loc_id, String group_name, @Cast("H5_index_t") int idx_type, @Cast("H5_iter_order_t") int order, @Cast("hsize_t") long n, H5O_info2_t oinfo, @Cast("unsigned") int fields, @Cast("hid_t") long lapl_id)
-
H5Oget_native_info
@Cast("herr_t") public static int H5Oget_native_info(@Cast("hid_t") long loc_id, H5O_native_info_t oinfo, @Cast("unsigned") int fields)
------------------------------------------------------------------------- \ingroup H5O \brief Retrieve native file format information about an object \fgdta_loc_obj_id{loc_id}- Parameters:
oinfo- [out] Buffer in which to return native object informationfields- [in] Flags to determine which fields in \p oinfo are filled in- Returns:
- \herr_t \details H5Oget_native_info() retrieves the native file format information for an object specified by \p loc_id. The \p fields parameter indicates which fields to fill in H5O_native_info_t. Possible values defined in H5Opublic.h are: \snippet this H5O_native_info_fields_snip \par Example An example snippet from test/tfile.c: \par \snippet tfile.c H5Oget_native_info_snip
- Since:
- 1.12.0
-
H5Oget_native_info_by_name
@Cast("herr_t") public static int H5Oget_native_info_by_name(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer name, H5O_native_info_t oinfo, @Cast("unsigned") int fields, @Cast("hid_t") long lapl_id)
------------------------------------------------------------------------- \ingroup H5O \brief Retrieve native file format information about an object given its name \fgdta_loc_obj_id{loc_id}- Parameters:
name- [in] Name of objectoinfo- [out] Buffer in which to return native object informationfields- [in] Flags to determine which fields in \p oinfo are filled in \lapl_id- Returns:
- \herr_t \details H5Oget_native_info_by_name() retrieves the native file format information for an object specified by \p loc_id and the name \p name. The \p fields parameter which fields to fill in H5O_native_info_t. Possible values defined in H5Opublic.h are: \snippet this H5O_native_info_fields_snip \par Example An example snippet from test/tfile.c: \snippet tfile.c H5Oget_native_info_by_name_snip
- Since:
- 1.12.0
-
H5Oget_native_info_by_name
@Cast("herr_t") public static int H5Oget_native_info_by_name(@Cast("hid_t") long loc_id, String name, H5O_native_info_t oinfo, @Cast("unsigned") int fields, @Cast("hid_t") long lapl_id)
-
H5Oget_native_info_by_idx
@Cast("herr_t") public static int H5Oget_native_info_by_idx(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer group_name, @Cast("H5_index_t") int idx_type, @Cast("H5_iter_order_t") int order, @Cast("hsize_t") long n, H5O_native_info_t oinfo, @Cast("unsigned") int fields, @Cast("hid_t") long lapl_id)
------------------------------------------------------------------------- \ingroup H5O \brief Retrieve native file format information about an object according to the order of an index \fgdta_loc_obj_id{loc_id}- Parameters:
group_name- [in] Name of group in which object is located \idx_type \ordern- [in] Position within the indexoinfo- [out] Buffer in which to return native object informationfields- [in] Flags to determine which fields in \p oinfo are filled in \lapl_id- Returns:
- \herr_t \details H5Oget_native_info_by_idx() retrieves the native file format information for an object specified by \p loc_id, group name, \p group_name, the index by which objects in the group are tracked, \p idx_type, the order by which the index is to be traversed, \p order , and an object's position \p n within that index. The \p fields parameter indicates which fields to fill in H5O_native_info_t. Possible values defined in H5Opublic.h are: \snippet this H5O_native_info_fields_snip The link access property list, \c lapl_id, is not currently used; it should be passed in as #H5P_DEFAULT.
- Since:
- 1.12.0
-
H5Oget_native_info_by_idx
@Cast("herr_t") public static int H5Oget_native_info_by_idx(@Cast("hid_t") long loc_id, String group_name, @Cast("H5_index_t") int idx_type, @Cast("H5_iter_order_t") int order, @Cast("hsize_t") long n, H5O_native_info_t oinfo, @Cast("unsigned") int fields, @Cast("hid_t") long lapl_id)
-
H5Olink
@Cast("herr_t") public static int H5Olink(@Cast("hid_t") long obj_id, @Cast("hid_t") long new_loc_id, @Cast("const char*") BytePointer new_name, @Cast("hid_t") long lcpl_id, @Cast("hid_t") long lapl_id)
------------------------------------------------------------------------- \ingroup H5O \brief Creates a hard link to an object in an HDF5 file- Parameters:
obj_id- [in] Object to be linkednew_loc_id- [in] Location identifier at which object is to be linked; may be a file, group, dataset, named datatype or attribute identifier.new_name- [in] Name of link to be created, relative to \p new_loc_id. \lcpl_id \lapl_id- Returns:
- \herr_t
\details H5Olink() creates a new hard link to an object in an HDF5 file.
\p new_loc_id and \p \p new_link_name specify the location and name of the
new link while \p object_id identifies the object that the link
points to.
H5Olink() is designed for two purposes:
- To create the first hard link to an object that has just
been created with H5Dcreate_anon(), H5Gcreate_anon(), or
H5Tcommit_anon().
- To add additional structure to an existing
file so that, for example, an object can be shared among
multiple groups.
\p lcpl and \p lapl are the link creation and access property lists
associated with the new link.
\par Example:
To create a new link to an object while simultaneously creating
missing intermediate groups: Suppose that an application must
create the group C with the path /A/B01/C but may not know
at run time whether the groups A and B01 exist. The following
code ensures that those groups are created if they are missing:
\par
\par Note that unless the object is intended to be temporary, the H5O_LINK call is mandatory if an object created with one of the H5*_CREATE_ANON functions (or with H5T_COMMIT_ANON) is to be retained in the file; without an H5O_LINK call, the object will not be linked into the HDF5 file structure and will be deleted when the file is closed.// Creates a link creation property list (LCPL). hid_t lcpl_id = H5Pcreate(H5P_LINK_CREATE); // Sets "create missing intermediate groups" property in that LCPL. int status = H5Pset_create_intermediate_group(lcpl_id, TRUE); // Creates a group without linking it into the file structure. hid_t gid = H5Gcreate_anon(file_id, H5P_DEFAULT, H5P_DEFAULT); // Links group into file structure. status = H5Olink(gid, file_id, "/A/B01/C", lcpl_id, H5P_DEFAULT); - Since:
- 1.8.0
-
H5Olink
@Cast("herr_t") public static int H5Olink(@Cast("hid_t") long obj_id, @Cast("hid_t") long new_loc_id, String new_name, @Cast("hid_t") long lcpl_id, @Cast("hid_t") long lapl_id)
-
H5Oincr_refcount
@Cast("herr_t") public static int H5Oincr_refcount(@Cast("hid_t") long object_id)
------------------------------------------------------------------------- \ingroup H5O \brief Increments an object reference count \fgdta_loc_obj_id{object_id}- Returns:
- \herr_t \details H5Oincr_refcount() increments the hard link reference count for an object. It should be used any time a user-defined link that references an object by address is added. When the link is deleted, H5Odecr_refcount() should be used. An objectâs reference count is the number of hard links in the file that point to that object. See the âProgramming Modelâ section of the HDF5 Groups chapter in the -- \ref UG for a more complete discussion of reference counts. If a user application needs to determine an objectâs reference count, an H5Oget_info() call is required; the reference count is returned in the \c rc field of the #H5O_info_t \c struct. \warning This function must be used with care! \warning Improper use can lead to inaccessible data, wasted space in the file, or file corruption.
- Since:
- 1.8.0
-
H5Odecr_refcount
@Cast("herr_t") public static int H5Odecr_refcount(@Cast("hid_t") long object_id)
------------------------------------------------------------------------- \ingroup H5O \brief Decrements an object reference count \fgdta_loc_obj_id{object_id}- Returns:
- \herr_t \details H5Odecr_refcount() decrements the hard link reference count for an object. It should be used any time a user-defined link that references an object by address is deleted. In general, H5Oincr_refcount() will have been used previously, when the link was created. An objectâs reference count is the number of hard links in the file that point to that object. See the âProgramming Modelâ section of the HDF5 Groups chapter in the \ref UG for a more complete discussion of reference counts. If a user application needs to determine an objectâs reference count, an H5Oget_info() call is required; the reference count is returned in the \c rc field of the #H5O_info_t \c struct. \warning This function must be used with care! \warning Improper use can lead to inaccessible data, wasted space in the file, or file corruption.
- Since:
- 1.8.0
-
H5Ocopy
@Cast("herr_t") public static int H5Ocopy(@Cast("hid_t") long src_loc_id, @Cast("const char*") BytePointer src_name, @Cast("hid_t") long dst_loc_id, @Cast("const char*") BytePointer dst_name, @Cast("hid_t") long ocpypl_id, @Cast("hid_t") long lcpl_id)
------------------------------------------------------------------------- \ingroup H5O \brief Copies an object in an HDF5 file- Parameters:
src_loc_id- [in] Object identifier indicating the location of the source object to be copiedsrc_name- [in] Name of the source object to be copieddst_loc_id- [in] Location identifier specifying the destinationdst_name- [in] Name to be assigned to the new copyocpypl_id- [in] Object copy property list \lcpl_id- Returns:
- \herr_t \details H5Ocopy() copies the group, dataset or committed datatype specified by \p src_name from the file or group specified by \p src_loc_id to the destination location \p dst_loc_id. The destination location, as specified in dst_loc_id, may be a group in the current file or a location in a different file. If dst_loc_id is a file identifier, the copy will be placed in that fileâs root group. The copy will be created with the path specified in \p dst_name, which must not pre-exist in the destination location. If \p dst_name already exists at the location \p dst_loc_id, H5Ocopy() will fail. If \p dst_name is an absolute path, the copy will be created relative to the fileâs root group. The copy of the object is created with the property lists specified by \p ocpypl_id and \p lcpl_id. #H5P_DEFAULT can be passed in for these property lists. The default behavior: - of the link creation property list is to NOT create intermediate groups. - of the flags specified by the object creation property list is described in H5Pset_copy_object(). These property lists or flags can be modified to govern the behavior of H5Ocopy() as follows: - A flag controlling the creation of intermediate groups that may not yet exist is set in the link creation property list \p lcpl_id with H5Pset_create_intermediate_group(). - Copying of committed datatypes can be tuned through the use of H5Pset_copy_object(), H5Padd_merge_committed_dtype_path(), H5Pset_mcdt_search_cb(), and related functions. - Flags controlling other aspects of object copying are set in the object copy property list \p ocpypl_id with H5Pset_copy_object(). H5Ocopy() will always try to make a copy of the object specified in \p src_name. - If the object specified by \p src_name is a group containing a soft or external link, the default is that the new copy will contain a soft or external link with the same value as the original. See H5Pset_copy_object() for optional settings. - If the path specified in \p src_name is or contains a soft link or an external link, H5Ocopy() will copy the target object. Use H5Lcopy() if the intent is to create a new soft or external link with the same value as the original link. H5Ocopy() can be used to copy an object in an HDF5 file. If an object has been changed since it was opened, it should be written back to the file before using H5Ocopy(). The object can be written back either by closing the object (H5Gclose(), H5Oclose(), H5Dclose(), or H5Tclose()) or by flushing the HDF5 file (H5Fflush()). \par See Also: - Functions to modify the behavior of H5Ocopy(): - H5Padd_merge_committed_dtype_path() - H5Pset_copy_object() - H5Pset_create_intermediate_group() - H5Pset_mcdt_search_cb() - Copying Committed Datatypes with #H5Ocopy - A comprehensive discussion of copying committed datatypes (PDF) in Advanced Topics in HDF5
- Since:
- 1.8.0
-
H5Ocopy
@Cast("herr_t") public static int H5Ocopy(@Cast("hid_t") long src_loc_id, String src_name, @Cast("hid_t") long dst_loc_id, String dst_name, @Cast("hid_t") long ocpypl_id, @Cast("hid_t") long lcpl_id)
-
H5Ocopy_async
@Cast("herr_t") public static int H5Ocopy_async(@Cast("const char*") BytePointer app_file, @Cast("const char*") BytePointer app_func, @Cast("unsigned") int app_line, @Cast("hid_t") long src_loc_id, @Cast("const char*") BytePointer src_name, @Cast("hid_t") long dst_loc_id, @Cast("const char*") BytePointer dst_name, @Cast("hid_t") long ocpypl_id, @Cast("hid_t") long lcpl_id, @Cast("hid_t") long es_id)
-------------------------------------------------------------------------- \ingroup ASYNC \async_variant_of{H5Ocopy}
-
H5Ocopy_async
@Cast("herr_t") public static int H5Ocopy_async(String app_file, String app_func, @Cast("unsigned") int app_line, @Cast("hid_t") long src_loc_id, String src_name, @Cast("hid_t") long dst_loc_id, String dst_name, @Cast("hid_t") long ocpypl_id, @Cast("hid_t") long lcpl_id, @Cast("hid_t") long es_id)
-
H5Oset_comment
@Cast("herr_t") public static int H5Oset_comment(@Cast("hid_t") long obj_id, @Cast("const char*") BytePointer comment)
------------------------------------------------------------------------- \ingroup H5O \brief Sets comment for specified object \fgdta_loc_obj_id{obj_id}- Parameters:
comment- [in] The new comment- Returns:
- \herr_t \details H5Oset_comment() sets the comment for the specified object to the contents of \p comment. Any previously existing comment is overwritten. The target object is specified by an identifier, \p obj_id. If \p comment is the empty string or a null pointer, any existing comment message is removed from the object. Comments should be relatively short, null-terminated, ASCII strings. Comments can be attached to any object that has an object header. Datasets, groups, and committed (named) datatypes have object headers. Symbolic links do not have object headers. If a comment is being added to an object attribute, this comment will be attached to the object to which the attribute belongs and not to the attribute itself.
- Since:
- 1.8.0
-
H5Oset_comment
@Cast("herr_t") public static int H5Oset_comment(@Cast("hid_t") long obj_id, String comment)
-
H5Oset_comment_by_name
@Cast("herr_t") public static int H5Oset_comment_by_name(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer name, @Cast("const char*") BytePointer comment, @Cast("hid_t") long lapl_id)
------------------------------------------------------------------------- \ingroup H5O \brief Sets comment for specified object \fgdta_loc_obj_id{loc_id}- Parameters:
name- [in] Name of the object whose comment is to be set or resetcomment- [in] The new comment \lapl_id- Returns:
- \herr_t \details H5Oset_comment_by_name() sets the comment for the specified object to the contents of \p comment. Any previously existing comment is overwritten. The target object is specified by \p loc_id and \p name. \p loc_id can specify any object in the file. \p name can be one of the following: - The name of the object specified as a path relative to \p loc_id - An absolute name of the object, starting from \c /, the fileâs root group - A dot (\c .), if \p loc_id fully specifies the object If \p comment is the empty string or a null pointer, any existing comment message is removed from the object. Comments should be relatively short, null-terminated, ASCII strings. Comments can be attached to any object that has an object header. Datasets, groups, and committed (named) datatypes have object headers. Symbolic links do not have object headers. If a comment is being added to an object attribute, this comment will be attached to the object to which the attribute belongs and not to the attribute itself. \p lapl_id contains a link access property list identifier. A link access property list can come into play when traversing links to access an object.
- Since:
- 1.8.0
-
H5Oset_comment_by_name
@Cast("herr_t") public static int H5Oset_comment_by_name(@Cast("hid_t") long loc_id, String name, String comment, @Cast("hid_t") long lapl_id)
-
H5Oget_comment
@Cast("ssize_t") public static long H5Oget_comment(@Cast("hid_t") long obj_id, @Cast("char*") BytePointer comment, @Cast("size_t") long bufsize)
------------------------------------------------------------------------- \ingroup H5O \brief Retrieves comment for specified object \fgdta_loc_obj_id{obj_id}- Parameters:
comment- [out] The commentbufsize- [in] Anticipated required size of the comment buffer- Returns:
- Upon success, returns the number of characters in the comment, not including the \c NULL terminator, or zero (\c 0) if the object has no comment. The value returned may be larger than \p bufsize. Otherwise returns a negative value. \details H5Oget_comment() retrieves the comment for the specified object in the buffer \p comment. The target object is specified by an identifier, \p object_id. The size in bytes of the buffer \p comment, including the \c NULL terminator, is specified in \p bufsize. If \p bufsize is unknown, a preliminary H5Oget_comment() call with the pointer \p comment set to \c NULL will return the size of the comment without the \c NULL terminator. If \p bufsize is set to a smaller value than described above, only \p bufsize bytes of the comment, without a \c NULL terminator, are returned in \p comment. If an object does not have a comment, the empty string is returned in \p comment.
- Since:
- 1.8.0
-
H5Oget_comment
@Cast("ssize_t") public static long H5Oget_comment(@Cast("hid_t") long obj_id, @Cast("char*") ByteBuffer comment, @Cast("size_t") long bufsize)
-
H5Oget_comment
@Cast("ssize_t") public static long H5Oget_comment(@Cast("hid_t") long obj_id, @Cast("char*") byte[] comment, @Cast("size_t") long bufsize)
-
H5Oget_comment_by_name
@Cast("ssize_t") public static long H5Oget_comment_by_name(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer name, @Cast("char*") BytePointer comment, @Cast("size_t") long bufsize, @Cast("hid_t") long lapl_id)
------------------------------------------------------------------------- \ingroup H5O \brief Retrieves comment for specified object \fgdta_loc_obj_id{loc_id}- Parameters:
name- [in] Name of the object whose comment is to be retrievedcomment- [out] The commentbufsize- [in] Anticipated required size of the \p comment buffer \lapl_id- Returns:
- Upon success, returns the number of characters in the comment, not including the \c NULL terminator, or zero (\c 0) if the object has no comment. The value returned may be larger than \c bufsize. Otherwise returns a negative value. \details H5Oget_comment_by_name() retrieves the comment for an object in the buffer \p comment. The target object is specified by \p loc_id and \p name. \p loc_id can specify any object in the file. \p name can be one of the following: - The name of the object relative to \p loc_id - An absolute name of the object, starting from \c /, the fileâs root group - A dot (\c .), if \p loc_id fully specifies the object The size in bytes of the comment, including the \c NULL terminator, is specified in \p bufsize. If \p bufsize is unknown, a preliminary H5Oget_comment_by_name() call with the pointer \p comment set to \c NULL will return the size of the comment without the \c NULL terminator. If \p bufsize is set to a smaller value than described above, only \p bufsize bytes of the comment, without a \c NULL terminator, are returned in \p comment. If an object does not have a comment, the empty string is returned in \p comment. \p lapl_id contains a link access property list identifier. A link access property list can come into play when traversing links to access an object.
- Since:
- 1.8.0
-
H5Oget_comment_by_name
@Cast("ssize_t") public static long H5Oget_comment_by_name(@Cast("hid_t") long loc_id, String name, @Cast("char*") ByteBuffer comment, @Cast("size_t") long bufsize, @Cast("hid_t") long lapl_id)
-
H5Oget_comment_by_name
@Cast("ssize_t") public static long H5Oget_comment_by_name(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer name, @Cast("char*") byte[] comment, @Cast("size_t") long bufsize, @Cast("hid_t") long lapl_id)
-
H5Oget_comment_by_name
@Cast("ssize_t") public static long H5Oget_comment_by_name(@Cast("hid_t") long loc_id, String name, @Cast("char*") BytePointer comment, @Cast("size_t") long bufsize, @Cast("hid_t") long lapl_id)
-
H5Oget_comment_by_name
@Cast("ssize_t") public static long H5Oget_comment_by_name(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer name, @Cast("char*") ByteBuffer comment, @Cast("size_t") long bufsize, @Cast("hid_t") long lapl_id)
-
H5Oget_comment_by_name
@Cast("ssize_t") public static long H5Oget_comment_by_name(@Cast("hid_t") long loc_id, String name, @Cast("char*") byte[] comment, @Cast("size_t") long bufsize, @Cast("hid_t") long lapl_id)
-
H5Ovisit3
@Cast("herr_t") public static int H5Ovisit3(@Cast("hid_t") long obj_id, @Cast("H5_index_t") int idx_type, @Cast("H5_iter_order_t") int order, H5O_iterate2_t op, Pointer op_data, @Cast("unsigned") int fields)
------------------------------------------------------------------------- \ingroup H5O \brief Recursively visits all objects accessible from a specified object \fgdta_loc_obj_id{obj_id} \idx_type \order- Parameters:
op- [in] Callback function passing data regarding the object to the calling applicationop_data- [in] User-defined pointer to data required by the application for its processing of the objectfields- [in] Flags specifying the fields to be retrieved to the callback \p op- Returns:
- On success, returns the return value of the first operator that returns a positive value, or zero if all members were processed with no operator returning non-zero.
- Since:
- 1.12.0
-
H5Ovisit_by_name3
@Cast("herr_t") public static int H5Ovisit_by_name3(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer obj_name, @Cast("H5_index_t") int idx_type, @Cast("H5_iter_order_t") int order, H5O_iterate2_t op, Pointer op_data, @Cast("unsigned") int fields, @Cast("hid_t") long lapl_id)
------------------------------------------------------------------------- \ingroup H5O \brief Recursively visits all objects accessible from a specified object \fgdta_loc_obj_id{loc_id}- Parameters:
obj_name- [in] Name of the object, generally relative to \p loc_id, that will serve as root of the iteration \idx_type \orderop- [in] Callback function passing data regarding the object to the calling applicationop_data- [in] User-defined pointer to data required by the application for its processing of the objectfields- [in] Flags specifying the fields to be retrieved to the callback function \p op \lapl_id- Returns:
- On success, returns the return value of the first operator that returns a positive value, or zero if all members were processed with no operator returning non-zero.
- Since:
- 1.12.0
-
H5Ovisit_by_name3
@Cast("herr_t") public static int H5Ovisit_by_name3(@Cast("hid_t") long loc_id, String obj_name, @Cast("H5_index_t") int idx_type, @Cast("H5_iter_order_t") int order, H5O_iterate2_t op, Pointer op_data, @Cast("unsigned") int fields, @Cast("hid_t") long lapl_id)
-
H5Oclose
@Cast("herr_t") public static int H5Oclose(@Cast("hid_t") long object_id)
------------------------------------------------------------------------- \ingroup H5O \brief Closes an object in an HDF5 file \obj_id{object_id}- Returns:
- \herr_t \details H5Oclose() closes the group, dataset, or named datatype specified by object_id. This function is the companion to H5Oopen(), and has the same effect as calling H5Gclose(), H5Dclose(), or H5Tclose(). H5Oclose() is not used to close a dataspace, attribute, property list, or file.
- Since:
- 1.8.0
-
H5Oclose_async
@Cast("herr_t") public static int H5Oclose_async(@Cast("const char*") BytePointer app_file, @Cast("const char*") BytePointer app_func, @Cast("unsigned") int app_line, @Cast("hid_t") long object_id, @Cast("hid_t") long es_id)
-------------------------------------------------------------------------- \ingroup ASYNC \async_variant_of{H5Oclose}
-
H5Oclose_async
@Cast("herr_t") public static int H5Oclose_async(String app_file, String app_func, @Cast("unsigned") int app_line, @Cast("hid_t") long object_id, @Cast("hid_t") long es_id)
-
H5Oflush
@Cast("herr_t") public static int H5Oflush(@Cast("hid_t") long obj_id)
------------------------------------------------------------------------- \ingroup H5O \brief Flushes all buffers associated with an HDF5 object to disk \fgdta_loc_obj_id{obj_id}- Returns:
- \herr_t \details H5Oflush() causes all buffers associated with an object to be immediately flushed to disk without removing the data from the cache. The object associated with \p object_id can be any named object in an HDF5 file including a dataset, a group, or a committed datatype. \warning H5Oflush doesn't work correctly with parallel. It causes an assertion failure in metadata cache during H5Fclose(). \note HDF5 does not possess full control over buffering. H5Oflush() flushes the internal HDF5 buffers and then asks the operating system (the OS) to flush the system buffers for the open files. After that, the OS is responsible for ensuring that the data is actually flushed to disk.
- Since:
- 1.10.0
-
H5Oflush_async
@Cast("herr_t") public static int H5Oflush_async(@Cast("const char*") BytePointer app_file, @Cast("const char*") BytePointer app_func, @Cast("unsigned") int app_line, @Cast("hid_t") long obj_id, @Cast("hid_t") long es_id)
-------------------------------------------------------------------------- \ingroup ASYNC \async_variant_of{H5Oflush}
-
H5Oflush_async
@Cast("herr_t") public static int H5Oflush_async(String app_file, String app_func, @Cast("unsigned") int app_line, @Cast("hid_t") long obj_id, @Cast("hid_t") long es_id)
-
H5Orefresh
@Cast("herr_t") public static int H5Orefresh(@Cast("hid_t") long oid)
------------------------------------------------------------------------- \ingroup H5O \brief Refreshes all buffers associated with an HDF5 object \fgdta_loc_obj_id{oid}- Returns:
- \herr_t \details H5Orefresh() causes all buffers associated with an object to be cleared and immediately re-loaded with updated contents from disk. This function essentially closes the object, evicts all metadata associated with it from the cache, and then re-opens the object. The reopened object is automatically re-registered with the same identifier. The object associated with \p oid can be any named object in an HDF5 file including a dataset, a group, or a committed datatype.
- Since:
- 1.10.0
-
H5Orefresh_async
@Cast("herr_t") public static int H5Orefresh_async(@Cast("const char*") BytePointer app_file, @Cast("const char*") BytePointer app_func, @Cast("unsigned") int app_line, @Cast("hid_t") long oid, @Cast("hid_t") long es_id)
-------------------------------------------------------------------------- \ingroup ASYNC \async_variant_of{H5Orefresh}
-
H5Orefresh_async
@Cast("herr_t") public static int H5Orefresh_async(String app_file, String app_func, @Cast("unsigned") int app_line, @Cast("hid_t") long oid, @Cast("hid_t") long es_id)
-
H5Odisable_mdc_flushes
@Cast("herr_t") public static int H5Odisable_mdc_flushes(@Cast("hid_t") long object_id)
------------------------------------------------------------------------- \ingroup H5O \brief Prevents metadata entries for an HDF5 object from being flushed from the metadata cache to storage- Parameters:
object_id- [in] Identifier of the object that will have flushes disabled; may be a group, named datatype, or dataset identifier- Returns:
- \herr_t \details H5Odisable_mdc_flushes(), H5Oenable_mdc_flushes() and associated flush functions can be used to control the flushing of entries from a fileâs metadata cache. This function prevents an objectâs or cacheâs dirty metadata entries from being flushed from the cache by the usual cache eviction/flush policy. Instead, users must manually flush the cache or entries for individual objects via the appropriate H5Fflush(), H5Dflush(), H5Gflush(), H5Tflush(), and H5Oflush() calls. Metadata cache entries can be controlled at both the individual HDF5 object level (datasets, groups, committed datatypes) and the entire metadata cache level. \note HDF5 objects include datasets, groups, and committed datatypes. Only #hid_t identifiers that represent these objects can be passed to the function. Passing in a #hid_t identifier that represents any other HDF5 entity is considered an error. It is an error to pass an HDF5 file identifier (obtained from H5Fopen() or H5Fcreate()) to this function. Misuse of this function can cause the cache to exhaust available memory. Objects can be returned to the default automatic flush behavior with H5Oenable_mdc_flushes(). Flush prevention only pertains to new or dirty metadata entries. Clean entries can be evicted from the cache. Calling this function on an object that has already had flushes disabled will return an error.
- Since:
- 1.10.0
-
H5Oenable_mdc_flushes
@Cast("herr_t") public static int H5Oenable_mdc_flushes(@Cast("hid_t") long object_id)
------------------------------------------------------------------------- \ingroup H5O \brief Enables flushing of dirty metadata entries from a fileâs metadata cache- Parameters:
object_id- [in] Identifier of the object that will have flushes re-enabled; may be a group, named datatype, or dataset identifier- Returns:
- \herr_t \details H5Oenable_mdc_flushes(), H5Odisable_mdc_flushes() and associated flush functions can be used to control the flushing of entries from a fileâs metadata cache. This function allows an object or cacheâs dirty metadata entries to be flushed from the cache by the usual cache eviction/flush policy. Metadata cache entries can be controlled at both the individual HDF5 object level (datasets, groups, committed datatypes) and the entire metadata cache level. \note HDF5 objects include datasets, groups, and committed datatypes. Only #hid_t identifiers that represent these objects can be passed to the function. Passing in a #hid_t identifier that represents any other HDF5 entity is considered an error. It is an error to pass an HDF5 file identifier (obtained from H5Fopen() or H5Fcreate()) to this function. Using this function on an object that has not had flushes disabled is considered an error. The state of an object can be determined with H5Oare_mdc_flushes_disabled(). An object will be returned to the default flush algorithm when it is closed. All objects will be returned to the default flush algorithm when the file is closed. An objectâs entries will not necessarily be flushed as a result of calling this function.
- Since:
- 1.10.0
-
H5Oare_mdc_flushes_disabled
@Cast("herr_t") public static int H5Oare_mdc_flushes_disabled(@Cast("hid_t") long object_id, @Cast("hbool_t*") BoolPointer are_disabled)
------------------------------------------------------------------------- \ingroup H5O \brief Retrieves comment for specified object- Parameters:
object_id- [in] Identifier of an object in the cache; may be a group, named datatype, or dataset identifierare_disabled- [out] Flushes enabled/disabled- Returns:
- \p are_disabled will be set to \c 1 if an object has had flushes disabled and \c 0 if it has not had flushes disabled.
- Since:
- 1.10.0
-
H5Oare_mdc_flushes_disabled
@Cast("herr_t") public static int H5Oare_mdc_flushes_disabled(@Cast("hid_t") long object_id, @Cast("hbool_t*") boolean[] are_disabled)
-
H5Otoken_cmp
@Cast("herr_t") public static int H5Otoken_cmp(@Cast("hid_t") long loc_id, @Const H5O_token_t token1, @Const H5O_token_t token2, IntPointer cmp_value)
------------------------------------------------------------------------- \ingroup H5O \brief Compares two VOL connector object tokens \fgdta_loc_obj_id{loc_id}- Parameters:
token- [in] 1 First object tokentoken- [in] 2 Second object tokencmp_value- [out] Comparison value- Returns:
- \herr_t
\details H5Otoken_cmp() compares two VOL connector object tokens, \p token1
and \p token2 for the file or group identifier specified by \p loc_id.
Both object tokens must be from the same VOL connector class.
H5O_token_t is defined in H5public.h as follows:
\snippet H5public.h H5O_token_t_snip
A comparison value, \p cmp_value, is returned, which indicates the
result of the comparison:
\par Example An example snippet from test/links.c: \snippet links.c H5Otoken_cmp_snipcmp_value Result > 0 \p token1 > \p token2 < 0 \p token1 < \p token2 0 \p token1 = \p token2 - Since:
- 1.12.0
-
H5Otoken_cmp
@Cast("herr_t") public static int H5Otoken_cmp(@Cast("hid_t") long loc_id, @Const H5O_token_t token1, @Const H5O_token_t token2, IntBuffer cmp_value)
-
H5Otoken_cmp
@Cast("herr_t") public static int H5Otoken_cmp(@Cast("hid_t") long loc_id, @Const H5O_token_t token1, @Const H5O_token_t token2, int[] cmp_value)
-
H5Otoken_to_str
@Cast("herr_t") public static int H5Otoken_to_str(@Cast("hid_t") long loc_id, @Const H5O_token_t token, @Cast("char**") PointerPointer token_str)
------------------------------------------------------------------------- \ingroup H5O \brief Serializes a connector's object token into a string \fgdta_loc_obj_id{loc_id}- Parameters:
token- [in] Connector object tokentoken_str- [out] String for connector object token \p token- Returns:
- \herr_t \details H5Otoken_to_str() serializes a connector's object token specified by \p token and the location identifier for the object, \p loc_id, into a string, \p token_str.
- Since:
- 1.12.0
-
H5Otoken_to_str
@Cast("herr_t") public static int H5Otoken_to_str(@Cast("hid_t") long loc_id, @Const H5O_token_t token, @Cast("char**") @ByPtrPtr BytePointer token_str)
-
H5Otoken_to_str
@Cast("herr_t") public static int H5Otoken_to_str(@Cast("hid_t") long loc_id, @Const H5O_token_t token, @Cast("char**") @ByPtrPtr ByteBuffer token_str)
-
H5Otoken_to_str
@Cast("herr_t") public static int H5Otoken_to_str(@Cast("hid_t") long loc_id, @Const H5O_token_t token, @Cast("char**") @ByPtrPtr byte[] token_str)
-
H5Otoken_from_str
@Cast("herr_t") public static int H5Otoken_from_str(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer token_str, H5O_token_t token)
------------------------------------------------------------------------- \ingroup H5O \brief Deserializes a string into a connector object token \fgdta_loc_obj_id{loc_id}- Parameters:
token_str- [in] Object token stringtoken- [out] Connector object token- Returns:
- \herr_t \details H5Otoken_from_str() deserializes a string, \p token_str, into a connector object token, \p token, for the object specified by the location identifier, \p loc_id.
- Since:
- 1.12.0
-
H5Otoken_from_str
@Cast("herr_t") public static int H5Otoken_from_str(@Cast("hid_t") long loc_id, String token_str, H5O_token_t token)
-
H5O_TOKEN_UNDEF_g
@MemberGetter @Const @ByRef public static H5O_token_t H5O_TOKEN_UNDEF_g()
\endcond
-
H5Zfilter_avail
@Cast("htri_t") public static int H5Zfilter_avail(@Cast("H5Z_filter_t") int id)
\ingroup H5Z \brief Determines whether a filter is available- Parameters:
id- [in] Filter identifier- Returns:
- \htri_t \details H5Zfilter_avail() determines whether the filter specified in \p id is available to the application.
- Since:
- 1.6.0
-
H5Zget_filter_info
@Cast("herr_t") public static int H5Zget_filter_info(@Cast("H5Z_filter_t") int filter, @Cast("unsigned int*") IntPointer filter_config_flags)
\ingroup H5Z \brief Retrieves information about a filter- Parameters:
filter- [in] Filter identifierfilter_config_flags- [out] A bit field encoding the returned filter information- Returns:
- \herr_t
\details H5Zget_filter_info() retrieves information about a filter. At
present, this means that the function retrieves a filter's
configuration flags, indicating whether the filter is configured to
decode data, to encode data, neither, or both.
If \p filter_config_flags is not set to NULL prior to the function
call, the returned parameter contains a bit field specifying the
available filter configuration. The configuration flag values can
then be determined through a series of bitwise AND operations, as
described below.
Valid filter configuration flags include the following:
A bitwise AND of the returned \p filter_config_flags and a valid filter configuration flag will reveal whether the related configuration option is available. For example, if the value of#H5Z_FILTER_CONFIG_ENCODE_ENABLED Encoding is enabled for this filter #H5Z_FILTER_CONFIG_DECODE_ENABLED Decoding is enabled for this filter
is true, i.e., greater than 0 (zero), the queried filter is configured to encode data; if the value is \c FALSE, i.e., equal to 0 (zero), the filter is not so configured. If a filter is not encode-enabled, the corresponding \c H5Pset_* function will return an error if the filter is added to a dataset creation property list (which is required if the filter is to be used to encode that dataset). For example, if the #H5Z_FILTER_CONFIG_ENCODE_ENABLED flag is not returned for the SZIP filter, #H5Z_FILTER_SZIP, a call to H5Pset_szip() will fail. If a filter is not decode-enabled, the application will not be able to read an existing file encoded with that filter. This function should be called, and the returned \p filter_config_flags analyzed, before calling any other function, such as H5Pset_szip() , that might require a particular filter configuration.H5Z_FILTER_CONFIG_ENCODE_ENABLED & filter_config_flags - Since:
- 1.6.3
-
H5Zget_filter_info
@Cast("herr_t") public static int H5Zget_filter_info(@Cast("H5Z_filter_t") int filter, @Cast("unsigned int*") IntBuffer filter_config_flags)
-
H5Zget_filter_info
@Cast("herr_t") public static int H5Zget_filter_info(@Cast("H5Z_filter_t") int filter, @Cast("unsigned int*") int[] filter_config_flags)
-
H5Aclose
@Cast("herr_t") public static int H5Aclose(@Cast("hid_t") long attr_id)
\ingroup H5A \brief Closes the specified attribute \attr_id- Returns:
- \herr_t \details H5Aclose() terminates access to the attribute through \p attr_id and releases the identifier. \par Example \snippet H5A_examples.c create
- Since:
- 1.0.0
-
H5Aclose_async
@Cast("herr_t") public static int H5Aclose_async(@Cast("const char*") BytePointer app_file, @Cast("const char*") BytePointer app_func, @Cast("unsigned") int app_line, @Cast("hid_t") long attr_id, @Cast("hid_t") long es_id)
\ingroup ASYNC \async_variant_of{H5Aclose}
-
H5Aclose_async
@Cast("herr_t") public static int H5Aclose_async(String app_file, String app_func, @Cast("unsigned") int app_line, @Cast("hid_t") long attr_id, @Cast("hid_t") long es_id)
-
H5Acreate2
@Cast("hid_t") public static long H5Acreate2(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer attr_name, @Cast("hid_t") long type_id, @Cast("hid_t") long space_id, @Cast("hid_t") long acpl_id, @Cast("hid_t") long aapl_id)
\ingroup H5A \brief Creates an attribute attached to a specified object \fgdt_loc_id- Parameters:
attr_name- [in] Name of attributetype_id- [in] Attribute datatype identifier \space_id \acpl_id \aapl_id- Returns:
- \hid_tv{attribute} \details H5Acreate2() creates an attribute, \p attr_name, which is attached to the object specified by the identifier \p loc_id. The attribute name, \p attr_name, must be unique for the object. The attribute is created with the specified datatype and dataspace, \p type_id and \p space_id. \plist_unused{acpl} The attribute identifier returned by this function must be released with H5Aclose() resource leaks will develop. \note If \p loc_id is a file identifier, the attribute will be attached that fileâs root group. \par Example \snippet H5A_examples.c create
- Since:
- 1.8.0
- See Also:
H5Aclose()
-
H5Acreate2
@Cast("hid_t") public static long H5Acreate2(@Cast("hid_t") long loc_id, String attr_name, @Cast("hid_t") long type_id, @Cast("hid_t") long space_id, @Cast("hid_t") long acpl_id, @Cast("hid_t") long aapl_id)
-
H5Acreate_async
@Cast("hid_t") public static long H5Acreate_async(@Cast("const char*") BytePointer app_file, @Cast("const char*") BytePointer app_func, @Cast("unsigned") int app_line, @Cast("hid_t") long loc_id, @Cast("const char*") BytePointer attr_name, @Cast("hid_t") long type_id, @Cast("hid_t") long space_id, @Cast("hid_t") long acpl_id, @Cast("hid_t") long aapl_id, @Cast("hid_t") long es_id)
\ingroup ASYNC \async_variant_of{H5Acreate}
-
H5Acreate_async
@Cast("hid_t") public static long H5Acreate_async(String app_file, String app_func, @Cast("unsigned") int app_line, @Cast("hid_t") long loc_id, String attr_name, @Cast("hid_t") long type_id, @Cast("hid_t") long space_id, @Cast("hid_t") long acpl_id, @Cast("hid_t") long aapl_id, @Cast("hid_t") long es_id)
-
H5Acreate_by_name
@Cast("hid_t") public static long H5Acreate_by_name(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer obj_name, @Cast("const char*") BytePointer attr_name, @Cast("hid_t") long type_id, @Cast("hid_t") long space_id, @Cast("hid_t") long acpl_id, @Cast("hid_t") long aapl_id, @Cast("hid_t") long lapl_id)
\ingroup H5A \brief Creates an attribute attached to a specified object \fgdt_loc_id- Parameters:
obj_name- [in] Name, relative to \p loc_id, of object that attribute is to be attached toattr_name- [in] Attribute nametype_id- [in] Attribute datatype identifier \space_id \acpl_id \aapl_id \lapl_id- Returns:
- \hid_tv{attribute} \details H5Acreate_by_name() creates an attribute, \p attr_name, which is attached to the object specified by \p loc_id and \p obj_name. \p loc_id is a location identifier; \p obj_name is the object name relative to \p loc_id. The attribute name, \p attr_name, must be unique for the object. The attribute is created with the specified datatype and dataspace, \p type_id and \p space_id. \plist_unused{aapl} The link access property list, \p lapl_id, may provide information regarding the properties of links required to access the object, \p obj_name.
- Since:
- 1.8.0
-
H5Acreate_by_name
@Cast("hid_t") public static long H5Acreate_by_name(@Cast("hid_t") long loc_id, String obj_name, String attr_name, @Cast("hid_t") long type_id, @Cast("hid_t") long space_id, @Cast("hid_t") long acpl_id, @Cast("hid_t") long aapl_id, @Cast("hid_t") long lapl_id)
-
H5Acreate_by_name_async
@Cast("hid_t") public static long H5Acreate_by_name_async(@Cast("const char*") BytePointer app_file, @Cast("const char*") BytePointer app_func, @Cast("unsigned") int app_line, @Cast("hid_t") long loc_id, @Cast("const char*") BytePointer obj_name, @Cast("const char*") BytePointer attr_name, @Cast("hid_t") long type_id, @Cast("hid_t") long space_id, @Cast("hid_t") long acpl_id, @Cast("hid_t") long aapl_id, @Cast("hid_t") long lapl_id, @Cast("hid_t") long es_id)
\ingroup ASYNC \async_variant_of{H5Acreate_by_name}
-
H5Acreate_by_name_async
@Cast("hid_t") public static long H5Acreate_by_name_async(String app_file, String app_func, @Cast("unsigned") int app_line, @Cast("hid_t") long loc_id, String obj_name, String attr_name, @Cast("hid_t") long type_id, @Cast("hid_t") long space_id, @Cast("hid_t") long acpl_id, @Cast("hid_t") long aapl_id, @Cast("hid_t") long lapl_id, @Cast("hid_t") long es_id)
-
H5Adelete
@Cast("herr_t") public static int H5Adelete(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer attr_name)
\ingroup H5A \brief Deletes an attribute from a specified location \fgdt_loc_id- Parameters:
attr_name- [in] Name of the attribute to delete- Returns:
- \herr_t \details H5Adelete() removes the attribute specified by its name, \p attr_name, from a file, dataset, group, or named datatype. \attention This function should not be used when other attribute identifiers are open on \p loc_id. This may cause the internal indexes of the attributes to change and future writes to the open attributes to produce incorrect results. \par Example \snippet H5A_examples.c delete
- Since:
- 1.0.0
-
H5Adelete
@Cast("herr_t") public static int H5Adelete(@Cast("hid_t") long loc_id, String attr_name)
-
H5Adelete_by_idx
@Cast("herr_t") public static int H5Adelete_by_idx(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer obj_name, @Cast("H5_index_t") int idx_type, @Cast("H5_iter_order_t") int order, @Cast("hsize_t") long n, @Cast("hid_t") long lapl_id)
\ingroup H5A \brief Deletes an attribute from an object according to index order \fgdt_loc_id- Parameters:
obj_name- [in] Name of object, relative to location, from which attribute is to be removedidx_type- [in] Type of indexorder- [in] Order in which to iterate over indexn- [in] Offset within index \lapl_id- Returns:
- \herr_t \details H5Adelete_by_idx() removes an attribute, specified by its location in an index, from an object. The object from which the attribute is to be removed is specified by a location identifier and name, \p loc_id and \p obj_name, respectively. The attribute to be removed is specified by a position in an index, \p n. The type of index is specified by \p idx_type. The order in which the index is to be traversed is specified by \p order. For example, if \p idx_type, \p order, and \p n are set to #H5_INDEX_NAME, #H5_ITER_INC, and 5, respectively, the fifth attribute in lexicographic order of attribute names will be removed. The link access property list, \p lapl_id, may provide information regarding the properties of links required to access the object, \p obj_name.
- Since:
- 1.8.0
-
H5Adelete_by_idx
@Cast("herr_t") public static int H5Adelete_by_idx(@Cast("hid_t") long loc_id, String obj_name, @Cast("H5_index_t") int idx_type, @Cast("H5_iter_order_t") int order, @Cast("hsize_t") long n, @Cast("hid_t") long lapl_id)
-
H5Adelete_by_name
@Cast("herr_t") public static int H5Adelete_by_name(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer obj_name, @Cast("const char*") BytePointer attr_name, @Cast("hid_t") long lapl_id)
\ingroup H5A \brief Removes an attribute from a specified location \fgdt_loc_id- Parameters:
obj_name- [in] Name of object, relative to location, from which attribute is to be removedattr_name- [in] Name of attribute to delete \lapl_id- Returns:
- \herr_t \details H5Adelete_by_name() removes the attribute \p attr_name from an object specified by location and name, \p loc_id and \p obj_name, respectively. The link access property list, \p lapl_id, may provide information regarding the properties of links required to access the object, \p obj_name.
- Since:
- 1.8.0
-
H5Adelete_by_name
@Cast("herr_t") public static int H5Adelete_by_name(@Cast("hid_t") long loc_id, String obj_name, String attr_name, @Cast("hid_t") long lapl_id)
-
H5Aexists
@Cast("htri_t") public static int H5Aexists(@Cast("hid_t") long obj_id, @Cast("const char*") BytePointer attr_name)
\ingroup H5A \brief Determines whether an attribute with a given name exists on an object \fgdt_loc_id{obj_id}- Parameters:
attr_name- [in] Attribute name- Returns:
- \htri_t \details H5Aexists() determines whether the attribute \p attr_name exists on the object specified by \p obj_id.
- Since:
- 1.8.0
-
H5Aexists
@Cast("htri_t") public static int H5Aexists(@Cast("hid_t") long obj_id, String attr_name)
-
H5Aexists_async
@Cast("herr_t") public static int H5Aexists_async(@Cast("const char*") BytePointer app_file, @Cast("const char*") BytePointer app_func, @Cast("unsigned") int app_line, @Cast("hid_t") long obj_id, @Cast("const char*") BytePointer attr_name, @Cast("hbool_t*") BoolPointer exists, @Cast("hid_t") long es_id)
\ingroup ASYNC \async_variant_of{H5Aexists}
-
H5Aexists_async
@Cast("herr_t") public static int H5Aexists_async(String app_file, String app_func, @Cast("unsigned") int app_line, @Cast("hid_t") long obj_id, String attr_name, @Cast("hbool_t*") boolean[] exists, @Cast("hid_t") long es_id)
-
H5Aexists_by_name
@Cast("htri_t") public static int H5Aexists_by_name(@Cast("hid_t") long obj_id, @Cast("const char*") BytePointer obj_name, @Cast("const char*") BytePointer attr_name, @Cast("hid_t") long lapl_id)
\ingroup H5A \brief Determines whether an attribute with a given name exists on an object \fgdt_loc_id{obj_id}- Parameters:
obj_name- [in] Object nameattr_name- [in] Attribute name \lapl_id- Returns:
- \htri_t \details H5Aexists_by_name() determines whether the attribute \p attr_name exists on an object. That object is specified by its location and name, \p loc_id and \p obj_name, respectively. \p loc_id specifies a location in the file containing the object. \p obj_name is the name of the object to which the attribute is attached and can be a relative name, relative to \p loc_id, or an absolute name, based in the root group of the file. The link access property list, \p lapl_id, may provide information regarding the properties of links required to access \p obj_name.
- Since:
- 1.8.0
-
H5Aexists_by_name
@Cast("htri_t") public static int H5Aexists_by_name(@Cast("hid_t") long obj_id, String obj_name, String attr_name, @Cast("hid_t") long lapl_id)
-
H5Aexists_by_name_async
@Cast("herr_t") public static int H5Aexists_by_name_async(@Cast("const char*") BytePointer app_file, @Cast("const char*") BytePointer app_func, @Cast("unsigned") int app_line, @Cast("hid_t") long loc_id, @Cast("const char*") BytePointer obj_name, @Cast("const char*") BytePointer attr_name, @Cast("hbool_t*") BoolPointer exists, @Cast("hid_t") long lapl_id, @Cast("hid_t") long es_id)
\ingroup ASYNC \async_variant_of{H5Aexists_by_name}
-
H5Aexists_by_name_async
@Cast("herr_t") public static int H5Aexists_by_name_async(String app_file, String app_func, @Cast("unsigned") int app_line, @Cast("hid_t") long loc_id, String obj_name, String attr_name, @Cast("hbool_t*") boolean[] exists, @Cast("hid_t") long lapl_id, @Cast("hid_t") long es_id)
-
H5Aget_create_plist
@Cast("hid_t") public static long H5Aget_create_plist(@Cast("hid_t") long attr_id)
\ingroup H5A \brief Gets an attribute creation property list identifier \attr_id- Returns:
- \hid_tv{attribute's creation property list} \details H5Aget_create_plist() returns an identifier for the attribute creation property list associated with the attribute specified by \p attr_id.
- Since:
- 1.8.0
-
H5Aget_info
@Cast("herr_t") public static int H5Aget_info(@Cast("hid_t") long attr_id, H5A_info_t ainfo)
\ingroup H5A \brief Retrieves attribute information, by attribute identifier \attr_id- Parameters:
ainfo- [out] Attribute information struct- Returns:
- \herr_t \details H5Aget_info() retrieves attribute information, locating the attribute with an attribute identifier, \p attr_id. The attribute information is returned in the \p ainfo struct.
- Since:
- 1.8.0
-
H5Aget_info_by_idx
@Cast("herr_t") public static int H5Aget_info_by_idx(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer obj_name, @Cast("H5_index_t") int idx_type, @Cast("H5_iter_order_t") int order, @Cast("hsize_t") long n, H5A_info_t ainfo, @Cast("hid_t") long lapl_id)
\ingroup H5A \brief Retrieves attribute information by attribute index position \fgdt_loc_id- Parameters:
obj_name- [in] Name of object to which attribute is attached, relative to locationidx_type- [in] Type of indexorder- [in] Index traversal ordern- [in] Attributeâs position in indexainfo- [out] Struct containing returned attribute information \lapl_id- Returns:
- \herr_t \details H5Aget_info_by_idx() retrieves information for an attribute that is attached to an object, which is specified by its location and name, \p loc_id and \p obj_name, respectively. The attribute is located by its index position and the attribute information is returned in the \p ainfo struct. The attribute is located by means of an index type, an index traversal order, and a position in the index, \p idx_type, \p order and \p n, respectively. The link access property list, \p lapl_id, may provide information regarding the properties of links required to access the object, \p obj_name.
- Since:
- 1.8.0
-
H5Aget_info_by_idx
@Cast("herr_t") public static int H5Aget_info_by_idx(@Cast("hid_t") long loc_id, String obj_name, @Cast("H5_index_t") int idx_type, @Cast("H5_iter_order_t") int order, @Cast("hsize_t") long n, H5A_info_t ainfo, @Cast("hid_t") long lapl_id)
-
H5Aget_info_by_name
@Cast("herr_t") public static int H5Aget_info_by_name(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer obj_name, @Cast("const char*") BytePointer attr_name, H5A_info_t ainfo, @Cast("hid_t") long lapl_id)
\ingroup H5A \brief Retrieves attribute information, by attribute name \fgdt_loc_id- Parameters:
obj_name- [in] Name of the object to which an attribute is attached, relative to locationattr_name- [in] Attribute nameainfo- [out] Struct containing returned attribute information \lapl_id- Returns:
- \herr_t \details H5Aget_info_by_name() retrieves information for an attribute, \p attr_name, that is attached to an object specified by its location and name, \p loc_id and \p obj_name, respectively. The attribute information is returned in the \p ainfo struct. The link access property list, \p lapl_id, may provide information regarding the properties of links required to access the object, \p obj_name.
- Since:
- 1.8.0
-
H5Aget_info_by_name
@Cast("herr_t") public static int H5Aget_info_by_name(@Cast("hid_t") long loc_id, String obj_name, String attr_name, H5A_info_t ainfo, @Cast("hid_t") long lapl_id)
-
H5Aget_name
@Cast("ssize_t") public static long H5Aget_name(@Cast("hid_t") long attr_id, @Cast("size_t") long buf_size, @Cast("char*") BytePointer buf)
\ingroup H5A \brief Gets an attribute name \attr_id- Parameters:
buf_size- [in] The size of the buffer to store the name inbuf- [out] Buffer to store name in- Returns:
- Returns the length of the attribute's name, which may be longer than \p buf_size, if successful. Otherwise returns a negative value. \details H5Aget_name() retrieves the name of an attribute specified by the identifier, \p attr_id. Up to \p buf_size characters are stored in \p buf followed by a \0 string terminator. If the name of the attribute is longer than (\p buf_size -1), the string terminator is stored in the last position of the buffer to properly terminate the string. If the user only wants to retrieve the name length, the values 0 and NULL should be passed for the parameters \p bufsize and \p buf.
- Since:
- 1.0.0
-
H5Aget_name
@Cast("ssize_t") public static long H5Aget_name(@Cast("hid_t") long attr_id, @Cast("size_t") long buf_size, @Cast("char*") ByteBuffer buf)
-
H5Aget_name
@Cast("ssize_t") public static long H5Aget_name(@Cast("hid_t") long attr_id, @Cast("size_t") long buf_size, @Cast("char*") byte[] buf)
-
H5Aget_name_by_idx
@Cast("ssize_t") public static long H5Aget_name_by_idx(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer obj_name, @Cast("H5_index_t") int idx_type, @Cast("H5_iter_order_t") int order, @Cast("hsize_t") long n, @Cast("char*") BytePointer name, @Cast("size_t") long size, @Cast("hid_t") long lapl_id)
\ingroup H5A \brief Gets an attribute name by attribute index position \fgdt_loc_id- Parameters:
obj_name- [in] Name of object to which attribute is attached, relative to locationidx_type- [in] Type of indexorder- [in] Index traversal ordern- [in] Attributeâs position in indexname- [out] Attribute namesize- [in] Size, in bytes, of attribute name \lapl_id- Returns:
- Returns attribute name size, in bytes, if successful; otherwise returns a negative value. \details H5Aget_name_by_idx() retrieves the name of an attribute that is attached to an object, which is specified by its location and name, \p loc_id and \p obj_name, respectively. The attribute is located by its index position, the size of the name is specified in \p size, and the attribute name is returned in \p name. The attribute is located by means of an index type, an index traversal order, and a position in the index, \p idx_type, \p order and \p n, respectively. If the attribute nameâs size is unknown, the values 0 and NULL can be passed in for the parameters \p size and \p name. The functionâs return value will provide the correct value for \p size. The link access property list, \p lapl_id, may provide information regarding the properties of links required to access the object, \p obj_name.
- Since:
- 1.8.0
-
H5Aget_name_by_idx
@Cast("ssize_t") public static long H5Aget_name_by_idx(@Cast("hid_t") long loc_id, String obj_name, @Cast("H5_index_t") int idx_type, @Cast("H5_iter_order_t") int order, @Cast("hsize_t") long n, @Cast("char*") ByteBuffer name, @Cast("size_t") long size, @Cast("hid_t") long lapl_id)
-
H5Aget_name_by_idx
@Cast("ssize_t") public static long H5Aget_name_by_idx(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer obj_name, @Cast("H5_index_t") int idx_type, @Cast("H5_iter_order_t") int order, @Cast("hsize_t") long n, @Cast("char*") byte[] name, @Cast("size_t") long size, @Cast("hid_t") long lapl_id)
-
H5Aget_name_by_idx
@Cast("ssize_t") public static long H5Aget_name_by_idx(@Cast("hid_t") long loc_id, String obj_name, @Cast("H5_index_t") int idx_type, @Cast("H5_iter_order_t") int order, @Cast("hsize_t") long n, @Cast("char*") BytePointer name, @Cast("size_t") long size, @Cast("hid_t") long lapl_id)
-
H5Aget_name_by_idx
@Cast("ssize_t") public static long H5Aget_name_by_idx(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer obj_name, @Cast("H5_index_t") int idx_type, @Cast("H5_iter_order_t") int order, @Cast("hsize_t") long n, @Cast("char*") ByteBuffer name, @Cast("size_t") long size, @Cast("hid_t") long lapl_id)
-
H5Aget_name_by_idx
@Cast("ssize_t") public static long H5Aget_name_by_idx(@Cast("hid_t") long loc_id, String obj_name, @Cast("H5_index_t") int idx_type, @Cast("H5_iter_order_t") int order, @Cast("hsize_t") long n, @Cast("char*") byte[] name, @Cast("size_t") long size, @Cast("hid_t") long lapl_id)
-
H5Aget_space
@Cast("hid_t") public static long H5Aget_space(@Cast("hid_t") long attr_id)
\ingroup H5A \brief Gets a copy of the dataspace for an attribute \attr_id- Returns:
- \hid_tv{attribute dataspace} \details H5Aget_space() retrieves a copy of the dataspace for an attribute. The dataspace identifier returned from this function must be released with H5Sclose() or resource leaks will develop.
- Since:
- 1.0.0
-
H5Aget_storage_size
@Cast("hsize_t") public static long H5Aget_storage_size(@Cast("hid_t") long attr_id)
\ingroup H5A \brief Returns the amount of storage used to store an attribute \attr_id- Returns:
- Returns the amount of storage size allocated for the attribute; otherwise returns 0 (zero). \details H5Aget_storage_size() returns the amount of storage that is required for the specified attribute, \p attr_id.
- Since:
- 1.6.0
-
H5Aget_type
@Cast("hid_t") public static long H5Aget_type(@Cast("hid_t") long attr_id)
\ingroup H5A \brief Gets an attribute's datatype \attr_id- Returns:
- \hid_t{datatype} \details H5Aget_type() retrieves a copy of the attribute's datatype. The datatype is reopened if it is a named type before returning it to the application. The datatypes returned by this function are always read-only. The datatype identifier returned from this function must be released with H5Tclose() or resource leaks will develop.
- Since:
- 1.0.0
-
H5Aiterate2
@Cast("herr_t") public static int H5Aiterate2(@Cast("hid_t") long loc_id, @Cast("H5_index_t") int idx_type, @Cast("H5_iter_order_t") int order, @Cast("hsize_t*") LongPointer idx, H5A_operator2_t op, Pointer op_data)
\ingroup H5A \brief Calls a user-defined function for each attribute on an object \fgdt_loc_id- Parameters:
idx_type- [in] Type of indexorder- [in] Order in which to iterate over indexidx- [in,out] Initial and returned offset within indexop- [in] User-defined function to pass each attribute toop_data- [in,out] User data to pass through to and to be returned by iterator operator function- Returns:
- \herr_t Further note that this function returns the return value of the last operator if it was non-zero, which can be a negative value, zero if all attributes were processed, or a positive value indicating short-circuit success. \details H5Aiterate2() iterates over the attributes attached to a dataset, named datatype, or group, as specified by \p loc_id. For each attribute, user-provided data, \p op_data, with additional information as defined below, is passed to a user-defined function, \p op, which operates on that attribute. The order of the iteration and the attributes iterated over are specified by three parameters: the index type, \p idx_type; the order in which the index is to be traversed, \p order; and the attributeâs position in the index, \p idx. The next attribute to be operated on is specified by \p idx, a position in the index. For example, if \p idx_type, \p order, and \p idx are set to #H5_INDEX_NAME, #H5_ITER_INC, and 5, respectively, the attribute in question is the fifth attribute from the beginning of the alphanumeric index of attribute names. If \p order were set to #H5_ITER_DEC, it would be the fifth attribute from the end of the index. The parameter \p idx is passed in on an H5Aiterate2() call with one value and may be returned with another value. The value passed in identifies the parameter to be operated on first; the value returned identifies the parameter to be operated on in the next step of the iteration. \note This function is also available through the H5Aiterate() macro.
- Since:
- 1.8.0
-
H5Aiterate2
@Cast("herr_t") public static int H5Aiterate2(@Cast("hid_t") long loc_id, @Cast("H5_index_t") int idx_type, @Cast("H5_iter_order_t") int order, @Cast("hsize_t*") LongBuffer idx, H5A_operator2_t op, Pointer op_data)
-
H5Aiterate2
@Cast("herr_t") public static int H5Aiterate2(@Cast("hid_t") long loc_id, @Cast("H5_index_t") int idx_type, @Cast("H5_iter_order_t") int order, @Cast("hsize_t*") long[] idx, H5A_operator2_t op, Pointer op_data)
-
H5Aiterate_by_name
@Cast("herr_t") public static int H5Aiterate_by_name(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer obj_name, @Cast("H5_index_t") int idx_type, @Cast("H5_iter_order_t") int order, @Cast("hsize_t*") LongPointer idx, H5A_operator2_t op, Pointer op_data, @Cast("hid_t") long lapl_id)
\ingroup H5A \brief Calls user-defined function for each attribute on an object \fgdt_loc_id- Parameters:
obj_name- [in] Name of object, relative to locationidx_type- [in] Type of indexorder- [in] Order in which to iterate over indexidx- [in,out] Initial and returned offset within indexop- [in] User-defined function to pass each attribute toop_data- [in,out] User data to pass through to and to be returned by iterator operator function \lapl_id- Returns:
- \herr_t Further note that this function returns the return value of the last operator if it was non-zero, which can be a negative value, zero if all attributes were processed, or a positive value indicating short-circuit success. \details H5Aiterate_by_name() iterates over the attributes attached to the dataset or group specified with \p loc_id and \p obj_name. For each attribute, user-provided data, \p op_data, with additional information as defined below, is passed to a user-defined function, \p op, which operates on that attribute. The order of the iteration and the attributes iterated over are specified by three parameters: the index type, \p idx_type; the order in which the index is to be traversed, \p order; and the attributeâs position in the index, \p idx. The next attribute to be operated on is specified by \p idx, a position in the index. For example, if \p idx_type, \p order, and \p idx are set to #H5_INDEX_NAME, #H5_ITER_INC, and 5, respectively, the attribute in question is the fifth attribute from the beginning of the alphanumeric index of attribute names. If \p order were set to #H5_ITER_DEC, it would be the fifth attribute from the end of the index. The parameter \p idx is passed in on an H5Aiterate_by_name() call with one value and may be returned with another value. The value passed in identifies the parameter to be operated on first; the value returned identifies the parameter to be operated on in the next step of the iteration. The link access property list, \p lapl_id, may provide information regarding the properties of links required to access the object, \p obj_name.
- Since:
- 1.8.0
-
H5Aiterate_by_name
@Cast("herr_t") public static int H5Aiterate_by_name(@Cast("hid_t") long loc_id, String obj_name, @Cast("H5_index_t") int idx_type, @Cast("H5_iter_order_t") int order, @Cast("hsize_t*") LongBuffer idx, H5A_operator2_t op, Pointer op_data, @Cast("hid_t") long lapl_id)
-
H5Aiterate_by_name
@Cast("herr_t") public static int H5Aiterate_by_name(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer obj_name, @Cast("H5_index_t") int idx_type, @Cast("H5_iter_order_t") int order, @Cast("hsize_t*") long[] idx, H5A_operator2_t op, Pointer op_data, @Cast("hid_t") long lapl_id)
-
H5Aiterate_by_name
@Cast("herr_t") public static int H5Aiterate_by_name(@Cast("hid_t") long loc_id, String obj_name, @Cast("H5_index_t") int idx_type, @Cast("H5_iter_order_t") int order, @Cast("hsize_t*") LongPointer idx, H5A_operator2_t op, Pointer op_data, @Cast("hid_t") long lapl_id)
-
H5Aiterate_by_name
@Cast("herr_t") public static int H5Aiterate_by_name(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer obj_name, @Cast("H5_index_t") int idx_type, @Cast("H5_iter_order_t") int order, @Cast("hsize_t*") LongBuffer idx, H5A_operator2_t op, Pointer op_data, @Cast("hid_t") long lapl_id)
-
H5Aiterate_by_name
@Cast("herr_t") public static int H5Aiterate_by_name(@Cast("hid_t") long loc_id, String obj_name, @Cast("H5_index_t") int idx_type, @Cast("H5_iter_order_t") int order, @Cast("hsize_t*") long[] idx, H5A_operator2_t op, Pointer op_data, @Cast("hid_t") long lapl_id)
-
H5Aopen
@Cast("hid_t") public static long H5Aopen(@Cast("hid_t") long obj_id, @Cast("const char*") BytePointer attr_name, @Cast("hid_t") long aapl_id)
\ingroup H5A \brief Opens an attribute for an object specified by object identifier and attribute name \fgdt_loc_id{obj_id}- Parameters:
attr_name- [in] Name of attribute to open \aapl_id- Returns:
- \hid_tv{attribute} \details H5Aopen() opens an existing attribute, \p attr_name, that is attached to object specified by an object identifier, \p obj_id. \plist_unused{aapl_id} This function, H5Aopen_by_idx() or H5Aopen_by_name() must be called before the attribute can be accessed for any further purpose, including reading, writing, or any modification. The attribute identifier returned by this function must be released with H5Aclose() or resource leaks will develop. \par Example \snippet H5A_examples.c read
- Since:
- 1.8.0
-
H5Aopen
@Cast("hid_t") public static long H5Aopen(@Cast("hid_t") long obj_id, String attr_name, @Cast("hid_t") long aapl_id)
-
H5Aopen_async
@Cast("hid_t") public static long H5Aopen_async(@Cast("const char*") BytePointer app_file, @Cast("const char*") BytePointer app_func, @Cast("unsigned") int app_line, @Cast("hid_t") long obj_id, @Cast("const char*") BytePointer attr_name, @Cast("hid_t") long aapl_id, @Cast("hid_t") long es_id)
\ingroup ASYNC \async_variant_of{H5Aopen}
-
H5Aopen_async
@Cast("hid_t") public static long H5Aopen_async(String app_file, String app_func, @Cast("unsigned") int app_line, @Cast("hid_t") long obj_id, String attr_name, @Cast("hid_t") long aapl_id, @Cast("hid_t") long es_id)
-
H5Aopen_by_idx
@Cast("hid_t") public static long H5Aopen_by_idx(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer obj_name, @Cast("H5_index_t") int idx_type, @Cast("H5_iter_order_t") int order, @Cast("hsize_t") long n, @Cast("hid_t") long aapl_id, @Cast("hid_t") long lapl_id)
\ingroup H5A \brief Opens the nth attribute attached to an object \loc_id- Parameters:
obj_name- [in] Name of object to which attribute is attached, relative to locationidx_type- [in] Type of indexorder- [in] Index traversal ordern- [in] Attributeâs position in index \aapl_id \lapl_id- Returns:
- \hid_tv{attribute} \details H5Aopen_by_idx() opens an existing attribute that is attached to an object specified by location and name, \p loc_id and \p obj_name, respectively. The attribute is identified by an index type, an index traversal order, and a position in the index, \p idx_type, \p order and \p n, respectively. \plist_unused{aapl_id} The link access property list, \p lapl_id, may provide information regarding the properties of links required to access the object, \p obj_name. This function, H5Aopen(), or H5Aopen_by_name() must be called before an attribute can be accessed for any further purpose, including reading, writing, or any modification. The attribute identifier returned by this function must be released with H5Aclose() or resource leaks will develop.
- Since:
- 1.8.0
-
H5Aopen_by_idx
@Cast("hid_t") public static long H5Aopen_by_idx(@Cast("hid_t") long loc_id, String obj_name, @Cast("H5_index_t") int idx_type, @Cast("H5_iter_order_t") int order, @Cast("hsize_t") long n, @Cast("hid_t") long aapl_id, @Cast("hid_t") long lapl_id)
-
H5Aopen_by_idx_async
@Cast("hid_t") public static long H5Aopen_by_idx_async(@Cast("const char*") BytePointer app_file, @Cast("const char*") BytePointer app_func, @Cast("unsigned") int app_line, @Cast("hid_t") long loc_id, @Cast("const char*") BytePointer obj_name, @Cast("H5_index_t") int idx_type, @Cast("H5_iter_order_t") int order, @Cast("hsize_t") long n, @Cast("hid_t") long aapl_id, @Cast("hid_t") long lapl_id, @Cast("hid_t") long es_id)
\ingroup ASYNC \async_variant_of{H5Aopen_by_idx}
-
H5Aopen_by_idx_async
@Cast("hid_t") public static long H5Aopen_by_idx_async(String app_file, String app_func, @Cast("unsigned") int app_line, @Cast("hid_t") long loc_id, String obj_name, @Cast("H5_index_t") int idx_type, @Cast("H5_iter_order_t") int order, @Cast("hsize_t") long n, @Cast("hid_t") long aapl_id, @Cast("hid_t") long lapl_id, @Cast("hid_t") long es_id)
-
H5Aopen_by_name
@Cast("hid_t") public static long H5Aopen_by_name(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer obj_name, @Cast("const char*") BytePointer attr_name, @Cast("hid_t") long aapl_id, @Cast("hid_t") long lapl_id)
\ingroup H5A \brief Opens an attribute for an object by object name and attribute name \fgdt_loc_id- Parameters:
obj_name- [in] Name of object to which attribute is attached, relative to \p loc_idattr_name- [in] Name of attribute to open \aapl_id \lapl_id- Returns:
- \hid_tv{attribute} \details H5Aopen_by_name() opens an existing attribute, \p attr_name, that is attached to an object specified by location and name, \p loc_id and \p obj_name, respectively. \p loc_id specifies a location from which the target object can be located and \p obj_name is an object name relative to \p loc_id. \plist_unused{aapl_id} The link access property list, \p lapl_id, may provide information regarding the properties of links required to access the object, \p obj_name. This function, H5Aopen(), or H5Aopen_by_idx() must be called before an attribute can be accessed for any further purpose, including reading, writing, or any modification. The attribute identifier returned by this function must be released with H5Aclose() or resource leaks will develop.
- Since:
- 1.8.0
-
H5Aopen_by_name
@Cast("hid_t") public static long H5Aopen_by_name(@Cast("hid_t") long loc_id, String obj_name, String attr_name, @Cast("hid_t") long aapl_id, @Cast("hid_t") long lapl_id)
-
H5Aopen_by_name_async
@Cast("hid_t") public static long H5Aopen_by_name_async(@Cast("const char*") BytePointer app_file, @Cast("const char*") BytePointer app_func, @Cast("unsigned") int app_line, @Cast("hid_t") long loc_id, @Cast("const char*") BytePointer obj_name, @Cast("const char*") BytePointer attr_name, @Cast("hid_t") long aapl_id, @Cast("hid_t") long lapl_id, @Cast("hid_t") long es_id)
\ingroup ASYNC \async_variant_of{H5Aopen_by_name}
-
H5Aopen_by_name_async
@Cast("hid_t") public static long H5Aopen_by_name_async(String app_file, String app_func, @Cast("unsigned") int app_line, @Cast("hid_t") long loc_id, String obj_name, String attr_name, @Cast("hid_t") long aapl_id, @Cast("hid_t") long lapl_id, @Cast("hid_t") long es_id)
-
H5Aread
@Cast("herr_t") public static int H5Aread(@Cast("hid_t") long attr_id, @Cast("hid_t") long type_id, Pointer buf)
\ingroup H5A \brief Reads the value of an attribute \attr_id \mem_type_id{type_id}- Parameters:
buf- [out] Buffer for data to be read- Returns:
- \herr_t \details H5Aread() reads an attribute, specified with \p attr_id. The attribute's in-memory datatype is specified with \p type_id. The entire attribute is read into \p buf from the file. Datatype conversion takes place at the time of a read or write and is automatic. \par Example \snippet H5A_examples.c read
- Since:
- 1.0.0
- See Also:
H5Awrite()
-
H5Aread_async
@Cast("herr_t") public static int H5Aread_async(@Cast("const char*") BytePointer app_file, @Cast("const char*") BytePointer app_func, @Cast("unsigned") int app_line, @Cast("hid_t") long attr_id, @Cast("hid_t") long dtype_id, Pointer buf, @Cast("hid_t") long es_id)
\ingroup ASYNC \async_variant_of{H5Aread}
-
H5Aread_async
@Cast("herr_t") public static int H5Aread_async(String app_file, String app_func, @Cast("unsigned") int app_line, @Cast("hid_t") long attr_id, @Cast("hid_t") long dtype_id, Pointer buf, @Cast("hid_t") long es_id)
-
H5Arename
@Cast("herr_t") public static int H5Arename(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer old_name, @Cast("const char*") BytePointer new_name)
\ingroup H5A \brief Renames an attribute \fgdt_loc_id- Parameters:
old_name- [in] Name of the attribute to be changednew_name- [in] New name for the attribute- Returns:
- \herr_t \details H5Arename() changes the name of the attribute located at \p loc_id. The old name, \p old_name, is changed to the new name, \p new_name.
- Since:
- 1.6.0
-
H5Arename
@Cast("herr_t") public static int H5Arename(@Cast("hid_t") long loc_id, String old_name, String new_name)
-
H5Arename_async
@Cast("herr_t") public static int H5Arename_async(@Cast("const char*") BytePointer app_file, @Cast("const char*") BytePointer app_func, @Cast("unsigned") int app_line, @Cast("hid_t") long loc_id, @Cast("const char*") BytePointer old_name, @Cast("const char*") BytePointer new_name, @Cast("hid_t") long es_id)
\ingroup ASYNC \async_variant_of{H5Arename}
-
H5Arename_async
@Cast("herr_t") public static int H5Arename_async(String app_file, String app_func, @Cast("unsigned") int app_line, @Cast("hid_t") long loc_id, String old_name, String new_name, @Cast("hid_t") long es_id)
-
H5Arename_by_name_async
@Cast("herr_t") public static int H5Arename_by_name_async(@Cast("const char*") BytePointer app_file, @Cast("const char*") BytePointer app_func, @Cast("unsigned") int app_line, @Cast("hid_t") long loc_id, @Cast("const char*") BytePointer obj_name, @Cast("const char*") BytePointer old_attr_name, @Cast("const char*") BytePointer new_attr_name, @Cast("hid_t") long lapl_id, @Cast("hid_t") long es_id)
\ingroup ASYNC \async_variant_of{H5Arename_by_name}
-
H5Arename_by_name_async
@Cast("herr_t") public static int H5Arename_by_name_async(String app_file, String app_func, @Cast("unsigned") int app_line, @Cast("hid_t") long loc_id, String obj_name, String old_attr_name, String new_attr_name, @Cast("hid_t") long lapl_id, @Cast("hid_t") long es_id)
-
H5Awrite
@Cast("herr_t") public static int H5Awrite(@Cast("hid_t") long attr_id, @Cast("hid_t") long type_id, @Const Pointer buf)
\ingroup H5A \brief Writes data to an attribute \attr_id \mem_type_id{type_id}- Parameters:
buf- [out] Data to be written- Returns:
- \herr_t \details H5Awrite() writes an attribute, specified with \p attr_id. The attribute's in-memory datatype is specified with \p type_id. The entire attribute is written from \p buf to the file. Datatype conversion takes place at the time of a read or write and is automatic. \par Example \snippet H5A_examples.c update
- Since:
- 1.0.0
- See Also:
H5Aread()
-
H5Awrite_async
@Cast("herr_t") public static int H5Awrite_async(@Cast("const char*") BytePointer app_file, @Cast("const char*") BytePointer app_func, @Cast("unsigned") int app_line, @Cast("hid_t") long attr_id, @Cast("hid_t") long type_id, @Const Pointer buf, @Cast("hid_t") long es_id)
\ingroup ASYNC \async_variant_of{H5Awrite}
-
H5Awrite_async
@Cast("herr_t") public static int H5Awrite_async(String app_file, String app_func, @Cast("unsigned") int app_line, @Cast("hid_t") long attr_id, @Cast("hid_t") long type_id, @Const Pointer buf, @Cast("hid_t") long es_id)
-
H5Arename_by_name
@Cast("herr_t") public static int H5Arename_by_name(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer obj_name, @Cast("const char*") BytePointer old_attr_name, @Cast("const char*") BytePointer new_attr_name, @Cast("hid_t") long lapl_id)
\ingroup H5A \fgdt_loc_id- Parameters:
obj_name- [in] Name of object, relative to location, whose attribute is to be renamedold_attr_name- [in] Prior attribute namenew_attr_name- [in] New attribute name \lapl_id \details H5Arename_by_name() changes the name of attribute that is attached to the object specified by \p loc_id and \p obj_name. The attribute named \p old_attr_name is renamed \p new_attr_name. The link access property list, \p lapl_id, may provide information regarding the properties of links required to access the object, \p obj_name.- Since:
- 1.8.0
-
H5Arename_by_name
@Cast("herr_t") public static int H5Arename_by_name(@Cast("hid_t") long loc_id, String obj_name, String old_attr_name, String new_attr_name, @Cast("hid_t") long lapl_id)
-
H5D_CHUNK_CACHE_NSLOTS_DEFAULT
@MemberGetter public static int H5D_CHUNK_CACHE_NSLOTS_DEFAULT()
-
H5D_CHUNK_CACHE_NBYTES_DEFAULT
@MemberGetter public static int H5D_CHUNK_CACHE_NBYTES_DEFAULT()
-
H5Dcreate2
@Cast("hid_t") public static long H5Dcreate2(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer name, @Cast("hid_t") long type_id, @Cast("hid_t") long space_id, @Cast("hid_t") long lcpl_id, @Cast("hid_t") long dcpl_id, @Cast("hid_t") long dapl_id)
-------------------------------------------------------------------------- \ingroup H5D \brief Creates a new dataset and links it into the file \fgdta_loc_id- Parameters:
name- [in] Name of the dataset to create \type_id \space_id \lcpl_id \dcpl_id \dapl_id- Returns:
- \hid_t{dataset} \details H5Dcreate2() creates a new dataset named \p name at the location specified by \p loc_id, and associates constant and initial persistent properties with that dataset, including the datatype \p dtype_id, the dataspace \p space_id, and other properties as specified by the dataset creation property list \p dcpl_id and the access property list \p dapl_id, respectively. Once created, the dataset is opened for access. \p loc_id may specify a file, group, dataset, named datatype, or attribute. If an attribute, dataset, or named datatype is specified then the dataset will be created at the location where the attribute, dataset, or named datatype is attached. \p name may be either an absolute path in the file or a relative path from \p loc_id naming the dataset. If \p dtype_id is a committed datatype, and if the file location associated with the committed datatype is different from the file location where the dataset will be created, the datatype is copied and converted to a transient type. The link creation property list, \p lcpl_id, governs creation of the link(s) by which the new dataset is accessed and the creation of any intermediate groups that may be missing. The datatype and dataspace properties and the dataset creation and access property lists are attached to the dataset, so the caller may derive new datatypes, dataspaces, and creation and access properties from the old ones and reuse them in calls to create additional datasets. Once created, the dataset can be read from or written to. Reading data from a dataset that was not previously written, the HDF5 library will return default or user-defined fill values. \par Example \snippet H5D_examples.c create
- Since:
- 1.8.0
-
H5Dcreate2
@Cast("hid_t") public static long H5Dcreate2(@Cast("hid_t") long loc_id, String name, @Cast("hid_t") long type_id, @Cast("hid_t") long space_id, @Cast("hid_t") long lcpl_id, @Cast("hid_t") long dcpl_id, @Cast("hid_t") long dapl_id)
-
H5Dcreate_async
@Cast("hid_t") public static long H5Dcreate_async(@Cast("const char*") BytePointer app_file, @Cast("const char*") BytePointer app_func, @Cast("unsigned") int app_line, @Cast("hid_t") long loc_id, @Cast("const char*") BytePointer name, @Cast("hid_t") long type_id, @Cast("hid_t") long space_id, @Cast("hid_t") long lcpl_id, @Cast("hid_t") long dcpl_id, @Cast("hid_t") long dapl_id, @Cast("hid_t") long es_id)
-------------------------------------------------------------------------- \ingroup ASYNC \async_variant_of{H5Dcreate}
-
H5Dcreate_async
@Cast("hid_t") public static long H5Dcreate_async(String app_file, String app_func, @Cast("unsigned") int app_line, @Cast("hid_t") long loc_id, String name, @Cast("hid_t") long type_id, @Cast("hid_t") long space_id, @Cast("hid_t") long lcpl_id, @Cast("hid_t") long dcpl_id, @Cast("hid_t") long dapl_id, @Cast("hid_t") long es_id)
-
H5Dcreate_anon
@Cast("hid_t") public static long H5Dcreate_anon(@Cast("hid_t") long loc_id, @Cast("hid_t") long type_id, @Cast("hid_t") long space_id, @Cast("hid_t") long dcpl_id, @Cast("hid_t") long dapl_id)
-------------------------------------------------------------------------- \ingroup H5D \brief Creates a dataset in a file without linking it into the file structure \fgdta_loc_id \type_id \space_id \dcpl_id \dapl_id- Returns:
- \hid_t{dataset} \details H5Dcreate_anon() creates a dataset in the file specified by \p loc_id. \p loc_id may specify a file, group, dataset, named datatype, or attribute. If an attribute, dataset, or named datatype is specified then the dataset will be created at the location where the attribute, dataset, or named datatype is attached. The datasetâs datatype and dataspace are specified by \p type_id and \p space_id, respectively. These are the datatype and dataspace of the dataset as it will exist in the file, which may differ from the datatype and dataspace in application memory. H5Dcreate_anon() returns a new dataset identifier. Using this identifier, the new dataset must be linked into the HDF5 file structure with H5Olink() or it will be deleted when the file is closed.
- Since:
- 1.8.0
-
H5Dopen2
@Cast("hid_t") public static long H5Dopen2(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer name, @Cast("hid_t") long dapl_id)
-------------------------------------------------------------------------- \ingroup H5D \brief Opens an existing dataset \fgdta_loc_id- Parameters:
name- [in] Name of the dataset to open \dapl_id- Returns:
- \hid_t{dataset} \details H5Dopen2() opens the existing dataset specified by a location identifier and name, \p loc_id and \p name, respectively. \p loc_id may specify a file, group, dataset, named datatype, or attribute. If an attribute, dataset, or named datatype is specified then the dataset will be opened at the location where the attribute, dataset, or named datatype is attached.
- Since:
- 1.8.0
-
H5Dopen2
@Cast("hid_t") public static long H5Dopen2(@Cast("hid_t") long loc_id, String name, @Cast("hid_t") long dapl_id)
-
H5Dopen_async
@Cast("hid_t") public static long H5Dopen_async(@Cast("const char*") BytePointer app_file, @Cast("const char*") BytePointer app_func, @Cast("unsigned") int app_line, @Cast("hid_t") long loc_id, @Cast("const char*") BytePointer name, @Cast("hid_t") long dapl_id, @Cast("hid_t") long es_id)
-------------------------------------------------------------------------- \ingroup ASYNC \async_variant_of{H5Dopen}
-
H5Dopen_async
@Cast("hid_t") public static long H5Dopen_async(String app_file, String app_func, @Cast("unsigned") int app_line, @Cast("hid_t") long loc_id, String name, @Cast("hid_t") long dapl_id, @Cast("hid_t") long es_id)
-
H5Dget_space
@Cast("hid_t") public static long H5Dget_space(@Cast("hid_t") long dset_id)
-------------------------------------------------------------------------- \ingroup H5D \brief Returns an identifier for a copy of the dataspace for a dataset \dset_id- Returns:
- \hid_t{dataspace} \details H5Dget_space() makes a copy of the dataspace of the dataset specified by \p dset_id. The function returns an identifier for the new copy of the dataspace. A dataspace identifier returned from this function should be released with H5Sclose() when the identifier is no longer needed so that resource leaks will not occur. \par Example \snippet H5D_examples.c update
- See Also:
H5Sclose()
-
H5Dget_space_async
@Cast("hid_t") public static long H5Dget_space_async(@Cast("const char*") BytePointer app_file, @Cast("const char*") BytePointer app_func, @Cast("unsigned") int app_line, @Cast("hid_t") long dset_id, @Cast("hid_t") long es_id)
-------------------------------------------------------------------------- \ingroup ASYNC \async_variant_of{H5Dget_space}
-
H5Dget_space_async
@Cast("hid_t") public static long H5Dget_space_async(String app_file, String app_func, @Cast("unsigned") int app_line, @Cast("hid_t") long dset_id, @Cast("hid_t") long es_id)
-
H5Dget_space_status
@Cast("herr_t") public static int H5Dget_space_status(@Cast("hid_t") long dset_id, @Cast("H5D_space_status_t*") IntPointer allocation)
-------------------------------------------------------------------------- \ingroup H5D \brief Determines whether space has been allocated for a dataset \dset_id- Parameters:
allocation- [out] Space allocation status- Returns:
- \herr_t \details H5Dget_space_status() determines whether space has been allocated for the dataset \p dset_id.
- Since:
- 1.6.0
-
H5Dget_space_status
@Cast("herr_t") public static int H5Dget_space_status(@Cast("hid_t") long dset_id, @Cast("H5D_space_status_t*") IntBuffer allocation)
-
H5Dget_space_status
@Cast("herr_t") public static int H5Dget_space_status(@Cast("hid_t") long dset_id, @Cast("H5D_space_status_t*") int[] allocation)
-
H5Dget_type
@Cast("hid_t") public static long H5Dget_type(@Cast("hid_t") long dset_id)
-------------------------------------------------------------------------- \ingroup H5D \brief Returns an identifier for a copy of the datatype for a dataset \dset_id- Returns:
- \hid_t{datatype} \details H5Dget_type() returns an identifier of a copy of the datatype for a dataset. If a dataset has a named datatype, then an identifier to the opened datatype is returned. Otherwise, the returned datatype is read-only.
-
H5Dget_create_plist
@Cast("hid_t") public static long H5Dget_create_plist(@Cast("hid_t") long dset_id)
-------------------------------------------------------------------------- \ingroup H5D \brief Returns an identifier for a copy of the dataset creation property list for a dataset \dset_id- Returns:
- \hid_t{dataset creation property list} \details H5Dget_create_plist() returns an identifier for a copy of the dataset creation property list associated with the dataset specified by \p dset_id.
-
H5Dget_access_plist
@Cast("hid_t") public static long H5Dget_access_plist(@Cast("hid_t") long dset_id)
-------------------------------------------------------------------------- \ingroup H5D \brief Returns the dataset access property list associated with a dataset \dset_id- Returns:
- \hid_t{dataset access property list} \details H5Dget_access_plist() returns a copy of the dataset access property list used to open the specified dataset, \p dset_id. Modifications to the returned property list will have no effect on the dataset it was retrieved from. The chunk cache parameters in the returned property lists will be those used by the dataset. If the properties in the file access property list were used to determine the dataset's chunk cache configuration, then those properties will be present in the returned dataset access property list. If the dataset does not use a chunked layout, then the chunk cache properties will be set to the default. The chunk cache properties in the returned list are considered to be âsetâ, and any use of this list will override the corresponding properties in the fileâs file access property list. All link access properties in the returned list will be set to the default values.
- Since:
- 1.8.3
-
H5Dget_storage_size
@Cast("hsize_t") public static long H5Dget_storage_size(@Cast("hid_t") long dset_id)
-------------------------------------------------------------------------- \ingroup H5D \brief Returns the amount of storage allocated for a dataset \dset_id- Returns:
- Returns the amount of storage space, in bytes, or 0 (zero). \details H5Dget_storage_size() returns the amount of storage, in bytes, that is allocated in the file for the raw data of the dataset specified by \p dset_id. H5Dget_storage_size() reports only the space required to store the dataset elements, excluding any metadata. \li For contiguous datasets, the returned size equals the current allocated size of the raw data. \li For unfiltered chunked datasets, the returned size is the number of allocated chunks times the chunk size. \li For filtered chunked datasets, the returned size is the space required to store the filtered data. For example, if a compression filter is in use, H5Dget_storage_size() will return the total space required to store the compressed chunks. \note Note that H5Dget_storage_size() is not generally an appropriate function to use when determining the amount of memory required to work with a dataset. In such circumstances, you must determine the number of data points in a dataset and the size of an individual dataset element. H5Sget_simple_extent_npoints() and H5Tget_size() can be used to calculate that amount. \warning H5Dget_storage_size() does not differentiate between 0 (zero), the value returned for the storage size of a dataset with no stored values, and 0 (zero), the value returned to indicate an error.
-
H5Dget_chunk_storage_size
@Cast("herr_t") public static int H5Dget_chunk_storage_size(@Cast("hid_t") long dset_id, @Cast("const hsize_t*") LongPointer offset, @Cast("hsize_t*") LongPointer chunk_bytes)
-------------------------------------------------------------------------- \ingroup H5D \brief Returns the amount of storage allocated within the file for a raw data chunk in a dataset \dset_id- Parameters:
offset- [in] Logical offset in the dataset for the chunk to querychunk_bytes- [out] The size in bytes for the chunk- Returns:
- \herr_t \details H5Dget_chunk_storage_size() returns the size in bytes allocated in the file for a raw data chunk as specified by its logical \p offset in the dataset \p dset_id. The size is returned in \p chunk_nbytes. It is the size of the compressed data if the chunk is filtered and the size may be zero if no storage is allocated yet for the dataset.
- Since:
- 1.10.2
-
H5Dget_chunk_storage_size
@Cast("herr_t") public static int H5Dget_chunk_storage_size(@Cast("hid_t") long dset_id, @Cast("const hsize_t*") LongBuffer offset, @Cast("hsize_t*") LongBuffer chunk_bytes)
-
H5Dget_chunk_storage_size
@Cast("herr_t") public static int H5Dget_chunk_storage_size(@Cast("hid_t") long dset_id, @Cast("const hsize_t*") long[] offset, @Cast("hsize_t*") long... chunk_bytes)
-
H5Dget_num_chunks
@Cast("herr_t") public static int H5Dget_num_chunks(@Cast("hid_t") long dset_id, @Cast("hid_t") long fspace_id, @Cast("hsize_t*") LongPointer nchunks)
-------------------------------------------------------------------------- \ingroup H5D \brief Retrieves number of chunks that have nonempty intersection with a specified selection \dset_id- Parameters:
fspace_id- [in] File dataspace selection identifiernchunks- [out] Number of chunks in the selection- Returns:
- \herr_t \details H5Dget_num_chunks() retrieves the number of chunks nchunks in a set of selected elements specified by \p fspace_id for a dataset specified by the identifier \p dset_id. If \p fspace_id is #H5S_ALL, the function will retrieve the total number of chunks stored for the dataset. \p fspace_id specifies the file dataspace selection. It is intended to take #H5S_ALL for specifying the current selection. \note Please be aware that this function currently does not support non-trivial selections, thus \p fspace_id has no effect. Also, the implementation does not handle the #H5S_ALL macro correctly. As a workaround, application can get the dataspace for the dataset using H5Dget_space() and pass that in for \p fspace_id. This will be fixed in a future release.
- Since:
- 1.10.5
-
H5Dget_num_chunks
@Cast("herr_t") public static int H5Dget_num_chunks(@Cast("hid_t") long dset_id, @Cast("hid_t") long fspace_id, @Cast("hsize_t*") LongBuffer nchunks)
-
H5Dget_num_chunks
@Cast("herr_t") public static int H5Dget_num_chunks(@Cast("hid_t") long dset_id, @Cast("hid_t") long fspace_id, @Cast("hsize_t*") long... nchunks)
-
H5Dget_chunk_info_by_coord
@Cast("herr_t") public static int H5Dget_chunk_info_by_coord(@Cast("hid_t") long dset_id, @Cast("const hsize_t*") LongPointer offset, @Cast("unsigned*") IntPointer filter_mask, @Cast("haddr_t*") LongPointer addr, @Cast("hsize_t*") LongPointer size)
-------------------------------------------------------------------------- \ingroup H5D \brief Retrieves information about a chunk specified by its coordinates \dset_id- Parameters:
offset- [in] Logical position of the chunkâs first element in units of dataset elementsfilter_mask- [out] Bitmask indicating the filters used when the chunk was writtenaddr- [out] Chunk address in the filesize- [out] Chunk size in bytes, 0 if the chunk does not exist- Returns:
- \herr_t \details H5Dget_chunk_info_by_coord() retrieves the \p filter_mask, \p size, and \p addr for a chunk in the dataset specified by \p dset_id, using the coordinates specified by \p offset. If the queried chunk does not exist in the file, \p size will be set to 0, \p addr to \c HADDR_UNDEF, and the buffer \p filter_mask will not be modified. \p offset is a pointer to a one-dimensional array with a size equal to the datasetâs rank. Each element is the logical position of the chunkâs first element in a dimension.
- Since:
- 1.10.5
-
H5Dget_chunk_info_by_coord
@Cast("herr_t") public static int H5Dget_chunk_info_by_coord(@Cast("hid_t") long dset_id, @Cast("const hsize_t*") LongBuffer offset, @Cast("unsigned*") IntBuffer filter_mask, @Cast("haddr_t*") LongBuffer addr, @Cast("hsize_t*") LongBuffer size)
-
H5Dget_chunk_info_by_coord
@Cast("herr_t") public static int H5Dget_chunk_info_by_coord(@Cast("hid_t") long dset_id, @Cast("const hsize_t*") long[] offset, @Cast("unsigned*") int[] filter_mask, @Cast("haddr_t*") long[] addr, @Cast("hsize_t*") long... size)
-
H5Dchunk_iter
@Cast("herr_t") public static int H5Dchunk_iter(@Cast("hid_t") long dset_id, @Cast("hid_t") long dxpl_id, H5D_chunk_iter_op_t cb, Pointer op_data)
-------------------------------------------------------------------------- \ingroup H5D \brief Iterate over all chunks of a chunked dataset \dset_id- Parameters:
dxpl_id- [in] Identifier of a transfer property listcb- [in] User callback function, called for every chunk.op_data- [in] User-defined pointer to data required by op- Returns:
- \herr_t \details H5Dchunk_iter iterates over all chunks in the dataset, calling the user supplied callback with the details of the chunk and the supplied context \p op_data. \par Example For each chunk, print the allocated chunk size (0 for un-allocated chunks). \snippet H5D_examples.c H5Dchunk_iter_cb Iterate over all chunked datasets and chunks in a file. \snippet H5D_examples.c H5Ovisit_cb
- Since:
- 1.14.0
-
H5Dget_chunk_info
@Cast("herr_t") public static int H5Dget_chunk_info(@Cast("hid_t") long dset_id, @Cast("hid_t") long fspace_id, @Cast("hsize_t") long chk_idx, @Cast("hsize_t*") LongPointer offset, @Cast("unsigned*") IntPointer filter_mask, @Cast("haddr_t*") LongPointer addr, @Cast("hsize_t*") LongPointer size)
-------------------------------------------------------------------------- \ingroup H5D \brief Retrieves information about a chunk specified by its index \dset_id- Parameters:
fspace_id- [in] File dataspace selection identifier (See Note below)chk_idx- [in] Index of the chunkoffset- [out] Logical position of the chunkâs first element in units of dataset elementsfilter_mask- [out] Bitmask indicating the filters used when the chunk was writtenaddr- [out] Chunk address in the filesize- [out] Chunk size in bytes, 0 if the chunk does not exist- Returns:
- \herr_t \details H5Dget_chunk_info() retrieves the offset coordinates, \p offset, filter mask, \p filter_mask, size, \p size, and address \p addr for the dataset specified by the identifier \p dset_id and the chunk specified by the index \p index. The chunk belongs to a set of chunks in the selection specified by \p fspace_id. If the queried chunk does not exist in the file, the size will be set to 0 and address to #HADDR_UNDEF. The value pointed to by filter_mask will not be modified. \c NULL can be passed in for any \p out parameters. \p chk_idx is the chunk index in the selection. The index value may have a value of 0 up to the number of chunks stored in the file that have a nonempty intersection with the file dataspace selection \note As of 1.10.5, the dataspace intersection is not yet supported, hence, the index is of all the written chunks. \p fspace_id specifies the file dataspace selection. It is intended to take #H5S_ALL for specifying the current selection. \note Please be aware that this function currently does not support non-trivial selections, thus \p fspace_id has no effect. Also, the implementation does not handle the #H5S_ALL macro correctly. As a workaround, an application can get the dataspace for the dataset using H5Dget_space() and pass that in for \p fspace_id. This will be fixed in a future release.
- Since:
- 1.10.5
-
H5Dget_chunk_info
@Cast("herr_t") public static int H5Dget_chunk_info(@Cast("hid_t") long dset_id, @Cast("hid_t") long fspace_id, @Cast("hsize_t") long chk_idx, @Cast("hsize_t*") LongBuffer offset, @Cast("unsigned*") IntBuffer filter_mask, @Cast("haddr_t*") LongBuffer addr, @Cast("hsize_t*") LongBuffer size)
-
H5Dget_chunk_info
@Cast("herr_t") public static int H5Dget_chunk_info(@Cast("hid_t") long dset_id, @Cast("hid_t") long fspace_id, @Cast("hsize_t") long chk_idx, @Cast("hsize_t*") long[] offset, @Cast("unsigned*") int[] filter_mask, @Cast("haddr_t*") long[] addr, @Cast("hsize_t*") long... size)
-
H5Dget_offset
@Cast("haddr_t") public static long H5Dget_offset(@Cast("hid_t") long dset_id)
-------------------------------------------------------------------------- \ingroup H5D \brief Returns dataset address in file \dset_id- Returns:
- Returns the offset in bytes; otherwise, returns #HADDR_UNDEF, a negative value. \details H5Dget_offset() returns the address in the file of the dataset, \p dset_id. That address is expressed as the offset in bytes from the beginning of the file.
- Since:
- 1.6.0
-
H5Dread
@Cast("herr_t") public static int H5Dread(@Cast("hid_t") long dset_id, @Cast("hid_t") long mem_type_id, @Cast("hid_t") long mem_space_id, @Cast("hid_t") long file_space_id, @Cast("hid_t") long dxpl_id, Pointer buf)
-------------------------------------------------------------------------- \ingroup H5D \brief Reads raw data from a dataset into a provided buffer \dset_id Identifier of the dataset to read from- Parameters:
mem_type_id- [in] Identifier of the memory datatypemem_space_id- [in] Identifier of the memory dataspacefile_space_id- [in] Identifier of the dataset's dataspace in the filedxpl_id- [in] Identifier of a transfer property listbuf- [out] Buffer to receive data read from file- Returns:
- \herr_t
\details H5Dread() reads a dataset, specified by its identifier
\p dset_id, from the file into an application memory buffer \p
buf. Data transfer properties are defined by the argument \p
dxpl_id. The memory datatype of the (partial) dataset
is identified by the identifier \p mem_type_id. The part
of the dataset to read is defined by \p mem_space_id and \p
file_space_id.
\p file_space_id is used to specify only the selection within
the file dataset's dataspace. Any dataspace specified in \p
file_space_id is ignored by the library and the dataset's
dataspace is always used. \p file_space_id can be the constant
#H5S_ALL, which indicates that the entire file dataspace,
as defined by the current dimensions of the dataset, is to
be selected.
\p mem_space_id is used to specify both the memory dataspace
and the selection within that dataspace. \p mem_space_id can
be the constant #H5S_ALL, in which case the file dataspace is
used for the memory dataspace and the selection defined with \p
file_space_id is used for the selection within that dataspace.
The number of elements selected in the memory dataspace \Emph{must}
be equal to the number of elements selected in the file dataspace.
The behavior of the library for the various combinations of
valid dataspace identifiers and #H5S_ALL for the \p mem_space_id
and the \p file_space_id parameters is described below:
\note If no storage space was allocated for the dataset and a fill value is defined, the returned buffer \p buf is filled with the fill value. \par Example \snippet H5D_examples.c readmem_space_id file_space_id Behavior valid dataspace ID valid dataspace ID \p mem_space_id specifies the memory dataspace and the selection within it. \p file_space_id specifies the selection within the file dataset's dataspace. #H5S_ALL valid dataspace ID The file dataset's dataspace is used for the memory dataspace and the selection specified with \p file_space_id specifies the selection within it. The combination of the file dataset's dataspace and the selection from \p file_space_id is used for memory also. valid dataspace ID #H5S_ALL \p mem_space_id specifies the memory dataspace and the selection within it. The selection within the file dataset's dataspace is set to the "all" selection. #H5S_ALL #H5S_ALL The file dataset's dataspace is used for the memory dataspace and the selection within the memory dataspace is set to the "all" selection. The selection within the file dataset's dataspace is set to the "all" selection.
-
H5Dread_multi
@Cast("herr_t") public static int H5Dread_multi(@Cast("size_t") long count, @Cast("hid_t*") LongPointer dset_id, @Cast("hid_t*") LongPointer mem_type_id, @Cast("hid_t*") LongPointer mem_space_id, @Cast("hid_t*") LongPointer file_space_id, @Cast("hid_t") long dxpl_id, @Cast("void**") PointerPointer buf)
-------------------------------------------------------------------------- \ingroup H5D \brief Reads raw data from a set of datasets into the provided buffers- Parameters:
count- [in] Number of datasets to read fromdset_id- [in] Identifiers of the datasets to read frommem_type_id- [in] Identifiers of the memory datatypesmem_space_id- [in] Identifiers of the memory dataspacesfile_space_id- [in] Identifiers of the datasets' dataspaces in the filedxpl_id- [in] Identifier of a transfer property listbuf- [out] Buffers to receive data read from file- Returns:
- \herr_t \details H5Dread_multi() reads data from \p count datasets, whose identifiers are listed in the \p dset_id array, from the file into multiple application memory buffers listed in the \p buf array. Data transfer properties are defined by the argument \p dxpl_id. The memory datatypes of each dataset are listed by identifier in the \p mem_type_id array. The parts of each dataset to read are listed by identifier in the \p file_space_id array, and the parts of each application memory buffer to read to are listed by identifier in the \p mem_space_id array. All array parameters have length \p count. This function will produce the same results as \p count calls to H5Dread(). Information listed in that function about the specifics of its behaviour also apply to H5Dread_multi(). By calling H5Dread_multi() instead of multiple calls to H5Dread(), however, the library can in some cases pass information about the entire I/O operation to the file driver, which can improve performance. All datasets must be in the same HDF5 file, and each unique dataset may only be listed once. If this function is called collectively in parallel, each rank must pass exactly the same list of datasets in \p dset_id , though the other parameters may differ.
- Since:
- 1.14.0
- See Also:
H5Dread()
-
H5Dread_multi
@Cast("herr_t") public static int H5Dread_multi(@Cast("size_t") long count, @Cast("hid_t*") LongPointer dset_id, @Cast("hid_t*") LongPointer mem_type_id, @Cast("hid_t*") LongPointer mem_space_id, @Cast("hid_t*") LongPointer file_space_id, @Cast("hid_t") long dxpl_id, @Cast("void**") @ByPtrPtr Pointer buf)
-
H5Dread_multi
@Cast("herr_t") public static int H5Dread_multi(@Cast("size_t") long count, @Cast("hid_t*") LongBuffer dset_id, @Cast("hid_t*") LongBuffer mem_type_id, @Cast("hid_t*") LongBuffer mem_space_id, @Cast("hid_t*") LongBuffer file_space_id, @Cast("hid_t") long dxpl_id, @Cast("void**") @ByPtrPtr Pointer buf)
-
H5Dread_multi
@Cast("herr_t") public static int H5Dread_multi(@Cast("size_t") long count, @Cast("hid_t*") long[] dset_id, @Cast("hid_t*") long[] mem_type_id, @Cast("hid_t*") long[] mem_space_id, @Cast("hid_t*") long[] file_space_id, @Cast("hid_t") long dxpl_id, @Cast("void**") @ByPtrPtr Pointer buf)
-
H5Dread_async
@Cast("herr_t") public static int H5Dread_async(@Cast("const char*") BytePointer app_file, @Cast("const char*") BytePointer app_func, @Cast("unsigned") int app_line, @Cast("hid_t") long dset_id, @Cast("hid_t") long mem_type_id, @Cast("hid_t") long mem_space_id, @Cast("hid_t") long file_space_id, @Cast("hid_t") long dxpl_id, Pointer buf, @Cast("hid_t") long es_id)
-------------------------------------------------------------------------- \ingroup ASYNC \async_variant_of{H5Dread}
-
H5Dread_async
@Cast("herr_t") public static int H5Dread_async(String app_file, String app_func, @Cast("unsigned") int app_line, @Cast("hid_t") long dset_id, @Cast("hid_t") long mem_type_id, @Cast("hid_t") long mem_space_id, @Cast("hid_t") long file_space_id, @Cast("hid_t") long dxpl_id, Pointer buf, @Cast("hid_t") long es_id)
-
H5Dread_multi_async
@Cast("herr_t") public static int H5Dread_multi_async(@Cast("const char*") BytePointer app_file, @Cast("const char*") BytePointer app_func, @Cast("unsigned") int app_line, @Cast("size_t") long count, @Cast("hid_t*") LongPointer dset_id, @Cast("hid_t*") LongPointer mem_type_id, @Cast("hid_t*") LongPointer mem_space_id, @Cast("hid_t*") LongPointer file_space_id, @Cast("hid_t") long dxpl_id, @Cast("void**") PointerPointer buf, @Cast("hid_t") long es_id)
-------------------------------------------------------------------------- \ingroup ASYNC \async_variant_of{H5Dread_multi}
-
H5Dread_multi_async
@Cast("herr_t") public static int H5Dread_multi_async(@Cast("const char*") BytePointer app_file, @Cast("const char*") BytePointer app_func, @Cast("unsigned") int app_line, @Cast("size_t") long count, @Cast("hid_t*") LongPointer dset_id, @Cast("hid_t*") LongPointer mem_type_id, @Cast("hid_t*") LongPointer mem_space_id, @Cast("hid_t*") LongPointer file_space_id, @Cast("hid_t") long dxpl_id, @Cast("void**") @ByPtrPtr Pointer buf, @Cast("hid_t") long es_id)
-
H5Dread_multi_async
@Cast("herr_t") public static int H5Dread_multi_async(String app_file, String app_func, @Cast("unsigned") int app_line, @Cast("size_t") long count, @Cast("hid_t*") LongBuffer dset_id, @Cast("hid_t*") LongBuffer mem_type_id, @Cast("hid_t*") LongBuffer mem_space_id, @Cast("hid_t*") LongBuffer file_space_id, @Cast("hid_t") long dxpl_id, @Cast("void**") @ByPtrPtr Pointer buf, @Cast("hid_t") long es_id)
-
H5Dread_multi_async
@Cast("herr_t") public static int H5Dread_multi_async(@Cast("const char*") BytePointer app_file, @Cast("const char*") BytePointer app_func, @Cast("unsigned") int app_line, @Cast("size_t") long count, @Cast("hid_t*") long[] dset_id, @Cast("hid_t*") long[] mem_type_id, @Cast("hid_t*") long[] mem_space_id, @Cast("hid_t*") long[] file_space_id, @Cast("hid_t") long dxpl_id, @Cast("void**") @ByPtrPtr Pointer buf, @Cast("hid_t") long es_id)
-
H5Dread_multi_async
@Cast("herr_t") public static int H5Dread_multi_async(String app_file, String app_func, @Cast("unsigned") int app_line, @Cast("size_t") long count, @Cast("hid_t*") LongPointer dset_id, @Cast("hid_t*") LongPointer mem_type_id, @Cast("hid_t*") LongPointer mem_space_id, @Cast("hid_t*") LongPointer file_space_id, @Cast("hid_t") long dxpl_id, @Cast("void**") @ByPtrPtr Pointer buf, @Cast("hid_t") long es_id)
-
H5Dread_multi_async
@Cast("herr_t") public static int H5Dread_multi_async(@Cast("const char*") BytePointer app_file, @Cast("const char*") BytePointer app_func, @Cast("unsigned") int app_line, @Cast("size_t") long count, @Cast("hid_t*") LongBuffer dset_id, @Cast("hid_t*") LongBuffer mem_type_id, @Cast("hid_t*") LongBuffer mem_space_id, @Cast("hid_t*") LongBuffer file_space_id, @Cast("hid_t") long dxpl_id, @Cast("void**") @ByPtrPtr Pointer buf, @Cast("hid_t") long es_id)
-
H5Dread_multi_async
@Cast("herr_t") public static int H5Dread_multi_async(String app_file, String app_func, @Cast("unsigned") int app_line, @Cast("size_t") long count, @Cast("hid_t*") long[] dset_id, @Cast("hid_t*") long[] mem_type_id, @Cast("hid_t*") long[] mem_space_id, @Cast("hid_t*") long[] file_space_id, @Cast("hid_t") long dxpl_id, @Cast("void**") @ByPtrPtr Pointer buf, @Cast("hid_t") long es_id)
-
H5Dwrite
@Cast("herr_t") public static int H5Dwrite(@Cast("hid_t") long dset_id, @Cast("hid_t") long mem_type_id, @Cast("hid_t") long mem_space_id, @Cast("hid_t") long file_space_id, @Cast("hid_t") long dxpl_id, @Const Pointer buf)
-------------------------------------------------------------------------- \ingroup H5D \brief Writes raw data from a buffer to a dataset- Parameters:
dset_id- [in] Identifier of the dataset to read frommem_type_id- [in] Identifier of the memory datatypemem_space_id- [in] Identifier of the memory dataspacefile_space_id- [in] Identifier of the dataset's dataspace in the file \dxpl_idbuf- [out] Buffer with data to be written to the file- Returns:
- \herr_t
\details H5Dwrite() writes a (partial) dataset, specified by
its identifier \p dset_id, from the application memory buffer \p
buf into the file. Data transfer properties are defined by the
argument \p dxpl_id. The memory datatype of the (partial)
dataset is identified by the identifier \p mem_type_id. The
part of the dataset to write is defined by \p mem_space_id
and \p file_space_id.
If \p mem_type_id is either a fixed-length or variable-length
string, it is important to set the string length when defining
the datatype. String datatypes are derived from #H5T_C_S1
(or #H5T_FORTRAN_S1 for Fortran codes), which defaults
to 1 character in size. See H5Tset_size() and Creating
variable-length string datatypes.
\p file_space_id is used to specify only the selection within
the file dataset's dataspace. Any dataspace specified in \p
file_space_id is ignored by the library and the dataset's
dataspace is always used. \p file_space_id can be the constant
#H5S_ALL, which indicates that the entire file dataspace,
as defined by the current dimensions of the dataset, is to
be selected.
\p mem_space_id is used to specify both the memory dataspace
and the selection within that dataspace. mem_space_id can be
the constant #H5S_ALL, in which case the file dataspace is
used for the memory dataspace and the selection defined with \p
file_space_id is used for the selection within that dataspace.
The behavior of the library for the various combinations of
valid dataspace IDs and #H5S_ALL for the mem_space_id and
thefile_space_id parameters is described below:
Setting an "all" selection indicates that the entire dataspace, as defined by the current dimensions of a dataspace, will be selected. The number of elements selected in the memory dataspace must match the number of elements selected in the file dataspace. \p dxpl_id can be the constant #H5P_DEFAULT, in which case the default data transfer properties are used. Writing to a dataset will fail if the HDF5 file was not opened with write access permissions. If the dataset's space allocation time is set to #H5D_ALLOC_TIME_LATE or #H5D_ALLOC_TIME_INCR and the space for the dataset has not yet been allocated, that space is allocated when the first raw data is written to the dataset. Unused space in the dataset will be written with fill values at the same time if the dataset's fill time is set to #H5D_FILL_TIME_IFSET or #H5D_FILL_TIME_ALLOC. \par_compr_note \attention If a dataset's storage layout is 'compact', care must be taken when writing data to the dataset in parallel. A compact dataset's raw data is cached in memory and may be flushed to the file from any of the parallel processes, so parallel applications should always attempt to write identical data to the dataset from all processes. \par Example \snippet H5D_examples.c update\c mem_space_id \c file_space_id Behavior valid dataspace ID valid dataspace ID \p mem_space_id specifies the memory dataspace and the selection within it. \p file_space_id specifies the selection within the file dataset's dataspace. #H5S_ALL valid dataspace ID The file dataset's dataspace is used for the memory dataspace and the selection specified with \p file_space_id specifies the selection within it. The combination of the file dataset's dataspace and the selection from \p file_space_id is used for memory also. valid dataspace ID valid dataspace ID #H5S_ALL \p mem_space_id specifies the memory dataspace and the selection within it. The selection within the file dataset's dataspace is set to "all" selection. #H5S_ALL #H5S_ALL The file dataset's dataspace is used for the memory dataspace and the selection within the memory dataspace is set to the "all" selection. The selection within the file dataset's dataspace is set to the "all" selection.
-
H5Dwrite_multi
@Cast("herr_t") public static int H5Dwrite_multi(@Cast("size_t") long count, @Cast("hid_t*") LongPointer dset_id, @Cast("hid_t*") LongPointer mem_type_id, @Cast("hid_t*") LongPointer mem_space_id, @Cast("hid_t*") LongPointer file_space_id, @Cast("hid_t") long dxpl_id, @Cast("const void**") PointerPointer buf)
-------------------------------------------------------------------------- \ingroup H5D \brief Writes raw data from a set buffers to a set of datasets- Parameters:
count- [in] Number of datasets to write todset_id- [in] Identifiers of the datasets to write tomem_type_id- [in] Identifiers of the memory datatypesmem_space_id- [in] Identifiers of the memory dataspacesfile_space_id- [in] Identifiers of the datasets' dataspaces in the filedxpl_id- [in] Identifier of a transfer property listbuf- [in] Buffers with data to be written to the file- Returns:
- \herr_t \details H5Dwrite_multi() writes data to \p count datasets, whose identifiers are listed in the \p dset_id array, from multiple application memory buffers listed in the \p buf array. Data transfer properties are defined by the argument \p dxpl_id. The memory datatypes of each dataset are listed by identifier in the \p mem_type_id array. The parts of each dataset to write are listed by identifier in the \p file_space_id array, and the parts of each application memory buffer to write from are listed by identifier in the \p mem_space_id array. All array parameters have length \p count. This function will produce the same results as \p count calls to H5Dwrite(). Information listed in that function's documentation about the specifics of its behaviour also apply to H5Dwrite_multi(). By calling H5Dwrite_multi() instead of multiple calls to H5Dwrite(), however, the library can in some cases pass information about the entire I/O operation to the file driver, which can improve performance. All datasets must be in the same HDF5 file, and each unique dataset may only be listed once. If this function is called collectively in parallel, each rank must pass exactly the same list of datasets in \p dset_id , though the other parameters may differ.
- Since:
- 1.14.0
- See Also:
H5Dwrite()
-
H5Dwrite_multi
@Cast("herr_t") public static int H5Dwrite_multi(@Cast("size_t") long count, @Cast("hid_t*") LongPointer dset_id, @Cast("hid_t*") LongPointer mem_type_id, @Cast("hid_t*") LongPointer mem_space_id, @Cast("hid_t*") LongPointer file_space_id, @Cast("hid_t") long dxpl_id, @Cast("const void**") @ByPtrPtr Pointer buf)
-
H5Dwrite_multi
@Cast("herr_t") public static int H5Dwrite_multi(@Cast("size_t") long count, @Cast("hid_t*") LongBuffer dset_id, @Cast("hid_t*") LongBuffer mem_type_id, @Cast("hid_t*") LongBuffer mem_space_id, @Cast("hid_t*") LongBuffer file_space_id, @Cast("hid_t") long dxpl_id, @Cast("const void**") @ByPtrPtr Pointer buf)
-
H5Dwrite_multi
@Cast("herr_t") public static int H5Dwrite_multi(@Cast("size_t") long count, @Cast("hid_t*") long[] dset_id, @Cast("hid_t*") long[] mem_type_id, @Cast("hid_t*") long[] mem_space_id, @Cast("hid_t*") long[] file_space_id, @Cast("hid_t") long dxpl_id, @Cast("const void**") @ByPtrPtr Pointer buf)
-
H5Dwrite_async
@Cast("herr_t") public static int H5Dwrite_async(@Cast("const char*") BytePointer app_file, @Cast("const char*") BytePointer app_func, @Cast("unsigned") int app_line, @Cast("hid_t") long dset_id, @Cast("hid_t") long mem_type_id, @Cast("hid_t") long mem_space_id, @Cast("hid_t") long file_space_id, @Cast("hid_t") long dxpl_id, @Const Pointer buf, @Cast("hid_t") long es_id)
-------------------------------------------------------------------------- \ingroup ASYNC \async_variant_of{H5Dwrite}
-
H5Dwrite_async
@Cast("herr_t") public static int H5Dwrite_async(String app_file, String app_func, @Cast("unsigned") int app_line, @Cast("hid_t") long dset_id, @Cast("hid_t") long mem_type_id, @Cast("hid_t") long mem_space_id, @Cast("hid_t") long file_space_id, @Cast("hid_t") long dxpl_id, @Const Pointer buf, @Cast("hid_t") long es_id)
-
H5Dwrite_multi_async
@Cast("herr_t") public static int H5Dwrite_multi_async(@Cast("const char*") BytePointer app_file, @Cast("const char*") BytePointer app_func, @Cast("unsigned") int app_line, @Cast("size_t") long count, @Cast("hid_t*") LongPointer dset_id, @Cast("hid_t*") LongPointer mem_type_id, @Cast("hid_t*") LongPointer mem_space_id, @Cast("hid_t*") LongPointer file_space_id, @Cast("hid_t") long dxpl_id, @Cast("const void**") PointerPointer buf, @Cast("hid_t") long es_id)
-------------------------------------------------------------------------- \ingroup ASYNC \async_variant_of{H5Dwrite_multi}
-
H5Dwrite_multi_async
@Cast("herr_t") public static int H5Dwrite_multi_async(@Cast("const char*") BytePointer app_file, @Cast("const char*") BytePointer app_func, @Cast("unsigned") int app_line, @Cast("size_t") long count, @Cast("hid_t*") LongPointer dset_id, @Cast("hid_t*") LongPointer mem_type_id, @Cast("hid_t*") LongPointer mem_space_id, @Cast("hid_t*") LongPointer file_space_id, @Cast("hid_t") long dxpl_id, @Cast("const void**") @ByPtrPtr Pointer buf, @Cast("hid_t") long es_id)
-
H5Dwrite_multi_async
@Cast("herr_t") public static int H5Dwrite_multi_async(String app_file, String app_func, @Cast("unsigned") int app_line, @Cast("size_t") long count, @Cast("hid_t*") LongBuffer dset_id, @Cast("hid_t*") LongBuffer mem_type_id, @Cast("hid_t*") LongBuffer mem_space_id, @Cast("hid_t*") LongBuffer file_space_id, @Cast("hid_t") long dxpl_id, @Cast("const void**") @ByPtrPtr Pointer buf, @Cast("hid_t") long es_id)
-
H5Dwrite_multi_async
@Cast("herr_t") public static int H5Dwrite_multi_async(@Cast("const char*") BytePointer app_file, @Cast("const char*") BytePointer app_func, @Cast("unsigned") int app_line, @Cast("size_t") long count, @Cast("hid_t*") long[] dset_id, @Cast("hid_t*") long[] mem_type_id, @Cast("hid_t*") long[] mem_space_id, @Cast("hid_t*") long[] file_space_id, @Cast("hid_t") long dxpl_id, @Cast("const void**") @ByPtrPtr Pointer buf, @Cast("hid_t") long es_id)
-
H5Dwrite_multi_async
@Cast("herr_t") public static int H5Dwrite_multi_async(String app_file, String app_func, @Cast("unsigned") int app_line, @Cast("size_t") long count, @Cast("hid_t*") LongPointer dset_id, @Cast("hid_t*") LongPointer mem_type_id, @Cast("hid_t*") LongPointer mem_space_id, @Cast("hid_t*") LongPointer file_space_id, @Cast("hid_t") long dxpl_id, @Cast("const void**") @ByPtrPtr Pointer buf, @Cast("hid_t") long es_id)
-
H5Dwrite_multi_async
@Cast("herr_t") public static int H5Dwrite_multi_async(@Cast("const char*") BytePointer app_file, @Cast("const char*") BytePointer app_func, @Cast("unsigned") int app_line, @Cast("size_t") long count, @Cast("hid_t*") LongBuffer dset_id, @Cast("hid_t*") LongBuffer mem_type_id, @Cast("hid_t*") LongBuffer mem_space_id, @Cast("hid_t*") LongBuffer file_space_id, @Cast("hid_t") long dxpl_id, @Cast("const void**") @ByPtrPtr Pointer buf, @Cast("hid_t") long es_id)
-
H5Dwrite_multi_async
@Cast("herr_t") public static int H5Dwrite_multi_async(String app_file, String app_func, @Cast("unsigned") int app_line, @Cast("size_t") long count, @Cast("hid_t*") long[] dset_id, @Cast("hid_t*") long[] mem_type_id, @Cast("hid_t*") long[] mem_space_id, @Cast("hid_t*") long[] file_space_id, @Cast("hid_t") long dxpl_id, @Cast("const void**") @ByPtrPtr Pointer buf, @Cast("hid_t") long es_id)
-
H5Dwrite_chunk
@Cast("herr_t") public static int H5Dwrite_chunk(@Cast("hid_t") long dset_id, @Cast("hid_t") long dxpl_id, @Cast("uint32_t") int filters, @Cast("const hsize_t*") LongPointer offset, @Cast("size_t") long data_size, @Const Pointer buf)
-------------------------------------------------------------------------- \ingroup H5D \brief Writes a raw data chunk from a buffer directly to a dataset in a file \dset_id \dxpl_id- Parameters:
filters- [in] Mask for identifying the filters in useoffset- [in] Logical position of the chunkâs first element in the dataspacedata_size- [in] Size of the actual data to be written in bytesbuf- [in] Buffer containing data to be written to the chunk- Returns:
- \herr_t \details H5Dwrite_chunk() writes a raw data chunk as specified by its logical offset \p offset in a chunked dataset \p dset_id from the application memory buffer \p buf to the dataset in the file. Typically, the data in \p buf is preprocessed in memory by a custom transformation, such as compression. The chunk will bypass the libraryâs internal data transfer pipeline, including filters, and will be written directly to the file. Only one chunk can be written with this function. \p filters is a mask providing a record of which filters are used with the the chunk. The default value of the mask is zero (0), indicating that all enabled filters are applied. A filter is skipped if the bit corresponding to the filterâs position in the pipeline (0 ⤠position < 32) is turned on. This mask is saved with the chunk in the file. \p offset is an array specifying the logical position of the first element of the chunk in the datasetâs dataspace. The length of the offset array must equal the number of dimensions, or rank, of the dataspace. The values in offset must not exceed the dimension limits and must specify a point that falls on a dataset chunk boundary. \p data_size is the size in bytes of the chunk, representing the number of bytes to be read from the buffer \p buf. If the data chunk has been precompressed, \p data_size should be the size of the compressed data. \p buf is the memory buffer containing data to be written to the chunk in the file. \attention Exercise caution when using H5Dread_chunk() and H5Dwrite_chunk(), as they read and write data chunks directly in a file. H5Dwrite_chunk() bypasses hyperslab selection, the conversion of data from one datatype to another, and the filter pipeline to write the chunk. Developers should have experience with these processes before using this function. \note H5Dread_chunk() and H5Dwrite_chunk() are currently not supported with parallel HDF5 and do not support variable-length types.
- Since:
- 1.10.2
-
H5Dwrite_chunk
@Cast("herr_t") public static int H5Dwrite_chunk(@Cast("hid_t") long dset_id, @Cast("hid_t") long dxpl_id, @Cast("uint32_t") int filters, @Cast("const hsize_t*") LongBuffer offset, @Cast("size_t") long data_size, @Const Pointer buf)
-
H5Dwrite_chunk
@Cast("herr_t") public static int H5Dwrite_chunk(@Cast("hid_t") long dset_id, @Cast("hid_t") long dxpl_id, @Cast("uint32_t") int filters, @Cast("const hsize_t*") long[] offset, @Cast("size_t") long data_size, @Const Pointer buf)
-
H5Dread_chunk
@Cast("herr_t") public static int H5Dread_chunk(@Cast("hid_t") long dset_id, @Cast("hid_t") long dxpl_id, @Cast("const hsize_t*") LongPointer offset, @Cast("uint32_t*") IntPointer filters, Pointer buf)
-------------------------------------------------------------------------- \ingroup H5D \brief Reads a raw data chunk directly from a dataset in a file into a buffer \dset_id \dxpl_id- Parameters:
offset- [in] Logical position of the chunkâs first element in the dataspacefilters- [in,out] Mask for identifying the filters in usebuf- [out] Buffer containing data to be written to the chunk- Returns:
- \herr_t \details H5Dread_chunk() reads a raw data chunk as specified by its logical offset \p offset in a chunked dataset \p dset_id from the dataset in the file into the application memory buffer \p buf. The data in \p buf is read directly from the file bypassing the libraryâs internal data transfer pipeline, including filters. \p offset is an array specifying the logical position of the first element of the chunk in the datasetâs dataspace. The length of the \p offset array must equal the number of dimensions, or rank, of the dataspace. The values in \p offset must not exceed the dimension limits and must specify a point that falls on a dataset chunk boundary. The mask \p filters indicates which filters were used when the chunk was written. A zero value (all bits 0) indicates that all enabled filters are applied on the chunk. A filter is skipped if the bit corresponding to the filterâs position in the pipeline (0 ⤠position < 32) is turned on. \p buf is the memory buffer containing the chunk read from the dataset in the file. \attention Exercise caution when using H5Dread_chunk() and H5Dwrite_chunk(), as they read and write data chunks directly in a file. H5Dwrite_chunk() bypasses hyperslab selection, the conversion of data from one datatype to another, and the filter pipeline to write the chunk. Developers should have experience with these processes before using this function. Please see Using the Direct Chunk Write Function for more information. \note H5Dread_chunk() and H5Dwrite_chunk() are currently not supported with parallel HDF5 and do not support variable-length datatypes.
- Since:
- 1.10.2
-
H5Dread_chunk
@Cast("herr_t") public static int H5Dread_chunk(@Cast("hid_t") long dset_id, @Cast("hid_t") long dxpl_id, @Cast("const hsize_t*") LongBuffer offset, @Cast("uint32_t*") IntBuffer filters, Pointer buf)
-
H5Dread_chunk
@Cast("herr_t") public static int H5Dread_chunk(@Cast("hid_t") long dset_id, @Cast("hid_t") long dxpl_id, @Cast("const hsize_t*") long[] offset, @Cast("uint32_t*") int[] filters, Pointer buf)
-
H5Diterate
@Cast("herr_t") public static int H5Diterate(Pointer buf, @Cast("hid_t") long type_id, @Cast("hid_t") long space_id, H5D_operator_t op, Pointer operator_data)
-------------------------------------------------------------------------- \ingroup H5D \brief Iterates over all selected elements in a dataspace- Parameters:
buf- [in,out] Buffer containing the elements to iterate over \type_id \space_idop- [in] Function pointeroperator_data- [in,out] User-defined data- Returns:
- \success{The return value of the first operator that returns non-zero, or zero if all members were processed with no operator returning non-zero.}
- Since:
- 1.10.2
-
H5Dvlen_get_buf_size
@Cast("herr_t") public static int H5Dvlen_get_buf_size(@Cast("hid_t") long dset_id, @Cast("hid_t") long type_id, @Cast("hid_t") long space_id, @Cast("hsize_t*") LongPointer size)
-------------------------------------------------------------------------- \ingroup H5D \brief Determines the number of bytes required to store variable-length (VL) data \dset_id \type_id \space_id- Parameters:
size- [out] Size in bytes of the memory buffer required to store the VL data- Returns:
- \herr_t \details H5Dvlen_get_buf_size() determines the number of bytes required to store the VL data from the dataset, using \p space_id for the selection in the dataset on disk and the \p type_id for the memory representation of the VL data in memory. \p size is returned with the number of bytes required to store the VL data in memory.
- Since:
- 1.10.2
-
H5Dvlen_get_buf_size
@Cast("herr_t") public static int H5Dvlen_get_buf_size(@Cast("hid_t") long dset_id, @Cast("hid_t") long type_id, @Cast("hid_t") long space_id, @Cast("hsize_t*") LongBuffer size)
-
H5Dvlen_get_buf_size
@Cast("herr_t") public static int H5Dvlen_get_buf_size(@Cast("hid_t") long dset_id, @Cast("hid_t") long type_id, @Cast("hid_t") long space_id, @Cast("hsize_t*") long... size)
-
H5Dfill
@Cast("herr_t") public static int H5Dfill(@Const Pointer _fill, @Cast("hid_t") long fill_type_id, Pointer buf, @Cast("hid_t") long buf_type_id, @Cast("hid_t") long space_id)
-------------------------------------------------------------------------- \ingroup H5D \brief Fills dataspace elements with a fill value in a memory buffer- Parameters:
fill- [in] Pointer to the fill value to be usedfill_type_id- [in] Fill value datatype identifierbuf- [in,out] Pointer to the memory buffer containing the selection to be filledbuf_type_id- [in] Datatype of dataspace elements to be filled \space_id- Returns:
- \herr_t \details H5Dfill() fills the dataspace selection, \p space_id, in memory with the fill value specified in \p fill. If \p fill is NULL, a fill value of 0 (zero) is used. \p fill_type_id specifies the datatype of the fill value. \p buf specifies the buffer in which the fill elements will be written. \p buf_type_id specifies the datatype of those data elements. \note Note that if the fill value datatype differs from the memory buffer datatype, the fill value will be converted to the memory buffer datatype before filling the selection. \note Applications sometimes write data only to portions of an allocated dataset. It is often useful in such cases to fill the unused space with a known fill value.
-
H5Dset_extent
@Cast("herr_t") public static int H5Dset_extent(@Cast("hid_t") long dset_id, @Cast("const hsize_t*") LongPointer size)
-------------------------------------------------------------------------- \ingroup H5D \brief Changes the sizes of a datasetâs dimensions \dset_id- Parameters:
size- [in] [] Array containing the new magnitude of each dimension of the dataset- Returns:
- \herr_t \details H5Dset_extent() sets the current dimensions of the chunked dataset \p dset_id to the sizes specified in size. \p size is a 1-dimensional array with n elements, where \p n is the rank of the datasetâs current dataspace. This function can be applied to the following datasets: - A chunked dataset with unlimited dimensions - A chunked dataset with fixed dimensions if the new dimension sizes are less than the maximum sizes set with maxdims (see H5Screate_simple()) - An external dataset with unlimited dimensions - An external dataset with fixed dimensions if the new dimension sizes are less than the maximum sizes set with \p maxdims Note that external datasets are always contiguous and can be extended only along the first dimension. Space on disk is immediately allocated for the new dataset extent if the datasetâs space allocation time is set to #H5D_ALLOC_TIME_EARLY. Fill values will be written to the dataset in either of the following situations, but not otherwise: - If the datasetâs fill time is set to #H5D_FILL_TIME_IFSET and a fill value is defined (see H5Pset_fill_time() and H5Pset_fill_value()) - If the datasetâs fill time is set to #H5D_FILL_TIME_ALLOC (see H5Pset_alloc_time()) \note If the sizes specified in \p size array are smaller than the datasetâs current dimension sizes, H5Dset_extent() will reduce the datasetâs dimension sizes to the specified values. It is the user applicationâs responsibility to ensure that valuable data is not lost as H5Dset_extent() does not check. \note Except for external datasets, H5Dset_extent() is for use with chunked datasets only, not contiguous datasets. \note A call to H5Dset_extent() affects the dataspace of a dataset. If a dataspace handle was opened for a dataset prior to a call to H5Dset_extent() then that dataspace handle will no longer reflect the correct dataspace extent of the dataset. H5Dget_space() must be called (after closing the previous handle) to obtain the current dataspace extent.
- Since:
- 1.8.0
-
H5Dset_extent
@Cast("herr_t") public static int H5Dset_extent(@Cast("hid_t") long dset_id, @Cast("const hsize_t*") LongBuffer size)
-
H5Dset_extent
@Cast("herr_t") public static int H5Dset_extent(@Cast("hid_t") long dset_id, @Cast("const hsize_t*") long... size)
-
H5Dset_extent_async
@Cast("herr_t") public static int H5Dset_extent_async(@Cast("const char*") BytePointer app_file, @Cast("const char*") BytePointer app_func, @Cast("unsigned") int app_line, @Cast("hid_t") long dset_id, @Cast("const hsize_t*") LongPointer size, @Cast("hid_t") long es_id)
-------------------------------------------------------------------------- \ingroup ASYNC \async_variant_of{H5Dset_extent}
-
H5Dset_extent_async
@Cast("herr_t") public static int H5Dset_extent_async(String app_file, String app_func, @Cast("unsigned") int app_line, @Cast("hid_t") long dset_id, @Cast("const hsize_t*") LongBuffer size, @Cast("hid_t") long es_id)
-
H5Dset_extent_async
@Cast("herr_t") public static int H5Dset_extent_async(@Cast("const char*") BytePointer app_file, @Cast("const char*") BytePointer app_func, @Cast("unsigned") int app_line, @Cast("hid_t") long dset_id, @Cast("const hsize_t*") long[] size, @Cast("hid_t") long es_id)
-
H5Dset_extent_async
@Cast("herr_t") public static int H5Dset_extent_async(String app_file, String app_func, @Cast("unsigned") int app_line, @Cast("hid_t") long dset_id, @Cast("const hsize_t*") LongPointer size, @Cast("hid_t") long es_id)
-
H5Dset_extent_async
@Cast("herr_t") public static int H5Dset_extent_async(@Cast("const char*") BytePointer app_file, @Cast("const char*") BytePointer app_func, @Cast("unsigned") int app_line, @Cast("hid_t") long dset_id, @Cast("const hsize_t*") LongBuffer size, @Cast("hid_t") long es_id)
-
H5Dset_extent_async
@Cast("herr_t") public static int H5Dset_extent_async(String app_file, String app_func, @Cast("unsigned") int app_line, @Cast("hid_t") long dset_id, @Cast("const hsize_t*") long[] size, @Cast("hid_t") long es_id)
-
H5Dflush
@Cast("herr_t") public static int H5Dflush(@Cast("hid_t") long dset_id)
-------------------------------------------------------------------------- \ingroup H5D \brief Flushes all buffers associated with a dataset to disk \dset_id- Returns:
- \herr_t \details H5Dflush() causes all buffers associated with a dataset to be immediately flushed to disk without removing the data from the cache. \note HDF5 does not possess full control over buffering. H5Dflush() flushes the internal HDF5 buffers and then asks the operating system (the OS) to flush the system buffers for the open files. After that, the OS is responsible for ensuring that the data is actually flushed to disk.
- Since:
- 1.10.0
-
H5Drefresh
@Cast("herr_t") public static int H5Drefresh(@Cast("hid_t") long dset_id)
-------------------------------------------------------------------------- \ingroup H5D \brief Refreshes all buffers associated with a dataset \dset_id- Returns:
- \herr_t \details H5Drefresh() causes all buffers associated with a dataset to be cleared and immediately re-loaded with updated contents from disk. This function essentially closes the dataset, evicts all metadata associated with it from the cache, and then re-opens the dataset. The reopened dataset is automatically re-registered with the same identifier.
- Since:
- 1.10.2
-
H5Dscatter
@Cast("herr_t") public static int H5Dscatter(H5D_scatter_func_t op, Pointer op_data, @Cast("hid_t") long type_id, @Cast("hid_t") long dst_space_id, Pointer dst_buf)
-------------------------------------------------------------------------- \ingroup H5D \brief Scatters data into a selection within a memory buffer- Parameters:
op- [in] Callback function which provides data to be scatteredop_data- [in] User-defined pointer to data required by optype_id- [in] Identifier for the datatype describing the data in both the source and destination buffersdst_space_id- [in] Identifier for the dataspace for destinationdst_buf- [out] Destination buffer which the data will be scattered to- Returns:
- \herr_t \details H5Dscatter() retrieves data from the supplied callback \p op and scatters it to the supplied buffer \p dst_buf in a manner similar to data being written to a dataset. \p dst_space_id is a dataspace which defines the extent of \p dst_buf and the selection within it to scatter the data to. \p type_id is the datatype of the data to be scattered in both the source and destination buffers. \p dst_buf must be at least as large as the number of elements in the extent of \p dst_space_id times the size in bytes of \p type_id. To retrieve the data to be scattered, H5Dscatter() repeatedly calls \p op, which should return a valid source buffer, until enough data to fill the selection has been retrieved.
- Since:
- 1.10.2
-
H5Dgather
@Cast("herr_t") public static int H5Dgather(@Cast("hid_t") long src_space_id, @Const Pointer src_buf, @Cast("hid_t") long type_id, @Cast("size_t") long dst_buf_size, Pointer dst_buf, H5D_gather_func_t op, Pointer op_data)
-------------------------------------------------------------------------- \ingroup H5D \brief Gathers data from a selection within a memory buffer raw data chunk in a dataset- Parameters:
src_space_id- [in] Dataspace identifier for the source buffersrc_buf- [in] Source buffer which the data will be gathered fromtype_id- [in] Datatype identifier for the sourcedst_buf_size- [in] Size in bytes of \p dst_bufdst_buf- [out] Destination buffer for the gathered dataop- [in] Callback function which handles the gathered dataop_data- [in] User-defined pointer to data required by \p op- Returns:
- \herr_t \details H5Dgather() retrieves data from a selection within the supplied buffer src_buf and passes it to the supplied callback function \p op in a contiguous form. The dataspace \p src_space_id describes both the dimensions of the source buffer and the selection within the source buffer to gather data from. \p src_buf must be at least the size of the gathered data, that is, the number of elements in the extent of \p src_space_id times the size in bytes of \p type_id. The datatype \p type_id describes the data in both the source and destination buffers. This information is used to calculate the element size. The data is gathered into \p dst_buf, which needs to be large enough to hold all the data if the callback function \p op is not provided. \p op is a callback function which handles the gathered data. It is optional if \p dst_buf is large enough to hold all of the gathered data; required otherwise. If no callback function is provided, H5Dgather() simply gathers the data into \p dst_buf and returns. If a callback function is provided, H5Dgather() repeatedly gathers up to \p dst_buf_size bytes to process the serialized data. The callback function \p op should process, store, or otherwise, make use of the data returned in \p dst_buf before it returns, because the buffer will be overwritten unless it is the last call to the callback. This function will be repeatedly called until all gathered elements have been passed to the callback in \p dst_buf. The callback function should return zero (0) to indicate success, and a negative value to indicate failure.
- Since:
- 1.10.2
-
H5Dclose
@Cast("herr_t") public static int H5Dclose(@Cast("hid_t") long dset_id)
-------------------------------------------------------------------------- \ingroup H5D \brief Closes the specified dataset \dset_id- Returns:
- \herr_t \details H5Dclose() terminates access to a dataset via the identifier \p dset_id and releases the underlying resources. \par Example \snippet H5D_examples.c read
- Since:
- 1.8.0
-
H5Dclose_async
@Cast("herr_t") public static int H5Dclose_async(@Cast("const char*") BytePointer app_file, @Cast("const char*") BytePointer app_func, @Cast("unsigned") int app_line, @Cast("hid_t") long dset_id, @Cast("hid_t") long es_id)
-------------------------------------------------------------------------- \ingroup ASYNC \async_variant_of{H5Dclose}
-
H5Dclose_async
@Cast("herr_t") public static int H5Dclose_async(String app_file, String app_func, @Cast("unsigned") int app_line, @Cast("hid_t") long dset_id, @Cast("hid_t") long es_id)
-
H5Dget_chunk_index_type
@Cast("herr_t") public static int H5Dget_chunk_index_type(@Cast("hid_t") long did, @Cast("H5D_chunk_index_t*") IntPointer idx_type)
-
H5Dget_chunk_index_type
@Cast("herr_t") public static int H5Dget_chunk_index_type(@Cast("hid_t") long did, @Cast("H5D_chunk_index_t*") IntBuffer idx_type)
-
H5Dget_chunk_index_type
@Cast("herr_t") public static int H5Dget_chunk_index_type(@Cast("hid_t") long did, @Cast("H5D_chunk_index_t*") int[] idx_type)
-
H5E_DEFAULT
@MemberGetter public static int H5E_DEFAULT()
\endcond
-
H5Eregister_class
@Cast("hid_t") public static long H5Eregister_class(@Cast("const char*") BytePointer cls_name, @Cast("const char*") BytePointer lib_name, @Cast("const char*") BytePointer version)
-------------------------------------------------------------------------- \ingroup H5E \brief Registers a client library or application program to the HDF5 error API- Parameters:
cls_name- [in] Name of the error classlib_name- [in] Name of the client library or application to which the error class belongsversion- [in] Version of the client library or application to which the error class belongs. Can be \c NULL.- Returns:
- Returns a class identifier on success; otherwise returns H5I_INVALID_ID. \details H5Eregister_class() registers a client library or application program to the HDF5 error API so that the client library or application program can report errors together with the HDF5 library. It receives an identifier for this error class for further error operations. The library name and version number will be printed out in the error message as a preamble.
- Since:
- 1.8.0
-
H5Eregister_class
@Cast("hid_t") public static long H5Eregister_class(String cls_name, String lib_name, String version)
-
H5Eunregister_class
@Cast("herr_t") public static int H5Eunregister_class(@Cast("hid_t") long class_id)
-------------------------------------------------------------------------- \ingroup H5E \brief Removes an error class- Parameters:
class_id- [in] Error class identifier.- Returns:
- \herr_t \details H5Eunregister_class() removes the error class specified by \p class_id. All the major and minor errors in this class will also be closed.
- Since:
- 1.8.0
-
H5Eclose_msg
@Cast("herr_t") public static int H5Eclose_msg(@Cast("hid_t") long err_id)
-------------------------------------------------------------------------- \ingroup H5E \brief Closes an error message- Parameters:
err_id- [in] An error message identifier- Returns:
- \herr_t \details H5Eclose_msg() closes an error message identifier, which can be either a major or minor message.
- Since:
- 1.8.0
-
H5Ecreate_msg
@Cast("hid_t") public static long H5Ecreate_msg(@Cast("hid_t") long cls, @Cast("H5E_type_t") int msg_type, @Cast("const char*") BytePointer msg)
-------------------------------------------------------------------------- \ingroup H5E \brief Adds a major error message to an error class- Parameters:
cls- [in] An error class identifiermsg_type- [in] The type of the error messagemsg- [in] Major error message- Returns:
- \herr_t \details H5Ecreate_msg() adds an error message to an error class defined by client library or application program. The error message can be either major or minor as indicated by the parameter \p msg_type. Use H5Eclose_msg() to close the message identifier returned by this function.
- Since:
- 1.8.0
-
H5Ecreate_msg
@Cast("hid_t") public static long H5Ecreate_msg(@Cast("hid_t") long cls, @Cast("H5E_type_t") int msg_type, String msg)
-
H5Ecreate_stack
@Cast("hid_t") public static long H5Ecreate_stack()
-------------------------------------------------------------------------- \ingroup H5E \brief Creates a new, empty error stack- Returns:
- \hid_ti{error stack} \details H5Ecreate_stack() creates a new empty error stack and returns the new stackâs identifier. Use H5Eclose_stack() to close the error stack identifier returned by this function.
- Since:
- 1.8.0
-
H5Eget_current_stack
@Cast("hid_t") public static long H5Eget_current_stack()
-------------------------------------------------------------------------- \ingroup H5E \brief Returns a copy of the current error stack- Returns:
- \hid_ti{error stack} \details H5Eget_current_stack() copies the current error stack and returns an error stack identifier for the new copy.
- Since:
- 1.8.0
-
H5Eclose_stack
@Cast("herr_t") public static int H5Eclose_stack(@Cast("hid_t") long stack_id)
-------------------------------------------------------------------------- \ingroup H5E \brief Closes an error stack handle \estack_id{stack_id}- Returns:
- \herr_t \details H5Eclose_stack() closes the error stack handle \p stack_id and releases its resources. #H5E_DEFAULT cannot be closed.
- Since:
- 1.8.0
-
H5Eget_class_name
@Cast("ssize_t") public static long H5Eget_class_name(@Cast("hid_t") long class_id, @Cast("char*") BytePointer name, @Cast("size_t") long size)
-------------------------------------------------------------------------- \ingroup H5E \brief Retrieves error class name- Parameters:
class_id- [in] Error class identifiername- [out] Buffer for the error class namesize- [in] The maximum number of characters the class name to be returned by this function in\p name.- Returns:
- Returns non-negative value as on success; otherwise returns negative value. \details H5Eget_class_name() retrieves the name of the error class specified by the class identifier. If non-NULL pointer is passed in for \p name and \p size is greater than zero, the class name of \p size long is returned. The length of the error class name is also returned. If NULL is passed in as \p name, only the length of class name is returned. If zero is returned, it means no name. The user is responsible for allocating sufficient buffer space for the name.
- Since:
- 1.8.0
-
H5Eget_class_name
@Cast("ssize_t") public static long H5Eget_class_name(@Cast("hid_t") long class_id, @Cast("char*") ByteBuffer name, @Cast("size_t") long size)
-
H5Eget_class_name
@Cast("ssize_t") public static long H5Eget_class_name(@Cast("hid_t") long class_id, @Cast("char*") byte[] name, @Cast("size_t") long size)
-
H5Eset_current_stack
@Cast("herr_t") public static int H5Eset_current_stack(@Cast("hid_t") long err_stack_id)
-------------------------------------------------------------------------- \ingroup H5E \brief Replaces the current error stack \estack_id{err_stack_id}- Returns:
- \herr_t \details H5Eset_current_stack() replaces the content of the current error stack with a copy of the content of the error stack specified by \p err_stack_id, and it closes the error stack specified by \p err_stack_id.
- Since:
- 1.8.0
-
H5Epush2
@Cast("herr_t") public static int H5Epush2(@Cast("hid_t") long err_stack, @Cast("const char*") BytePointer file, @Cast("const char*") BytePointer func, @Cast("unsigned") int line, @Cast("hid_t") long cls_id, @Cast("hid_t") long maj_id, @Cast("hid_t") long min_id, @Cast("const char*") BytePointer msg)
-------------------------------------------------------------------------- \ingroup H5E \brief Pushes a new error record onto an error stack \estack_id{err_stack}. If the identifier is #H5E_DEFAULT, the error record will be pushed to the current stack.- Parameters:
file- [in] Name of the file in which the error was detectedfunc- [in] Name of the function in which the error was detectedline- [in] Line number in the file where the error was detectedcls_id- [in] Error class identifiermaj_id- [in] Major error identifiermin_id- [in] Minor error identifiermsg- [in] Error description string- Returns:
- \herr_t \details H5Epush2() pushes a new error record onto the error stack specified by \p err_stack.\n The error record contains the error class identifier \p cls_id, the major and minor message identifiers \p maj_id and \p min_id, the function name \p func where the error was detected, the file name \p file and line number \p line in the file where the error was detected, and an error description \p msg.\n The major and minor errors must be in the same error class.\n The function name, filename, and error description strings must be statically allocated.\n \p msg can be a format control string with additional arguments. This design of appending additional arguments is similar to the system and C functions printf() and fprintf().
- Since:
- 1.8.0
-
H5Epush2
@Cast("herr_t") public static int H5Epush2(@Cast("hid_t") long err_stack, String file, String func, @Cast("unsigned") int line, @Cast("hid_t") long cls_id, @Cast("hid_t") long maj_id, @Cast("hid_t") long min_id, String msg)
-
H5Epop
@Cast("herr_t") public static int H5Epop(@Cast("hid_t") long err_stack, @Cast("size_t") long count)
-------------------------------------------------------------------------- \ingroup H5E \brief Deletes specified number of error messages from the error stack \estack_id{err_stack}- Parameters:
count- [in] The number of error messages to be deleted from the top of error stack- Returns:
- \herr_t \details H5Epop() deletes the number of error records specified in \p count from the top of the error stack specified by \p err_stack (including major, minor messages and description). The number of error messages to be deleted is specified by \p count.
- Since:
- 1.8.0
-
H5Eprint2
@Cast("herr_t") public static int H5Eprint2(@Cast("hid_t") long err_stack, @Cast("FILE*") Pointer stream)
-------------------------------------------------------------------------- \ingroup H5E \brief Prints the specified error stack in a default manner \estack_id{err_stack}- Parameters:
stream- [in] File pointer, or \c NULL for \c stderr- Returns:
- \herr_t
\details H5Eprint2() prints the error stack specified by \p err_stack on the
specified stream, \p stream. Even if the error stack is empty, a
one-line message of the following form will be printed:
A similar line will appear before the error messages of each error class stating the library name, library version number, and thread identifier. If \p err_stack is #H5E_DEFAULT, the current error stack will be printed. H5Eprint2() is a convenience function for H5Ewalk2() with a function that prints error messages. Users are encouraged to write their own more specific error handlers.{.unparsed} HDF5-DIAG: Error detected in HDF5 library version: 1.5.62 thread 0. - Since:
- 1.8.0
-
H5Ewalk2
@Cast("herr_t") public static int H5Ewalk2(@Cast("hid_t") long err_stack, @Cast("H5E_direction_t") int direction, H5E_walk2_t func, Pointer client_data)
-------------------------------------------------------------------------- \ingroup H5E \brief Walks the specified error stack, calling the specified function \estack_id{err_stack}- Parameters:
direction- [in] Direction in which the error stack is to be walkedfunc- [in] Function to be called for each error encounteredclient_data- [in] Data to be passed to \p func- Returns:
- \herr_t \details H5Ewalk2() walks the error stack specified by err_stack for the current thread and calls the function specified in \p func for each error along the way. If the value of \p err_stack is #H5E_DEFAULT, then H5Ewalk2() walks the current error stack. \p direction specifies whether the stack is walked from the inside out or the outside in. A value of #H5E_WALK_UPWARD means to begin with the most specific error and end at the API; a value of #H5E_WALK_DOWNWARD means to start at the API and end at the innermost function where the error was first detected. \p func, a function conforming to the #H5E_walk2_t prototype, will be called for each error in the error stack. Its arguments will include an index number \c n (beginning at zero regardless of stack traversal direction), an error stack entry \c err_desc, and the \c client_data pointer passed to H5Eprint(). The #H5E_walk2_t prototype is as follows: \snippet this H5E_walk2_t_snip
- Since:
- 1.8.0
-
H5Eget_auto2
@Cast("herr_t") public static int H5Eget_auto2(@Cast("hid_t") long estack_id, @ByPtrPtr H5E_auto2_t func, @Cast("void**") PointerPointer client_data)
-------------------------------------------------------------------------- \ingroup H5E \brief Returns the settings for the automatic error stack traversal function and its data \estack_id- Parameters:
func- [out] The function currently set to be called upon an error conditionclient_data- [out] Data currently set to be passed to the error function- Returns:
- \herr_t \details H5Eget_auto2() returns the settings for the automatic error stack traversal function, \p func, and its data, \p client_data, that are associated with the error stack specified by \p estack_id. Either or both of the \p func and \p client_data arguments may be \c NULL, in which case the value is not returned. The library initializes its default error stack traversal functions to H5Eprint1() and H5Eprint2(). A call to H5Eget_auto2() returns H5Eprint2() or the user-defined function passed in through H5Eset_auto2(). A call to H5Eget_auto1() returns H5Eprint1() or the user-defined function passed in through H5Eset_auto1(). However, if the application passes in a user-defined function through H5Eset_auto1(), it should call H5Eget_auto1() to query the traversal function. If the application passes in a user-defined function through H5Eset_auto2(), it should call H5Eget_auto2() to query the traversal function. Mixing the new style and the old style functions will cause a failure. For example, if the application sets a user-defined old-style traversal function through H5Eset_auto1(), a call to H5Eget_auto2() will fail and will indicate that the application has mixed H5Eset_auto1() and H5Eget_auto2(). On the other hand, mixing H5Eset_auto2() and H5Eget_auto1() will also cause a failure. But if the traversal functions are the libraryâs default H5Eprint1() or H5Eprint2(), mixing H5Eset_auto1() and H5Eget_auto2() or mixing H5Eset_auto2() and H5Eget_auto1() does not fail.
- Since:
- 1.8.0
-
H5Eget_auto2
@Cast("herr_t") public static int H5Eget_auto2(@Cast("hid_t") long estack_id, @ByPtrPtr H5E_auto2_t func, @Cast("void**") @ByPtrPtr Pointer client_data)
-
H5Eset_auto2
@Cast("herr_t") public static int H5Eset_auto2(@Cast("hid_t") long estack_id, H5E_auto2_t func, Pointer client_data)
-------------------------------------------------------------------------- \ingroup H5E \brief Turns automatic error printing on or off \estack_id- Parameters:
func- [in] Function to be called upon an error conditionclient_data- [in] Data passed to the error function- Returns:
- \herr_t \details H5Eset_auto2() turns on or off automatic printing of errors for the error stack specified with \p estack_id. An \p estack_id value of #H5E_DEFAULT indicates the current stack. When automatic printing is turned on, by the use of a non-null \p func pointer, any API function which returns an error indication will first call \p func, passing it \p client_data as an argument. \p func, a function compliant with the #H5E_auto2_t prototype, is defined in the H5Epublic.h source code file as: \snippet this H5E_auto2_t_snip When the library is first initialized, the auto printing function is set to H5Eprint2() (cast appropriately) and \p client_data is the standard error stream pointer, \c stderr. Automatic stack traversal is always in the #H5E_WALK_DOWNWARD direction. Automatic error printing is turned off with a H5Eset_auto2() call with a \c NULL \p func pointer.
- Since:
- 1.8.0
-
H5Eclear2
@Cast("herr_t") public static int H5Eclear2(@Cast("hid_t") long err_stack)
-------------------------------------------------------------------------- \ingroup H5E \brief Clears the specified error stack or the error stack for the current thread \estack_id{err_stack}- Returns:
- \herr_t \details H5Eclear2() clears the error stack specified by \p err_stack, or, if \p err_stack is set to #H5E_DEFAULT, the error stack for the current thread. \p err_stack is an error stack identifier, such as that returned by H5Eget_current_stack(). The current error stack is also cleared whenever an API function is called, with certain exceptions (for instance, H5Eprint1() or H5Eprint2()).
- Since:
- 1.8.0
-
H5Eauto_is_v2
@Cast("herr_t") public static int H5Eauto_is_v2(@Cast("hid_t") long err_stack, @Cast("unsigned*") IntPointer is_stack)
-------------------------------------------------------------------------- \ingroup H5E \brief Determines the type of error stack \estack_id{err_stack}- Parameters:
is_stack- [out] A flag indicating which error stack \c typedef the specified error stack conforms to- Returns:
- \herr_t \details H5Eauto_is_v2() determines whether the error auto reporting function for an error stack conforms to the #H5E_auto2_t \c typedef or the #H5E_auto1_t \c typedef. The \p is_stack parameter is set to 1 if the error stack conforms to #H5E_auto2_t and 0 if it conforms to #H5E_auto1_t.
- Since:
- 1.8.0
-
H5Eauto_is_v2
@Cast("herr_t") public static int H5Eauto_is_v2(@Cast("hid_t") long err_stack, @Cast("unsigned*") IntBuffer is_stack)
-
H5Eauto_is_v2
@Cast("herr_t") public static int H5Eauto_is_v2(@Cast("hid_t") long err_stack, @Cast("unsigned*") int[] is_stack)
-
H5Eget_msg
@Cast("ssize_t") public static long H5Eget_msg(@Cast("hid_t") long msg_id, @Cast("H5E_type_t*") IntPointer type, @Cast("char*") BytePointer msg, @Cast("size_t") long size)
-------------------------------------------------------------------------- \ingroup H5E \brief Retrieves an error message- Parameters:
msg_id- [in] Error message identifiertype- [out] The type of the error message Valid values are #H5E_MAJOR and #H5E_MINOR.msg- [out] Error message buffersize- [in] The length of error message to be returned by this function- Returns:
- Returns the size of the error message in bytes on success; otherwise returns a negative value. \details H5Eget_msg() retrieves the error message including its length and type. The error message is specified by \p msg_id. The user is responsible for passing in sufficient buffer space for the message. If \p msg is not NULL and \p size is greater than zero, the error message of \p size long is returned. The length of the message is also returned. If NULL is passed in as \p msg, only the length and type of the message is returned. If the return value is zero, it means there is no message.
- Since:
- 1.8.0
-
H5Eget_msg
@Cast("ssize_t") public static long H5Eget_msg(@Cast("hid_t") long msg_id, @Cast("H5E_type_t*") IntBuffer type, @Cast("char*") ByteBuffer msg, @Cast("size_t") long size)
-
H5Eget_msg
@Cast("ssize_t") public static long H5Eget_msg(@Cast("hid_t") long msg_id, @Cast("H5E_type_t*") int[] type, @Cast("char*") byte[] msg, @Cast("size_t") long size)
-
H5Eget_num
@Cast("ssize_t") public static long H5Eget_num(@Cast("hid_t") long error_stack_id)
-------------------------------------------------------------------------- \ingroup H5E \brief Retrieves the number of error messages in an error stack \estack_id{error_stack_id}- Returns:
- Returns a non-negative value on success; otherwise returns a negative value. \details H5Eget_num() retrieves the number of error records in the error stack specified by \p error_stack_id (including major, minor messages and description).
- Since:
- 1.8.0
-
H5F_ACC_RDONLY
@MemberGetter public static int H5F_ACC_RDONLY()
Absence of RDWR: read-only
-
H5F_ACC_RDWR
@MemberGetter public static int H5F_ACC_RDWR()
Open for read and write
-
H5F_ACC_TRUNC
@MemberGetter public static int H5F_ACC_TRUNC()
Overwrite existing files
-
H5F_ACC_EXCL
@MemberGetter public static int H5F_ACC_EXCL()
Fail if file already exists
-
H5F_ACC_CREAT
@MemberGetter public static int H5F_ACC_CREAT()
Create non-existing files
-
H5F_ACC_SWMR_WRITE
@MemberGetter public static int H5F_ACC_SWMR_WRITE()
Indicate that this file is open for writing in a \ single-writer/multi-reader (SWMR) scenario. \ Note that the process(es) opening the file for reading \ must open the file with #H5F_ACC_RDONLY and use the \ #H5F_ACC_SWMR_READ access flag.
-
H5F_ACC_SWMR_READ
@MemberGetter public static int H5F_ACC_SWMR_READ()
Indicate that this file is open for reading in a \ single-writer/multi-reader (SWMR) scenario. Note that \ the process(es) opening the file for SWMR reading must \ also open the file with the #H5F_ACC_RDONLY flag.
-
H5F_ACC_DEFAULT
@MemberGetter public static int H5F_ACC_DEFAULT()
Default property list identifier \internal Value passed to H5Pset_elink_acc_flags to cause flags to be taken from the parent file. \internal ignore setting on lapl
-
H5F_FAMILY_DEFAULT
@MemberGetter public static int H5F_FAMILY_DEFAULT()
-
H5F_UNLIMITED
@MemberGetter public static int H5F_UNLIMITED()
Unlimited file size for H5Pset_external()
-
H5Fis_accessible
@Cast("htri_t") public static int H5Fis_accessible(@Cast("const char*") BytePointer container_name, @Cast("hid_t") long fapl_id)
\ingroup H5F \brief Checks if a file can be opened with a given file access property list- Parameters:
container_name- [in] Name of a file \fapl_id- Returns:
- \htri_t \details H5Fis_accessible() checks if the file specified by \p container_name can be opened with the file access property list \p fapl_id. \note The H5Fis_accessible() function enables files to be checked with a given file access property list, unlike H5Fis_hdf5(), which only uses the default file driver when opening a file.
- Since:
- 1.12.0
-
H5Fis_accessible
@Cast("htri_t") public static int H5Fis_accessible(String container_name, @Cast("hid_t") long fapl_id)
-
H5Fcreate
@Cast("hid_t") public static long H5Fcreate(@Cast("const char*") BytePointer filename, @Cast("unsigned") int flags, @Cast("hid_t") long fcpl_id, @Cast("hid_t") long fapl_id)
\ingroup H5F \brief Creates an HDF5 file- Parameters:
filename- [in] Name of the file to createflags- [in] File access flags. Allowable values are: - #H5F_ACC_TRUNC: Truncate file, if it already exists, erasing all data previously stored in the file - #H5F_ACC_EXCL: Fail if file already exists \fcpl_id \fapl_id- Returns:
- \hid_t{file} \details H5Fcreate() is the primary function for creating HDF5 files; it creates a new HDF5 file with the specified name and property lists. The \p filename parameter specifies the name of the new file. The \p flags parameter specifies whether an existing file is to be overwritten. It should be set to either #H5F_ACC_TRUNC to overwrite an existing file or #H5F_ACC_EXCL, instructing the function to fail if the file already exists. New files are always created in read-write mode, so the read-write and read-only flags, #H5F_ACC_RDWR and #H5F_ACC_RDONLY, respectively, are not relevant in this function. Further note that a specification of #H5F_ACC_RDONLY will be ignored; the file will be created in read-write mode, regardless. More complex behaviors of file creation and access are controlled through the file creation and file access property lists, \p fcpl_id and \p fapl_id, respectively. The value of #H5P_DEFAULT for any property list value indicates that the library should use the default values for that appropriate property list. The return value is a file identifier for the newly-created file; this file identifier should be closed by calling H5Fclose() when it is no longer needed. \par Example \snippet H5F_examples.c minimal \note #H5F_ACC_TRUNC and #H5F_ACC_EXCL are mutually exclusive; use exactly one. \note An additional flag, #H5F_ACC_DEBUG, prints debug information. This flag can be combined with one of the above values using the bit-wise OR operator (\c |), but it is used only by HDF5 library developers; \Emph{it is neither tested nor supported for use in applications}. \attention \Bold{Special case â File creation in the case of an already-open file:} If a file being created is already opened, by either a previous H5Fopen() or H5Fcreate() call, the HDF5 library may or may not detect that the open file and the new file are the same physical file. (See H5Fopen() regarding the limitations in detecting the re-opening of an already-open file.)\n If the library detects that the file is already opened, H5Fcreate() will return a failure, regardless of the use of #H5F_ACC_TRUNC.\n If the library does not detect that the file is already opened and #H5F_ACC_TRUNC is not used, H5Fcreate() will return a failure because the file already exists. Note that this is correct behavior.\n But if the library does not detect that the file is already opened and #H5F_ACC_TRUNC is used, H5Fcreate() will truncate the existing file and return a valid file identifier. Such a truncation of a currently-opened file will almost certainly result in errors. While unlikely, the HDF5 library may not be able to detect, and thus report, such errors.\n Applications should avoid calling H5Fcreate() with an already opened file.
- Since:
- 1.0.0
-
H5Fcreate
@Cast("hid_t") public static long H5Fcreate(String filename, @Cast("unsigned") int flags, @Cast("hid_t") long fcpl_id, @Cast("hid_t") long fapl_id)
-
H5Fcreate_async
@Cast("hid_t") public static long H5Fcreate_async(@Cast("const char*") BytePointer app_file, @Cast("const char*") BytePointer app_func, @Cast("unsigned") int app_line, @Cast("const char*") BytePointer filename, @Cast("unsigned") int flags, @Cast("hid_t") long fcpl_id, @Cast("hid_t") long fapl_id, @Cast("hid_t") long es_id)
-------------------------------------------------------------------------- \ingroup ASYNC \async_variant_of{H5Fcreate}
-
H5Fcreate_async
@Cast("hid_t") public static long H5Fcreate_async(String app_file, String app_func, @Cast("unsigned") int app_line, String filename, @Cast("unsigned") int flags, @Cast("hid_t") long fcpl_id, @Cast("hid_t") long fapl_id, @Cast("hid_t") long es_id)
-
H5Fopen
@Cast("hid_t") public static long H5Fopen(@Cast("const char*") BytePointer filename, @Cast("unsigned") int flags, @Cast("hid_t") long fapl_id)
\ingroup H5F \brief Opens an existing HDF5 file- Parameters:
filename- [in] Name of the file to be openedflags- [in] File access flags. Allowable values are: - #H5F_ACC_RDWR: Allows read and write access to file - #H5F_ACC_RDONLY: Allows read-only access to file - #H5F_ACC_RDWR \c | #H5F_ACC_SWMR_WRITE: Indicates that the file is open for writing in a single-writer/multi-writer (SWMR) scenario. - #H5F_ACC_RDONLY \c | #H5F_ACC_SWMR_READ: Indicates that the file is open for reading in a single-writer/multi-reader (SWMR) scenario. - An additional flag, #H5F_ACC_DEBUG, prints debug information. This flag can be combined with one of the above values using the bit-wise OR operator (\c |), but it is used only by HDF5 library developers; \Emph{it is neither tested nor supported} for use in applications. \fapl_id- Returns:
- \hid_t{file} \details H5Fopen() is the primary function for accessing existing HDF5 files. This function opens the named file in the specified access mode and with the specified access property list. Note that H5Fopen() does not create a file if it does not already exist; see H5Fcreate(). The \p filename parameter specifies the name of the file to be opened. The \p fapl_id parameter specifies the file access property list. Use of #H5P_DEFAULT specifies that default I/O access properties are to be used. The \p flags parameter specifies whether the file will be opened in read-write or read-only mode, #H5F_ACC_RDWR or #H5F_ACC_RDONLY, respectively. More complex behaviors of file access are controlled through the file-access property list. The return value is a file identifier for the open file; this file identifier should be closed by calling H5Fclose() when it is no longer needed. \par Example \snippet H5F_examples.c open \note #H5F_ACC_RDWR and #H5F_ACC_RDONLY are mutually exclusive; use exactly one. \attention \Bold{Special cases â Multiple opens:} A file can often be opened with a new H5Fopen() call without closing an already-open identifier established in a previous H5Fopen() or H5Fcreate() call. Each such H5Fopen() call will return a unique identifier and the file can be accessed through any of these identifiers as long as the identifier remains valid. In such multiply-opened cases, the open calls must use the same flags argument and the file access property lists must use the same file close degree property setting (see the external link discussion below and H5Pset_fclose_degree()).\n In some cases, such as files on a local Unix file system, the HDF5 library can detect that a file is multiply opened and will maintain coherent access among the file identifiers.\n But in many other cases, such as parallel file systems or networked file systems, it is not always possible to detect multiple opens of the same physical file. In such cases, HDF5 will treat the file identifiers as though they are accessing different files and will be unable to maintain coherent access. Errors are likely to result in these cases. While unlikely, the HDF5 library may not be able to detect, and thus report, such errors.\n It is generally recommended that applications avoid multiple opens of the same file. \attention \Bold{Special restriction on multiple opens of a file first opened by means of an external link:} When an external link is followed, the external file is always opened with the weak file close degree property setting, #H5F_CLOSE_WEAK (see H5Lcreate_external() and H5Pset_fclose_degree()). If the file is reopened with H5Fopen while it remains held open from such an external link call, the file access property list used in the open call must include the file close degree setting #H5F_CLOSE_WEAK or the open will fail.
- See Also:
H5Fclose()
-
H5Fopen
@Cast("hid_t") public static long H5Fopen(String filename, @Cast("unsigned") int flags, @Cast("hid_t") long fapl_id)
-
H5Fopen_async
@Cast("hid_t") public static long H5Fopen_async(@Cast("const char*") BytePointer app_file, @Cast("const char*") BytePointer app_func, @Cast("unsigned") int app_line, @Cast("const char*") BytePointer filename, @Cast("unsigned") int flags, @Cast("hid_t") long access_plist, @Cast("hid_t") long es_id)
-------------------------------------------------------------------------- \ingroup ASYNC \async_variant_of{H5Fopen}
-
H5Fopen_async
@Cast("hid_t") public static long H5Fopen_async(String app_file, String app_func, @Cast("unsigned") int app_line, String filename, @Cast("unsigned") int flags, @Cast("hid_t") long access_plist, @Cast("hid_t") long es_id)
-
H5Freopen
@Cast("hid_t") public static long H5Freopen(@Cast("hid_t") long file_id)
\ingroup H5F \brief Returns a new identifier for a previously-opened HDF5 file- Parameters:
file_id- [in] Identifier of a file for which an additional identifier is required- Returns:
- \hid_t{file} \details H5Freopen() returns a new file identifier for an already-open HDF5 file, as specified by \p file_id. Both identifiers share caches and other information. The only difference between the identifiers is that the new identifier is not mounted anywhere and no files are mounted on it. The new file identifier should be closed by calling H5Fclose() when it is no longer needed. \note Note that there is no circumstance under which H5Freopen() can actually open a closed file; the file must already be open and have an active \p file_id. E.g., one cannot close a file with H5Fclose() on \p file_id then use H5Freopen() on \p file_id to reopen it.
-
H5Freopen_async
@Cast("hid_t") public static long H5Freopen_async(@Cast("const char*") BytePointer app_file, @Cast("const char*") BytePointer app_func, @Cast("unsigned") int app_line, @Cast("hid_t") long file_id, @Cast("hid_t") long es_id)
-------------------------------------------------------------------------- \ingroup ASYNC \async_variant_of{H5Freopen}
-
H5Freopen_async
@Cast("hid_t") public static long H5Freopen_async(String app_file, String app_func, @Cast("unsigned") int app_line, @Cast("hid_t") long file_id, @Cast("hid_t") long es_id)
-
H5Fflush
@Cast("herr_t") public static int H5Fflush(@Cast("hid_t") long object_id, @Cast("H5F_scope_t") int scope)
\ingroup H5F \brief Flushes all buffers associated with a file to storage \loc_id{object_id}- Parameters:
scope- [in] The scope of the flush action- Returns:
- \herr_t \details H5Fflush() causes all buffers associated with a file to be immediately flushed to storage without removing the data from the cache. \p object_id can be any object associated with the file, including the file itself, a dataset, a group, an attribute, or a named datatype. \p scope specifies whether the scope of the flush action is global or local. Valid values are as follows: \scopes \par Example \snippet H5F_examples.c flush \attention HDF5 does not possess full control over buffering. H5Fflush() flushes the internal HDF5 buffers then asks the operating system (the OS) to flush the system buffers for the open files. After that, the OS is responsible for ensuring that the data is actually flushed to disk.
-
H5Fflush_async
@Cast("herr_t") public static int H5Fflush_async(@Cast("const char*") BytePointer app_file, @Cast("const char*") BytePointer app_func, @Cast("unsigned") int app_line, @Cast("hid_t") long object_id, @Cast("H5F_scope_t") int scope, @Cast("hid_t") long es_id)
-------------------------------------------------------------------------- \ingroup ASYNC \async_variant_of{H5Fflush}
-
H5Fflush_async
@Cast("herr_t") public static int H5Fflush_async(String app_file, String app_func, @Cast("unsigned") int app_line, @Cast("hid_t") long object_id, @Cast("H5F_scope_t") int scope, @Cast("hid_t") long es_id)
-
H5Fclose
@Cast("herr_t") public static int H5Fclose(@Cast("hid_t") long file_id)
\ingroup H5F \brief Terminates access to an HDF5 file \file_id- Returns:
- \herr_t \details H5Fclose() terminates access to an HDF5 file (specified by \p file_id) by flushing all data to storage. If this is the last file identifier open for the file and no other access identifier is open (e.g., a dataset identifier, group identifier, or shared datatype identifier), the file will be fully closed and access will end. \par Example \snippet H5F_examples.c minimal \note \Bold{Delayed close:} Note the following deviation from the above-described behavior. If H5Fclose() is called for a file but one or more objects within the file remain open, those objects will remain accessible until they are individually closed. Thus, if the dataset \c data_sample is open when H5Fclose() is called for the file containing it, \c data_sample will remain open and accessible (including writable) until it is explicitly closed. The file will be automatically closed once all objects in the file have been closed.\n Be warned, however, that there are circumstances where it is not possible to delay closing a file. For example, an MPI-IO file close is a collective call; all of the processes that opened the file must close it collectively. The file cannot be closed at some time in the future by each process in an independent fashion. Another example is that an application using an AFS token-based file access privilege may destroy its AFS token after H5Fclose() has returned successfully. This would make any future access to the file, or any object within it, illegal.\n In such situations, applications must close all open objects in a file before calling H5Fclose. It is generally recommended to do so in all cases.
- See Also:
H5Fopen()
-
H5Fclose_async
@Cast("herr_t") public static int H5Fclose_async(@Cast("const char*") BytePointer app_file, @Cast("const char*") BytePointer app_func, @Cast("unsigned") int app_line, @Cast("hid_t") long file_id, @Cast("hid_t") long es_id)
-------------------------------------------------------------------------- \ingroup ASYNC \async_variant_of{H5Fclose}
-
H5Fclose_async
@Cast("herr_t") public static int H5Fclose_async(String app_file, String app_func, @Cast("unsigned") int app_line, @Cast("hid_t") long file_id, @Cast("hid_t") long es_id)
-
H5Fdelete
@Cast("herr_t") public static int H5Fdelete(@Cast("const char*") BytePointer filename, @Cast("hid_t") long fapl_id)
\ingroup H5F \brief Deletes an HDF5 file- Parameters:
filename- [in] Name of the file to delete \fapl_id- Returns:
- \herr_t \details H5Fdelete() deletes an HDF5 file \p filename with a file access property list \p fapl_id. The \p fapl_id should be configured with the same VOL connector or VFD that was used to open the file. This API was introduced for use with the Virtual Object Layer (VOL). With the VOL, HDF5 "files" can map to arbitrary storage schemes such as object stores and relational database tables. The data created by these implementations may be inconvenient for a user to remove without a detailed knowledge of the storage scheme. H5Fdelete() gives VOL connector authors the ability to add connector-specific delete code to their connectors so that users can remove these "files" without detailed knowledge of the storage scheme. For a VOL connector, H5Fdelete() deletes the file in a way that makes sense for the specified VOL connector. For the native HDF5 connector, HDF5 files will be deleted via the VFDs, each of which will have to be modified to delete the files it creates. For all implementations, H5Fdelete() will first check if the file is an HDF5 file via H5Fis_accessible(). This is done to ensure that H5Fdelete() cannot be used as an arbitrary file deletion call.
- Since:
- 1.12.0
-
H5Fdelete
@Cast("herr_t") public static int H5Fdelete(String filename, @Cast("hid_t") long fapl_id)
-
H5Fget_create_plist
@Cast("hid_t") public static long H5Fget_create_plist(@Cast("hid_t") long file_id)
\ingroup H5F \brief Returns a file creation property list identifier \file_id- Returns:
- \hid_t{file creation property list} \details H5Fget_create_plist() returns the file creation property list identifier identifying the creation properties used to create this file. This function is useful for duplicating properties when creating another file. The creation property list identifier should be released with H5Pclose().
-
H5Fget_access_plist
@Cast("hid_t") public static long H5Fget_access_plist(@Cast("hid_t") long file_id)
\ingroup H5F \brief Returns a file access property list identifier \file_id- Returns:
- \hid_t{file access property list} \details H5Fget_access_plist() returns the file access property list identifier of the specified file.
-
H5Fget_intent
@Cast("herr_t") public static int H5Fget_intent(@Cast("hid_t") long file_id, @Cast("unsigned*") IntPointer intent)
\ingroup H5F \brief Determines the read/write or read-only status of a file \file_id- Parameters:
intent- [out] Access mode flag as originally passed with H5Fopen()- Returns:
- \herr_t \details Given the identifier of an open file, \p file_id, H5Fget_intent() retrieves the intended access mode" flag passed with H5Fopen() when the file was opened. The value of the flag is returned in \p intent. Valid values are as follows: \file_access \note The function will not return an error if intent is NULL; it will simply do nothing.
- Since:
- 1.8.0
-
H5Fget_intent
@Cast("herr_t") public static int H5Fget_intent(@Cast("hid_t") long file_id, @Cast("unsigned*") IntBuffer intent)
-
H5Fget_intent
@Cast("herr_t") public static int H5Fget_intent(@Cast("hid_t") long file_id, @Cast("unsigned*") int[] intent)
-
H5Fget_fileno
@Cast("herr_t") public static int H5Fget_fileno(@Cast("hid_t") long file_id, @Cast("unsigned long*") CLongPointer fileno)
\ingroup H5F \brief Retrieves a file's file number that uniquely identifies an open file \file_id- Parameters:
fileno- [out] A buffer to hold the file number- Returns:
- \herr_t \details H5Fget_fileno() retrieves a file number for a file specified by the file identifier \p file_id and the pointer \p fnumber to the file number.
- Since:
- 1.12.0
-
H5Fget_obj_count
@Cast("ssize_t") public static long H5Fget_obj_count(@Cast("hid_t") long file_id, @Cast("unsigned") int types)
\ingroup H5F \brief Returns the number of open object identifiers for an open file \file_id or #H5F_OBJ_ALL for all currently-open HDF5 files- Parameters:
types- [in] Type of object for which identifiers are to be returned- Returns:
- Returns the number of open objects if successful; otherwise returns a negative value. \details Given the identifier of an open file, file_id, and the desired object types, types, H5Fget_obj_count() returns the number of open object identifiers for the file. To retrieve a count of open identifiers for open objects in all HDF5 application files that are currently open, pass the value #H5F_OBJ_ALL in \p file_id. The types of objects to be counted are specified in types as follows: \obj_types Multiple object types can be combined with the logical \c OR operator (|). For example, the expression \c (#H5F_OBJ_DATASET|#H5F_OBJ_GROUP) would call for datasets and groups.
-
H5Fget_obj_ids
@Cast("ssize_t") public static long H5Fget_obj_ids(@Cast("hid_t") long file_id, @Cast("unsigned") int types, @Cast("size_t") long max_objs, @Cast("hid_t*") LongPointer obj_id_list)
------------------------------------------------------------------------- \ingroup H5F \brief Returns a list of open object identifiers \file_id or #H5F_OBJ_ALL for all currently-open HDF5 files- Parameters:
types- [in] Type of object for which identifiers are to be returnedmax_objs- [in] Maximum number of object identifiers to place into \p obj_id_listobj_id_list- [out] Pointer to the returned buffer of open object identifiers- Returns:
- Returns number of objects placed into \p obj_id_list if successful; otherwise returns a negative value. \details Given the file identifier \p file_id and the type of objects to be identified, types, H5Fget_obj_ids() returns the list of identifiers for all open HDF5 objects fitting the specified criteria. To retrieve identifiers for open objects in all HDF5 application files that are currently open, pass the value #H5F_OBJ_ALL in \p file_id. The types of object identifiers to be retrieved are specified in types using the codes listed for the same parameter in H5Fget_obj_count(). To retrieve a count of open objects, use the H5Fget_obj_count() function. This count can be used to set the \p max_objs parameter.
- Since:
- 1.6.0
-
H5Fget_obj_ids
@Cast("ssize_t") public static long H5Fget_obj_ids(@Cast("hid_t") long file_id, @Cast("unsigned") int types, @Cast("size_t") long max_objs, @Cast("hid_t*") LongBuffer obj_id_list)
-
H5Fget_obj_ids
@Cast("ssize_t") public static long H5Fget_obj_ids(@Cast("hid_t") long file_id, @Cast("unsigned") int types, @Cast("size_t") long max_objs, @Cast("hid_t*") long... obj_id_list)
-
H5Fget_vfd_handle
@Cast("herr_t") public static int H5Fget_vfd_handle(@Cast("hid_t") long file_id, @Cast("hid_t") long fapl, @Cast("void**") PointerPointer file_handle)
\ingroup H5F \brief Returns pointer to the file handle from the virtual file driver \file_id \fapl_id{fapl}- Parameters:
file_handle- [out] Pointer to the file handle being used by the low-level virtual file driver- Returns:
- \herr_t \details Given the file identifier \p file_id and the file access property list \p fapl_id, H5Fget_vfd_handle() returns a pointer to the file handle from the low-level file driver currently being used by the HDF5 library for file I/O. \note For most drivers, the value of \p fapl_id will be #H5P_DEFAULT. For the \c FAMILY or \c MULTI drivers, this value should be defined through the property list functions: H5Pset_family_offset() for the \c FAMILY driver and H5Pset_multi_type() for the \c MULTI driver
- Since:
- 1.6.0
-
H5Fget_vfd_handle
@Cast("herr_t") public static int H5Fget_vfd_handle(@Cast("hid_t") long file_id, @Cast("hid_t") long fapl, @Cast("void**") @ByPtrPtr Pointer file_handle)
-
H5Fmount
@Cast("herr_t") public static int H5Fmount(@Cast("hid_t") long loc, @Cast("const char*") BytePointer name, @Cast("hid_t") long child, @Cast("hid_t") long plist)
\ingroup H5F \brief Mounts an HDF5 file \loc_id{loc}- Parameters:
name- [in] Name of the group onto which the file specified by \p child is to be mounted \file_id{child}plist- [in] File mount property list identifier. Pass #H5P_DEFAULT!- Returns:
- \herr_t \details H5Fmount() mounts the file specified by \p child onto the object specified by \p loc and \p name using the mount properties \p plist If the object specified by \p loc is a dataset, named datatype or attribute, then the file will be mounted at the location where the attribute, dataset, or named datatype is attached. \par Example \snippet H5F_examples.c mount \note To date, no file mount properties have been defined in HDF5. The proper value to pass for \p plist is #H5P_DEFAULT, indicating the default file mount property list.
-
H5Fmount
@Cast("herr_t") public static int H5Fmount(@Cast("hid_t") long loc, String name, @Cast("hid_t") long child, @Cast("hid_t") long plist)
-
H5Funmount
@Cast("herr_t") public static int H5Funmount(@Cast("hid_t") long loc, @Cast("const char*") BytePointer name)
\ingroup H5F \brief Unounts an HDF5 file \loc_id{loc}- Parameters:
name- [in] Name of the mount point- Returns:
- \herr_t \details Given a mount point, H5Funmount() dissociates the mount point's file from the file mounted there. This function does not close either file. The mount point can be either the group in the parent or the root group of the mounted file (both groups have the same name). If the mount point was opened before the mount then it is the group in the parent; if it was opened after the mount then it is the root group of the child.
-
H5Fget_freespace
@Cast("hssize_t") public static long H5Fget_freespace(@Cast("hid_t") long file_id)
\ingroup H5F \brief Returns the amount of free space in a file (in bytes) \file_id- Returns:
- Returns the amount of free space in the file if successful; otherwise returns a negative value. \details Given the identifier of an open file, \p file_id, H5Fget_freespace() returns the amount of space that is unused by any objects in the file. The interpretation of this number depends on the configured free space management strategy. For example, if the HDF5 library only tracks free space in a file from a file open or create until that file is closed, then this routine will report the free space that has been created during that interval.
- Since:
- 1.6.1
-
H5Fget_filesize
@Cast("herr_t") public static int H5Fget_filesize(@Cast("hid_t") long file_id, @Cast("hsize_t*") LongPointer size)
\ingroup H5F \brief Returns the size of an HDF5 file (in bytes) \file_id- Parameters:
size- [out] Size of the file, in bytes- Returns:
- \herr_t \details H5Fget_filesize() returns the size of the HDF5 file specified by \p file_id. The returned size is that of the entire file, as opposed to only the HDF5 portion of the file. I.e., size includes the user block, if any, the HDF5 portion of the file, and any data that may have been appended beyond the data written through the HDF5 library.
- Since:
- 1.6.3
-
H5Fget_filesize
@Cast("herr_t") public static int H5Fget_filesize(@Cast("hid_t") long file_id, @Cast("hsize_t*") LongBuffer size)
-
H5Fget_filesize
@Cast("herr_t") public static int H5Fget_filesize(@Cast("hid_t") long file_id, @Cast("hsize_t*") long... size)
-
H5Fget_eoa
@Cast("herr_t") public static int H5Fget_eoa(@Cast("hid_t") long file_id, @Cast("haddr_t*") LongPointer eoa)
\ingroup H5F \brief Retrieves the file's end-of-allocation (EOA) \file_id- Parameters:
eoa- [out] The file's EOA- Returns:
- \herr_t \details H5Fget_eoa() retrieves the file's EOA and returns it in the parameter eoa.
- Since:
- 1.10.2
-
H5Fget_eoa
@Cast("herr_t") public static int H5Fget_eoa(@Cast("hid_t") long file_id, @Cast("haddr_t*") LongBuffer eoa)
-
H5Fget_eoa
@Cast("herr_t") public static int H5Fget_eoa(@Cast("hid_t") long file_id, @Cast("haddr_t*") long... eoa)
-
H5Fincrement_filesize
@Cast("herr_t") public static int H5Fincrement_filesize(@Cast("hid_t") long file_id, @Cast("hsize_t") long increment)
\ingroup H5F \brief Sets the file' EOA to the maximum of (EOA, EOF) + increment \file_id- Parameters:
increment- [in] The number of bytes to be added to the maximum of (EOA, EOF)- Returns:
- \herr_t \details H5Fincrement_filesize() sets the file's EOA to the maximum of (EOA, EOF) + \p increment. The EOA is the end-of-file address stored in the file's superblock while EOF is the file's actual end-of-file.
- Since:
- 1.10.2
-
H5Fget_file_image
@Cast("ssize_t") public static long H5Fget_file_image(@Cast("hid_t") long file_id, Pointer buf_ptr, @Cast("size_t") long buf_len)
\ingroup H5F \brief Retrieves a copy of the image of an existing, open file \file_id- Parameters:
buf_ptr- [out] Pointer to the buffer into which the image of the HDF5 file is to be copied. If \p buf_ptr is NULL, no data will be copied but the functionâs return value will still indicate the buffer size required (or a negative value on error).buf_len- [out] Size of the supplied buffer- Returns:
- ssize_t \details H5Fget_file_image() retrieves a copy of the image of an existing, open file. This routine can be used with files opened using the SEC2 (or POSIX), STDIO, and Core (or Memory) virtual file drivers (VFDs). If the return value of H5Fget_file_image() is a positive value, it will be the length in bytes of the buffer required to store the file image. So if the file size is unknown, it can be safely determined with an initial H5Fget_file_image() call with buf_ptr set to NULL. The file image can then be retrieved with a second H5Fget_file_image() call with \p buf_len set to the initial callâs return value. While the current file size can also be retrieved with H5Fget_filesize(), that call may produce a larger value than is needed. The value returned by H5Fget_filesize() includes the user block, if it exists, and any unallocated space at the end of the file. It is safe in all situations to get the file size with H5Fget_file_image() and it often produces a value that is more appropriate for the size of a file image buffer. \note \Bold{Recommended Reading:} This function is part of the file image operations feature set. It is highly recommended to study the guide \ref_file_image_ops before using this feature set. \attention H5Pget_file_image() will fail, returning a negative value, if the file is too large for the supplied buffer.
- Since:
- 1.8.0
-
H5Fget_mdc_config
@Cast("herr_t") public static int H5Fget_mdc_config(@Cast("hid_t") long file_id, H5AC_cache_config_t config_ptr)
\ingroup MDC \brief Obtains current metadata cache configuration for target file \file_id- Parameters:
config_ptr- [in,out] Pointer to the H5AC_cache_config_t instance in which the current metadata cache configuration is to be reported. The fields of this structure are discussed \ref H5AC-cache-config-t "here".- Returns:
- \herr_t \note The \c in direction applies only to the H5AC_cache_config_t::version field. All other fields are out parameters. \details H5Fget_mdc_config() loads the current metadata cache configuration into the instance of H5AC_cache_config_t pointed to by the \p config_ptr parameter.\n The fields of the H5AC_cache_config_t structure are shown below: \snippet H5ACpublic.h H5AC_cache_config_t_snip \click4more
- Since:
- 1.8.0
-
H5Fset_mdc_config
@Cast("herr_t") public static int H5Fset_mdc_config(@Cast("hid_t") long file_id, @Const H5AC_cache_config_t config_ptr)
\ingroup MDC \brief Attempts to configure metadata cache of target file \file_id- Parameters:
config_ptr- [in,out] Pointer to the H5AC_cache_config_t instance containing the desired configuration. The fields of this structure are discussed \ref H5AC-cache-config-t "here".- Returns:
- \herr_t \details H5Fset_mdc_config() attempts to configure the file's metadata cache according configuration supplied in \p config_ptr. \snippet H5ACpublic.h H5AC_cache_config_t_snip \click4more
- Since:
- 1.8.0
-
H5Fget_mdc_hit_rate
@Cast("herr_t") public static int H5Fget_mdc_hit_rate(@Cast("hid_t") long file_id, DoublePointer hit_rate_ptr)
\ingroup MDC \brief Obtains target file's metadata cache hit rate \file_id- Parameters:
hit_rate_ptr- [out] Pointer to the double in which the hit rate is returned. Note that \p hit_rate_ptr is undefined if the API call fails- Returns:
- \herr_t \details H5Fget_mdc_hit_rate() queries the metadata cache of the target file to obtain its hit rate \Code{(cache hits / (cache hits + cache misses))} since the last time hit rate statistics were reset. If the cache has not been accessed since the last time the hit rate stats were reset, the hit rate is defined to be 0.0. The hit rate stats can be reset either manually (via H5Freset_mdc_hit_rate_stats()), or automatically. If the cache's adaptive resize code is enabled, the hit rate stats will be reset once per epoch. If they are reset manually as well, the cache may behave oddly. See the overview of the metadata cache in the special topics section of the user manual for details on the metadata cache and its adaptive resize algorithms.
-
H5Fget_mdc_hit_rate
@Cast("herr_t") public static int H5Fget_mdc_hit_rate(@Cast("hid_t") long file_id, DoubleBuffer hit_rate_ptr)
-
H5Fget_mdc_hit_rate
@Cast("herr_t") public static int H5Fget_mdc_hit_rate(@Cast("hid_t") long file_id, double[] hit_rate_ptr)
-
H5Fget_mdc_size
@Cast("herr_t") public static int H5Fget_mdc_size(@Cast("hid_t") long file_id, @Cast("size_t*") SizeTPointer max_size_ptr, @Cast("size_t*") SizeTPointer min_clean_size_ptr, @Cast("size_t*") SizeTPointer cur_size_ptr, IntPointer cur_num_entries_ptr)
\ingroup MDC \brief Obtains current metadata cache size data for specified file \file_id- Parameters:
max_size_ptr- [out] Pointer to the location in which the current cache maximum size is to be returned, or NULL if this datum is not desiredmin_clean_size_ptr- [out] Pointer to the location in which the current cache minimum clean size is to be returned, or NULL if that datum is not desiredcur_size_ptr- [out] Pointer to the location in which the current cache size is to be returned, or NULL if that datum is not desiredcur_num_entries_ptr- [out] Pointer to the location in which the current number of entries in the cache is to be returned, or NULL if that datum is not desired- Returns:
- \herr_t \details H5Fget_mdc_size() queries the metadata cache of the target file for the desired size information, and returns this information in the locations indicated by the pointer parameters. If any pointer parameter is NULL, the associated data is not returned. If the API call fails, the values returned via the pointer parameters are undefined. If adaptive cache resizing is enabled, the cache maximum size and minimum clean size may change at the end of each epoch. Current size and current number of entries can change on each cache access. Current size can exceed maximum size under certain conditions. See the overview of the metadata cache in the special topics section of the user manual for a discussion of this.
-
H5Fget_mdc_size
@Cast("herr_t") public static int H5Fget_mdc_size(@Cast("hid_t") long file_id, @Cast("size_t*") SizeTPointer max_size_ptr, @Cast("size_t*") SizeTPointer min_clean_size_ptr, @Cast("size_t*") SizeTPointer cur_size_ptr, IntBuffer cur_num_entries_ptr)
-
H5Fget_mdc_size
@Cast("herr_t") public static int H5Fget_mdc_size(@Cast("hid_t") long file_id, @Cast("size_t*") SizeTPointer max_size_ptr, @Cast("size_t*") SizeTPointer min_clean_size_ptr, @Cast("size_t*") SizeTPointer cur_size_ptr, int[] cur_num_entries_ptr)
-
H5Freset_mdc_hit_rate_stats
@Cast("herr_t") public static int H5Freset_mdc_hit_rate_stats(@Cast("hid_t") long file_id)
\ingroup MDC \brief Resets hit rate statistics counters for the target file \file_id- Returns:
- \herr_t \details \parblock H5Freset_mdc_hit_rate_stats() resets the hit rate statistics counters in the metadata cache associated with the specified file. If the adaptive cache resizing code is enabled, the hit rate statistics are reset at the beginning of each epoch. This API call allows you to do the same thing from your program. The adaptive cache resizing code may behave oddly if you use this call when adaptive cache resizing is enabled. However, the call should be useful if you choose to control metadata cache size from your program. See \ref_mdc_in_hdf5 for details about the metadata cache and the adaptive cache resizing algorithms. If you have not read, understood, and thought about the material covered in that documentation, you should not be using this API call. \endparblock
-
H5Fget_name
@Cast("ssize_t") public static long H5Fget_name(@Cast("hid_t") long obj_id, @Cast("char*") BytePointer name, @Cast("size_t") long size)
\ingroup H5F \brief Retrieves name of file to which object belongs \obj_id- Parameters:
name- [out] Buffer for the file namesize- [in] Size, in bytes, of the \p name buffer- Returns:
- Returns the length of the file name if successful; otherwise returns a negative value. \details H5Fget_name() retrieves the name of the file to which the object \p obj_id belongs. The object can be a file, group, dataset, attribute, or named datatype. Up to \p size characters of the file name are returned in \p name; additional characters, if any, are not returned to the user application. If the length of the name, which determines the required value of size, is unknown, a preliminary H5Fget_name() call can be made by setting \p name to NULL. The return value of this call will be the size of the file name; that value plus one (1) can then be assigned to size for a second H5Fget_name() call, which will retrieve the actual name. (The value passed in with the parameter \p size must be one greater than size in bytes of the actual name in order to accommodate the null terminator; if \p size is set to the exact size of the name, the last byte passed back will contain the null terminator and the last character will be missing from the name passed back to the calling application.) If an error occurs, the buffer pointed to by \p name is unchanged and the function returns a negative value.
- Since:
- 1.6.3
-
H5Fget_name
@Cast("ssize_t") public static long H5Fget_name(@Cast("hid_t") long obj_id, @Cast("char*") ByteBuffer name, @Cast("size_t") long size)
-
H5Fget_name
@Cast("ssize_t") public static long H5Fget_name(@Cast("hid_t") long obj_id, @Cast("char*") byte[] name, @Cast("size_t") long size)
-
H5Fget_info2
@Cast("herr_t") public static int H5Fget_info2(@Cast("hid_t") long obj_id, H5F_info2_t file_info)
\ingroup H5F \brief Retrieves name of file to which object belongs \fgdta_obj_id- Parameters:
file_info- [out] Buffer for global file information- Returns:
- \herr_t \details H5Fget_info2() returns global information for the file associated with the object identifier \p obj_id in the H5F_info2_t \c struct named \p file_info. \p obj_id is an identifier for any object in the file of interest. H5F_info2_t struct is defined in H5Fpublic.h as follows: \snippet this H5F_info2_t_snip The \c super sub-struct contains the following information: \li \c vers is the version number of the superblock. \li \c super_size is the size of the superblock. \li \c super_ext_size is the size of the superblock extension. The \c free sub-struct contains the following information: \li vers is the version number of the free-space manager. \li \c hdr_size is the size of the free-space manager header. \li \c tot_space is the total amount of free space in the file. The \c sohm sub-struct contains shared object header message information as follows: \li \c vers is the version number of the shared object header information. \li \c hdr_size is the size of the shared object header message. \li \c msgs_info is an H5_ih_info_t struct defined in H5public.h as follows: \snippet H5public.h H5_ih_info_t_snip \li \p index_size is the summed size of all the shared object header indexes. Each index might be either a B-tree or a list. \li \p heap_size is the size of the heap.
- Since:
- 1.10.0
-
H5Fget_metadata_read_retry_info
@Cast("herr_t") public static int H5Fget_metadata_read_retry_info(@Cast("hid_t") long file_id, H5F_retry_info_t info)
\ingroup SWMR \brief Retrieves the collection of read retries for metadata entries with checksum \file_id- Parameters:
info- [out] Struct containing the collection of read retries for metadata entries with checksum- Returns:
- \herr_t\n
\details \Bold{Failure Modes:}
\li When the input identifier is not a file identifier.
\li When the pointer to the output structure is NULL.
\li When the memory allocation for \p retries failed.
\details H5Fget_metadata_read_retry_info() retrieves information regarding the number
of read retries for metadata entries with checksum for the file \p file_id.
This information is reported in the H5F_retry_info_t struct defined in
H5Fpublic.h as follows:
\snippet this H5F_retry_info_t_snip
\c nbins is the number of bins for each \c retries[i] of metadata entry \c i.
It is calculated based on the current number of read attempts used in the
library and logarithmic base 10.
If read retries are incurred for a metadata entry \c i, the library will
allocate memory for \Code{retries[i] (nbins * sizeof(uint32_t)} and store
the collection of retries there. If there are no retries for a metadata entry
\c i, \Code{retries[i]} will be NULL. After a call to this routine, users should
free each \Code{retries[i]} that is non-NULL, otherwise resource leak will occur.
For the library default read attempts of 100 for SWMR access, nbins will be 2
as depicted below:
\li \Code{retries[i][0]} is the number of 1 to 9 read retries.
\li \Code{retries[i][1]} is the number of 10 to 99 read retries.
For the library default read attempts of 1 for non-SWMR access, \c nbins will
be 0 and each \Code{retries[i]} will be NULL.
The following table lists the 21 metadata entries of \Code{retries[]}:
\note On a system that is not atomic, the library might possibly read inconsistent metadata with checksum when performing single-writer/multiple-reader (SWMR) operations for an HDF5 file. Upon encountering such situations, the library will try reading the metadata again for a set number of times to attempt to obtain consistent data. The maximum number of read attempts used by the library will be either the value set via H5Pset_metadata_read_attempts() or the library default value when a value is not set.\n When the current number of metadata read attempts used in the library is unable to remedy the reading of inconsistent metadata on a system, the user can assess the information obtained via this routine to derive a different maximum value. The information can also be helpful for debugging purposes to identify potential issues with metadata flush dependencies and SWMR implementation in general.Index for \Code{retries[]} Metadata entries* 0 Object header (version 2) 1 Object header chunk (version 2) 2 B-tree header (version 2) 3 B-tree internal node (version 2) 4 B-tree leaf node (version 2) 5 Fractal heap header 6 Fractal heap direct block (optional checksum) 7 Fractal heap indirect block 8 Free-space header 9 Free-space sections 10 Shared object header message table 11 Shared message record list 12 Extensive array header 13 Extensive array index block 14 Extensive array super block 15 Extensive array data block 16 Extensive array data block page 17 Fixed array super block 18 Fixed array data block 19 Fixed array data block page 20 File's superblock (version 2) * All entries are of version 0 (zero) unless indicated otherwise. - Since:
- 1.10.0
-
H5Fstart_swmr_write
@Cast("herr_t") public static int H5Fstart_swmr_write(@Cast("hid_t") long file_id)
\ingroup SWMR \brief Retrieves free-space section information for a file \file_id- Returns:
- \herr_t \details H5Fstart_swmr_write() will activate SWMR writing mode for a file associated with \p file_id. This routine will prepare and ensure the file is safe for SWMR writing as follows: \li Check that the file is opened with write access (#H5F_ACC_RDWR). \li Check that the file is opened with the latest library format to ensure data structures with check-summed metadata are used. \li Check that the file is not already marked in SWMR writing mode. \li Enable reading retries for check-summed metadata to remedy possible checksum failures from reading inconsistent metadata on a system that is not atomic. \li Turn off usage of the library's accumulator to avoid possible ordering problem on a system that is not atomic. \li Perform a flush of the fileâs data buffers and metadata to set a consistent state for starting SWMR write operations. Library objects are groups, datasets, and committed datatypes. For the current implementation, groups and datasets can remain open when activating SWMR writing mode, but not committed datatypes. Attributes attached to objects cannot remain open either.
- Since:
- 1.10.0
-
H5Fget_free_sections
@Cast("ssize_t") public static long H5Fget_free_sections(@Cast("hid_t") long file_id, @Cast("H5F_mem_t") int type, @Cast("size_t") long nsects, H5F_sect_info_t sect_info)
\ingroup H5F \brief Retrieves free-space section information for a file \file_id- Parameters:
type- [in] The file memory allocation typensects- [in] The number of free-space sectionssect_info- [out] Array of instances of H5F_sect_info_t in which the free-space section information is to be returned- Returns:
- Returns the number of free-space sections for the specified free-space manager in the file; otherwise returns a negative value. \details H5Fget_free_sections() retrieves free-space section information for the free-space manager with type that is associated with file \p file_id. If type is #H5FD_MEM_DEFAULT, this routine retrieves free-space section information for all the free-space managers in the file. Valid values for \p type are the following: \mem_types H5F_sect_info_t is defined as follows (in H5Fpublic.h): \snippet this H5F_sect_info_t_snip This routine retrieves free-space section information for \p nsects sections or at most the maximum number of sections in the specified free-space manager. If the number of sections is not known, a preliminary H5Fget_free_sections() call can be made by setting \p sect_info to NULL and the total number of free-space sections for the specified free-space manager will be returned. Users can then allocate space for entries in \p sect_info, each of which is defined as an H5F_sect_info_t \c struct. \attention \Bold{Failure Modes:} This routine will fail when the following is true: \li The library fails to retrieve the file creation property list associated with \p file_id. \li If the parameter \p sect_info is non-null, but the parameter \p nsects is equal to 0. \li The library fails to retrieve free-space section information for the file.
- Since:
- 1.10.0
-
H5Fclear_elink_file_cache
@Cast("herr_t") public static int H5Fclear_elink_file_cache(@Cast("hid_t") long file_id)
\ingroup H5F \brief Clears the external link open file cache \file_id- Returns:
- \herr_t \details H5Fclear_elink_file_cache() evicts all the cached child files in the specified fileâs external file cache, causing them to be closed if there is nothing else holding them open. H5Fclear_elink_file_cache() does not close the cache itself; subsequent external link traversals from the parent file will again cache the target file. See H5Pset_elink_file_cache_size() for information on closing the file cache.
- Since:
- 1.8.7
-
H5Fset_libver_bounds
@Cast("herr_t") public static int H5Fset_libver_bounds(@Cast("hid_t") long file_id, @Cast("H5F_libver_t") int low, @Cast("H5F_libver_t") int high)
\ingroup H5F \brief Enables the switch of version bounds setting for a file \file_id- Parameters:
low- [in] The earliest version of the library that will be used for writing objectshigh- [in] The latest version of the library that will be used for writing objects- Returns:
- \herr_t \details H5Fset_libver_bounds() enables the switch of version bounds setting for an open file associated with \p file_id. For the parameters \p low and \p high, see the description for H5Pset_libver_bounds(). \par Example \snippet H5F_examples.c libver_bounds
- Since:
- 1.10.2
-
H5Fstart_mdc_logging
@Cast("herr_t") public static int H5Fstart_mdc_logging(@Cast("hid_t") long file_id)
\ingroup MDC \brief Starts logging metadata cache events if logging was previously enabled \file_id- Returns:
- \herr_t \details The metadata cache is a central part of the HDF5 library through which all \Emph{file metadata} reads and writes take place. File metadata is normally invisible to the user and is used by the library for purposes such as locating and indexing data. File metadata should not be confused with user metadata, which consists of attributes created by users and attached to HDF5 objects such as datasets via H5A API calls. Due to the complexity of the cache, a trace/logging feature has been created that can be used by HDF5 developers for debugging and performance analysis. The functions that control this functionality will normally be of use to a very limited number of developers outside of The HDF Group. The functions have been documented to help users create logs that can be sent with bug reports. Control of the log functionality is straightforward. Logging is enabled via the H5Pset_mdc_log_options() function, which will modify the file access property list used to open or create a file. This function has a flag that determines whether logging begins at file open or starts in a paused state. Log messages can then be controlled via the H5Fstart_mdc_logging() and H5Fstop_mdc_logging() functions. H5Pget_mdc_log_options() can be used to examine a file access property list, and H5Fget_mdc_logging_status() will return the current state of the logging flags. The log format is described in the \ref_mdc_logging document. \note Logging can only be started or stopped if metadata cache logging was enabled via H5Pset_mdc_log_options().\n When enabled and currently logging, the overhead of the logging feature will almost certainly be significant.\n The log file is opened when the HDF5 file is opened or created and not when this function is called for the first time.\n This function opens the log file and starts logging metadata cache operations for a particular file. Calling this function when logging has already been enabled will be considered an error.
- Since:
- 1.10.0
-
H5Fstop_mdc_logging
@Cast("herr_t") public static int H5Fstop_mdc_logging(@Cast("hid_t") long file_id)
\ingroup MDC \brief Stops logging metadata cache events if logging was previously enabled and is currently ongoing \file_id- Returns:
- \herr_t \details The metadata cache is a central part of the HDF5 library through which all \Emph{file metadata} reads and writes take place. File metadata is normally invisible to the user and is used by the library for purposes such as locating and indexing data. File metadata should not be confused with user metadata, which consists of attributes created by users and attached to HDF5 objects such as datasets via H5A API calls. Due to the complexity of the cache, a trace/logging feature has been created that can be used by HDF5 developers for debugging and performance analysis. The functions that control this functionality will normally be of use to a very limited number of developers outside of The HDF Group. The functions have been documented to help users create logs that can be sent with bug reports. Control of the log functionality is straightforward. Logging is enabled via the H5Pset_mdc_log_options() function, which will modify the file access property list used to open or create a file. This function has a flag that determines whether logging begins at file open or starts in a paused state. Log messages can then be controlled via the H5Fstart_mdc_logging() and H5Fstop_mdc_logging() functions. H5Pget_mdc_log_options() can be used to examine a file access property list, and H5Fget_mdc_logging_status() will return the current state of the logging flags. The log format is described in the \ref_mdc_logging document. \note Logging can only be started or stopped if metadata cache logging was enabled via H5Pset_mdc_log_options().\n This function only suspends the logging operations. The log file will remain open and will not be closed until the HDF5 file is closed.
- Since:
- 1.10.0
-
H5Fget_mdc_logging_status
@Cast("herr_t") public static int H5Fget_mdc_logging_status(@Cast("hid_t") long file_id, @Cast("hbool_t*") BoolPointer is_enabled, @Cast("hbool_t*") BoolPointer is_currently_logging)
\ingroup MDC \brief Gets the current metadata cache logging status \file_id- Parameters:
is_enabled- [out] Whether logging is enabledis_currently_logging- [out] Whether events are currently being logged- Returns:
- \herr_t \details The metadata cache is a central part of the HDF5 library through which all \Emph{file metadata} reads and writes take place. File metadata is normally invisible to the user and is used by the library for purposes such as locating and indexing data. File metadata should not be confused with user metadata, which consists of attributes created by users and attached to HDF5 objects such as datasets via H5A API calls. Due to the complexity of the cache, a trace/logging feature has been created that can be used by HDF5 developers for debugging and performance analysis. The functions that control this functionality will normally be of use to a very limited number of developers outside of The HDF Group. The functions have been documented to help users create logs that can be sent with bug reports. Control of the log functionality is straightforward. Logging is enabled via the H5Pset_mdc_log_options() function, which will modify the file access property list used to open or create a file. This function has a flag that determines whether logging begins at file open or starts in a paused state. Log messages can then be controlled via the H5Fstart_mdc_logging() and H5Fstop_mdc_logging() functions. H5Pget_mdc_log_options() can be used to examine a file access property list, and H5Fget_mdc_logging_status() will return the current state of the logging flags. The log format is described in the \ref_mdc_logging document. \note Unlike H5Fstart_mdc_logging() and H5Fstop_mdc_logging(), this function can be called on any open file identifier.
- Since:
- 1.10.0
-
H5Fget_mdc_logging_status
@Cast("herr_t") public static int H5Fget_mdc_logging_status(@Cast("hid_t") long file_id, @Cast("hbool_t*") boolean[] is_enabled, @Cast("hbool_t*") boolean[] is_currently_logging)
-
H5Freset_page_buffering_stats
@Cast("herr_t") public static int H5Freset_page_buffering_stats(@Cast("hid_t") long file_id)
\ingroup H5F \brief Resets the page buffer statistics \file_id- Returns:
- \herr_t \details H5Freset_page_buffering_stats() resets the page buffer statistics for a specified file identifier \p file_id.
- Since:
- 1.10.1
-
H5Fget_page_buffering_stats
@Cast("herr_t") public static int H5Fget_page_buffering_stats(@Cast("hid_t") long file_id, @Cast("unsigned*") IntPointer accesses, @Cast("unsigned*") IntPointer hits, @Cast("unsigned*") IntPointer misses, @Cast("unsigned*") IntPointer evictions, @Cast("unsigned*") IntPointer bypasses)
\ingroup H5F \brief Retrieves statistics about page access when it is enabled \file_id- Parameters:
accesses- [out] Two integer array for the number of metadata and raw data accesses to the page bufferhits- [out] Two integer array for the number of metadata and raw data hits in the page buffermisses- [out] Two integer array for the number of metadata and raw data misses in the page bufferevictions- [out] Two integer array for the number of metadata and raw data evictions from the page bufferbypasses- [out] Two integer array for the number of metadata and raw data accesses that bypass the page buffer- Returns:
- \herr_t \details H5Fget_page_buffering_stats() retrieves page buffering statistics such as the number of metadata and raw data accesses (\p accesses), hits (\p hits), misses (\p misses), evictions (\p evictions), and accesses that bypass the page buffer (\p bypasses).
- Since:
- 1.10.1
-
H5Fget_page_buffering_stats
@Cast("herr_t") public static int H5Fget_page_buffering_stats(@Cast("hid_t") long file_id, @Cast("unsigned*") IntBuffer accesses, @Cast("unsigned*") IntBuffer hits, @Cast("unsigned*") IntBuffer misses, @Cast("unsigned*") IntBuffer evictions, @Cast("unsigned*") IntBuffer bypasses)
-
H5Fget_page_buffering_stats
@Cast("herr_t") public static int H5Fget_page_buffering_stats(@Cast("hid_t") long file_id, @Cast("unsigned*") int[] accesses, @Cast("unsigned*") int[] hits, @Cast("unsigned*") int[] misses, @Cast("unsigned*") int[] evictions, @Cast("unsigned*") int[] bypasses)
-
H5Fget_mdc_image_info
@Cast("herr_t") public static int H5Fget_mdc_image_info(@Cast("hid_t") long file_id, @Cast("haddr_t*") LongPointer image_addr, @Cast("hsize_t*") LongPointer image_size)
\ingroup MDC \brief Obtains information about a cache image if it exists \file_id- Parameters:
image_addr- [out] Offset of the cache image if it exists, or #HADDR_UNDEF if it does notimage_size- [out] Length of the cache image if it exists, or 0 if it does not- Returns:
- \herr_t \details \parblock H5Fget_mdc_image_info() returns information about a cache image if it exists. When an HDF5 file is opened in Read/Write mode, any metadata cache image will be read and deleted from the file on the first metadata cache access (or, if persistent free space managers are enabled, on the first file space allocation / deallocation, or read of free space manager status, whichever comes first). Thus, if the file is opened Read/Write, H5Fget_mdc_image_info() should be called immediately after file open and before any other operation. If H5Fget_mdc_image_info() is called after the cache image is loaded, it will correctly report that no cache image exists, as the image will have already been read and deleted from the file. In the Read Only case, the function may be called at any time, as any cache image will not be deleted from the file. \endparblock
- Since:
- 1.10.1
-
H5Fget_mdc_image_info
@Cast("herr_t") public static int H5Fget_mdc_image_info(@Cast("hid_t") long file_id, @Cast("haddr_t*") LongBuffer image_addr, @Cast("hsize_t*") LongBuffer image_size)
-
H5Fget_mdc_image_info
@Cast("herr_t") public static int H5Fget_mdc_image_info(@Cast("hid_t") long file_id, @Cast("haddr_t*") long[] image_addr, @Cast("hsize_t*") long... image_size)
-
H5Fget_dset_no_attrs_hint
@Cast("herr_t") public static int H5Fget_dset_no_attrs_hint(@Cast("hid_t") long file_id, @Cast("hbool_t*") BoolPointer minimize)
\ingroup H5F \brief Retrieves the setting for whether or not a file will create minimized dataset object headers \file_id- Parameters:
minimize- [out] Flag indicating whether the library will or will not create minimized dataset object headers- Returns:
- \herr_t \details H5Fget_dset_no_attrs_hint() retrieves the no dataset attributes hint setting for the file specified by the file identifier \p file_id. This setting is used to inform the library to create minimized dataset object headers when \c TRUE. The setting's value is returned in the boolean pointer minimize.
- Since:
- 1.10.5
-
H5Fget_dset_no_attrs_hint
@Cast("herr_t") public static int H5Fget_dset_no_attrs_hint(@Cast("hid_t") long file_id, @Cast("hbool_t*") boolean[] minimize)
-
H5Fset_dset_no_attrs_hint
@Cast("herr_t") public static int H5Fset_dset_no_attrs_hint(@Cast("hid_t") long file_id, @Cast("hbool_t") boolean minimize)
\ingroup H5F \brief Sets the flag to create minimized dataset object headers \file_id- Parameters:
minimize- [in] Flag indicating whether the library will or will not create minimized dataset object headers- Returns:
- \herr_t \details H5Fset_dset_no_attrs_hint() sets the no dataset attributes hint setting for the file specified by the file identifier \p file_id. If the boolean flag \p minimize is set to \c TRUE, then the library will create minimized dataset object headers in the file. \Bold{All} files that refer to the same file-on-disk will be affected by the most recent setting, regardless of the file identifier/handle (e.g., as returned by H5Fopen()). By setting the \p minimize flag to \c TRUE, the library expects that no attributes will be added to the dataset - attributes can be added, but they are appended with a continuation message, which can reduce performance. \attention This setting interacts with H5Pset_dset_no_attrs_hint(): if either is set to \c TRUE, then the created dataset's object header will be minimized.
- Since:
- 1.10.5
-
H5Fformat_convert
@Cast("herr_t") public static int H5Fformat_convert(@Cast("hid_t") long fid)
\cond DEV
-
H5_VFD_INVALID
@MemberGetter public static int H5_VFD_INVALID()
-
H5_VFD_SEC2
@MemberGetter public static int H5_VFD_SEC2()
-
H5_VFD_CORE
@MemberGetter public static int H5_VFD_CORE()
-
H5_VFD_LOG
@MemberGetter public static int H5_VFD_LOG()
-
H5_VFD_FAMILY
@MemberGetter public static int H5_VFD_FAMILY()
-
H5_VFD_MULTI
@MemberGetter public static int H5_VFD_MULTI()
-
H5_VFD_STDIO
@MemberGetter public static int H5_VFD_STDIO()
-
H5_VFD_SPLITTER
@MemberGetter public static int H5_VFD_SPLITTER()
-
H5_VFD_MPIO
@MemberGetter public static int H5_VFD_MPIO()
-
H5_VFD_DIRECT
@MemberGetter public static int H5_VFD_DIRECT()
-
H5_VFD_MIRROR
@MemberGetter public static int H5_VFD_MIRROR()
-
H5_VFD_HDFS
@MemberGetter public static int H5_VFD_HDFS()
-
H5_VFD_ROS3
@MemberGetter public static int H5_VFD_ROS3()
-
H5_VFD_SUBFILING
@MemberGetter public static int H5_VFD_SUBFILING()
-
H5_VFD_IOC
@MemberGetter public static int H5_VFD_IOC()
-
H5_VFD_ONION
@MemberGetter public static int H5_VFD_ONION()
-
H5FDdriver_query
@Cast("herr_t") public static int H5FDdriver_query(@Cast("hid_t") long driver_id, @Cast("unsigned long*") CLongPointer flags)
\ingroup H5FD \brief Allows querying a VFD ID for features before the file is opened- Parameters:
driver_id- [in] Virtual File Driver (VFD) IDflags- [out] VFD flags supported- Returns:
- \herr_t \details Queries a virtual file driver (VFD) for feature flags. Takes a VFD hid_t so it can be used before the file is opened. For example, this could be used to check if a VFD supports SWMR. \note The flags obtained here are just those of the base driver and do not take any configuration options (e.g., set via a fapl call) into consideration.
- Since:
- 1.10.2
-
H5Gcreate2
@Cast("hid_t") public static long H5Gcreate2(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer name, @Cast("hid_t") long lcpl_id, @Cast("hid_t") long gcpl_id, @Cast("hid_t") long gapl_id)
------------------------------------------------------------------------- \ingroup H5G \brief Creates a new group and links it into the file \fgdta_loc_id- Parameters:
name- [in] Name of the group to create \lcpl_id \gcpl_id \gapl_id- Returns:
- \hid_t{group} \details H5Gcreate2() creates a new group in a file. After a group has been created, links to datasets and to other groups can be added. The \p loc_id and \p name parameters specify where the group is located. \p loc_id may be a file, group, dataset, named datatype or attribute in the file. If an attribute, dataset, or named datatype is specified for \p loc_id then the group will be created at the location where the attribute, dataset, or named datatype is attached. \p name is the link to the group; \p name may be either an absolute path in the file (the links from the root group to the new group) or a relative path from \p loc_id (the link(s) from the group specified by \p loc_id to the new group). \p lcpl_id, \p gcpl_id, and \p gapl_id are property list identifiers. These property lists govern how the link to the group is created, how the group is created, and how the group can be accessed in the future, respectively. #H5P_DEFAULT can be passed in if the default properties are appropriate for these property lists. Currently, there are no APIs for the group access property list; use #H5P_DEFAULT. The group identifier should be closed by H5Gclose() when access is no longer required to prevent resource leaks.
- Since:
- 1.8.0
-
H5Gcreate2
@Cast("hid_t") public static long H5Gcreate2(@Cast("hid_t") long loc_id, String name, @Cast("hid_t") long lcpl_id, @Cast("hid_t") long gcpl_id, @Cast("hid_t") long gapl_id)
-
H5Gcreate_async
@Cast("hid_t") public static long H5Gcreate_async(@Cast("const char*") BytePointer app_file, @Cast("const char*") BytePointer app_func, @Cast("unsigned") int app_line, @Cast("hid_t") long loc_id, @Cast("const char*") BytePointer name, @Cast("hid_t") long lcpl_id, @Cast("hid_t") long gcpl_id, @Cast("hid_t") long gapl_id, @Cast("hid_t") long es_id)
-------------------------------------------------------------------------- \ingroup ASYNC \async_variant_of{H5Gcreate}
-
H5Gcreate_async
@Cast("hid_t") public static long H5Gcreate_async(String app_file, String app_func, @Cast("unsigned") int app_line, @Cast("hid_t") long loc_id, String name, @Cast("hid_t") long lcpl_id, @Cast("hid_t") long gcpl_id, @Cast("hid_t") long gapl_id, @Cast("hid_t") long es_id)
-
H5Gcreate_anon
@Cast("hid_t") public static long H5Gcreate_anon(@Cast("hid_t") long loc_id, @Cast("hid_t") long gcpl_id, @Cast("hid_t") long gapl_id)
------------------------------------------------------------------------- \ingroup H5G \brief Creates a new empty group without linking it into the file structure \fgdta_loc_id \gcpl_id \gapl_id- Returns:
- \hid_t{group} \details H5Gcreate_anon() creates a new empty group in the file specified by \p loc_id. With default settings, H5Gcreate_anon() provides similar functionality to that provided by H5Gcreate1(), with the differences described in the list below. The new groupâs creation and access properties are specified in \p gcpl_id and \p gapl_id, respectively. H5Gcreate_anon() returns a new group identifier. This identifier must be linked into the HDF5 file structure with H5Olink() or it will be deleted from the file when the file is closed. The differences between this function and H5Gcreate1() are as follows: \li H5Gcreate1() does not provide for the use of custom property lists; H5Gcreate1() always uses default properties. \li H5Gcreate_anon() neither provides the new groupâs name nor links it into the HDF5 file structure; those actions must be performed separately through a call to H5Olink(), which offers greater control over linking. \li H5Gcreate_anon() does not directly provide a hint mechanism for the groupâs heap size. Comparable information can be included in the group creation property list \p gcpl_id through a H5Pset_local_heap_size_hint() call. A group created with this function should be closed with H5Gclose() when the group is no longer needed so that resource leaks will not develop.
- Since:
- 1.8.0
-
H5Gopen2
@Cast("hid_t") public static long H5Gopen2(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer name, @Cast("hid_t") long gapl_id)
------------------------------------------------------------------------- \ingroup H5G \brief Opens an existing group in a file \fgdta_loc_id- Parameters:
name- [in] Name of the group to open \gapl_id- Returns:
- \hid_t{group} \details H5Gopen2() opens an existing group, \p name, at the location specified by \p loc_id. With default settings, H5Gopen2() provides similar functionality to that provided by H5Gopen(). The only difference is that H5Gopen2() can provide a group access property list, \p gapl_id. H5Gopen2() returns a group identifier for the group that was opened. This group identifier should be released by H5Gclose() when it is no longer needed to prevent resource leaks.
- Since:
- 1.8.0
-
H5Gopen2
@Cast("hid_t") public static long H5Gopen2(@Cast("hid_t") long loc_id, String name, @Cast("hid_t") long gapl_id)
-
H5Gopen_async
@Cast("hid_t") public static long H5Gopen_async(@Cast("const char*") BytePointer app_file, @Cast("const char*") BytePointer app_func, @Cast("unsigned") int app_line, @Cast("hid_t") long loc_id, @Cast("const char*") BytePointer name, @Cast("hid_t") long gapl_id, @Cast("hid_t") long es_id)
-------------------------------------------------------------------------- \ingroup ASYNC \async_variant_of{H5Gopen}
-
H5Gopen_async
@Cast("hid_t") public static long H5Gopen_async(String app_file, String app_func, @Cast("unsigned") int app_line, @Cast("hid_t") long loc_id, String name, @Cast("hid_t") long gapl_id, @Cast("hid_t") long es_id)
-
H5Gget_create_plist
@Cast("hid_t") public static long H5Gget_create_plist(@Cast("hid_t") long group_id)
------------------------------------------------------------------------- \ingroup H5G \brief Gets a group creation property list identifier \group_id- Returns:
- \hid_t{creation property list} \details H5Gget_create_plist() returns an identifier for the group creation property list associated with the group specified by \p group_id. The creation property list identifier should be released with H5Gclose() to prevent resource leaks.
- Since:
- 1.8.0
-
H5Gget_info
@Cast("herr_t") public static int H5Gget_info(@Cast("hid_t") long loc_id, H5G_info_t ginfo)
------------------------------------------------------------------------- \ingroup H5G \brief Retrieves information about a group \fgdta_loc_id- Parameters:
ginfo- [out] Struct in which group information is returned- Returns:
- \hid_t{group} \details H5Gget_info() retrieves information about the group at location specified by \p loc_id. The information is returned in the \p ginfo. \p ginfo is an H5G_info_t struct and is defined (in H5Gpublic.h) as follows: \snippet this H5G_info_t_snip Possible values of \p storage_type are: \storage_type
- Since:
- 1.8.0
-
H5Gget_info_async
@Cast("herr_t") public static int H5Gget_info_async(@Cast("const char*") BytePointer app_file, @Cast("const char*") BytePointer app_func, @Cast("unsigned") int app_line, @Cast("hid_t") long loc_id, H5G_info_t ginfo, @Cast("hid_t") long es_id)
-------------------------------------------------------------------------- \ingroup ASYNC \async_variant_of{H5Gget_info}
-
H5Gget_info_async
@Cast("herr_t") public static int H5Gget_info_async(String app_file, String app_func, @Cast("unsigned") int app_line, @Cast("hid_t") long loc_id, H5G_info_t ginfo, @Cast("hid_t") long es_id)
-
H5Gget_info_by_name
@Cast("herr_t") public static int H5Gget_info_by_name(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer name, H5G_info_t ginfo, @Cast("hid_t") long lapl_id)
------------------------------------------------------------------------- \ingroup H5G \brief Retrieves information about a group by its name \fgdta_loc_id- Parameters:
name- [in] Name of the group to queryginfo- [out] Struct in which group information is returned \lapl_id- Returns:
- \herr_t \details H5Gget_info_by_name() retrieves information about the group \p name at location specified by \p loc_id. The information is returned in the \p ginfo struct. If \p loc_id specifies the group for which information is queried, then the group's \p name can be a dot (.). \p ginfo is an H5G_info_t struct and is defined (in H5Gpublic.h) as follows: \snippet this H5G_info_t_snip Possible values of \p storage_type are: \storage_type
- Since:
- 1.8.0
-
H5Gget_info_by_name
@Cast("herr_t") public static int H5Gget_info_by_name(@Cast("hid_t") long loc_id, String name, H5G_info_t ginfo, @Cast("hid_t") long lapl_id)
-
H5Gget_info_by_name_async
@Cast("herr_t") public static int H5Gget_info_by_name_async(@Cast("const char*") BytePointer app_file, @Cast("const char*") BytePointer app_func, @Cast("unsigned") int app_line, @Cast("hid_t") long loc_id, @Cast("const char*") BytePointer name, H5G_info_t ginfo, @Cast("hid_t") long lapl_id, @Cast("hid_t") long es_id)
-------------------------------------------------------------------------- \ingroup ASYNC \async_variant_of{H5Gget_info_by_name}
-
H5Gget_info_by_name_async
@Cast("herr_t") public static int H5Gget_info_by_name_async(String app_file, String app_func, @Cast("unsigned") int app_line, @Cast("hid_t") long loc_id, String name, H5G_info_t ginfo, @Cast("hid_t") long lapl_id, @Cast("hid_t") long es_id)
-
H5Gget_info_by_idx
@Cast("herr_t") public static int H5Gget_info_by_idx(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer group_name, @Cast("H5_index_t") int idx_type, @Cast("H5_iter_order_t") int order, @Cast("hsize_t") long n, H5G_info_t ginfo, @Cast("hid_t") long lapl_id)
------------------------------------------------------------------------- \ingroup H5G \brief Retrieves information about a group, according to the groupâs position within an index \fgdta_loc_id- Parameters:
group_name- [in] Name of the group to queryidx_type- [in] Transient index identifying objectorder- [in] Transient index identifying objectn- [in] Position in the index of the group to queryginfo- [out] Struct in which group information is returned \lapl_id- Returns:
- Returns \li The size of the object name if successful, or \li 0 if no name is associated with the group identifier, or \li negative value, if failure occurred \details H5Gget_info_by_idx() retrieves the same information about a group as retrieved by the function H5Gget_info(), but the means of identifying the group differs; the group is identified by position in an index rather than by name. \p loc_id and \p group_name specify the group containing the group for which information is sought. The groups in \p group_name are indexed by \p idx_type; the group for which information is retrieved is identified in that index by index order, \p order, and index position, \p n. If \p loc_id specifies the group containing the group for which information is queried, \p group_name can be a dot (.). Valid values for \p index_type are as follows: \indexes The order in which the index is to be examined, as specified by \p order, can be one of the following: \orders
- Since:
- 1.8.0
-
H5Gget_info_by_idx
@Cast("herr_t") public static int H5Gget_info_by_idx(@Cast("hid_t") long loc_id, String group_name, @Cast("H5_index_t") int idx_type, @Cast("H5_iter_order_t") int order, @Cast("hsize_t") long n, H5G_info_t ginfo, @Cast("hid_t") long lapl_id)
-
H5Gget_info_by_idx_async
@Cast("herr_t") public static int H5Gget_info_by_idx_async(@Cast("const char*") BytePointer app_file, @Cast("const char*") BytePointer app_func, @Cast("unsigned") int app_line, @Cast("hid_t") long loc_id, @Cast("const char*") BytePointer group_name, @Cast("H5_index_t") int idx_type, @Cast("H5_iter_order_t") int order, @Cast("hsize_t") long n, H5G_info_t ginfo, @Cast("hid_t") long lapl_id, @Cast("hid_t") long es_id)
-------------------------------------------------------------------------- \ingroup ASYNC \async_variant_of{H5Gget_info_by_idx}
-
H5Gget_info_by_idx_async
@Cast("herr_t") public static int H5Gget_info_by_idx_async(String app_file, String app_func, @Cast("unsigned") int app_line, @Cast("hid_t") long loc_id, String group_name, @Cast("H5_index_t") int idx_type, @Cast("H5_iter_order_t") int order, @Cast("hsize_t") long n, H5G_info_t ginfo, @Cast("hid_t") long lapl_id, @Cast("hid_t") long es_id)
-
H5Gflush
@Cast("herr_t") public static int H5Gflush(@Cast("hid_t") long group_id)
------------------------------------------------------------------------- \ingroup H5G \brief Flushes all buffers associated with a group to disk \group_id- Returns:
- \herr_t \details H5Gflush() causes all buffers associated with a group to be immediately flushed to disk without removing the data from the cache. \attention HDF5 does not possess full control over buffering. H5G_FLUSH flushes the internal HDF5 buffers and then asks the operating system (the OS) to flush the system buffers for the open files. After that, the OS is responsible for ensuring that the data is actually flushed to disk.
- Since:
- 1.8.0
-
H5Grefresh
@Cast("herr_t") public static int H5Grefresh(@Cast("hid_t") long group_id)
------------------------------------------------------------------------- \ingroup H5G \brief Refreshes all buffers associated with a group \group_id- Returns:
- \herr_t \details H5Grefresh() causes all buffers associated with a group to be cleared and immediately re-loaded with updated contents from disk. This function essentially closes the group, evicts all metadata associated with it from the cache, and then re-opens the group. The reopened group is automatically re-registered with the same identifier.
- Since:
- 1.8.0
-
H5Gclose
@Cast("herr_t") public static int H5Gclose(@Cast("hid_t") long group_id)
------------------------------------------------------------------------- \ingroup H5G \brief Closes the specified group \group_id- Returns:
- \herr_t \details H5Gclose() releases resources used by a group which was opened by H5Gcreate() or H5Gopen(). After closing a group, \p group_id cannot be used again until another H5Gcreate() or H5Gopen() is called on it. Failure to release a group with this call will result in resource leaks. \par Example \snippet H5F_examples.c mount
- Since:
- 1.0.0
-
H5Gclose_async
@Cast("herr_t") public static int H5Gclose_async(@Cast("const char*") BytePointer app_file, @Cast("const char*") BytePointer app_func, @Cast("unsigned") int app_line, @Cast("hid_t") long group_id, @Cast("hid_t") long es_id)
-------------------------------------------------------------------------- \ingroup ASYNC \async_variant_of{H5Gclose}
-
H5Gclose_async
@Cast("herr_t") public static int H5Gclose_async(String app_file, String app_func, @Cast("unsigned") int app_line, @Cast("hid_t") long group_id, @Cast("hid_t") long es_id)
-
H5P_ROOT
@MemberGetter public static int H5P_ROOT()
-
H5P_OBJECT_CREATE
@MemberGetter public static int H5P_OBJECT_CREATE()
-
H5P_FILE_CREATE
@MemberGetter public static int H5P_FILE_CREATE()
-
H5P_FILE_ACCESS
@MemberGetter public static int H5P_FILE_ACCESS()
-
H5P_DATASET_CREATE
@MemberGetter public static int H5P_DATASET_CREATE()
-
H5P_DATASET_ACCESS
@MemberGetter public static int H5P_DATASET_ACCESS()
-
H5P_DATASET_XFER
@MemberGetter public static int H5P_DATASET_XFER()
-
H5P_FILE_MOUNT
@MemberGetter public static int H5P_FILE_MOUNT()
-
H5P_GROUP_CREATE
@MemberGetter public static int H5P_GROUP_CREATE()
-
H5P_GROUP_ACCESS
@MemberGetter public static int H5P_GROUP_ACCESS()
-
H5P_DATATYPE_CREATE
@MemberGetter public static int H5P_DATATYPE_CREATE()
-
H5P_DATATYPE_ACCESS
@MemberGetter public static int H5P_DATATYPE_ACCESS()
-
H5P_MAP_CREATE
@MemberGetter public static int H5P_MAP_CREATE()
-
H5P_MAP_ACCESS
@MemberGetter public static int H5P_MAP_ACCESS()
-
H5P_STRING_CREATE
@MemberGetter public static int H5P_STRING_CREATE()
-
H5P_ATTRIBUTE_CREATE
@MemberGetter public static int H5P_ATTRIBUTE_CREATE()
-
H5P_ATTRIBUTE_ACCESS
@MemberGetter public static int H5P_ATTRIBUTE_ACCESS()
-
H5P_OBJECT_COPY
@MemberGetter public static int H5P_OBJECT_COPY()
-
H5P_LINK_CREATE
@MemberGetter public static int H5P_LINK_CREATE()
-
H5P_LINK_ACCESS
@MemberGetter public static int H5P_LINK_ACCESS()
-
H5P_VOL_INITIALIZE
@MemberGetter public static int H5P_VOL_INITIALIZE()
-
H5P_REFERENCE_ACCESS
@MemberGetter public static int H5P_REFERENCE_ACCESS()
-
H5P_FILE_CREATE_DEFAULT
@MemberGetter public static int H5P_FILE_CREATE_DEFAULT()
-
H5P_FILE_ACCESS_DEFAULT
@MemberGetter public static int H5P_FILE_ACCESS_DEFAULT()
-
H5P_DATASET_CREATE_DEFAULT
@MemberGetter public static int H5P_DATASET_CREATE_DEFAULT()
-
H5P_DATASET_ACCESS_DEFAULT
@MemberGetter public static int H5P_DATASET_ACCESS_DEFAULT()
-
H5P_DATASET_XFER_DEFAULT
@MemberGetter public static int H5P_DATASET_XFER_DEFAULT()
-
H5P_FILE_MOUNT_DEFAULT
@MemberGetter public static int H5P_FILE_MOUNT_DEFAULT()
-
H5P_GROUP_CREATE_DEFAULT
@MemberGetter public static int H5P_GROUP_CREATE_DEFAULT()
-
H5P_GROUP_ACCESS_DEFAULT
@MemberGetter public static int H5P_GROUP_ACCESS_DEFAULT()
-
H5P_DATATYPE_CREATE_DEFAULT
@MemberGetter public static int H5P_DATATYPE_CREATE_DEFAULT()
-
H5P_DATATYPE_ACCESS_DEFAULT
@MemberGetter public static int H5P_DATATYPE_ACCESS_DEFAULT()
-
H5P_MAP_CREATE_DEFAULT
@MemberGetter public static int H5P_MAP_CREATE_DEFAULT()
-
H5P_MAP_ACCESS_DEFAULT
@MemberGetter public static int H5P_MAP_ACCESS_DEFAULT()
-
H5P_ATTRIBUTE_CREATE_DEFAULT
@MemberGetter public static int H5P_ATTRIBUTE_CREATE_DEFAULT()
-
H5P_ATTRIBUTE_ACCESS_DEFAULT
@MemberGetter public static int H5P_ATTRIBUTE_ACCESS_DEFAULT()
-
H5P_OBJECT_COPY_DEFAULT
@MemberGetter public static int H5P_OBJECT_COPY_DEFAULT()
-
H5P_LINK_CREATE_DEFAULT
@MemberGetter public static int H5P_LINK_CREATE_DEFAULT()
-
H5P_LINK_ACCESS_DEFAULT
@MemberGetter public static int H5P_LINK_ACCESS_DEFAULT()
-
H5P_VOL_INITIALIZE_DEFAULT
@MemberGetter public static int H5P_VOL_INITIALIZE_DEFAULT()
-
H5P_REFERENCE_ACCESS_DEFAULT
@MemberGetter public static int H5P_REFERENCE_ACCESS_DEFAULT()
-
H5P_DEFAULT
@MemberGetter public static int H5P_DEFAULT()
Default value of type \ref hid_t for all property list classes
-
H5P_CLS_ROOT_ID_g
@Cast("hid_t") public static long H5P_CLS_ROOT_ID_g()
-
H5P_CLS_ROOT_ID_g
public static void H5P_CLS_ROOT_ID_g(long setter)
-
H5P_CLS_OBJECT_CREATE_ID_g
@Cast("hid_t") public static long H5P_CLS_OBJECT_CREATE_ID_g()
-
H5P_CLS_OBJECT_CREATE_ID_g
public static void H5P_CLS_OBJECT_CREATE_ID_g(long setter)
-
H5P_CLS_FILE_CREATE_ID_g
@Cast("hid_t") public static long H5P_CLS_FILE_CREATE_ID_g()
-
H5P_CLS_FILE_CREATE_ID_g
public static void H5P_CLS_FILE_CREATE_ID_g(long setter)
-
H5P_CLS_FILE_ACCESS_ID_g
@Cast("hid_t") public static long H5P_CLS_FILE_ACCESS_ID_g()
-
H5P_CLS_FILE_ACCESS_ID_g
public static void H5P_CLS_FILE_ACCESS_ID_g(long setter)
-
H5P_CLS_DATASET_CREATE_ID_g
@Cast("hid_t") public static long H5P_CLS_DATASET_CREATE_ID_g()
-
H5P_CLS_DATASET_CREATE_ID_g
public static void H5P_CLS_DATASET_CREATE_ID_g(long setter)
-
H5P_CLS_DATASET_ACCESS_ID_g
@Cast("hid_t") public static long H5P_CLS_DATASET_ACCESS_ID_g()
-
H5P_CLS_DATASET_ACCESS_ID_g
public static void H5P_CLS_DATASET_ACCESS_ID_g(long setter)
-
H5P_CLS_DATASET_XFER_ID_g
@Cast("hid_t") public static long H5P_CLS_DATASET_XFER_ID_g()
-
H5P_CLS_DATASET_XFER_ID_g
public static void H5P_CLS_DATASET_XFER_ID_g(long setter)
-
H5P_CLS_FILE_MOUNT_ID_g
@Cast("hid_t") public static long H5P_CLS_FILE_MOUNT_ID_g()
-
H5P_CLS_FILE_MOUNT_ID_g
public static void H5P_CLS_FILE_MOUNT_ID_g(long setter)
-
H5P_CLS_GROUP_CREATE_ID_g
@Cast("hid_t") public static long H5P_CLS_GROUP_CREATE_ID_g()
-
H5P_CLS_GROUP_CREATE_ID_g
public static void H5P_CLS_GROUP_CREATE_ID_g(long setter)
-
H5P_CLS_GROUP_ACCESS_ID_g
@Cast("hid_t") public static long H5P_CLS_GROUP_ACCESS_ID_g()
-
H5P_CLS_GROUP_ACCESS_ID_g
public static void H5P_CLS_GROUP_ACCESS_ID_g(long setter)
-
H5P_CLS_DATATYPE_CREATE_ID_g
@Cast("hid_t") public static long H5P_CLS_DATATYPE_CREATE_ID_g()
-
H5P_CLS_DATATYPE_CREATE_ID_g
public static void H5P_CLS_DATATYPE_CREATE_ID_g(long setter)
-
H5P_CLS_DATATYPE_ACCESS_ID_g
@Cast("hid_t") public static long H5P_CLS_DATATYPE_ACCESS_ID_g()
-
H5P_CLS_DATATYPE_ACCESS_ID_g
public static void H5P_CLS_DATATYPE_ACCESS_ID_g(long setter)
-
H5P_CLS_MAP_CREATE_ID_g
@Cast("hid_t") public static long H5P_CLS_MAP_CREATE_ID_g()
-
H5P_CLS_MAP_CREATE_ID_g
public static void H5P_CLS_MAP_CREATE_ID_g(long setter)
-
H5P_CLS_MAP_ACCESS_ID_g
@Cast("hid_t") public static long H5P_CLS_MAP_ACCESS_ID_g()
-
H5P_CLS_MAP_ACCESS_ID_g
public static void H5P_CLS_MAP_ACCESS_ID_g(long setter)
-
H5P_CLS_STRING_CREATE_ID_g
@Cast("hid_t") public static long H5P_CLS_STRING_CREATE_ID_g()
-
H5P_CLS_STRING_CREATE_ID_g
public static void H5P_CLS_STRING_CREATE_ID_g(long setter)
-
H5P_CLS_ATTRIBUTE_CREATE_ID_g
@Cast("hid_t") public static long H5P_CLS_ATTRIBUTE_CREATE_ID_g()
-
H5P_CLS_ATTRIBUTE_CREATE_ID_g
public static void H5P_CLS_ATTRIBUTE_CREATE_ID_g(long setter)
-
H5P_CLS_ATTRIBUTE_ACCESS_ID_g
@Cast("hid_t") public static long H5P_CLS_ATTRIBUTE_ACCESS_ID_g()
-
H5P_CLS_ATTRIBUTE_ACCESS_ID_g
public static void H5P_CLS_ATTRIBUTE_ACCESS_ID_g(long setter)
-
H5P_CLS_OBJECT_COPY_ID_g
@Cast("hid_t") public static long H5P_CLS_OBJECT_COPY_ID_g()
-
H5P_CLS_OBJECT_COPY_ID_g
public static void H5P_CLS_OBJECT_COPY_ID_g(long setter)
-
H5P_CLS_LINK_CREATE_ID_g
@Cast("hid_t") public static long H5P_CLS_LINK_CREATE_ID_g()
-
H5P_CLS_LINK_CREATE_ID_g
public static void H5P_CLS_LINK_CREATE_ID_g(long setter)
-
H5P_CLS_LINK_ACCESS_ID_g
@Cast("hid_t") public static long H5P_CLS_LINK_ACCESS_ID_g()
-
H5P_CLS_LINK_ACCESS_ID_g
public static void H5P_CLS_LINK_ACCESS_ID_g(long setter)
-
H5P_CLS_VOL_INITIALIZE_ID_g
@Cast("hid_t") public static long H5P_CLS_VOL_INITIALIZE_ID_g()
-
H5P_CLS_VOL_INITIALIZE_ID_g
public static void H5P_CLS_VOL_INITIALIZE_ID_g(long setter)
-
H5P_CLS_REFERENCE_ACCESS_ID_g
@Cast("hid_t") public static long H5P_CLS_REFERENCE_ACCESS_ID_g()
-
H5P_CLS_REFERENCE_ACCESS_ID_g
public static void H5P_CLS_REFERENCE_ACCESS_ID_g(long setter)
-
H5P_LST_FILE_CREATE_ID_g
@Cast("hid_t") public static long H5P_LST_FILE_CREATE_ID_g()
-
H5P_LST_FILE_CREATE_ID_g
public static void H5P_LST_FILE_CREATE_ID_g(long setter)
-
H5P_LST_FILE_ACCESS_ID_g
@Cast("hid_t") public static long H5P_LST_FILE_ACCESS_ID_g()
-
H5P_LST_FILE_ACCESS_ID_g
public static void H5P_LST_FILE_ACCESS_ID_g(long setter)
-
H5P_LST_DATASET_CREATE_ID_g
@Cast("hid_t") public static long H5P_LST_DATASET_CREATE_ID_g()
-
H5P_LST_DATASET_CREATE_ID_g
public static void H5P_LST_DATASET_CREATE_ID_g(long setter)
-
H5P_LST_DATASET_ACCESS_ID_g
@Cast("hid_t") public static long H5P_LST_DATASET_ACCESS_ID_g()
-
H5P_LST_DATASET_ACCESS_ID_g
public static void H5P_LST_DATASET_ACCESS_ID_g(long setter)
-
H5P_LST_DATASET_XFER_ID_g
@Cast("hid_t") public static long H5P_LST_DATASET_XFER_ID_g()
-
H5P_LST_DATASET_XFER_ID_g
public static void H5P_LST_DATASET_XFER_ID_g(long setter)
-
H5P_LST_FILE_MOUNT_ID_g
@Cast("hid_t") public static long H5P_LST_FILE_MOUNT_ID_g()
-
H5P_LST_FILE_MOUNT_ID_g
public static void H5P_LST_FILE_MOUNT_ID_g(long setter)
-
H5P_LST_GROUP_CREATE_ID_g
@Cast("hid_t") public static long H5P_LST_GROUP_CREATE_ID_g()
-
H5P_LST_GROUP_CREATE_ID_g
public static void H5P_LST_GROUP_CREATE_ID_g(long setter)
-
H5P_LST_GROUP_ACCESS_ID_g
@Cast("hid_t") public static long H5P_LST_GROUP_ACCESS_ID_g()
-
H5P_LST_GROUP_ACCESS_ID_g
public static void H5P_LST_GROUP_ACCESS_ID_g(long setter)
-
H5P_LST_DATATYPE_CREATE_ID_g
@Cast("hid_t") public static long H5P_LST_DATATYPE_CREATE_ID_g()
-
H5P_LST_DATATYPE_CREATE_ID_g
public static void H5P_LST_DATATYPE_CREATE_ID_g(long setter)
-
H5P_LST_DATATYPE_ACCESS_ID_g
@Cast("hid_t") public static long H5P_LST_DATATYPE_ACCESS_ID_g()
-
H5P_LST_DATATYPE_ACCESS_ID_g
public static void H5P_LST_DATATYPE_ACCESS_ID_g(long setter)
-
H5P_LST_MAP_CREATE_ID_g
@Cast("hid_t") public static long H5P_LST_MAP_CREATE_ID_g()
-
H5P_LST_MAP_CREATE_ID_g
public static void H5P_LST_MAP_CREATE_ID_g(long setter)
-
H5P_LST_MAP_ACCESS_ID_g
@Cast("hid_t") public static long H5P_LST_MAP_ACCESS_ID_g()
-
H5P_LST_MAP_ACCESS_ID_g
public static void H5P_LST_MAP_ACCESS_ID_g(long setter)
-
H5P_LST_ATTRIBUTE_CREATE_ID_g
@Cast("hid_t") public static long H5P_LST_ATTRIBUTE_CREATE_ID_g()
-
H5P_LST_ATTRIBUTE_CREATE_ID_g
public static void H5P_LST_ATTRIBUTE_CREATE_ID_g(long setter)
-
H5P_LST_ATTRIBUTE_ACCESS_ID_g
@Cast("hid_t") public static long H5P_LST_ATTRIBUTE_ACCESS_ID_g()
-
H5P_LST_ATTRIBUTE_ACCESS_ID_g
public static void H5P_LST_ATTRIBUTE_ACCESS_ID_g(long setter)
-
H5P_LST_OBJECT_COPY_ID_g
@Cast("hid_t") public static long H5P_LST_OBJECT_COPY_ID_g()
-
H5P_LST_OBJECT_COPY_ID_g
public static void H5P_LST_OBJECT_COPY_ID_g(long setter)
-
H5P_LST_LINK_CREATE_ID_g
@Cast("hid_t") public static long H5P_LST_LINK_CREATE_ID_g()
-
H5P_LST_LINK_CREATE_ID_g
public static void H5P_LST_LINK_CREATE_ID_g(long setter)
-
H5P_LST_LINK_ACCESS_ID_g
@Cast("hid_t") public static long H5P_LST_LINK_ACCESS_ID_g()
-
H5P_LST_LINK_ACCESS_ID_g
public static void H5P_LST_LINK_ACCESS_ID_g(long setter)
-
H5P_LST_VOL_INITIALIZE_ID_g
@Cast("hid_t") public static long H5P_LST_VOL_INITIALIZE_ID_g()
-
H5P_LST_VOL_INITIALIZE_ID_g
public static void H5P_LST_VOL_INITIALIZE_ID_g(long setter)
-
H5P_LST_REFERENCE_ACCESS_ID_g
@Cast("hid_t") public static long H5P_LST_REFERENCE_ACCESS_ID_g()
-
H5P_LST_REFERENCE_ACCESS_ID_g
public static void H5P_LST_REFERENCE_ACCESS_ID_g(long setter)
-
H5Pclose
@Cast("herr_t") public static int H5Pclose(@Cast("hid_t") long plist_id)
\ingroup PLCR \brief Terminates access to a property list \plist_id- Returns:
- \herr_t \details H5Pclose() terminates access to a property list. All property lists should be closed when the application is finished accessing them. This frees resources used by the property list.
- Since:
- 1.0.0
-
H5Pclose_class
@Cast("herr_t") public static int H5Pclose_class(@Cast("hid_t") long plist_id)
\ingroup PLCRA \brief Closes an existing property list class \plistcls_id{plist_id}- Returns:
- \herr_t \details H5Pclose_class() removes a property list class from the library. Existing property lists of this class will continue to exist, but new ones are not able to be created.
- Since:
- 1.4.0
-
H5Pcopy
@Cast("hid_t") public static long H5Pcopy(@Cast("hid_t") long plist_id)
\ingroup PLCR \brief Copies an existing property list to create a new property list \plist_id- Returns:
- \hid_t{property list} \details H5Pcopy() copies an existing property list to create a new property list. The new property list has the same properties and values as the original property list.
- Since:
- 1.0.0
-
H5Pcopy_prop
@Cast("herr_t") public static int H5Pcopy_prop(@Cast("hid_t") long dst_id, @Cast("hid_t") long src_id, @Cast("const char*") BytePointer name)
\ingroup PLCRA \brief Copies a property from one list or class to another- Parameters:
dst_id- [in] Identifier of the destination property list or classsrc_id- [in] Identifier of the source property list or classname- [in] Name of the property to copy- Returns:
- \herr_t \details H5Pcopy_prop() copies a property from one property list or class to another. If a property is copied from one class to another, all the property information will be first deleted from the destination class and then the property information will be copied from the source class into the destination class. If a property is copied from one list to another, the property will be first deleted from the destination list (generating a call to the close callback for the property, if one exists) and then the property is copied from the source list to the destination list (generating a call to the copy callback for the property, if one exists). If the property does not exist in the class or list, this call is equivalent to calling H5Pregister() or H5Pinsert() (for a class or list, as appropriate) and the create callback will be called in the case of the property being copied into a list (if such a callback exists for the property).
- Since:
- 1.6.0
-
H5Pcopy_prop
@Cast("herr_t") public static int H5Pcopy_prop(@Cast("hid_t") long dst_id, @Cast("hid_t") long src_id, String name)
-
H5Pcreate
@Cast("hid_t") public static long H5Pcreate(@Cast("hid_t") long cls_id)
\ingroup PLCR \brief Creates a new property list as an instance of a property list class \plistcls_id{cls_id}- Returns:
- \hid_t{property list}
\details H5Pcreate() creates a new property list as an instance of
some property list class. The new property list is initialized
with default values for the specified class. The classes are as
follows:
This property list must eventually be closed with H5Pclose(); otherwise, errors are likely to occur.Class Identifier Class Name Comments #H5P_ATTRIBUTE_CREATE attribute create Properties for attribute creation #H5P_DATASET_ACCESS dataset access Properties for dataset access #H5P_DATASET_CREATE dataset create Properties for dataset creation #H5P_DATASET_XFER data transfer Properties for raw data transfer #H5P_DATATYPE_ACCESS datatype access Properties for datatype access #H5P_DATATYPE_CREATE datatype create Properties for datatype creation #H5P_FILE_ACCESS file access Properties for file access #H5P_FILE_CREATE file create Properties for file creation #H5P_FILE_MOUNT file mount Properties for file mounting #H5P_GROUP_ACCESS group access Properties for group access #H5P_GROUP_CREATE group create Properties for group creation #H5P_LINK_ACCESS link access Properties governing link traversal when accessing objects #H5P_LINK_CREATE link create Properties governing link creation #H5P_OBJECT_COPY object copy Properties governing the object copying process #H5P_OBJECT_CREATE object create Properties for object creation #H5P_STRING_CREATE string create Properties for character encoding when encoding strings or object names #H5P_VOL_INITIALIZE vol initialize Properties for VOL initialization - Since:
- 1.0.0
-
H5Pcreate_class
@Cast("hid_t") public static long H5Pcreate_class(@Cast("hid_t") long parent, @Cast("const char*") BytePointer name, H5P_cls_create_func_t create, Pointer create_data, H5P_cls_copy_func_t copy, Pointer copy_data, H5P_cls_close_func_t _close, Pointer close_data)
\ingroup PLCRA \brief Creates a new property list class \plistcls_id{parent}- Parameters:
name- [in] Name of property list class to registercreate- [in] Callback routine called when a property list is createdcreate_data- [in] Pointer to user-defined class create data, to be passed along to class create callbackcopy- [in] Callback routine called when a property list is copiedcopy_data- [in] Pointer to user-defined class copy data, to be passed along to class copy callbackclose- [in] Callback routine called when a property list is being closedclose_data- [in] Pointer to user-defined class close data, to be passed along to class close callback- Returns:
- \hid_t{property list class} \details H5Pcreate_class() registers a new property list class with the library. The new property list class can inherit from an existing property list class, \p parent, or may be derived from the default âemptyâ class, NULL. New classes with inherited properties from existing classes may not remove those existing properties, only add or remove their own class properties. Property list classes defined and supported in the HDF5 library distribution are listed and briefly described in H5Pcreate(). The \p create, \p copy, \p close functions are called when a property list of the new class is created, copied, or closed, respectively. H5Pclose_class() must be used to release the property list class identifier returned by this function.
- Since:
- 1.4.0
-
H5Pcreate_class
@Cast("hid_t") public static long H5Pcreate_class(@Cast("hid_t") long parent, String name, H5P_cls_create_func_t create, Pointer create_data, H5P_cls_copy_func_t copy, Pointer copy_data, H5P_cls_close_func_t _close, Pointer close_data)
-
H5Pdecode
@Cast("hid_t") public static long H5Pdecode(@Const Pointer buf)
\ingroup PLCR \brief Decodes property list received in a binary object buffer and returns a new property list identifier- Parameters:
buf- [in] Buffer holding the encoded property list- Returns:
- \hid_tv{object} \details Given a binary property list description in a buffer, H5Pdecode() reconstructs the HDF5 property list and returns an identifier for the new property list. The binary description of the property list is encoded by H5Pencode(). The user is responsible for passing in the correct buffer. The property list identifier returned by this function should be released with H5Pclose() when the identifier is no longer needed so that resource leaks will not develop. \note Some properties cannot be encoded and therefore will not be available in the decoded property list. These properties are discussed in H5Pencode().
- Since:
- 1.10.0
-
H5Pencode2
@Cast("herr_t") public static int H5Pencode2(@Cast("hid_t") long plist_id, Pointer buf, @Cast("size_t*") SizeTPointer nalloc, @Cast("hid_t") long fapl_id)
\ingroup PLCR \brief Encodes the property values in a property list into a binary buffer \plist_id- Parameters:
buf- [out] Buffer into which the property list will be encoded. If the provided buffer is NULL, the size of the buffer required is returned through \p nalloc; the function does nothing more.nalloc- [out] The size of the required buffer \fapl_id- Returns:
- \herr_t \details H5Pencode2() encodes the property list \p plist_id into the binary buffer \p buf, according to the file format setting specified by the file access property list \p fapl_id. If the required buffer size is unknown, \p buf can be passed in as NULL and the function will set the required buffer size in \p nalloc. The buffer can then be created and the property list encoded with a subsequent H5Pencode2() call. If the buffer passed in is not big enough to hold the encoded properties, the H5Pencode2() call can be expected to fail with a segmentation fault. The file access property list \p fapl_id is used to control the encoding via the \a libver_bounds property (see H5Pset_libver_bounds()). If the \a libver_bounds property is missing, H5Pencode2() proceeds as if the \a libver_bounds property were set to (#H5F_LIBVER_EARLIEST, #H5F_LIBVER_LATEST). (Functionally, H5Pencode1() is identical to H5Pencode2() with \a libver_bounds set to (#H5F_LIBVER_EARLIEST, #H5F_LIBVER_LATEST).) Properties that do not have encode callbacks will be skipped. There is currently no mechanism to register an encode callback for a user-defined property, so user-defined properties cannot currently be encoded. Some properties cannot be encoded, particularly properties that are reliant on local context. \b Motivation: This function was introduced in HDF5-1.12 as part of the \a H5Sencode format change to enable 64-bit selection encodings and a dataspace selection that is tied to a file.
- Since:
- 1.12.0
-
H5Pequal
@Cast("htri_t") public static int H5Pequal(@Cast("hid_t") long id1, @Cast("hid_t") long id2)
\ingroup PLCRA \brief Compares two property lists or classes for equality- Parameters:
id- [in] 1 First property object to be comparedid- [in] 2 Second property object to be compared- Returns:
- \htri_t \details H5Pequal() compares two property lists or classes to determine whether they are equal to one another. Either both \p id1 and \p id2 must be property lists or both must be classes; comparing a list to a class is an error.
- Since:
- 1.4.0
-
H5Pexist
@Cast("htri_t") public static int H5Pexist(@Cast("hid_t") long plist_id, @Cast("const char*") BytePointer name)
\ingroup PLCRA \brief Queries whether a property name exists in a property list or class- Parameters:
plist_id- [in] Identifier for the property list or class to queryname- [in] Name of property to check for- Returns:
- \htri_t \details H5Pexist() determines whether a property exists within a property list or class.
- Since:
- 1.4.0
-
H5Pget
@Cast("herr_t") public static int H5Pget(@Cast("hid_t") long plist_id, @Cast("const char*") BytePointer name, Pointer value)
\ingroup PLCRA \brief Queries the value of a property \plist_id- Parameters:
name- [in] Name of property to queryvalue- [out] Pointer to a location to which to copy the value of the property- Returns:
- \herr_t \details H5Pget() retrieves a copy of the value for a property in a property list. If there is a \p get callback routine registered for this property, the copy of the value of the property will first be passed to that routine and any changes to the copy of the value will be used when returning the property value from this routine. This routine may be called for zero-sized properties with the \p value set to NULL. The \p get routine will be called with a NULL value if the callback exists. The property name must exist or this routine will fail. If the \p get callback routine returns an error, \ value will not be modified.
- Since:
- 1.4.0
-
H5Pget
@Cast("herr_t") public static int H5Pget(@Cast("hid_t") long plist_id, String name, Pointer value)
-
H5Pget_class
@Cast("hid_t") public static long H5Pget_class(@Cast("hid_t") long plist_id)
\ingroup PLCR \brief Returns the property list class identifier for a property list \plist_id- Returns:
- \hid_t{property list class}
\details H5Pget_class() returns the property list class identifier for
the property list identified by the \p plist_id parameter.
Note that H5Pget_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 H5Pequal() or H5Pget_class_name() to determine which
predefined HDF5 property list class H5Pget_class() has returned.
A full list of valid predefined property list classes appears
in the description of H5Pcreate().
Determining the HDF5 property list class name with H5Pequal()
requires a series of H5Pequal() calls in an if-else sequence.
An iterative sequence of H5Pequal() calls can compare the
identifier returned by H5Pget_class() to members of the list of
valid property list class names. A pseudo-code snippet might
read as follows:
H5Pget_class_name() returns the property list class name directly as a string: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. ] .
Note that frequent use of H5Pget_class_name() can become a performance problem in a high-performance environment. The H5Pequal() approach is generally much faster.plist_class_id = H5Pget_class (dsetA_plist); plist_class_name = H5Pget_class_name (plist_class_id) - Since:
- 1.0.0
-
H5Pget_class_name
@Cast("char*") public static BytePointer H5Pget_class_name(@Cast("hid_t") long pclass_id)
\ingroup PLCRA \brief Retrieves the name of a class \plistcls_id{pclass_id}- Returns:
- Returns a pointer to an allocated string containing the class
name if successful, and NULL if not successful.
\details H5Pget_class_name() retrieves the name of a generic property
list class. The pointer to the name must be freed by the user
with a call to H5free_memory() after each successful call.
Class Name (class identifier) Returned Property List Class Expanded Name of the Property List Class The Class Identifier Used with H5Pcreate Comments attribute create acpl Attribute Creation Property List H5P_ATTRIBUTE_CREATE dataset access dapl Dataset Access Property List H5P_DATASET_ACCESS dataset create dcpl Dataset Creation Property List H5P_DATASET_CREATE data transfer dxpl Data Transfer Property List H5P_DATASET_XFER datatype access H5P_DATATYPE_ACCESS This class can be created, but there are no properties in the class currently. datatype create H5P_DATATYPE_CREATE This class can be created, but there are no properties in the class currently. file access fapl File Access Property List H5P_FILE_ACCESS file create fcpl File Creation Property List H5P_FILE_CREATE file mount fmpl File Mount Property List H5P_FILE_MOUNT group access H5P_GROUP_ACCESS This class can be created, but there are no properties in the class currently. group create gcpl Group Creation Property List H5P_GROUP_CREATE link access lapl Link Access Property List H5P_LINK_ACCESS link create lcpl Link Creation Property List H5P_LINK_CREATE object copy ocpypl Object Copy Property List H5P_OBJECT_COPY object create ocpl Object Creation Property List H5P_OBJECT_CREATE string create strcpl String Creation Property List H5P_STRING_CREATE - Since:
- 1.4.0
-
H5Pget_class_parent
@Cast("hid_t") public static long H5Pget_class_parent(@Cast("hid_t") long pclass_id)
\ingroup PLCRA \brief Retrieves the parent class of a property class \plistcls_id{pclass_id}- Returns:
- \hid_t{parent class object} \details H5Pget_class_parent() retrieves an identifier for the parent class of a property class.
- Since:
- 1.4.0
-
H5Pget_nprops
@Cast("herr_t") public static int H5Pget_nprops(@Cast("hid_t") long id, @Cast("size_t*") SizeTPointer nprops)
\ingroup PLCRA \brief Queries the number of properties in a property list or class- Parameters:
id- [in] Identifier for property object to querynprops- [out] Number of properties in object- Returns:
- \herr_t \details H5Pget_nprops() retrieves the number of properties in a property list or property list class. If \p id is a property list identifier, the current number of properties in the list is returned in \p nprops. If \p id is a property list class identifier, the number of registered properties in the class is returned in \p nprops.
- Since:
- 1.4.0
-
H5Pget_size
@Cast("herr_t") public static int H5Pget_size(@Cast("hid_t") long id, @Cast("const char*") BytePointer name, @Cast("size_t*") SizeTPointer size)
\ingroup PLCRA \brief Queries the size of a property value in bytes- Parameters:
id- [in] Identifier of property object to queryname- [in] Name of property to querysize- [out] Size of property in bytes- Returns:
- \herr_t \details H5Pget_size() retrieves the size of a property's value in bytes. This function operates on both property lists and property classes. Zero-sized properties are allowed and return 0.
- Since:
- 1.4.0
-
H5Pget_size
@Cast("herr_t") public static int H5Pget_size(@Cast("hid_t") long id, String name, @Cast("size_t*") SizeTPointer size)
-
H5Pinsert2
@Cast("herr_t") public static int H5Pinsert2(@Cast("hid_t") long plist_id, @Cast("const char*") BytePointer name, @Cast("size_t") long size, Pointer value, @Cast("H5P_prp_set_func_t") H5P_prp_cb2_t set, @Cast("H5P_prp_get_func_t") H5P_prp_cb2_t get, @Cast("H5P_prp_delete_func_t") H5P_prp_cb2_t prp_del, @Cast("H5P_prp_copy_func_t") H5P_prp_cb1_t copy, H5P_prp_compare_func_t compare, @Cast("H5P_prp_close_func_t") H5P_prp_cb1_t _close)
\ingroup PLCRA \brief Registers a temporary property with a property list \plist_id- Parameters:
name- [in] Name of property to createsize- [in] Size of property in bytesvalue- [in] Initial value for the propertyset- [in] Callback routine called before a new value is copied into the property's valueget- [in] Callback routine called when a property value is retrieved from the propertyprp_del- [in] Callback routine called when a property is deleted from a property listcopy- [in] Callback routine called when a property is copied from an existing property listcompare- [in] Callback routine called when a property is compared with another property listclose- [in] Callback routine called when a property list is being closed and the property value will be disposed of- Returns:
- \herr_t
\details H5Pinsert2() creates a new property in a property
list. The property will exist only in this property list and
copies made from it.
The initial property value must be provided in \p value and
the property value will be set accordingly.
The name of the property must not already exist in this list,
or this routine will fail.
The \p set and \p get callback routines may be set to NULL
if they are not needed.
Zero-sized properties are allowed and do not store any data
in the property list. The default value of a zero-size
property may be set to NULL. They may be used to indicate the
presence or absence of a particular piece of information.
The \p set routine is called before a new value is copied
into the property. The #H5P_prp_set_func_t callback function
is defined as follows:
\snippet this H5P_prp_cb2_t_snip
The parameters to the callback function are defined as follows:
The \p set routine may modify the value pointer to be set and those changes will be used when setting the property's value. If the \p set routine returns a negative value, the new property value is not copied into the property and the \p set routine returns an error value. The \p set routine will be called for the initial value. \b Note: The \p set callback function may be useful to range check the value being set for the property or may perform some transformation or translation of the value set. The \p get callback would then reverse the transformation or translation. A single \p get or \p set callback could handle multiple properties by performing different actions based on the property name or other properties in the property list. The \p get routine is called when a value is retrieved from a property value. The #H5P_prp_get_func_t callback function is defined as follows: \snippet this H5P_prp_cb2_t_snip The parameters to the above callback function are:\ref hid_t \c prop_id IN: The identifier of the property list being modified \Code{const char * name} IN: The name of the property being modified \Code{size_t size} IN: The size of the property in bytes \Code{void * value} IN: Pointer to new value pointer for the property being modified
The \p get routine may modify the value to be returned from the query and those changes will be preserved. If the \p get routine returns a negative value, the query routine returns an error value. The \p prp_del routine is called when a property is being deleted from a property list. The #H5P_prp_delete_func_t callback function is defined as follows: \snippet this H5P_prp_cb2_t_snip The parameters to the above callback function are:\ref hid_t \c prop_id IN: The identifier of the property list being queried \Code{const char * name} IN: The name of the property being queried \Code{size_t size} IN: The size of the property in bytes \Code{void * value} IN: The value of the property being returned
The \p prp_del routine may modify the value passed in, but the value is not used by the library when the \p prp_del routine returns. If the \p prp_del routine returns a negative value, the property list \p prp_del routine returns an error value but the property is still deleted. The \p copy routine is called when a new property list with this property is being created through a \p copy operation. The #H5P_prp_copy_func_t callback function is defined as follows: \snippet this H5P_prp_cb1_t_snip The parameters to the above callback function are:\ref hid_t \c prop_id IN: The identifier of the property list the property is being deleted from \Code{const char * name} IN: The name of the property in the list \Code{size_t size} IN: The size of the property in bytes \Code{void * value} IN: The value for the property being deleted
The \p copy routine may modify the value to be set and those changes will be stored as the new value of the property. If the \p copy routine returns a negative value, the new property value is not copied into the property and the copy routine returns an error value. The \p compare routine is called when a property list with this property is compared to another property list with the same property. The #H5P_prp_compare_func_t callback function is defined as follows: \snippet this H5P_prp_compare_func_t_snip The parameters to the callback function are defined as follows:\Code{const char * name} IN: The name of the property being copied \Code{size_t size} IN: The size of the property in bytes \Code{void * value} IN/OUT: The value for the property being copied
The \p compare routine may not modify the values. The \p compare routine should return a positive value if \p value1 is greater than \p value2, a negative value if \p value2 is greater than \p value1 and zero if \p value1 and \p value2 are equal. The \p close routine is called when a property list with this property is being closed. The #H5P_prp_close_func_t callback function is defined as follows: \snippet this H5P_prp_cb1_t_snip The parameters to the callback function are defined as follows:\Code{const void * value1} IN: The value of the first property to compare \Code{const void * value2} IN: The value of the second property to compare \Code{size_t size} IN: The size of the property in bytes
The \p close routine may modify the value passed in, the value is not used by the library when the close routine returns. If the \p close routine returns a negative value, the property list \p close routine returns an error value but the property list is still closed. \b Note: There is no \p create callback routine for temporary property list objects; the initial value is assumed to have any necessary setup already performed on it.\Code{const char * name} IN: The name of the property in the list \Code{size_t size} IN: The size of the property in bytes \Code{void * value} IN: The value for the property being closed - Since:
- 1.8.0
-
H5Pinsert2
@Cast("herr_t") public static int H5Pinsert2(@Cast("hid_t") long plist_id, String name, @Cast("size_t") long size, Pointer value, @Cast("H5P_prp_set_func_t") H5P_prp_cb2_t set, @Cast("H5P_prp_get_func_t") H5P_prp_cb2_t get, @Cast("H5P_prp_delete_func_t") H5P_prp_cb2_t prp_del, @Cast("H5P_prp_copy_func_t") H5P_prp_cb1_t copy, H5P_prp_compare_func_t compare, @Cast("H5P_prp_close_func_t") H5P_prp_cb1_t _close)
-
H5Pisa_class
@Cast("htri_t") public static int H5Pisa_class(@Cast("hid_t") long plist_id, @Cast("hid_t") long pclass_id)
\ingroup PLCRA \brief Determines whether a property list is a member of a class \plist_id \plistcls_id{pclass_id}- Returns:
- \htri_t \details H5Pisa_class() checks to determine whether the property list \p plist_id is a member of the property list class \p pclass_id.
- Since:
- 1.6.0
- See Also:
H5Pcreate()
-
H5Piterate
public static int H5Piterate(@Cast("hid_t") long id, IntPointer idx, H5P_iterate_t iter_func, Pointer iter_data)
\ingroup PLCRA \brief Iterates over properties in a property class or list- Parameters:
id- [in] Identifier of property object to iterate overidx- [in,out] Index of the property to begin withiter_func- [in] Function pointer to function to be called with each property iterated overiter_data- [in,out] Pointer to iteration data from user- Returns:
- On success: the return value of the last call to \p iter_func if it was non-zero; zero if all properties have been processed. On Failure, a negative value \details H5Piterate() iterates over the properties in the property object specified in \p id, which may be either a property list or a property class, performing a specified operation on each property in turn. For each property in the object, \p iter_func and the additional information specified below are passed to the #H5P_iterate_t operator function. The iteration begins with the \p idx-th property in the object; the next element to be processed by the operator is returned in \p idx. If \p idx is NULL, the iterator starts at the first property; since no stopping point is returned in this case, the iterator cannot be restarted if one of the calls to its operator returns non-zero. The operation \p iter_func receives the property list or class identifier for the object being iterated over, \p id, the name of the current property within the object, \p name, and the pointer to the operator data passed in to H5Piterate(), \p iter_data. H5Piterate() assumes that the properties in the object identified by \p id remain unchanged through the iteration. If the membership changes during the iteration, the function's behavior is undefined.
- Since:
- 1.4.0
-
H5Piterate
public static int H5Piterate(@Cast("hid_t") long id, IntBuffer idx, H5P_iterate_t iter_func, Pointer iter_data)
-
H5Piterate
public static int H5Piterate(@Cast("hid_t") long id, int[] idx, H5P_iterate_t iter_func, Pointer iter_data)
-
H5Pregister2
@Cast("herr_t") public static int H5Pregister2(@Cast("hid_t") long cls_id, @Cast("const char*") BytePointer name, @Cast("size_t") long size, Pointer def_value, @Cast("H5P_prp_create_func_t") H5P_prp_cb1_t create, @Cast("H5P_prp_set_func_t") H5P_prp_cb2_t set, @Cast("H5P_prp_get_func_t") H5P_prp_cb2_t get, @Cast("H5P_prp_delete_func_t") H5P_prp_cb2_t prp_del, @Cast("H5P_prp_copy_func_t") H5P_prp_cb1_t copy, H5P_prp_compare_func_t compare, @Cast("H5P_prp_close_func_t") H5P_prp_cb1_t _close)
\ingroup PLCRA \brief Registers a permanent property with a property list class \plistcls_id{cls_id}- Parameters:
name- [in] Name of property to registersize- [in] Size of property in bytesdef_value- [in] Default value for property in newly created property listscreate- [in] Callback routine called when a property list is being created and the property value will be initializedset- [in] Callback routine called before a new value is copied into the property's valueget- [in] Callback routine called when a property value is retrieved from the propertyprp_del- [in] Callback routine called when a property is deleted from a property listcopy- [in] Callback routine called when a property is copied from a property listcompare- [in] Callback routine called when a property is compared with another property listclose- [in] Callback routine called when a property list is being closed and the property value will be disposed of- Returns:
- \herr_t
\details H5Pregister2() registers a new property with a property list
class. The \p cls_id identifier can be obtained by calling
H5Pcreate_class(). The property will exist in all property
list objects of \p cl_id created after this routine finishes. The
name of the property must not already exist, or this routine
will fail. The default property value must be provided and all
new property lists created with this property will have the
property value set to the default value. Any of the callback
routines may be set to NULL if they are not needed.
Zero-sized properties are allowed and do not store any data in
the property list. These may be used as flags to indicate the
presence or absence of a particular piece of information. The
default pointer for a zero-sized property may be set to NULL.
The property \p create and \p close callbacks are called for
zero-sized properties, but the \p set and \p get callbacks are
never called.
The \p create routine is called when a new property list with
this property is being created. The #H5P_prp_create_func_t
callback function is defined as follows:
\snippet this H5P_prp_cb1_t_snip
The parameters to this callback function are defined as follows:
The \p create routine may modify the value to be set and those changes will be stored as the initial value of the property. If the \p create routine returns a negative value, the new property value is not copied into the property and the \p create routine returns an error value. The \p set routine is called before a new value is copied into the property. The #H5P_prp_set_func_t callback function is defined as follows: \snippet this H5P_prp_cb2_t_snip The parameters to this callback function are defined as follows:\Code{const char * name} IN: The name of the property being modified \Code{size_t size} IN: The size of the property in bytes \Code{void * value} IN/OUT: The default value for the property being created, which will be passed to H5Pregister2()
The \p set routine may modify the value pointer to be set and those changes will be used when setting the property's value. If the \p set routine returns a negative value, the new property value is not copied into the property and the \p set routine returns an error value. The \p set routine will not be called for the initial value; only the \p create routine will be called. \b Note: The \p set callback function may be useful to range check the value being set for the property or may perform some transformation or translation of the value set. The \p get callback would then reverse the transformation or translation. A single \p get or \p set callback could handle multiple properties by performing different actions based on the property name or other properties in the property list. The \p get routine is called when a value is retrieved from a property value. The #H5P_prp_get_func_t callback function is defined as follows: \snippet this H5P_prp_cb2_t_snip The parameters to the callback function are defined as follows:\ref hid_t \c prop_id IN: The identifier of the property list being modified \Code{const char * name} IN: The name of the property being modified \Code{size_t size} IN: The size of the property in bytes \Code{void *value} IN/OUT: Pointer to new value pointer for the property being modified
The \p get routine may modify the value to be returned from the query and those changes will be returned to the calling routine. If the \p set routine returns a negative value, the query routine returns an error value. The \p prp_del routine is called when a property is being deleted from a property list. The #H5P_prp_delete_func_t callback function is defined as follows: \snippet this H5P_prp_cb2_t_snip The parameters to the callback function are defined as follows:\ref hid_t \c prop_id IN: The identifier of the property list being queried \Code{const char * name} IN: The name of the property being queried \Code{size_t size} IN: The size of the property in bytes \Code{void * value} IN/OUT: The value of the property being returned
The \p prp_del routine may modify the value passed in, but the value is not used by the library when the \p prp_del routine returns. If the \p prp_del routine returns a negative value, the property list delete routine returns an error value but the property is still deleted. The \p copy routine is called when a new property list with this property is being created through a \p copy operation. The #H5P_prp_copy_func_t callback function is defined as follows: \snippet this H5P_prp_cb1_t_snip The parameters to the callback function are defined as follows:\ref hid_t \c prop_id IN: The identifier of the property list the property is being deleted from \Code{const char * name} IN: The name of the property in the list \Code{size_t size} IN: The size of the property in bytes \Code{void * value} IN: The value for the property being deleted
The \p copy routine may modify the value to be set and those changes will be stored as the new value of the property. If the \p copy routine returns a negative value, the new property value is not copied into the property and the \p copy routine returns an error value. The \p compare routine is called when a property list with this property is compared to another property list with the same property. The #H5P_prp_compare_func_t callback function is defined as follows: \snippet this H5P_prp_compare_func_t_snip The parameters to the callback function are defined as follows:\Code{const char * name} IN: The name of the property being copied \Code{size_t size} IN: The size of the property in bytes \Code{void * value} IN/OUT: The value for the property being copied
The \p compare routine may not modify the values. The \p compare routine should return a positive value if \p value1 is greater than \p value2, a negative value if \p value2 is greater than \p value1 and zero if \p value1 and \p value2 are equal. The \p close routine is called when a property list with this property is being closed. The #H5P_prp_close_func_t callback function is defined as follows: \snippet this H5P_prp_cb1_t_snip The parameters to the callback function are defined as follows:\Code{const void * value1} IN: The value of the first property to compare \Code{const void * value2} IN: The value of the second property to compare \Code{size_t size} IN: The size of the property in bytes
The \p close routine may modify the value passed in, but the value is not used by the library when the \p close routine returns. If the \p close routine returns a negative value, the property list close routine returns an error value but the property list is still closed.\Code{const char * name} IN: The name of the property in the list \Code{size_t size} IN: The size of the property in bytes \Code{void * value} IN: The value for the property being closed - Since:
- 1.8.0
-
H5Pregister2
@Cast("herr_t") public static int H5Pregister2(@Cast("hid_t") long cls_id, String name, @Cast("size_t") long size, Pointer def_value, @Cast("H5P_prp_create_func_t") H5P_prp_cb1_t create, @Cast("H5P_prp_set_func_t") H5P_prp_cb2_t set, @Cast("H5P_prp_get_func_t") H5P_prp_cb2_t get, @Cast("H5P_prp_delete_func_t") H5P_prp_cb2_t prp_del, @Cast("H5P_prp_copy_func_t") H5P_prp_cb1_t copy, H5P_prp_compare_func_t compare, @Cast("H5P_prp_close_func_t") H5P_prp_cb1_t _close)
-
H5Premove
@Cast("herr_t") public static int H5Premove(@Cast("hid_t") long plist_id, @Cast("const char*") BytePointer name)
\ingroup PLCRA \brief Removes a property from a property list \plist_id- Parameters:
name- [in] Name of property to remove- Returns:
- \herr_t \details H5Premove() removes a property from a property list. Both properties which were in existence when the property list was created (i.e. properties registered with H5Pregister()) and properties added to the list after it was created (i.e. added with H5Pinsert1() may be removed from a property list. Properties do not need to be removed from a property list before the list itself is closed; they will be released automatically when H5Pclose() is called. If a \p close callback exists for the removed property, it will be called before the property is released.
- Since:
- 1.4.0
-
H5Pset
@Cast("herr_t") public static int H5Pset(@Cast("hid_t") long plist_id, @Cast("const char*") BytePointer name, @Const Pointer value)
\ingroup PLCRA \brief Sets a property list value \plist_id- Parameters:
name- [in] Name of property to modifyvalue- [in] Pointer to value to set the property to- Returns:
- \herr_t \details H5Pset() sets a new value for a property in a property list. If there is a \p set callback routine registered for this property, the \p value will be passed to that routine and any changes to the \p value will be used when setting the property value. The information pointed to by the \p value pointer (possibly modified by the \p set callback) is copied into the property list value and may be changed by the application making the H5Pset() call without affecting the property value. The property name must exist or this routine will fail. If the \p set callback routine returns an error, the property value will not be modified. This routine may not be called for zero-sized properties and will return an error in that case.
- Since:
- 1.4.0
-
H5Pset
@Cast("herr_t") public static int H5Pset(@Cast("hid_t") long plist_id, String name, @Const Pointer value)
-
H5Punregister
@Cast("herr_t") public static int H5Punregister(@Cast("hid_t") long pclass_id, @Cast("const char*") BytePointer name)
\ingroup PLCRA \brief Removes a property from a property list class \plistcls_id{pclass_id}- Parameters:
name- [in] Name of property to remove- Returns:
- \herr_t \details H5Punregister() removes a property from a property list class. Future property lists created of that class will not contain this property; existing property lists containing this property are not affected.
- Since:
- 1.4.0
-
H5Punregister
@Cast("herr_t") public static int H5Punregister(@Cast("hid_t") long pclass_id, String name)
-
H5Pall_filters_avail
@Cast("htri_t") public static int H5Pall_filters_avail(@Cast("hid_t") long plist_id)
\ingroup DCPL \brief Verifies that all required filters are available \plist_id- Returns:
- \htri_t \details H5Pall_filters_avail() verifies that all of the filters set in the dataset or group creation property list \p plist_id are currently available.
- Since:
- 1.6.0
-
H5Pget_attr_creation_order
@Cast("herr_t") public static int H5Pget_attr_creation_order(@Cast("hid_t") long plist_id, @Cast("unsigned*") IntPointer crt_order_flags)
\ingroup OCPL \brief Retrieves tracking and indexing settings for attribute creation order \plist_id- Parameters:
crt_order_flags- [out] Flags specifying whether to track and index attribute creation order- Returns:
- \herr_t
\details H5Pget_attr_creation_order() retrieves the settings for
tracking and indexing attribute creation order on an object.
\p plist_id is an object creation property list (\p ocpl),
as it can be a dataset or group creation property list
identifier. The term \p ocpl is used when different types
of objects may be involved.
\p crt_order_flags returns flags with the following meanings:
If \p crt_order_flags is returned with a value of 0 (zero), attribute creation order is neither tracked nor indexed.#H5P_CRT_ORDER_TRACKED Attribute creation order is tracked but not necessarily indexed. #H5P_CRT_ORDER_INDEXED Attribute creation order is indexed (requires #H5P_CRT_ORDER_TRACKED). - Since:
- 1.8.0
-
H5Pget_attr_creation_order
@Cast("herr_t") public static int H5Pget_attr_creation_order(@Cast("hid_t") long plist_id, @Cast("unsigned*") IntBuffer crt_order_flags)
-
H5Pget_attr_creation_order
@Cast("herr_t") public static int H5Pget_attr_creation_order(@Cast("hid_t") long plist_id, @Cast("unsigned*") int[] crt_order_flags)
-
H5Pget_attr_phase_change
@Cast("herr_t") public static int H5Pget_attr_phase_change(@Cast("hid_t") long plist_id, @Cast("unsigned*") IntPointer max_compact, @Cast("unsigned*") IntPointer min_dense)
\ingroup OCPL \brief Retrieves attribute storage phase change thresholds \plist_id- Parameters:
max_compact- [out] Maximum number of attributes to be stored in compact storage (Default: 8)min_dense- [out] Minimum number of attributes to be stored in dense storage (Default: 6)- Returns:
- \herr_t \details H5Pget_attr_phase_change() retrieves threshold values for attribute storage on an object. These thresholds determine the point at which attribute storage changes from compact storage (i.e., storage in the object header) to dense storage (i.e., storage in a heap and indexed with a B-tree). In the general case, attributes are initially kept in compact storage. When the number of attributes exceeds \p max_compact, attribute storage switches to dense storage. If the number of attributes subsequently falls below \p min_dense, the attributes are returned to compact storage. If \p max_compact is set to 0 (zero), dense storage always used. \p plist_id is an object creation property list (\p ocpl), as it can be a dataset or group creation property list identifier. The term \p ocpl is used when different types of objects may be involved.
- Since:
- 1.8.0
-
H5Pget_attr_phase_change
@Cast("herr_t") public static int H5Pget_attr_phase_change(@Cast("hid_t") long plist_id, @Cast("unsigned*") IntBuffer max_compact, @Cast("unsigned*") IntBuffer min_dense)
-
H5Pget_attr_phase_change
@Cast("herr_t") public static int H5Pget_attr_phase_change(@Cast("hid_t") long plist_id, @Cast("unsigned*") int[] max_compact, @Cast("unsigned*") int[] min_dense)
-
H5Pget_filter2
@Cast("H5Z_filter_t") public static int H5Pget_filter2(@Cast("hid_t") long plist_id, @Cast("unsigned") int idx, @Cast("unsigned int*") IntPointer flags, @Cast("size_t*") SizeTPointer cd_nelmts, @Cast("unsigned*") IntPointer cd_values, @Cast("size_t") long namelen, @Cast("char*") BytePointer name, @Cast("unsigned*") IntPointer filter_config)
\ingroup OCPL \brief Returns information about a filter in a pipeline \ocpl_id{plist_id}- Parameters:
idx- [in] Sequence number within the filter pipeline of the filter for which information is soughtflags- [out] Bit vector specifying certain general properties of the filtercd_nelmts- [in,out] Number of elements in \p cd_valuescd_values- [out] Auxiliary data for the filternamelen- [in] Anticipated number of characters in \p namename- [out] Name of the filterfilter_config- [out] Bit field, as described in H5Zget_filter_info()- Returns:
- Returns a negative value on failure, and the filter identifier if successful (see #H5Z_filter_t): - #H5Z_FILTER_DEFLATE Data compression filter, employing the gzip algorithm - #H5Z_FILTER_SHUFFLE Data shuffling filter - #H5Z_FILTER_FLETCHER32 Error detection filter, employing the Fletcher32 checksum algorithm - #H5Z_FILTER_SZIP Data compression filter, employing the SZIP algorithm - #H5Z_FILTER_NBIT Data compression filter, employing the N-bit algorithm - #H5Z_FILTER_SCALEOFFSET Data compression filter, employing the scale-offset algorithm \details H5Pget_filter2() returns information about a filter specified by its filter number, in a filter pipeline specified by the property list with which it is associated. \p plist_id must be a dataset or group creation property list. \p idx is a value between zero and N-1, as described in H5Pget_nfilters(). The function will return a negative value if the filter number is out of range. The structure of the \p flags argument is discussed in H5Pset_filter(). On input, \p cd_nelmts indicates the number of entries in the \p cd_values array, as allocated by the caller; on return, \p cd_nelmts contains the number of values defined by the filter. If \p name is a pointer to an array of at least \p namelen bytes, the filter name will be copied into that array. The name will be null terminated if \p namelen is large enough. The filter name returned will be the name appearing in the file, the name registered for the filter, or an empty string. \p filter_config is the bit field described in H5Zget_filter_info().
- Since:
- 1.8.0
-
H5Pget_filter2
@Cast("H5Z_filter_t") public static int H5Pget_filter2(@Cast("hid_t") long plist_id, @Cast("unsigned") int idx, @Cast("unsigned int*") IntBuffer flags, @Cast("size_t*") SizeTPointer cd_nelmts, @Cast("unsigned*") IntBuffer cd_values, @Cast("size_t") long namelen, @Cast("char*") ByteBuffer name, @Cast("unsigned*") IntBuffer filter_config)
-
H5Pget_filter2
@Cast("H5Z_filter_t") public static int H5Pget_filter2(@Cast("hid_t") long plist_id, @Cast("unsigned") int idx, @Cast("unsigned int*") int[] flags, @Cast("size_t*") SizeTPointer cd_nelmts, @Cast("unsigned*") int[] cd_values, @Cast("size_t") long namelen, @Cast("char*") byte[] name, @Cast("unsigned*") int[] filter_config)
-
H5Pget_filter_by_id2
@Cast("herr_t") public static int H5Pget_filter_by_id2(@Cast("hid_t") long plist_id, @Cast("H5Z_filter_t") int filter_id, @Cast("unsigned int*") IntPointer flags, @Cast("size_t*") SizeTPointer cd_nelmts, @Cast("unsigned*") IntPointer cd_values, @Cast("size_t") long namelen, @Cast("char*") BytePointer name, @Cast("unsigned*") IntPointer filter_config)
\ingroup OCPL \brief Returns information about the specified filter \ocpl_id{plist_id}- Parameters:
filter_id- [in] Filter identifierflags- [out] Bit vector specifying certain general properties of the filtercd_nelmts- [in,out] Number of elements in \p cd_valuescd_values- [out] [] Auxiliary data for the filternamelen- [in] Length of filter name and number of elements in \p namename- [out] [] Name of filterfilter_config- [out] Bit field, as described in H5Zget_filter_info()- Returns:
- \herr_t \details H5Pget_filter_by_id2() returns information about the filter specified in \p filter_id, a filter identifier. \p plist_id must be a dataset or group creation property list and \p filter_id must be in the associated filter pipeline. The \p filter_id and \p flags parameters are used in the same manner as described in the discussion of H5Pset_filter(). Aside from the fact that they are used for output, the parameters \p cd_nelmts and \p cd_values[] are used in the same manner as described in the discussion of H5Pset_filter(). On input, the \p cd_nelmts parameter indicates the number of entries in the \p cd_values[] array allocated by the calling program; on exit it contains the number of values defined by the filter. On input, the \p namelen parameter indicates the number of characters allocated for the filter name by the calling program in the array \p name[]. On exit \p name[] contains the name of the filter with one character of the name in each element of the array. \p filter_config is the bit field described in H5Zget_filter_info(). If the filter specified in \p filter_id is not set for the property list, an error will be returned and H5Pget_filter_by_id2() will fail.
- Since:
- 1.8.0
-
H5Pget_filter_by_id2
@Cast("herr_t") public static int H5Pget_filter_by_id2(@Cast("hid_t") long plist_id, @Cast("H5Z_filter_t") int filter_id, @Cast("unsigned int*") IntBuffer flags, @Cast("size_t*") SizeTPointer cd_nelmts, @Cast("unsigned*") IntBuffer cd_values, @Cast("size_t") long namelen, @Cast("char*") ByteBuffer name, @Cast("unsigned*") IntBuffer filter_config)
-
H5Pget_filter_by_id2
@Cast("herr_t") public static int H5Pget_filter_by_id2(@Cast("hid_t") long plist_id, @Cast("H5Z_filter_t") int filter_id, @Cast("unsigned int*") int[] flags, @Cast("size_t*") SizeTPointer cd_nelmts, @Cast("unsigned*") int[] cd_values, @Cast("size_t") long namelen, @Cast("char*") byte[] name, @Cast("unsigned*") int[] filter_config)
-
H5Pget_nfilters
public static int H5Pget_nfilters(@Cast("hid_t") long plist_id)
\ingroup OCPL \brief Returns the number of filters in the pipeline \ocpl_id{plist_id}- Returns:
- Returns the number of filters in the pipeline if successful; otherwise returns a negative value. \details H5Pget_nfilters() returns the number of filters defined in the filter pipeline associated with the property list \p plist_id. In each pipeline, the filters are numbered from 0 through \Code{N-1}, where \c N is the value returned by this function. During output to the file, the filters are applied in increasing order; during input from the file, they are applied in decreasing order. H5Pget_nfilters() returns the number of filters in the pipeline, including zero (0) if there are none.
- Since:
- 1.0.0
-
H5Pget_obj_track_times
@Cast("herr_t") public static int H5Pget_obj_track_times(@Cast("hid_t") long plist_id, @Cast("hbool_t*") BoolPointer track_times)
\ingroup OCPL \brief Determines whether times associated with an object are being recorded \plist_id- Parameters:
track_times- [out] Boolean value, 1 (TRUE) or 0 (FALSE), specifying whether object times are being recorded- Returns:
- \herr_t \details H5Pget_obj_track_times() queries the object creation property list, \p plist_id, to determine whether object times are being recorded. If \p track_times is returned as 1, times are being recorded; if \p track_times is returned as 0, times are not being recorded. Time data can be retrieved with H5Oget_info(), which will return it in the #H5O_info_t struct. If times are not tracked, they will be reported as follows when queried: 12:00 AM UDT, Jan. 1, 1970 See H5Pset_obj_track_times() for further discussion.
- Since:
- 1.8.0
-
H5Pget_obj_track_times
@Cast("herr_t") public static int H5Pget_obj_track_times(@Cast("hid_t") long plist_id, @Cast("hbool_t*") boolean[] track_times)
-
H5Pmodify_filter
@Cast("herr_t") public static int H5Pmodify_filter(@Cast("hid_t") long plist_id, @Cast("H5Z_filter_t") int filter, @Cast("unsigned int") int flags, @Cast("size_t") long cd_nelmts, @Cast("const unsigned int*") IntPointer cd_values)
\ingroup OCPL \brief Modifies a filter in the filter pipeline \ocpl_id{plist_id}- Parameters:
filter- [in] Filter to be modifiedflags- [in] Bit vector specifying certain general properties of the filtercd_nelmts- [in] Number of elements in \p cd_valuescd_values- [in] [] Auxiliary data for the filter- Returns:
- \herr_t \details H5Pmodify_filter() modifies the specified \p filter in the filter pipeline. \p plist_id must be a dataset or group creation property list. The \p filter, \p flags \p cd_nelmts[], and \p cd_values parameters are used in the same manner and accept the same values as described in the discussion of H5Pset_filter().
- Since:
- 1.6.0
-
H5Pmodify_filter
@Cast("herr_t") public static int H5Pmodify_filter(@Cast("hid_t") long plist_id, @Cast("H5Z_filter_t") int filter, @Cast("unsigned int") int flags, @Cast("size_t") long cd_nelmts, @Cast("const unsigned int*") IntBuffer cd_values)
-
H5Pmodify_filter
@Cast("herr_t") public static int H5Pmodify_filter(@Cast("hid_t") long plist_id, @Cast("H5Z_filter_t") int filter, @Cast("unsigned int") int flags, @Cast("size_t") long cd_nelmts, @Cast("const unsigned int*") int[] cd_values)
-
H5Premove_filter
@Cast("herr_t") public static int H5Premove_filter(@Cast("hid_t") long plist_id, @Cast("H5Z_filter_t") int filter)
\ingroup OCPL \brief Delete one or more filters in the filter pipeline \ocpl_id{plist_id}- Parameters:
filter- [in] Filter to be deleted- Returns:
- \herr_t
\details H5Premove_filter() removes the specified \p filter from the
filter pipeline in the dataset or group creation property
list \p plist_id.
The \p filter parameter specifies the filter to be removed.
Valid values for use in \p filter are as follows:
Additionally, user-defined filters can be removed with this routine by passing the filter identifier with which they were registered with the HDF5 library. Attempting to remove a filter that is not in the filter pipeline is an error.#H5Z_FILTER_ALL Removes all filters from the filter pipeline #H5Z_FILTER_DEFLATE Data compression filter, employing the gzip algorithm #H5Z_FILTER_SHUFFLE Data shuffling filter #H5Z_FILTER_FLETCHER32 Error detection filter, employing the Fletcher32 checksum algorithm #H5Z_FILTER_SZIP Data compression filter, employing the SZIP algorithm #H5Z_FILTER_NBIT Data compression filter, employing the N-Bit algorithm #H5Z_FILTER_SCALEOFFSET Data compression filter, employing the scale-offset algorithm - Since:
- 1.6.3
-
H5Pset_attr_creation_order
@Cast("herr_t") public static int H5Pset_attr_creation_order(@Cast("hid_t") long plist_id, @Cast("unsigned") int crt_order_flags)
\ingroup OCPL \brief Sets tracking and indexing of attribute creation order \plist_id- Parameters:
crt_order_flags- [in] Flags specifying whether to track and index attribute creation order. \em Default: No flag set; attribute creation order is neither tracked not indexed- Returns:
- \herr_t
\details H5Pset_attr_creation_order() sets flags for tracking and
indexing attribute creation order on an object.
\p plist_id is a dataset or group creation property list
identifier.
\p crt_order_flags contains flags with the following meanings:
Default behavior is that attribute creation order is neither tracked nor indexed. H5Pset_attr_creation_order() can be used to set attribute creation order tracking, or to set attribute creation order tracking and indexing. \note If a creation order index is to be built, it must be specified in the object creation property list. HDF5 currently provides no mechanism to turn on attribute creation order tracking at object creation time and to build the index later.#H5P_CRT_ORDER_TRACKED Attribute creation order is tracked but not necessarily indexed. #H5P_CRT_ORDER_INDEXED Attribute creation order is indexed (requires #H5P_CRT_ORDER_TRACKED). - Since:
- 1.8.0
-
H5Pset_attr_phase_change
@Cast("herr_t") public static int H5Pset_attr_phase_change(@Cast("hid_t") long plist_id, @Cast("unsigned") int max_compact, @Cast("unsigned") int min_dense)
\ingroup OCPL \brief Sets attribute storage phase change thresholds \plist_id- Parameters:
max_compact- [in] Maximum number of attributes to be stored in compact storage (\em Default: 8); must be greater than or equal to \p min_densemin_dense- [in] Minimum number of attributes to be stored in dense storage (\em Default: 6)- Returns:
- \herr_t \details H5Pset_attr_phase_change() sets threshold values for attribute storage on an object. These thresholds determine the point at which attribute storage changes from compact storage (i.e., storage in the object header) to dense storage (i.e., storage in a heap and indexed with a B-tree). In the general case, attributes are initially kept in compact storage. When the number of attributes exceeds \p max_compact, attribute storage switches to dense storage. If the number of attributes subsequently falls below \p min_dense, the attributes are returned to compact storage. If \p max_compact is set to 0 (zero), dense storage is always used. \p min_dense must be set to 0 (zero) when \p max_compact is 0 (zero). \p plist_id is a dataset or group creation property list identifier.
- Since:
- 1.8.0
-
H5Pset_deflate
@Cast("herr_t") public static int H5Pset_deflate(@Cast("hid_t") long plist_id, @Cast("unsigned") int level)
\ingroup DCPL \brief Sets deflate (GNU gzip) compression method and compression level \ocpl_id{plist_id}- Parameters:
level- [in] Compression level- Returns:
- \herr_t
\par_compr_note
\details H5Pset_deflate() sets the deflate compression method and the
compression level, \p level, for a dataset or group creation
property list, \p plist_id.
The filter identifier set in the property list is
#H5Z_FILTER_DEFLATE.
The compression level, \p level, is a value from zero to nine,
inclusive. A compression level of 0 (zero) indicates no
compression; compression improves but speed slows progressively
from levels 1 through 9:
Note that setting the compression level to 0 (zero) does not turn off use of the gzip filter; it simply sets the filter to perform no compression as it processes the data. HDF5 relies on GNU gzip for this compression.Compression Level Gzip Action 0 No compression 1 Best compression speed; least compression 2 through 8 Compression improves; speed degrades 9 Best compression ratio; slowest speed - Since:
- 1.0.0
-
H5Pset_filter
@Cast("herr_t") public static int H5Pset_filter(@Cast("hid_t") long plist_id, @Cast("H5Z_filter_t") int filter, @Cast("unsigned int") int flags, @Cast("size_t") long cd_nelmts, @Cast("const unsigned int*") IntPointer c_values)
\ingroup OCPL \brief Adds a filter to the filter pipeline \ocpl_id{plist_id}- Parameters:
filter- [in] Filter identifier for the filter to be added to the pipelineflags- [in] Bit vector specifying certain general properties of the filtercd_nelmts- [in] Number of elements in \p c_valuesc_values- [in] Auxiliary data for the filter- Returns:
- \herr_t
\details H5Pset_filter() adds the specified \p filter identifier and
corresponding properties to the end of an output filter
pipeline.
\p plist_id must be either a dataset creation property list or
group creation property list identifier. If \p plist_id is a
dataset creation property list identifier, the filter is added
to the raw data filter pipeline.
If \p plist_id is a group creation property list identifier,
the filter is added to the link filter pipeline, which filters
the fractal heap used to store most of the link metadata in
certain types of groups. The only predefined filters that can
be set in a group creation property list are the gzip filter
(#H5Z_FILTER_DEFLATE) and the Fletcher32 error detection filter
(#H5Z_FILTER_FLETCHER32).
The array \p c_values contains \p cd_nelmts integers which are
auxiliary data for the filter. The integer values will be
stored in the dataset object header as part of the filter
information.
The \p flags argument is a bit vector with the following
fields specifying certain general properties of the filter:
The \p filter parameter specifies the filter to be set. Valid pre-defined filter identifiers are as follows:#H5Z_FLAG_OPTIONAL If this bit is set then the filter is optional. If the filter fails (see below) during an H5Dwrite() operation then the filter is just excluded from the pipeline for the chunk for which it failed; the filter will not participate in the pipeline during an H5Dread() of the chunk. This is commonly used for compression filters: if the filter result would be larger than the input, then the compression filter returns failure and the uncompressed data is stored in the file.
This flag should not be set for the Fletcher32 checksum filter as it will bypass the checksum filter without reporting checksum errors to an application.#H5Z_FLAG_MANDATORY If the filter is required, that is, set to mandatory, and the filter fails, the libraryâs behavior depends on whether the chunk cache is in use: \li If the chunk cache is enabled, data chunks will be flushed to the file during H5Dclose() and the library will return the failure in H5Dclose(). \li When the chunk cache is disabled or not big enough, or the chunk is being evicted from the cache, the failure will happen during H5Dwrite(). In each case, the library will still write to the file all data chunks that were processed by the filter before the failure occurred.
For example, assume that an application creates a dataset of four chunks, the chunk cache is enabled and is big enough to hold all four chunks, and the filter fails when it tries to write the fourth chunk. The actual flush of the chunks will happen during H5Dclose(), not H5Dwrite(). By the time H5Dclose() fails, the first three chunks will have been written to the file. Even though H5Dclose() fails, all the resources will be released and the file can be closed properly.
If, however, the filter fails on the second chunk, only the first chunk will be written to the file as nothing further can be written once the filter fails.
Also see H5Pset_edc_check() and H5Pset_filter_callback(). \note When a non-empty filter pipeline is used with a group creation property list, the group will be created with the new group file format. The filters will come into play only when dense storage is used (see H5Pset_link_phase_change()) and will be applied to the groupâs fractal heap. The fractal heap will contain most of the the groupâs link metadata, including link names. \note When working with group creation property lists, if you are adding a filter that is not in HDF5âs set of predefined filters, i.e., a user-defined or third-party filter, you must first determine that the filter will work for a group. See the discussion of the set local and can apply callback functions in H5Zregister(). \note If multiple filters are set for a property list, they will be applied to each chunk of raw data for datasets or each block of the fractal heap for groups in the order in which they were set. \note Filters can be applied only to chunked datasets; they cannot be used with other dataset storage methods, such as contiguous, compact, or external datasets. \note Dataset elements of variable-length and dataset region reference datatypes are stored in separate structures in the file called heaps. Filters cannot currently be applied to these heaps. \note Filter Behavior in HDF5:#H5Z_FILTER_DEFLATE Data compression filter, employing the gzip algorithm #H5Z_FILTER_SHUFFLE Data shuffling filter #H5Z_FILTER_FLETCHER32 Error detection filter, employing the Fletcher32 checksum algorithm #H5Z_FILTER_SZIP Data compression filter, employing the SZIP algorithm #H5Z_FILTER_NBIT Data compression filter, employing the N-Bit algorithm #H5Z_FILTER_SCALEOFFSET Data compression filter, employing the scale-offset algorithm
Filters can be inserted into the HDF5 pipeline to perform functions such as compression and conversion. As such, they are a very flexible aspect of HDF5; for example, a user-defined filter could provide encryption for an HDF5 dataset. \note A filter can be declared as either required or optional. Required is the default status; optional status must be explicitly declared. \note A required filter that fails or is not defined causes an entire output operation to fail; if it was applied when the data was written, such a filter will cause an input operation to fail. \note The following table summarizes required filter behavior.
\note An optional filter can be set for an HDF5 dataset even when the filter is not available. Such a filter can then be applied to the dataset when it becomes available on the original system or when the file containing the dataset is processed on a system on which it is available. \note A filter can be declared as optional through the use of the #H5Z_FLAG_OPTIONAL flag with H5Pset_filter(). \note Consider a situation where one is creating files that will normally be used only on systems where the optional (and fictional) filter FILTER_Z is routinely available. One can create those files on system A, which lacks FILTER_Z, create chunked datasets in the files with FILTER_Z defined in the dataset creation property list, and even write data to those datasets. The dataset object header will indicate that FILTER_Z has been associated with this dataset. But since system A does not have FILTER_Z, dataset chunks will be written without it being applied. \note HDF5 has a mechanism for determining whether chunks are actually written with the filters specified in the object header, so while the filter remains unavailable, system A will be able to read the data. Once the file is moved to system B, where FILTER_Z is available, HDF5 will apply FILTER_Z to any data rewritten or new data written in these datasets. Dataset chunks that have been written on system B will then be unreadable on system A; chunks that have not been re-written since being written on system A will remain readable on system A. All chunks will be readable on system B. \note The following table summarizes optional filter behavior.Required FILTER_X not available FILTER_X available H5Pset_ Will fail. Will succeed. H5Dwrite with FILTER_X set Will fail. Will succeed; FILTER_X will be applied to the data. H5Dread with FILTER_X set Will fail. Will succeed.
\note The above principles apply generally in the use of HDF5 optional filters insofar as HDF5 does as much as possible to complete an operation when an optional filter is unavailable. (The SZIP filter is an exception to this rule; see H5Pset_szip() for details.)FILTER_Z not available FILTER_Z available
with encode and decodeFILTER_Z available decode only H5Pset_ Will succeed. Will succeed. Will succeed. H5Dread with FILTER_Z set Will succeed if FILTER_Z has not actually
been applied to data.Will succeed. Will succeed. H5Dwrite with FILTER_Z set Will succeed;
FILTER_Z will not be applied to the data.Will succeed;
FILTER_Z will be applied to the data.Will succeed;
FILTER_Z will not be applied to the data. - Since:
- 1.6.0
-
H5Pset_filter
@Cast("herr_t") public static int H5Pset_filter(@Cast("hid_t") long plist_id, @Cast("H5Z_filter_t") int filter, @Cast("unsigned int") int flags, @Cast("size_t") long cd_nelmts, @Cast("const unsigned int*") IntBuffer c_values)
-
H5Pset_filter
@Cast("herr_t") public static int H5Pset_filter(@Cast("hid_t") long plist_id, @Cast("H5Z_filter_t") int filter, @Cast("unsigned int") int flags, @Cast("size_t") long cd_nelmts, @Cast("const unsigned int*") int[] c_values)
-
H5Pset_fletcher32
@Cast("herr_t") public static int H5Pset_fletcher32(@Cast("hid_t") long plist_id)
\ingroup OCPL \brief Sets up use of the Fletcher32 checksum filter \ocpl_id{plist_id}- Returns:
- \herr_t \details H5Pset_fletcher32() sets the Fletcher32 checksum filter in the dataset or group creation property list \p plist_id. \attention The Fletcher32 EDC checksum filter was added in HDF5 Release 1.6.0. In the original implementation, however, the checksum value was calculated incorrectly on little-endian systems. The error was fixed in HDF5 Release 1.6.3. \attention As a result of this fix, an HDF5 library of Release 1.6.0 through Release 1.6.2 cannot read a dataset created or written with Release 1.6.3 or later if the dataset was created with the checksum filter and the filter is enabled in the reading library. (Libraries of Release 1.6.3 and later understand the earlier error and compensate appropriately.) \attention \b Work-around: An HDF5 library of Release 1.6.2 or earlier will be able to read a dataset created or written with the checksum filter by an HDF5 library of Release 1.6.3 or later if the checksum filter is disabled for the read operation. This can be accomplished via a call to H5Pset_edc_check() with the value #H5Z_DISABLE_EDC in the second parameter. This has the obvious drawback that the application will be unable to verify the checksum, but the data does remain accessible.
- Since:
- 1.6.0
-
H5Pset_obj_track_times
@Cast("herr_t") public static int H5Pset_obj_track_times(@Cast("hid_t") long plist_id, @Cast("hbool_t") boolean track_times)
\ingroup OCPL \brief Sets the recording of times associated with an object- Parameters:
plist_id- [in] Object creation property list identifiertrack_times- [in] Boolean value, 1 or 0, specifying whether object times are to be tracked- Returns:
- \herr_t \details H5Pset_obj_track_times() sets a property in the object creation property list, \p plist_id, that governs the recording of times associated with an object. If \p track_times is set to 1, time data will be recorded. If \p track_times is set to 0, time data will not be recorded. Time data can be retrieved with H5Oget_info(), which will return it in the #H5O_info_t struct. If times are not tracked, they will be reported as follows when queried: \Code{ 12:00 AM UDT, Jan. 1, 1970} That date and time are commonly used to represent the beginning of the UNIX epoch.
- Since:
- 1.8.0
-
H5Pget_file_space_page_size
@Cast("herr_t") public static int H5Pget_file_space_page_size(@Cast("hid_t") long plist_id, @Cast("hsize_t*") LongPointer fsp_size)
\ingroup FCPL \brief Retrieves the file space page size for a file creation property list \fcpl_id{plist_id}- Parameters:
fsp_size- [out] File space page size- Returns:
- \herr_t \details H5Pget_file_space_page_size() retrieves the file space page size for paged aggregation in the parameter \p fsp_size. The library default is 4KB (4096) if \p fsp_size is not previously set via a call to H5Pset_file_space_page_size().
- Since:
- 1.10.1
-
H5Pget_file_space_page_size
@Cast("herr_t") public static int H5Pget_file_space_page_size(@Cast("hid_t") long plist_id, @Cast("hsize_t*") LongBuffer fsp_size)
-
H5Pget_file_space_page_size
@Cast("herr_t") public static int H5Pget_file_space_page_size(@Cast("hid_t") long plist_id, @Cast("hsize_t*") long... fsp_size)
-
H5Pget_file_space_strategy
@Cast("herr_t") public static int H5Pget_file_space_strategy(@Cast("hid_t") long plist_id, @Cast("H5F_fspace_strategy_t*") IntPointer strategy, @Cast("hbool_t*") BoolPointer persist, @Cast("hsize_t*") LongPointer threshold)
\ingroup FCPL \brief Retrieves the file space handling strategy, persisting free-space condition and threshold value for a file creation property list \fcpl_id{plist_id}- Parameters:
strategy- [out] The file space handling strategypersist- [out] The boolean value indicating whether free space is persistent or notthreshold- [out] The free-space section size threshold value- Returns:
- \herr_t \details H5Pget_file_space_strategy() retrieves the file space handling strategy, the persisting free-space condition and the threshold value in the parameters \p strategy, \p persist and \p threshold respectively. The library default values returned when H5Pset_file_space_strategy() has not been called are: \li \p strategy - #H5F_FSPACE_STRATEGY_FSM_AGGR \li \p persist - 0 \li \p threshold - 1
- Since:
- 1.10.1
-
H5Pget_file_space_strategy
@Cast("herr_t") public static int H5Pget_file_space_strategy(@Cast("hid_t") long plist_id, @Cast("H5F_fspace_strategy_t*") IntBuffer strategy, @Cast("hbool_t*") boolean[] persist, @Cast("hsize_t*") LongBuffer threshold)
-
H5Pget_file_space_strategy
@Cast("herr_t") public static int H5Pget_file_space_strategy(@Cast("hid_t") long plist_id, @Cast("H5F_fspace_strategy_t*") int[] strategy, @Cast("hbool_t*") BoolPointer persist, @Cast("hsize_t*") long... threshold)
-
H5Pget_file_space_strategy
@Cast("herr_t") public static int H5Pget_file_space_strategy(@Cast("hid_t") long plist_id, @Cast("H5F_fspace_strategy_t*") IntPointer strategy, @Cast("hbool_t*") boolean[] persist, @Cast("hsize_t*") LongPointer threshold)
-
H5Pget_file_space_strategy
@Cast("herr_t") public static int H5Pget_file_space_strategy(@Cast("hid_t") long plist_id, @Cast("H5F_fspace_strategy_t*") IntBuffer strategy, @Cast("hbool_t*") BoolPointer persist, @Cast("hsize_t*") LongBuffer threshold)
-
H5Pget_file_space_strategy
@Cast("herr_t") public static int H5Pget_file_space_strategy(@Cast("hid_t") long plist_id, @Cast("H5F_fspace_strategy_t*") int[] strategy, @Cast("hbool_t*") boolean[] persist, @Cast("hsize_t*") long... threshold)
-
H5Pget_istore_k
@Cast("herr_t") public static int H5Pget_istore_k(@Cast("hid_t") long plist_id, @Cast("unsigned*") IntPointer ik)
\ingroup FCPL \brief Queries the 1/2 rank of an indexed storage B-tree \fcpl_id{plist_id}- Parameters:
ik- [out] Pointer to location to return the chunked storage B-tree 1/2 rank (Default value of B-tree 1/2 rank: 32)- Returns:
- \herr_t \details H5Pget_istore_k() queries the 1/2 rank of an indexed storage B-tree. The argument \p ik may be the null pointer (NULL). This function is valid only for file creation property lists.
- Since:
- 1.0.0
- See Also:
H5Pset_istore_k()
-
H5Pget_istore_k
@Cast("herr_t") public static int H5Pget_istore_k(@Cast("hid_t") long plist_id, @Cast("unsigned*") IntBuffer ik)
-
H5Pget_istore_k
@Cast("herr_t") public static int H5Pget_istore_k(@Cast("hid_t") long plist_id, @Cast("unsigned*") int[] ik)
-
H5Pget_shared_mesg_index
@Cast("herr_t") public static int H5Pget_shared_mesg_index(@Cast("hid_t") long plist_id, @Cast("unsigned") int index_num, @Cast("unsigned*") IntPointer mesg_type_flags, @Cast("unsigned*") IntPointer min_mesg_size)
\ingroup FCPL \brief Retrieves the configuration settings for a shared message index \fcpl_id{plist_id}- Parameters:
index_num- [in] Index being configuredmesg_type_flags- [out] Types of messages that may be stored in this indexmin_mesg_size- [out] Minimum message size- Returns:
- \herr_t \details H5Pget_shared_mesg_index() retrieves the message type and minimum message size settings from the file creation property list \p plist_id for the shared object header message index specified by \p index_num. \p index_num specifies the index. \p index_num is zero-indexed, so in a file with three indexes, they will be numbered 0, 1, and 2. \p mesg_type_flags and \p min_mesg_size will contain, respectively, the types of messages and the minimum size, in bytes, of messages that can be stored in this index. Valid message types are described in H5Pset_shared_mesg_index().
- Since:
- 1.8.0
-
H5Pget_shared_mesg_index
@Cast("herr_t") public static int H5Pget_shared_mesg_index(@Cast("hid_t") long plist_id, @Cast("unsigned") int index_num, @Cast("unsigned*") IntBuffer mesg_type_flags, @Cast("unsigned*") IntBuffer min_mesg_size)
-
H5Pget_shared_mesg_index
@Cast("herr_t") public static int H5Pget_shared_mesg_index(@Cast("hid_t") long plist_id, @Cast("unsigned") int index_num, @Cast("unsigned*") int[] mesg_type_flags, @Cast("unsigned*") int[] min_mesg_size)
-
H5Pget_shared_mesg_nindexes
@Cast("herr_t") public static int H5Pget_shared_mesg_nindexes(@Cast("hid_t") long plist_id, @Cast("unsigned*") IntPointer nindexes)
\ingroup FCPL \brief Retrieves the number of shared object header message indexes in file creation property list \fcpl_id{plist_id}- Parameters:
nindexes- [out] Number of shared object header message indexes available in files created with this property list- Returns:
- \herr_t \details H5Pget_shared_mesg_nindexes() retrieves the number of shared object header message indexes in the specified file creation property list \p plist_id. If the value of \p nindexes is 0 (zero), shared object header messages are disabled in files created with this property list.
- Since:
- 1.8.0
-
H5Pget_shared_mesg_nindexes
@Cast("herr_t") public static int H5Pget_shared_mesg_nindexes(@Cast("hid_t") long plist_id, @Cast("unsigned*") IntBuffer nindexes)
-
H5Pget_shared_mesg_nindexes
@Cast("herr_t") public static int H5Pget_shared_mesg_nindexes(@Cast("hid_t") long plist_id, @Cast("unsigned*") int[] nindexes)
-
H5Pget_shared_mesg_phase_change
@Cast("herr_t") public static int H5Pget_shared_mesg_phase_change(@Cast("hid_t") long plist_id, @Cast("unsigned*") IntPointer max_list, @Cast("unsigned*") IntPointer min_btree)
\ingroup FCPL \brief Retrieves shared object header message phase change information \fcpl_id{plist_id}- Parameters:
max_list- [out] Threshold above which storage of a shared object header message index shifts from list to B-treemin_btree- [out] Threshold below which storage of a shared object header message index reverts to list format- Returns:
- \herr_t \details H5Pget_shared_mesg_phase_change() retrieves the threshold values for storage of shared object header message indexes in a file. These phase change thresholds determine the point at which the index storage mechanism changes from a more compact list format to a more performance-oriented B-tree format, and vice-versa. By default, a shared object header message index is initially stored as a compact list. When the number of messages in an index exceeds the specified \p max_list threshold, storage switches to a B-tree format for improved performance. If the number of messages subsequently falls below the \p min_btree threshold, the index will revert to the list format. If \p max_list is set to 0 (zero), shared object header message indexes in the file will always be stored as B-trees. \p plist_id specifies the file creation property list.
- Since:
- 1.8.0
-
H5Pget_shared_mesg_phase_change
@Cast("herr_t") public static int H5Pget_shared_mesg_phase_change(@Cast("hid_t") long plist_id, @Cast("unsigned*") IntBuffer max_list, @Cast("unsigned*") IntBuffer min_btree)
-
H5Pget_shared_mesg_phase_change
@Cast("herr_t") public static int H5Pget_shared_mesg_phase_change(@Cast("hid_t") long plist_id, @Cast("unsigned*") int[] max_list, @Cast("unsigned*") int[] min_btree)
-
H5Pget_sizes
@Cast("herr_t") public static int H5Pget_sizes(@Cast("hid_t") long plist_id, @Cast("size_t*") SizeTPointer sizeof_addr, @Cast("size_t*") SizeTPointer sizeof_size)
\ingroup FCPL \brief Retrieves the size of the offsets and lengths used in an HDF5 file \fcpl_id{plist_id}- Parameters:
sizeof_addr- [out] Pointer to location to return offset size in bytessizeof_size- [out] Pointer to location to return length size in bytes- Returns:
- \herr_t \details H5Pget_sizes() retrieves the size of the offsets and lengths used in an HDF5 file. This function is only valid for file creation property lists.
- Since:
- 1.0.0
-
H5Pget_sym_k
@Cast("herr_t") public static int H5Pget_sym_k(@Cast("hid_t") long plist_id, @Cast("unsigned*") IntPointer ik, @Cast("unsigned*") IntPointer lk)
\ingroup FCPL \brief Retrieves the size of the symbol table B-tree 1/2 rank and the symbol table leaf node 1/2 size \fcpl_id{plist_id}- Parameters:
ik- [out] Pointer to location to return the symbol table's B-tree 1/2 rank (Default value of B-tree 1/2 rank: 16)lk- [out] Pointer to location to return the symbol table's leaf node 1/2 size (Default value of leaf node 1/2 size: 4)- Returns:
- \herr_t \details H5Pget_sym_k() retrieves the size of the symbol table B-tree 1/2 rank and the symbol table leaf node 1/2 size. This function is valid only for file creation property lists. If a parameter value is set to NULL, that parameter is not retrieved.
- Since:
- 1.0.0
- See Also:
H5Pset_sym_k()
-
H5Pget_sym_k
@Cast("herr_t") public static int H5Pget_sym_k(@Cast("hid_t") long plist_id, @Cast("unsigned*") IntBuffer ik, @Cast("unsigned*") IntBuffer lk)
-
H5Pget_sym_k
@Cast("herr_t") public static int H5Pget_sym_k(@Cast("hid_t") long plist_id, @Cast("unsigned*") int[] ik, @Cast("unsigned*") int[] lk)
-
H5Pget_userblock
@Cast("herr_t") public static int H5Pget_userblock(@Cast("hid_t") long plist_id, @Cast("hsize_t*") LongPointer size)
\ingroup FCPL \brief Retrieves the size of a user block \fcpl_id{plist_id}- Parameters:
size- [out] Pointer to location to return user-block size- Returns:
- \herr_t \details H5Pget_userblock() retrieves the size of a user block in a file creation property list.
- Since:
- 1.0.0
-
H5Pget_userblock
@Cast("herr_t") public static int H5Pget_userblock(@Cast("hid_t") long plist_id, @Cast("hsize_t*") LongBuffer size)
-
H5Pget_userblock
@Cast("herr_t") public static int H5Pget_userblock(@Cast("hid_t") long plist_id, @Cast("hsize_t*") long... size)
-
H5Pset_file_space_page_size
@Cast("herr_t") public static int H5Pset_file_space_page_size(@Cast("hid_t") long plist_id, @Cast("hsize_t") long fsp_size)
\ingroup FCPL \brief Sets the file space page size for a file creation property list \fcpl_id{plist_id}- Parameters:
fsp_size- [in] File space page size- Returns:
- \herr_t \details H5Pset_file_space_page_size() sets the file space page size \p fsp_size used in paged aggregation and paged buffering. \p fsp_size has a minimum size of 512. Setting a value less than 512 will return an error. The library default size for the file space page size when not set is 4096. The size set via this routine may not be changed for the life of the file.
- Since:
- 1.10.1
-
H5Pset_file_space_strategy
@Cast("herr_t") public static int H5Pset_file_space_strategy(@Cast("hid_t") long plist_id, @Cast("H5F_fspace_strategy_t") int strategy, @Cast("hbool_t") boolean persist, @Cast("hsize_t") long threshold)
\ingroup FCPL \brief Sets the file space handling strategy and persisting free-space values for a file creation property list \fcpl_id{plist_id}- Parameters:
strategy- [in] The file space handling strategy to be used. See: #H5F_fspace_strategy_tpersist- [in] A boolean value to indicate whether free space should be persistent or notthreshold- [in] The smallest free-space section size that the free space manager will track- Returns:
- \herr_t \details H5Pset_file_space_strategy() sets the file space handling \p strategy, specifies persisting free-space or not (\p persist), and sets the free-space section size \p threshold in the file creation property list \p plist_id. #H5F_fspace_strategy_t is a struct defined in H5Fpublic.h as follows: \snippet H5Fpublic.h H5F_fspace_strategy_t_snip This setting cannot be changed for the life of the file. As the #H5F_FSPACE_STRATEGY_AGGR and #H5F_FSPACE_STRATEGY_NONE strategies do not use the free-space managers, the \p persist and \p threshold settings will be ignored for those strategies.
- Since:
- 1.10.1
-
H5Pset_istore_k
@Cast("herr_t") public static int H5Pset_istore_k(@Cast("hid_t") long plist_id, @Cast("unsigned") int ik)
\ingroup FCPL \brief Sets the size of the parameter used to control the B-trees for indexing chunked datasets \fcpl_id{plist_id}- Parameters:
ik- [in] 1/2 rank of chunked storage B-tree- Returns:
- \herr_t \details H5Pset_istore_k() sets the size of the parameter used to control the B-trees for indexing chunked datasets. This function is valid only for file creation property lists. \p ik is one half the rank of a tree that stores chunked raw data. On average, such a tree will be 75% full, or have an average rank of 1.5 times the value of \p ik. The HDF5 library uses (\p ik*2) as the maximum # of entries before splitting a B-tree node. Since only 2 bytes are used in storing # of entries for a B-tree node in an HDF5 file, (\p ik*2) cannot exceed 65536. The default value for \p ik is 32.
- Since:
- 1.0.0
-
H5Pset_shared_mesg_index
@Cast("herr_t") public static int H5Pset_shared_mesg_index(@Cast("hid_t") long plist_id, @Cast("unsigned") int index_num, @Cast("unsigned") int mesg_type_flags, @Cast("unsigned") int min_mesg_size)
\ingroup FCPL \brief Configures the specified shared object header message index \fcpl_id{plist_id}- Parameters:
index_num- [in] Index being configuredmesg_type_flags- [in] Types of messages that should be stored in this indexmin_mesg_size- [in] Minimum message size- Returns:
- \herr_t
\details H5Pset_shared_mesg_index() is used to configure the specified
shared object header message index, setting the types of
messages that may be stored in the index and the minimum size
of each message.
\p plist_id specifies the file creation property list.
\p index_num specifies the index to be configured.
\p index_num is zero-indexed, so in a file with three indexes,
they will be numbered 0, 1, and 2.
\p mesg_type_flags and \p min_mesg_size specify, respectively,
the types and minimum size of messages that can be stored in
this index.
Valid message types are as follows:
#H5O_SHMESG_NONE_FLAG No shared messages #H5O_SHMESG_SDSPACE_FLAG Simple dataspace message #H5O_SHMESG_DTYPE_FLAG Datatype message #H5O_SHMESG_FILL_FLAG Fill value message #H5O_SHMESG_PLINE_FLAG Filter pipeline message #H5O_SHMESG_ATTR_FLAG Attribute message #H5O_SHMESG_ALL_FLAG All message types; i.e., equivalent to the following: (#H5O_SHMESG_SDSPACE_FLAG | #H5O_SHMESG_DTYPE_FLAG | #H5O_SHMESG_FILL_FLAG | #H5O_SHMESG_PLINE_FLAG | #H5O_SHMESG_ATTR_FLAG) - Since:
- 1.8.0
-
H5Pset_shared_mesg_nindexes
@Cast("herr_t") public static int H5Pset_shared_mesg_nindexes(@Cast("hid_t") long plist_id, @Cast("unsigned") int nindexes)
\ingroup FCPL \brief Sets number of shared object header message indexes \fcpl_id{plist_id}- Parameters:
nindexes- [in] Number of shared object header message indexes to be available in files created with this property list (\p nindexes must be <= #H5O_SHMESG_MAX_NINDEXES (8))- Returns:
- \herr_t \details H5Pset_shared_mesg_nindexes() sets the number of shared object header message indexes in the specified file creation property list. This setting determines the number of shared object header message indexes, \p nindexes, that will be available in files created with this property list. These indexes can then be configured with H5Pset_shared_mesg_index(). If \p nindexes is set to 0 (zero), shared object header messages are disabled in files created with this property list. There is a limit of #H5O_SHMESG_MAX_NINDEXES (8) that can be set with H5Pset_shared_mesg_nindexes(). An error will occur if specifying a value of \p nindexes that is greater than this value.
- Since:
- 1.8.0
-
H5Pset_shared_mesg_phase_change
@Cast("herr_t") public static int H5Pset_shared_mesg_phase_change(@Cast("hid_t") long plist_id, @Cast("unsigned") int max_list, @Cast("unsigned") int min_btree)
\ingroup FCPL \brief Sets shared object header message storage phase change thresholds \fcpl_id{plist_id}- Parameters:
max_list- [in] Threshold above which storage of a shared object header message index shifts from list to B-treemin_btree- [in] Threshold below which storage of a shared object header message index reverts to list format- Returns:
- \herr_t \details H5Pset_shared_mesg_phase_change() sets threshold values for storage of shared object header message indexes in a file. These phase change thresholds determine the point at which the index storage mechanism changes from a more compact list format to a more performance-oriented B-tree format, and vice-versa. By default, a shared object header message index is initially stored as a compact list. When the number of messages in an index exceeds the threshold value of \p max_list, storage switches to a B-tree for improved performance. If the number of messages subsequently falls below the \p min_btree threshold, the index will revert to the list format. If \p max_list is set to 0 (zero), shared object header message indexes in the file will be created as B-trees and will never revert to lists. \p plist_id specifies the file creation property list.
- Since:
- 1.8.0
-
H5Pset_sizes
@Cast("herr_t") public static int H5Pset_sizes(@Cast("hid_t") long plist_id, @Cast("size_t") long sizeof_addr, @Cast("size_t") long sizeof_size)
\ingroup FCPL \brief Sets the byte size of the offsets and lengths used to address objects in an HDF5 file \fcpl_id{plist_id}- Parameters:
sizeof_addr- [in] Size of an object offset in bytessizeof_size- [in] Size of an object length in bytes- Returns:
- \herr_t \details H5Pset_sizes() sets the byte size of the offsets and lengths used to address objects in an HDF5 file. This function is only valid for file creation property lists. Passing in a value of 0 for one of the parameters retains the current value. The default value for both values is the same as sizeof(hsize_t) in the library (normally 8 bytes). Valid values currently are 2, 4, 8 and 16.
- Since:
- 1.0.0
-
H5Pset_sym_k
@Cast("herr_t") public static int H5Pset_sym_k(@Cast("hid_t") long plist_id, @Cast("unsigned") int ik, @Cast("unsigned") int lk)
\ingroup FCPL \brief \fcpl_id{plist_id}- Parameters:
ik- [in] Symbol table tree ranklk- [in] Symbol table node size- Returns:
- \herr_t \details H5Pset_sym_k() sets the size of parameters used to control the symbol table nodes. This function is valid only for file creation property lists. Passing in a value of zero (0) for one of the parameters retains the current value. \p ik is one half the rank of a B-tree that stores a symbol table for a group. Internal nodes of the symbol table are on average 75% full. That is, the average rank of the tree is 1.5 times the value of \p ik. The HDF5 library uses (\p ik*2) as the maximum # of entries before splitting a B-tree node. Since only 2 bytes are used in storing # of entries for a B-tree node in an HDF5 file, (\p ik*2) cannot exceed 65536. The default value for \p ik is 16. \p lk is one half of the number of symbols that can be stored in a symbol table node. A symbol table node is the leaf of a symbol table tree which is used to store a group. When symbols are inserted randomly into a group, the group's symbol table nodes are 75% full on average. That is, they contain 1.5 times the number of symbols specified by \p lk. The default value for \p lk is 4.
- Since:
- 1.0.0
-
H5Pset_userblock
@Cast("herr_t") public static int H5Pset_userblock(@Cast("hid_t") long plist_id, @Cast("hsize_t") long size)
\ingroup FCPL \brief Sets user block size \fcpl_id{plist_id}- Parameters:
size- [in] Size of the user-block in bytes- Returns:
- \herr_t \details H5Pset_userblock() sets the user block size of a file creation property list. The default user block size is 0; it may be set to any power of 2 equal to 512 or greater (512, 1024, 2048, etc.).
- Since:
- 1.0.0
-
H5Pget_alignment
@Cast("herr_t") public static int H5Pget_alignment(@Cast("hid_t") long fapl_id, @Cast("hsize_t*") LongPointer threshold, @Cast("hsize_t*") LongPointer alignment)
\ingroup FAPL \brief Retrieves the current settings for alignment properties from a file access property list \fapl_id- Parameters:
threshold- [out] Pointer to location of return threshold valuealignment- [out] Pointer to location of return alignment value- Returns:
- \herr_t \details H5Pget_alignment() retrieves the current settings for alignment properties from a file access property list. The \p threshold and/or \p alignment pointers may be null pointers (NULL).
- Since:
- 1.0.0
-
H5Pget_alignment
@Cast("herr_t") public static int H5Pget_alignment(@Cast("hid_t") long fapl_id, @Cast("hsize_t*") LongBuffer threshold, @Cast("hsize_t*") LongBuffer alignment)
-
H5Pget_alignment
@Cast("herr_t") public static int H5Pget_alignment(@Cast("hid_t") long fapl_id, @Cast("hsize_t*") long[] threshold, @Cast("hsize_t*") long... alignment)
-
H5Pget_cache
@Cast("herr_t") public static int H5Pget_cache(@Cast("hid_t") long plist_id, IntPointer mdc_nelmts, @Cast("size_t*") SizeTPointer rdcc_nslots, @Cast("size_t*") SizeTPointer rdcc_nbytes, DoublePointer rdcc_w0)
\ingroup FAPL \brief Queries the raw data chunk cache parameters \fapl_id{plist_id}- Parameters:
mdc_nelmts- [in,out] No longer usedrdcc_nslots- [in,out] Number of elements (objects) in the raw data chunk cacherdcc_nbytes- [in,out] Total size of the raw data chunk cache, in bytesrdcc_w- [in,out] 0 Preemption policy- Returns:
- \herr_t \details H5Pget_cache() retrieves the maximum possible number of elements in the raw data chunk cache, the maximum possible number of bytes in the raw data chunk cache, and the preemption policy value. Any (or all) arguments may be null pointers, in which case the corresponding datum is not returned. Note that the \p mdc_nelmts parameter is no longer used.
- Since:
- 1.0.0
-
H5Pget_cache
@Cast("herr_t") public static int H5Pget_cache(@Cast("hid_t") long plist_id, IntBuffer mdc_nelmts, @Cast("size_t*") SizeTPointer rdcc_nslots, @Cast("size_t*") SizeTPointer rdcc_nbytes, DoubleBuffer rdcc_w0)
-
H5Pget_cache
@Cast("herr_t") public static int H5Pget_cache(@Cast("hid_t") long plist_id, int[] mdc_nelmts, @Cast("size_t*") SizeTPointer rdcc_nslots, @Cast("size_t*") SizeTPointer rdcc_nbytes, double[] rdcc_w0)
-
H5Pget_core_write_tracking
@Cast("herr_t") public static int H5Pget_core_write_tracking(@Cast("hid_t") long fapl_id, @Cast("hbool_t*") BoolPointer is_enabled, @Cast("size_t*") SizeTPointer page_size)
\ingroup FAPL \brief Gets information about the write tracking feature used by the core VFD \fapl_id- Parameters:
is_enabled- [out] Whether the feature is enabledpage_size- [out] Size, in bytes, of write aggregation pages- Returns:
- \herr_t \details H5Pget_core_write_tracking() retrieves information about the write tracking feature used by the core VFD. When a file is created or opened for writing using the core virtual file driver (VFD) with the backing store option turned on, the VFD can be configured to track changes to the file and only write out the modified bytes. To avoid a large number of small writes, the changes can be aggregated into pages of a user-specified size. The core VFD is also known as the memory VFD. The driver identifier is #H5FD_CORE. \note This function is only for use with the core VFD and must be used after the call to H5Pset_fapl_core(). It is an error to use this function with any other VFD. \note This function only applies to the backing store write operation which typically occurs when the file is flushed or closed. This function has no relationship to the increment parameter passed to H5Pset_fapl_core(). \note For optimum performance, the \p page_size parameter should be a power of two.
- Since:
- 1.8.13
-
H5Pget_core_write_tracking
@Cast("herr_t") public static int H5Pget_core_write_tracking(@Cast("hid_t") long fapl_id, @Cast("hbool_t*") boolean[] is_enabled, @Cast("size_t*") SizeTPointer page_size)
-
H5Pget_driver
@Cast("hid_t") public static long H5Pget_driver(@Cast("hid_t") long plist_id)
\ingroup FAPL \brief Returns low-lever driver identifier \plist_id- Returns:
- \hid_t{low level driver}
\details H5Pget_driver() returns the identifier of the low-level file
driver associated with the file access property list or
data transfer property list \p plist_id.
Valid driver identifiers distributed with HDF5 are listed and
described in the following table.
This list does not include custom drivers that might be defined and registered by a user. The returned driver identifier is only valid as long as the file driver remains registered.Driver Name Driver Identifier Description Related Function POSIX #H5FD_SEC2 This driver uses POSIX file-system functions like read and write to perform I/O to a single, permanent file on local disk with no system buffering. This driver is POSIX-compliant and is the default file driver for all systems. H5Pset_fapl_sec2() Direct #H5FD_DIRECT This is the #H5FD_SEC2 driver except data is written to or read from the file synchronously without being cached by the system. H5Pset_fapl_direct() Log #H5FD_LOG This is the #H5FD_SEC2 driver with logging capabilities. H5Pset_fapl_log() Windows #H5FD_WINDOWS This driver was modified in HDF5-1.8.8 to be a wrapper of the POSIX driver, #H5FD_SEC2. This change should not affect user applications. H5Pset_fapl_windows() STDIO #H5FD_STDIO This driver uses functions from the standard C stdio.h to perform I/O to a single, permanent file on local disk with additional system buffering. H5Pset_fapl_stdio() Memory #H5FD_CORE With this driver, an application can work with a file in memory for faster reads and writes. File contents are kept in memory until the file is closed. At closing, the memory version of the file can be written back to disk or abandoned. H5Pset_fapl_core() Family #H5FD_FAMILY With this driver, the HDF5 fileâs address space is partitioned into pieces and sent to separate storage files using an underlying driver of the userâs choice. This driver is for systems that do not support files larger than 2 gigabytes. H5Pset_fapl_family() Multi #H5FD_MULTI With this driver, data can be stored in multiple files according to the type of the data. I/O might work better if data is stored in separate files based on the type of data. The Split driver is a special case of this driver. H5Pset_fapl_multi() Parallel #H5FD_MPIO This is the standard HDF5 file driver for parallel file systems. This driver uses the MPI standard for both communication and file I/O. H5Pset_fapl_mpio() Parallel POSIX H5FD_MPIPOSIX This driver is no longer available. Stream H5FD_STREAM This driver is no longer available. - Since:
- 1.4.0
-
H5Pget_driver_info
@Const public static Pointer H5Pget_driver_info(@Cast("hid_t") long plist_id)
\ingroup FAPL \brief Returns a pointer to file driver information- Parameters:
plist_id- [in] File access or data transfer property list identifier- Returns:
- Returns a pointer to a struct containing low-level driver information. Otherwise returns NULL. NULL is also returned if no driver-specific properties have been registered. No error is pushed on the stack in this case. \details H5Pget_driver_info() returns a pointer to file driver-specific information for the low-level driver associated with the file access or data transfer property list \p plist_id. The pointer returned by this function points to an âuncopiedâ struct. Driver-specific versions of that struct are defined for each low-level driver in the relevant source code file H5FD*.c. For example, the struct used for the MULTI driver is \c H5FD_multi_fapl_t defined in H5FDmulti.c. If no driver-specific properties have been registered, H5Pget_driver_info() returns NULL. \note H5Pget_driver_info() and H5Pset_driver() are used only when creating a virtual file driver (VFD) in the virtual file layer (VFL).
-
H5Pget_driver_config_str
@Cast("ssize_t") public static long H5Pget_driver_config_str(@Cast("hid_t") long fapl_id, @Cast("char*") BytePointer config_buf, @Cast("size_t") long buf_size)
\ingroup FAPL \brief Retrieves a string representation of the configuration for the driver set on the given FAPL. The returned string can be used to configure the same driver in an identical way. \fapl_id- Parameters:
config_buf- [out] Driver configuration string output bufferbuf_size- [in] Size of driver configuration string output buffer- Returns:
- Returns the length of the driver configuration string on success (not including the NUL terminator). Returns negative on failure. \details H5Pget_driver_config_str() retrieves a string representation of the configuration for the driver set on the given FAPL. The returned string can be used to configure the same driver in an identical way. If \p config_buf is NULL, the length of the driver configuration string is simply returned. The caller can then allocate a buffer of the appropriate size and call this routine again.
-
H5Pget_driver_config_str
@Cast("ssize_t") public static long H5Pget_driver_config_str(@Cast("hid_t") long fapl_id, @Cast("char*") ByteBuffer config_buf, @Cast("size_t") long buf_size)
-
H5Pget_driver_config_str
@Cast("ssize_t") public static long H5Pget_driver_config_str(@Cast("hid_t") long fapl_id, @Cast("char*") byte[] config_buf, @Cast("size_t") long buf_size)
-
H5Pget_elink_file_cache_size
@Cast("herr_t") public static int H5Pget_elink_file_cache_size(@Cast("hid_t") long plist_id, @Cast("unsigned*") IntPointer efc_size)
\ingroup FAPL \brief Retrieves the size of the external link open file cache \fapl_id{plist_id}- Parameters:
efc_size- [out] External link open file cache size in number of files- Returns:
- \herr_t \details H5Pget_elink_file_cache_size() retrieves the number of files that can be held open in an external link open file cache.
- Since:
- 1.8.7
-
H5Pget_elink_file_cache_size
@Cast("herr_t") public static int H5Pget_elink_file_cache_size(@Cast("hid_t") long plist_id, @Cast("unsigned*") IntBuffer efc_size)
-
H5Pget_elink_file_cache_size
@Cast("herr_t") public static int H5Pget_elink_file_cache_size(@Cast("hid_t") long plist_id, @Cast("unsigned*") int[] efc_size)
-
H5Pget_evict_on_close
@Cast("herr_t") public static int H5Pget_evict_on_close(@Cast("hid_t") long fapl_id, @Cast("hbool_t*") BoolPointer evict_on_close)
\ingroup FAPL \brief Retrieves the file access property list setting that determines whether an HDF5 object will be evicted from the library's metadata cache when it is closed \fapl_id- Parameters:
evict_on_close- [out] Pointer to a variable that will indicate if the object will be evicted on close- Returns:
- \herr_t \details The library's metadata cache is fairly conservative about holding on to HDF5 object metadata (object headers, chunk index structures, etc.), which can cause the cache size to grow, resulting in memory pressure on an application or system. When enabled, the "evict on close" property will cause all metadata for an object to be immediately evicted from the cache as long as it is not referenced by any other open object. See H5Pset_evict_on_close() for additional notes on behavior.
- Since:
- 1.10.1
-
H5Pget_evict_on_close
@Cast("herr_t") public static int H5Pget_evict_on_close(@Cast("hid_t") long fapl_id, @Cast("hbool_t*") boolean[] evict_on_close)
-
H5Pget_family_offset
@Cast("herr_t") public static int H5Pget_family_offset(@Cast("hid_t") long fapl_id, @Cast("hsize_t*") LongPointer offset)
\ingroup FAPL \brief Retrieves a data offset from the file access property list \fapl_id- Parameters:
offset- [out] Offset in bytes within the HDF5 file- Returns:
- \herr_t \details H5Pget_family_offset() retrieves the value of offset from the file access property list \p fapl_id so that the user application can retrieve a file handle for low-level access to a particular member of a family of files. The file handle is retrieved with a separate call to H5Fget_vfd_handle() (or, in special circumstances, to H5FDget_vfd_handle(), see \ref VFL).
- Since:
- 1.6.0
-
H5Pget_family_offset
@Cast("herr_t") public static int H5Pget_family_offset(@Cast("hid_t") long fapl_id, @Cast("hsize_t*") LongBuffer offset)
-
H5Pget_family_offset
@Cast("herr_t") public static int H5Pget_family_offset(@Cast("hid_t") long fapl_id, @Cast("hsize_t*") long... offset)
-
H5Pget_fclose_degree
@Cast("herr_t") public static int H5Pget_fclose_degree(@Cast("hid_t") long fapl_id, @Cast("H5F_close_degree_t*") IntPointer degree)
\ingroup FAPL \brief Returns the file close degree \fapl_id- Parameters:
degree- [out] Pointer to a location to which to return the file close degree property, the value of \p degree- Returns:
- \herr_t \details H5Pget_fclose_degree() returns the current setting of the file close degree property \p degree in the file access property list \p fapl_id. The value of \p degree determines how aggressively H5Fclose() deals with objects within a file that remain open when H5Fclose() is called to close that file.
- Since:
- 1.6.0
-
H5Pget_fclose_degree
@Cast("herr_t") public static int H5Pget_fclose_degree(@Cast("hid_t") long fapl_id, @Cast("H5F_close_degree_t*") IntBuffer degree)
-
H5Pget_fclose_degree
@Cast("herr_t") public static int H5Pget_fclose_degree(@Cast("hid_t") long fapl_id, @Cast("H5F_close_degree_t*") int[] degree)
-
H5Pget_file_image
@Cast("herr_t") public static int H5Pget_file_image(@Cast("hid_t") long fapl_id, @Cast("void**") PointerPointer buf_ptr_ptr, @Cast("size_t*") SizeTPointer buf_len_ptr)
\ingroup FAPL \brief Retrieves a copy of the file image designated as the initial content and structure of a file \fapl_id- Parameters:
buf_ptr_ptr- [in,out] On input, \c NULL or a pointer to a pointer to a buffer that contains the file image.\n On successful return, if \p buf_ptr_ptr is not \c NULL, \Code{*buf_ptr_ptr} will contain a pointer to a copy of the initial image provided in the last call to H5Pset_file_image() for the supplied \p fapl_id. If no initial image has been set, \Code{*buf_ptr_ptr} will be \c NULL.buf_len_ptr- [in,out] On input, \c NULL or a pointer to a buffer specifying the required size of the buffer to hold the file image.\n On successful return, if \p buf_len_ptr was not passed in as \c NULL, \p buf_len_ptr will return the required size in bytes of the buffer to hold the initial file image in the supplied file access property list, \p fapl_id. If no initial image is set, the value of \Code{*buf_len_ptr} will be set to 0 (zero)- Returns:
- \herr_t \details H5Pget_file_image() allows an application to retrieve a copy of the file image designated for a VFD to use as the initial contents of a file. If file image callbacks are defined, H5Pget_file_image() will use them when allocating and loading the buffer to return to the application (see H5Pset_file_image_callbacks()). If file image callbacks are not defined, the function will use \c malloc and \c memcpy. When \c malloc and \c memcpy are used, it is the callerâs responsibility to discard the returned buffer with a call to \c free. It is the responsibility of the calling application to free the buffer whose address is returned in \p buf_ptr_ptr. This can be accomplished with \c free if file image callbacks have not been set (see H5Pset_file_image_callbacks()) or with the appropriate method if file image callbacks have been set.
- Since:
- 1.8.9
-
H5Pget_file_image
@Cast("herr_t") public static int H5Pget_file_image(@Cast("hid_t") long fapl_id, @Cast("void**") @ByPtrPtr Pointer buf_ptr_ptr, @Cast("size_t*") SizeTPointer buf_len_ptr)
-
H5Pget_file_image_callbacks
@Cast("herr_t") public static int H5Pget_file_image_callbacks(@Cast("hid_t") long fapl_id, H5FD_file_image_callbacks_t callbacks_ptr)
\ingroup FAPL \brief Retrieves callback routines for working with file images \fapl_id- Parameters:
callbacks_ptr- [in,out] Pointer to the instance of the #H5FD_file_image_callbacks_t struct in which the callback routines are to be returned\n Struct fields must be initialized to NULL before the call is made.\n Struct field contents upon return will match those passed in in the last H5Pset_file_image_callbacks() call for the file access property list \p fapl_id.- Returns:
- \herr_t \details H5Pget_file_image_callbacks() retrieves the callback routines set for working with file images opened with the file access property list \p fapl_id. The callbacks must have been previously set with H5Pset_file_image_callbacks() in the file access property list. Upon the successful return of H5Pset_file_image_callbacks(), the fields in the instance of the #H5FD_file_image_callbacks_t struct pointed to by \p callbacks_ptr will contain the same values as were passed in the most recent H5Pset_file_image_callbacks() call for the file access property list \p fapl_id.
- Since:
- 1.8.9
-
H5Pget_file_locking
@Cast("herr_t") public static int H5Pget_file_locking(@Cast("hid_t") long fapl_id, @Cast("hbool_t*") BoolPointer use_file_locking, @Cast("hbool_t*") BoolPointer ignore_when_disabled)
\ingroup FAPL \brief Retrieves the file locking property values \fapl_id- Parameters:
use_file_locking- [out] File locking flagignore_when_disabled- [out] Ignore when disabled flag- Returns:
- \herr_t \details H5Pget_file_locking() retrieves the file locking property values for the file access property list specified by \p fapl_id.
- Since:
- 1.10.7
-
H5Pget_file_locking
@Cast("herr_t") public static int H5Pget_file_locking(@Cast("hid_t") long fapl_id, @Cast("hbool_t*") boolean[] use_file_locking, @Cast("hbool_t*") boolean[] ignore_when_disabled)
-
H5Pget_gc_references
@Cast("herr_t") public static int H5Pget_gc_references(@Cast("hid_t") long fapl_id, @Cast("unsigned*") IntPointer gc_ref)
\ingroup FAPL \brief Returns garbage collecting references setting \fapl_id- Parameters:
gc_ref- [out] Flag returning the state of reference garbage collection. A returned value of 1 indicates that garbage collection is on while 0 indicates that garbage collection is off.- Returns:
- \herr_t \details H5Pget_gc_references() returns the current setting for the garbage collection references property from the specified file access property list. The garbage collection references property is set by H5Pset_gc_references().
- Since:
- 1.2.0
-
H5Pget_gc_references
@Cast("herr_t") public static int H5Pget_gc_references(@Cast("hid_t") long fapl_id, @Cast("unsigned*") IntBuffer gc_ref)
-
H5Pget_gc_references
@Cast("herr_t") public static int H5Pget_gc_references(@Cast("hid_t") long fapl_id, @Cast("unsigned*") int[] gc_ref)
-
H5Pget_libver_bounds
@Cast("herr_t") public static int H5Pget_libver_bounds(@Cast("hid_t") long plist_id, @Cast("H5F_libver_t*") IntPointer low, @Cast("H5F_libver_t*") IntPointer high)
\ingroup FAPL \brief Retrieves library version bounds settings that indirectly control the format versions used when creating objects \fapl_id{plist_id}- Parameters:
low- [out] The earliest version of the library that will be used for writing objectshigh- [out] The latest version of the library that will be used for writing objects- Returns:
- \herr_t \details H5Pget_libver_bounds() retrieves the lower and upper bounds on the HDF5 library release versions that indirectly determine the object format versions used when creating objects in the file. This property is retrieved from the file access property list specified by the parameter \p fapl_id. The value returned in the parameters \p low and \p high is one of the enumerated values in the #H5F_libver_t struct, which is defined in H5Fpublic.h.
- Since:
- 1.8.0
-
H5Pget_libver_bounds
@Cast("herr_t") public static int H5Pget_libver_bounds(@Cast("hid_t") long plist_id, @Cast("H5F_libver_t*") IntBuffer low, @Cast("H5F_libver_t*") IntBuffer high)
-
H5Pget_libver_bounds
@Cast("herr_t") public static int H5Pget_libver_bounds(@Cast("hid_t") long plist_id, @Cast("H5F_libver_t*") int[] low, @Cast("H5F_libver_t*") int[] high)
-
H5Pget_mdc_config
@Cast("herr_t") public static int H5Pget_mdc_config(@Cast("hid_t") long plist_id, H5AC_cache_config_t config_ptr)
\ingroup FAPL \brief Get the current initial metadata cache configuration from the provided file access property list \fapl_id{plist_id}- Parameters:
config_ptr- [in,out] Pointer to the instance of #H5AC_cache_config_t in which the current metadata cache configuration is to be reported- Returns:
- \herr_t \note The \c in direction applies only to the \ref H5AC_cache_config_t.version field. All other fields are \c out parameters. \details The fields of the #H5AC_cache_config_t structure are shown below: \snippet H5ACpublic.h H5AC_cache_config_t_snip \click4more H5Pget_mdc_config() gets the initial metadata cache configuration contained in a file access property list and loads it into the instance of #H5AC_cache_config_t pointed to by the \p config_ptr parameter. This configuration is used when the file is opened. Note that the version field of \Code{*config_ptr} must be initialized; this allows the library to support earlier versions of the #H5AC_cache_config_t structure. See the overview of the metadata cache in the special topics section of the user guide for details on the configuration data returned. If you haven't read and understood that documentation, the results of this call will not make much sense.
- Since:
- 1.8.0
-
H5Pget_mdc_image_config
@Cast("herr_t") public static int H5Pget_mdc_image_config(@Cast("hid_t") long plist_id, H5AC_cache_image_config_t config_ptr)
\ingroup FAPL \brief Retrieves the metadata cache image configuration values for a file access property list \fapl_id{plist_id}- Parameters:
config_ptr- [out] Pointer to metadata cache image configuration values- Returns:
- \herr_t \details H5Pget_mdc_image_config() retrieves the metadata cache image values into \p config_ptr for the file access property list specified in \p plist_id. #H5AC_cache_image_config_t is defined as follows: \snippet H5ACpublic.h H5AC_cache_image_config_t_snip \click4more
- Since:
- 1.10.1
-
H5Pget_mdc_log_options
@Cast("herr_t") public static int H5Pget_mdc_log_options(@Cast("hid_t") long plist_id, @Cast("hbool_t*") BoolPointer is_enabled, @Cast("char*") BytePointer location, @Cast("size_t*") SizeTPointer location_size, @Cast("hbool_t*") BoolPointer start_on_access)
\ingroup FAPL \brief Gets metadata cache logging options \fapl_id{plist_id}- Parameters:
is_enabled- [out] Flag whether logging is enabledlocation- [out] Location of log in UTF-8/ASCII (file path/name) (On Windows, this must be ASCII)location_size- [out] Size in bytes of the location stringstart_on_access- [out] Whether the logging begins as soon as the file is opened or created- Returns:
- \herr_t \details The metadata cache is a central part of the HDF5 library through which all file metadata reads and writes take place. File metadata is normally invisible to the user and is used by the library for purposes such as locating and indexing data. File metadata should not be confused with user metadata, which consists of attributes created by users and attached to HDF5 objects such as datasets via \ref H5A API calls. Due to the complexity of the cache, a trace/logging feature has been created that can be used by HDF5 developers for debugging and performance analysis. The functions that control this functionality will normally be of use to a very limited number of developers outside of The HDF Group. The functions have been documented to help users create logs that can be sent with bug reports. Control of the log functionality is straightforward. Logging is enabled via the H5Pset_mdc_log_options() function, which will modify the file access property list used to open or create a file. This function has a flag that determines whether logging begins at file open or starts in a paused state. Log messages can then be controlled via the H5Fstart_mdc_logging() / H5Fstop_mdc_logging() functions. H5Pget_mdc_log_options() can be used to examine a file access property list, and H5Fget_mdc_logging_status() will return the current state of the logging flags. The log format is described in the Metadata Cache Logging document.
- Since:
- 1.10.0
-
H5Pget_mdc_log_options
@Cast("herr_t") public static int H5Pget_mdc_log_options(@Cast("hid_t") long plist_id, @Cast("hbool_t*") boolean[] is_enabled, @Cast("char*") ByteBuffer location, @Cast("size_t*") SizeTPointer location_size, @Cast("hbool_t*") boolean[] start_on_access)
-
H5Pget_mdc_log_options
@Cast("herr_t") public static int H5Pget_mdc_log_options(@Cast("hid_t") long plist_id, @Cast("hbool_t*") BoolPointer is_enabled, @Cast("char*") byte[] location, @Cast("size_t*") SizeTPointer location_size, @Cast("hbool_t*") BoolPointer start_on_access)
-
H5Pget_mdc_log_options
@Cast("herr_t") public static int H5Pget_mdc_log_options(@Cast("hid_t") long plist_id, @Cast("hbool_t*") boolean[] is_enabled, @Cast("char*") BytePointer location, @Cast("size_t*") SizeTPointer location_size, @Cast("hbool_t*") boolean[] start_on_access)
-
H5Pget_mdc_log_options
@Cast("herr_t") public static int H5Pget_mdc_log_options(@Cast("hid_t") long plist_id, @Cast("hbool_t*") BoolPointer is_enabled, @Cast("char*") ByteBuffer location, @Cast("size_t*") SizeTPointer location_size, @Cast("hbool_t*") BoolPointer start_on_access)
-
H5Pget_mdc_log_options
@Cast("herr_t") public static int H5Pget_mdc_log_options(@Cast("hid_t") long plist_id, @Cast("hbool_t*") boolean[] is_enabled, @Cast("char*") byte[] location, @Cast("size_t*") SizeTPointer location_size, @Cast("hbool_t*") boolean[] start_on_access)
-
H5Pget_meta_block_size
@Cast("herr_t") public static int H5Pget_meta_block_size(@Cast("hid_t") long fapl_id, @Cast("hsize_t*") LongPointer size)
\ingroup FAPL \brief Returns the current metadata block size setting \fapl_id{fapl_id}- Parameters:
size- [out] Minimum size, in bytes, of metadata block allocations- Returns:
- \herr_t \details Returns the current minimum size, in bytes, of new metadata block allocations. This setting is retrieved from the file access property list \p fapl_id. This value is set by H5Pset_meta_block_size() and is retrieved from the file access property list \p fapl_id.
- Since:
- 1.4.0
-
H5Pget_meta_block_size
@Cast("herr_t") public static int H5Pget_meta_block_size(@Cast("hid_t") long fapl_id, @Cast("hsize_t*") LongBuffer size)
-
H5Pget_meta_block_size
@Cast("herr_t") public static int H5Pget_meta_block_size(@Cast("hid_t") long fapl_id, @Cast("hsize_t*") long... size)
-
H5Pget_metadata_read_attempts
@Cast("herr_t") public static int H5Pget_metadata_read_attempts(@Cast("hid_t") long plist_id, @Cast("unsigned*") IntPointer attempts)
\ingroup FAPL \brief Retrieves the number of read attempts from a file access property list \fapl_id{plist_id}- Parameters:
attempts- [out] The number of read attempts- Returns:
- \herr_t
\details H5Pget_metadata_read_attempts() retrieves the number of read
attempts that is set in the file access property list \p plist_id.
For a default file access property list, the value retrieved
will depend on whether the user sets the number of attempts via
H5Pset_metadata_read_attempts():
- If the number of attempts is set to N, the value returned will be N.
- If the number of attempts is not set, the value returned will be the default for non-SWMR access (1). SWMR is short for single-writer/multiple-reader.
- For a file opened with SWMR access:
- If the number of attempts is set to N, the value returned will be N.
- If the number of attempts is not set, the value returned will be the default for SWMR access (100).
- For a file opened without SWMR access, the value retrieved will always be the default for non-SWMR access (1). The value set via H5Pset_metadata_read_attempts() does not have any effect on non-SWMR access.
- Since:
- 1.10.0
-
H5Pget_metadata_read_attempts
@Cast("herr_t") public static int H5Pget_metadata_read_attempts(@Cast("hid_t") long plist_id, @Cast("unsigned*") IntBuffer attempts)
-
H5Pget_metadata_read_attempts
@Cast("herr_t") public static int H5Pget_metadata_read_attempts(@Cast("hid_t") long plist_id, @Cast("unsigned*") int[] attempts)
-
H5Pget_multi_type
@Cast("herr_t") public static int H5Pget_multi_type(@Cast("hid_t") long fapl_id, @Cast("H5FD_mem_t*") IntPointer type)
\ingroup FAPL \brief Retrieves type of data property for MULTI driver- Parameters:
fapl_id- [in] File access property list or data transfer property list identifiertype- [out] Type of data- Returns:
- \herr_t \details H5Pget_multi_type() retrieves the type of data setting from the file access or data transfer property list \p fapl_id. This enables a user application to specify the type of data the application wishes to access so that the application can retrieve a file handle for low-level access to the particular member of a set of MULTI files in which that type of data is stored. The file handle is retrieved with a separate call to H5Fget_vfd_handle() (or, in special circumstances, to H5FDget_vfd_handle(); see the Virtual File Layer documentation for more information. The type of data returned in \p type will be one of those listed in the discussion of the \p type parameter in the the description of the function H5Pset_multi_type(). Use of this function is only appropriate for an HDF5 file written as a set of files with the MULTI file driver.
- Since:
- 1.6.0
-
H5Pget_multi_type
@Cast("herr_t") public static int H5Pget_multi_type(@Cast("hid_t") long fapl_id, @Cast("H5FD_mem_t*") IntBuffer type)
-
H5Pget_multi_type
@Cast("herr_t") public static int H5Pget_multi_type(@Cast("hid_t") long fapl_id, @Cast("H5FD_mem_t*") int[] type)
-
H5Pget_object_flush_cb
@Cast("herr_t") public static int H5Pget_object_flush_cb(@Cast("hid_t") long plist_id, @ByPtrPtr H5F_flush_cb_t func, @Cast("void**") PointerPointer udata)
\ingroup FAPL \brief Retrieves the object flush property values from the file access property list \fapl_id{plist_id}- Parameters:
func- [in] The user-defined callback functionudata- [in] The user-defined input data for the callback function- Returns:
- \herr_t \details H5Pget_object_flush_cb() gets the user-defined callback function that is set in the file access property list \p fapl_id and stored in the parameter \p func. The callback is invoked whenever an object flush occurs in the file. This routine also obtains the user-defined input data that is passed along to the callback function in the parameter \p udata. \par Example \parblock The example below illustrates the usage of this routine to obtain the object flush property values. \include H5Pget_object_flush_cb.c \endparblock
- Since:
- 1.10.0
-
H5Pget_object_flush_cb
@Cast("herr_t") public static int H5Pget_object_flush_cb(@Cast("hid_t") long plist_id, @ByPtrPtr H5F_flush_cb_t func, @Cast("void**") @ByPtrPtr Pointer udata)
-
H5Pget_page_buffer_size
@Cast("herr_t") public static int H5Pget_page_buffer_size(@Cast("hid_t") long plist_id, @Cast("size_t*") SizeTPointer buf_size, @Cast("unsigned*") IntPointer min_meta_perc, @Cast("unsigned*") IntPointer min_raw_perc)
\ingroup FAPL \brief Retrieves the maximum size for the page buffer and the minimum percentage for metadata and raw data pages \fapl_id{plist_id}- Parameters:
buf_size- [out] Maximum size, in bytes, of the page buffermin_meta_perc- [out] Minimum metadata percentage to keep in the page buffer before allowing pages containing metadata to be evictedmin_raw_perc- [out] Minimum raw data percentage to keep in the page buffer before allowing pages containing raw data to be evicted- Returns:
- \herr_t \details H5Pget_page_buffer_size() retrieves \p buf_size, the maximum size in bytes of the page buffer, \p min_meta_perc, the minimum metadata percentage, and \p min_raw_perc, the minimum raw data percentage.
- Since:
- 1.10.1
-
H5Pget_page_buffer_size
@Cast("herr_t") public static int H5Pget_page_buffer_size(@Cast("hid_t") long plist_id, @Cast("size_t*") SizeTPointer buf_size, @Cast("unsigned*") IntBuffer min_meta_perc, @Cast("unsigned*") IntBuffer min_raw_perc)
-
H5Pget_page_buffer_size
@Cast("herr_t") public static int H5Pget_page_buffer_size(@Cast("hid_t") long plist_id, @Cast("size_t*") SizeTPointer buf_size, @Cast("unsigned*") int[] min_meta_perc, @Cast("unsigned*") int[] min_raw_perc)
-
H5Pget_sieve_buf_size
@Cast("herr_t") public static int H5Pget_sieve_buf_size(@Cast("hid_t") long fapl_id, @Cast("size_t*") SizeTPointer size)
\ingroup FAPL \brief Returns maximum data sieve buffer size \fapl_id{fapl_id}- Parameters:
size- [in] Maximum size, in bytes, of data sieve buffer- Returns:
- \herr_t \details H5Pget_sieve_buf_size() retrieves, size, the current maximum size of the data sieve buffer. This value is set by H5Pset_sieve_buf_size() and is retrieved from the file access property list fapl_id.
- Since:
- 1.4.0
-
H5Pget_small_data_block_size
@Cast("herr_t") public static int H5Pget_small_data_block_size(@Cast("hid_t") long fapl_id, @Cast("hsize_t*") LongPointer size)
\ingroup FAPL \brief Retrieves the current small data block size setting \fapl_id{fapl_id}- Parameters:
size- [out] Maximum size, in bytes, of the small data block- Returns:
- \herr_t \details H5Pget_small_data_block_size() retrieves the current setting for the size of the small data block. If the returned value is zero (0), the small data block mechanism has been disabled for the file.
- Since:
- 1.4.4
-
H5Pget_small_data_block_size
@Cast("herr_t") public static int H5Pget_small_data_block_size(@Cast("hid_t") long fapl_id, @Cast("hsize_t*") LongBuffer size)
-
H5Pget_small_data_block_size
@Cast("herr_t") public static int H5Pget_small_data_block_size(@Cast("hid_t") long fapl_id, @Cast("hsize_t*") long... size)
-
H5Pget_vol_id
@Cast("herr_t") public static int H5Pget_vol_id(@Cast("hid_t") long plist_id, @Cast("hid_t*") LongPointer vol_id)
\ingroup FAPL \brief Returns the identifier of the current VOL connector \fapl_id{plist_id}- Parameters:
vol_id- [out] Current VOL connector identifier- Returns:
- \herr_t \details H5Pget_vol_id() returns the VOL connector identifier \p vol_id for the file access property list \p plist_id. This identifier should be closed with H5VLclose().
- Since:
- 1.12.0
-
H5Pget_vol_id
@Cast("herr_t") public static int H5Pget_vol_id(@Cast("hid_t") long plist_id, @Cast("hid_t*") LongBuffer vol_id)
-
H5Pget_vol_id
@Cast("herr_t") public static int H5Pget_vol_id(@Cast("hid_t") long plist_id, @Cast("hid_t*") long... vol_id)
-
H5Pget_vol_info
@Cast("herr_t") public static int H5Pget_vol_info(@Cast("hid_t") long plist_id, @Cast("void**") PointerPointer vol_info)
\ingroup FAPL \brief Returns a copy of the VOL information for a connector \fapl_id{plist_id}- Parameters:
vol_info- [out] The VOL information for a connector- Returns:
- \herr_t \details H5Pget_vol_info() returns a copy of the VOL information \p vol_info for a connector specified by the file access property list \p plist_id.
- Since:
- 1.12.0
-
H5Pget_vol_info
@Cast("herr_t") public static int H5Pget_vol_info(@Cast("hid_t") long plist_id, @Cast("void**") @ByPtrPtr Pointer vol_info)
-
H5Pset_alignment
@Cast("herr_t") public static int H5Pset_alignment(@Cast("hid_t") long fapl_id, @Cast("hsize_t") long threshold, @Cast("hsize_t") long alignment)
\ingroup FAPL \brief Sets alignment properties of a file access property list \fapl_id- Parameters:
threshold- [in] Threshold value. Note that setting the threshold value to 0 (zero) has the effect of a special case, forcing everything to be alignedalignment- [in] Alignment value- Returns:
- \herr_t \details H5Pset_alignment() sets the alignment properties of a file access property list so that any file object greater than or equal in size to \p threshold bytes will be aligned on an address which is a multiple of \p alignment. The addresses are relative to the end of the user block; the alignment is calculated by subtracting the user block size from the absolute file address and then adjusting the address to be a multiple of \p alignment. Default values for \p threshold and \p alignment are one, implying no alignment. Generally the default values will result in the best performance for single-process access to the file. For MPI IO and other parallel systems, choose an alignment which is a multiple of the disk block size. If the file space handling strategy is set to #H5F_FSPACE_STRATEGY_PAGE, then the alignment set via this routine is ignored. The file space handling strategy is set by H5Pset_file_space_strategy().
- Since:
- 1.0.0
-
H5Pset_cache
@Cast("herr_t") public static int H5Pset_cache(@Cast("hid_t") long plist_id, int mdc_nelmts, @Cast("size_t") long rdcc_nslots, @Cast("size_t") long rdcc_nbytes, double rdcc_w0)
\ingroup FAPL \brief Sets the raw data chunk cache parameters \fapl_id{plist_id}- Parameters:
mdc_nelmts- [in] No longer used; any value passed is ignoredrdcc_nslots- [in] The number of chunk slots in the raw data chunk cache for this dataset. Increasing this value reduces the number of cache collisions, but slightly increases the memory used. Due to the hashing strategy, this value should ideally be a prime number. As a rule of thumb, this value should be at least 10 times the number of chunks that can fit in \p rdcc_nbytes bytes. For maximum performance, this value should be set approximately 100 times that number of chunks. The default value is 521.rdcc_nbytes- [in] Total size of the raw data chunk cache in bytes. The default size is 1 MB per dataset.rdcc_w- [in] 0 The chunk preemption policy for all datasets. This must be between 0 and 1 inclusive and indicates the weighting according to which chunks which have been fully read or written are penalized when determining which chunks to flush from cache. A value of 0 means fully read or written chunks are treated no differently than other chunks (the preemption is strictly LRU) while a value of 1 means fully read or written chunks are always preempted before other chunks. If your application only reads or writes data once, this can be safely set to 1. Otherwise, this should be set lower depending on how often you re-read or re-write the same data. The default value is 0.75. If the value passed is #H5D_CHUNK_CACHE_W0_DEFAULT, then the property will not be set on the dataset access property list, and the parameter will come from the file access property list.- Returns:
- \herr_t \details H5Pset_cache() sets the number of elements, the total number of bytes, and the preemption policy value for all datasets in a file on the fileâs file access property list. The raw data chunk cache inserts chunks into the cache by first computing a hash value using the address of a chunk and then by using that hash value as the chunkâs index into the table of cached chunks. In other words, the size of this hash table and the number of possible hash values is determined by the \p rdcc_nslots parameter. If a different chunk in the cache has the same hash value, a collision will occur, which will reduce efficiency. If inserting the chunk into the cache would cause the cache to be too big, then the cache will be pruned according to the \p rdcc_w0 parameter. The \p mdc_nelmts parameter is no longer used; any value passed in that parameter will be ignored. \b Motivation: Setting raw data chunk cache parameters can be done with H5Pset_cache(), H5Pset_chunk_cache(), or a combination of both. H5Pset_cache() is used to adjust the chunk cache parameters for all datasets via a global setting for the file, and H5Pset_chunk_cache() is used to adjust the chunk cache parameters for individual datasets. When both are used, parameters set with H5Pset_chunk_cache() will override any parameters set with H5Pset_cache(). \note Optimum chunk cache parameters may vary widely depending on different data layout and access patterns. For datasets with low performance requirements for example, changing the cache settings can save memory. \note Note: Raw dataset chunk caching is not currently supported when using the MPI I/O and MPI POSIX file drivers in read/write mode; see H5Pset_fapl_mpio(). When using this file driver, all calls to H5Dread() and H5Dwrite() will access the disk directly, and H5Pset_cache() will have no effect on performance. \note Raw dataset chunk caching is supported when these drivers are used in read-only mode.
- Since:
- 1.0.0
-
H5Pset_core_write_tracking
@Cast("herr_t") public static int H5Pset_core_write_tracking(@Cast("hid_t") long fapl_id, @Cast("hbool_t") boolean is_enabled, @Cast("size_t") long page_size)
\ingroup FAPL \brief Sets write tracking information for core driver, #H5FD_CORE \fapl_id{fapl_id}- Parameters:
is_enabled- [in] Boolean value specifying whether feature is enabledpage_size- [in] Positive integer specifying size, in bytes, of write aggregation pages Value of 1 (one) enables tracking with no paging.- Returns:
- \herr_t \details When a file is created or opened for writing using the core virtual file driver (VFD) with the backing store option turned on, the core driver can be configured to track changes to the file and write out only the modified bytes. This write tracking feature is enabled and disabled with \p is_enabled. The default setting is that write tracking is disabled, or off. To avoid a large number of small writes, changes can be aggregated into pages of a user-specified size, \p page_size. Setting \p page_size to 1 enables tracking with no page aggregation. The backing store option is set via the function H5Pset_fapl_core. \attention \parblock This function is only for use with the core VFD and must be used after the call to H5Pset_fapl_core(). It is an error to use this function with any other VFD. It is an error to use this function when the backing store flag has not been set using H5Pset_fapl_core(). This function only applies to the backing store write operation which typically occurs when the file is flushed or closed. This function has no relationship to the increment parameter passed to H5Pset_fapl_core(). For optimum performance, the \p page_size parameter should be a power of two. It is an error to set the page size to 0. \endparblock
- Since:
- 1.8.13
-
H5Pset_driver
@Cast("herr_t") public static int H5Pset_driver(@Cast("hid_t") long plist_id, @Cast("hid_t") long driver_id, @Const Pointer driver_info)
\ingroup FAPL \brief Sets a file driver \plist_id- Parameters:
driver_id- [in] The new driver identifierdriver_info- [in] Optional struct containing driver properties- Returns:
- \herr_t \details H5Pset_driver() sets the file driver, driver_id, for a file access or data transfer property list, \p plist_id, and supplies an optional struct containing the driver-specific properties, \p driver_info. The driver properties will be copied into the property list and the reference count on the driver will be incremented, allowing the caller to close the driver identifier but still use the property list.
-
H5Pset_driver_by_name
@Cast("herr_t") public static int H5Pset_driver_by_name(@Cast("hid_t") long plist_id, @Cast("const char*") BytePointer driver_name, @Cast("const char*") BytePointer driver_config)
\ingroup FAPL \brief Sets a file driver according to a given driver name \plist_id- Parameters:
driver_name- [in] The new driver namedriver_config- [in] Optional string containing driver properties- Returns:
- \herr_t \details H5Pset_driver_by_name() sets the file driver, by the name driver_name, for a file access or data transfer property list, \p plist_id, and supplies an optional string containing the driver-specific properties, \p driver_config. The driver properties string will be copied into the property list. If the driver specified by \p driver_name is not currently registered, an attempt will be made to load the driver as a plugin.
-
H5Pset_driver_by_name
@Cast("herr_t") public static int H5Pset_driver_by_name(@Cast("hid_t") long plist_id, String driver_name, String driver_config)
-
H5Pset_driver_by_value
@Cast("herr_t") public static int H5Pset_driver_by_value(@Cast("hid_t") long plist_id, @Cast("H5FD_class_value_t") int driver_value, @Cast("const char*") BytePointer driver_config)
\ingroup FAPL \brief Sets a file driver according to a given driver value (ID). \plist_id- Parameters:
driver_value- [in] The new driver value (ID)driver_config- [in] Optional string containing driver properties- Returns:
- \herr_t \details H5Pset_driver_by_value() sets the file driver, by the value driver_value, for a file access or data transfer property list, \p plist_id, and supplies an optional string containing the driver-specific properties, \p driver_config. The driver properties string will be copied into the property list. If the driver specified by \p driver_value is not currently registered, an attempt will be made to load the driver as a plugin.
-
H5Pset_driver_by_value
@Cast("herr_t") public static int H5Pset_driver_by_value(@Cast("hid_t") long plist_id, @Cast("H5FD_class_value_t") int driver_value, String driver_config)
-
H5Pset_elink_file_cache_size
@Cast("herr_t") public static int H5Pset_elink_file_cache_size(@Cast("hid_t") long plist_id, @Cast("unsigned") int efc_size)
\ingroup FAPL \brief Sets the number of files that can be held open in an external link open file cache \par Motivation \parblock The external link open file cache holds files open after they have been accessed via an external link. This cache reduces the number of times such files are opened when external links are accessed repeatedly and can significantly improves performance in certain heavy-use situations and when low-level file opens or closes are expensive. H5Pset_elink_file_cache_size() sets the number of files that will be held open in an external link open file cache. H5Pget_elink_file_cache_size() retrieves the size of an existing cache; and H5Fclear_elink_file_cache() clears an existing cache without closing it. \endparblock \fapl_id{plist_id}- Parameters:
efc_size- [in] External link open file cache size in number of files Default setting is 0 (zero).- Returns:
- \herr_t
\details H5Pset_elink_file_cache_size() specifies the number of files
that will be held open in an external link open file cache.
The default external link open file cache size is 0 (zero),
meaning that files accessed via an external link are not
held open. Setting the cache size to a positive integer
turns on the cache; setting the size back to zero turns it
off.
With this property set, files are placed in the external
link open file cache cache when they are opened via an
external link. Files are then held open until either
they are evicted from the cache or the parent file is
closed. This property setting can improve performance when
external links are repeatedly accessed.
When the cache is full, files will be evicted using a least
recently used (LRU) scheme; the file which has gone the
longest time without being accessed through the parent file
will be evicted and closed if nothing else is holding that
file open.
Files opened through external links inherit the parent
fileâs file access property list by default, and therefore
inherit the parent fileâs external link open file cache
setting.
When child files contain external links of their own, the
caches can form a graph of cached external files. Closing
the last external reference to such a graph will recursively
close all files in the graph, even if cycles are present.
\par Example
\parblock
The following code sets up an external link open file cache that will
hold open up to 8 files reached through external links:
\endparblockstatus = H5Pset_elink_file_cache_size(fapl_id, 8); - Since:
- 1.8.7
-
H5Pset_evict_on_close
@Cast("herr_t") public static int H5Pset_evict_on_close(@Cast("hid_t") long fapl_id, @Cast("hbool_t") boolean evict_on_close)
\ingroup FAPL \brief Controls the library's behavior of evicting metadata associated with a closed object \fapl_id- Parameters:
evict_on_close- [in] Whether the HDF5 object should be evicted on close- Returns:
- \herr_t \details The library's metadata cache is fairly conservative about holding on to HDF5 object metadata(object headers, chunk index structures, etc.), which can cause the cache size to grow, resulting in memory pressure on an application or system. When enabled, the "evict on close" property will cause all metadata for an object to be evicted from the cache as long as metadata is not referenced by any other open object. This function only applies to file access property lists. The default library behavior is to not evict on object or file close. When applied to a file access property list, any subsequently opened object will inherit the "evict on close" property and will have its metadata evicted when the object is closed.
- Since:
- 1.10.1
-
H5Pset_family_offset
@Cast("herr_t") public static int H5Pset_family_offset(@Cast("hid_t") long fapl_id, @Cast("hsize_t") long offset)
\ingroup FAPL \brief Sets offset property for low-level access to a file in a family of files \fapl_id- Parameters:
offset- [in] Offset in bytes within the HDF5 file- Returns:
- \herr_t \details H5Pset_family_offset() sets the offset property in the file access property list \p fapl_id so that the user application can retrieve a file handle for low-level access to a particular member of a family of files. The file handle is retrieved with a separate call to H5Fget_vfd_handle() (or, in special circumstances, to H5FDget_vfd_handle(); see \ref VFL). The value of \p offset is an offset in bytes from the beginning of the HDF5 file, identifying a user-determined location within the HDF5 file. The file handle the user application is seeking is for the specific member-file in the associated family of files to which this offset is mapped. Use of this function is only appropriate for an HDF5 file written as a family of files with the \c FAMILY file driver.
- Since:
- 1.6.0
-
H5Pset_fclose_degree
@Cast("herr_t") public static int H5Pset_fclose_degree(@Cast("hid_t") long fapl_id, @Cast("H5F_close_degree_t") int degree)
\ingroup FAPL \brief Sets the file close degree \fapl_id- Parameters:
degree- [in] Pointer to a location containing the file close degree property, the value of \p degree- Returns:
- \herr_t
\details H5Pset_fclose_degree() sets the file close degree property
\p degree in the file access property list \p fapl_id.
The value of \p degree determines how aggressively
H5Fclose() deals with objects within a file that remain open
when H5Fclose() is called to close that file. \p degree can
have any one of four valid values:
\warning If a file is opened multiple times without being closed, each open operation must use the same file close degree setting. For example, if a file is already open with #H5F_CLOSE_WEAK, an H5Fopen() call with #H5F_CLOSE_STRONG will fail.Degree name H5Fclose behavior with no open object in file H5Fclose behavior with open object(s) in file #H5F_CLOSE_WEAK Actual file is closed. Access to file identifier is terminated; actual file close is delayed until all objects in file are closed #H5F_CLOSE_SEMI Actual file is closed. Function returns FAILURE #H5F_CLOSE_STRONG Actual file is closed. All open objects remaining in the file are closed then file is closed #H5F_CLOSE_DEFAULT The VFL driver chooses the behavior. Currently, all VFL drivers set this value to #H5F_CLOSE_WEAK, except for the MPI-I/O driver, which sets it to #H5F_CLOSE_SEMI. - Since:
- 1.6.0
-
H5Pset_file_image
@Cast("herr_t") public static int H5Pset_file_image(@Cast("hid_t") long fapl_id, Pointer buf_ptr, @Cast("size_t") long buf_len)
\ingroup FAPL \brief Sets an initial file image in a memory buffer \fapl_id- Parameters:
buf_ptr- [in] Pointer to the initial file image, or NULL if no initial file image is desiredbuf_len- [in] Size of the supplied buffer, or 0 (zero) if no initial image is desired- Returns:
- \herr_t \details H5Pset_file_image() allows an application to provide a file image to be used as the initial contents of a file. Calling H5Pset_file_image()makes a copy of the buffer specified in \p buf_ptr of size \p buf_len. \par Motivation: H5Pset_file_image() and other elements of HDF5 are used to load an image of an HDF5 file into system memory and open that image as a regular HDF5 file. An application can then use the file without the overhead of disk I/O. \par Recommended Reading: This function is part of the file image operations feature set. It is highly recommended to study the guide [HDF5 File Image Operations] (https://portal.hdfgroup.org/display/HDF5/HDF5+File+Image+Operations ) before using this feature set. See the âSee Alsoâ section below for links to other elements of HDF5 file image operations.
- Since:
- 1.8.9
-
H5Pset_file_image_callbacks
@Cast("herr_t") public static int H5Pset_file_image_callbacks(@Cast("hid_t") long fapl_id, H5FD_file_image_callbacks_t callbacks_ptr)
\ingroup FAPL \brief Sets the callbacks for working with file images \note **Motivation:** H5Pset_file_image_callbacks() and other elements of HDF5 are used to load an image of an HDF5 file into system memory and open that image as a regular HDF5 file. An application can then use the file without the overhead of disk I/O.\n **Recommended Reading:** This function is part of the file image operations feature set. It is highly recommended to study the guide [HDF5 File Image Operations] (https://portal.hdfgroup.org/display/HDF5/HDF5+File+Image+Operations ) before using this feature set. See the âSee Alsoâ section below for links to other elements of HDF5 file image operations. \fapl_id- Parameters:
callbacks_ptr- [in,out] Pointer to the instance of the #H5FD_file_image_callbacks_t structure- Returns:
- \herr_t \n **Failure Modes**: Due to interactions between this function and H5Pset_file_image() and H5Pget_file_image(), H5Pset_file_image_callbacks() will fail if a file image has already been set in the target file access property list, \p fapl_id. \details H5Pset_file_image_callbacks() sets callback functions for working with file images in memory. H5Pset_file_image_callbacks() allows an application to control the management of file image buffers through user defined callbacks. These callbacks can be used in the management of file image buffers in property lists and with certain file drivers. H5Pset_file_image_callbacks() must be used before any file image has been set in the file access property list. Once a file image has been set, the function will fail. The callback routines set up by H5Pset_file_image_callbacks() are invoked when a new file image buffer is allocated, when an existing file image buffer is copied or resized, or when a file image buffer is released from use. Some file drivers allow the use of user-defined callback functions for allocating, freeing, and copying the driverâs internal buffer, potentially allowing optimizations such as avoiding large \c malloc and \c memcpy operations, or to perform detailed logging. From the perspective of the HDF5 library, the operations of the \ref H5FD_file_image_callbacks_t.image_malloc "image_malloc", \ref H5FD_file_image_callbacks_t.image_memcpy "image_memcpy", \ref H5FD_file_image_callbacks_t.image_realloc "image_realloc", and \ref H5FD_file_image_callbacks_t.image_free "image_free" callbacks must be identical to those of the corresponding C standard library calls (\c malloc, \c memcpy, \c realloc, and \c free). While the operations must be identical, the file image callbacks have more parameters. The return values of \ref H5FD_file_image_callbacks_t.image_malloc "image_malloc" and \ref H5FD_file_image_callbacks_t.image_realloc "image_realloc" are identical to the return values of \c malloc and \c realloc. The return values of \ref H5FD_file_image_callbacks_t.image_malloc "image_malloc" and \ref H5FD_file_image_callbacks_t.image_free "image_free" differ from the return values of \c memcpy and \c free in that the return values of \ref H5FD_file_image_callbacks_t.image_memcpy "image_memcpy" and \ref H5FD_file_image_callbacks_t.image_free "image_free" can also indicate failure. The callbacks and their parameters, along with a struct and an \c ENUM required for their use, are described below. Callback struct and \c ENUM: The callback functions set up by H5Pset_file_image_callbacks() use a struct and an \c ENUM that are defined as follows The struct #H5FD_file_image_callbacks_t serves as a container for the callback functions and a pointer to user-supplied data. The struct is defined as follows: \snippet H5FDpublic.h H5FD_file_image_callbacks_t_snip Elements of the #H5FD_file_image_op_t are used by the callbacks to invoke certain operations on file images. The ENUM is defined as follows: \snippet H5FDpublic.h H5FD_file_image_op_t_snip The elements of the #H5FD_file_image_op_t are used in the following callbacks: - The \ref H5FD_file_image_callbacks_t.image_malloc "image_malloc" callback contains a pointer to a function that must appear to HDF5 to have functionality identical to that of the standard C library \c malloc() call. - Signature in #H5FD_file_image_callbacks_t: \snippet H5FDpublic.h image_malloc_snip \n - The \ref H5FD_file_image_callbacks_t.image_memcpy "image_memcpy" callback contains a pointer to a function that must appear to HDF5 to have functionality identical to that of the standard C library \c memcopy() call, except that it returns a \p NULL on failure. (The \c memcpy C Library routine is defined to return the \p dest parameter in all cases.) - Setting \ref H5FD_file_image_callbacks_t.image_memcpy "image_memcpy" to \c NULL indicates that HDF5 should invoke the standard C library \c memcpy() routine when copying buffers. - Signature in #H5FD_file_image_callbacks_t: \snippet H5FDpublic.h image_memcpy_snip \n - The \ref H5FD_file_image_callbacks_t.image_realloc "image_realloc" callback contains a pointer to a function that must appear to HDF5 to have functionality identical to that of the standard C library \c realloc() call. - Setting \ref H5FD_file_image_callbacks_t.image_realloc "image_realloc" to \p NULL indicates that HDF5 should invoke the standard C library \c realloc() routine when resizing file image buffers. - Signature in #H5FD_file_image_callbacks_t: \snippet H5FDpublic.h image_realloc_snip \n - The \ref H5FD_file_image_callbacks_t.image_free "image_free" callback contains a pointer to a function that must appear to HDF5 to have functionality identical to that of the standard C library \c free() call, except that it will return \c 0 (\c SUCCEED) on success and \c -1 (\c FAIL) on failure. - Setting \ref H5FD_file_image_callbacks_t.image_free "image_free" to \c NULL indicates that HDF5 should invoke the standard C library \c free() routine when releasing file image buffers. - Signature in #H5FD_file_image_callbacks_t: \snippet H5FDpublic.h image_free_snip \n - The \ref H5FD_file_image_callbacks_t.udata_copy "udata_copy" callback contains a pointer to a function that, from the perspective of HDF5, allocates a buffer of suitable size, copies the contents of the supplied \p udata into the new buffer, and returns the address of the new buffer. The function returns NULL on failure. This function is necessary if a non-NULL \p udata parameter is supplied, so that property lists containing the image callbacks can be copied. If the \p udata parameter below is \c NULL, then this parameter should be \c NULL as well. - Signature in #H5FD_file_image_callbacks_t: \snippet H5FDpublic.h udata_copy_snip \n - The \ref H5FD_file_image_callbacks_t.udata_free "udata_free" callback contains a pointer to a function that, from the perspective of HDF5, frees a user data block. This function is necessary if a non-NULL udata parameter is supplied so that property lists containing image callbacks can be discarded without a memory leak. If the udata parameter below is \c NULL, this parameter should be \c NULL as well. - Signature in #H5FD_file_image_callbacks_t: \snippet H5FDpublic.h udata_free_snip - \p **udata**, the final field in the #H5FD_file_image_callbacks_t struct, provides a pointer to user-defined data. This pointer will be passed to the \ref H5FD_file_image_callbacks_t.image_malloc "image_malloc", \ref H5FD_file_image_callbacks_t.image_memcpy "image_memcpy", \ref H5FD_file_image_callbacks_t.image_realloc "image_realloc", and \ref H5FD_file_image_callbacks_t.image_free "image_free" callbacks. Define udata as \c NULL if no user-defined data is provided.
- Since:
- 1.8.9
-
H5Pset_file_locking
@Cast("herr_t") public static int H5Pset_file_locking(@Cast("hid_t") long fapl_id, @Cast("hbool_t") boolean use_file_locking, @Cast("hbool_t") boolean ignore_when_disabled)
\ingroup FAPL \brief Sets the file locking property values \fapl_id- Parameters:
use_file_locking- [in] Toggle to specify file locking (or not)ignore_when_disabled- [in] Toggle to ignore when disabled (or not)- Returns:
- \herr_t \details H5Pset_file_locking() overrides the default file locking flag setting that was set when the library was configured. This setting can be overridden by the \c HDF5_USE_FILE_LOCKING environment variable. File locking is used when creating/opening a file to prevent problematic file accesses.
- Since:
- 1.10.7
-
H5Pset_gc_references
@Cast("herr_t") public static int H5Pset_gc_references(@Cast("hid_t") long fapl_id, @Cast("unsigned") int gc_ref)
\ingroup FAPL \brief Sets garbage collecting references flag \fapl_id- Parameters:
gc_ref- [in] Flag setting reference garbage collection to on (1) or off (0)- Returns:
- \herr_t \details H5Pset_gc_references() sets the flag for garbage collecting references for the file. Dataset region references and other reference types use space in an HDF5 file's global heap. If garbage collection is on and the user passes in an uninitialized value in a reference structure, the heap might get corrupted. When garbage collection is off, however, and the user re-uses a reference, the previous heap block will be orphaned and not returned to the free heap space. When garbage collection is on, the user must initialize the reference structures to 0 or risk heap corruption. The default value for garbage collecting references is off.
-
H5Pset_libver_bounds
@Cast("herr_t") public static int H5Pset_libver_bounds(@Cast("hid_t") long plist_id, @Cast("H5F_libver_t") int low, @Cast("H5F_libver_t") int high)
\ingroup FAPL \brief Controls the range of library release versions used when creating objects in a file \fapl_id{plist_id}- Parameters:
low- [in] The earliest version of the library that will be used for writing objectshigh- [in] The latest version of the library that will be used for writing objects- Returns:
- \herr_t
\details H5Pset_libver_bounds() controls the range of library release
versions that will be used when creating objects in a file.
The object format versions are determined indirectly from the
library release versions specified in the call.
This property is set in the file access property list
specified by the parameter \p fapl_id.
The parameter \p low sets the earliest possible format
versions that the library will use when creating objects in
the file. Note that earliest possible is different from
earliest, as some features introduced in library versions
later than 1.0.0 resulted in updates to object formats.
The parameter \p high sets the latest format versions that
the library will be allowed to use when creating objects in
the file.
The parameters \p low and \p high must be one of the
enumerated values in the #H5F_libver_t struct, which is
defined in H5Fpublic.h.
The macro #H5F_LIBVER_LATEST is aliased to the highest
enumerated value in #H5F_libver_t, indicating that this is
currently the latest format available.
The library supports the following five pairs of
(\p low, \p high) combinations as derived from the values
in #H5F_libver_t:
Value of \p low and \p high Result \p low=#H5F_LIBVER_EARLIEST
\p high=#H5F_LIBVER_V18\li The library will create objects with the earliest possible format versions. \li The library will allow objects to be created with the latest format versions available to library release 1.8.x. \li API calls that create objects or features that are available to versions of the library greater than 1.8.x release will fail. \p low=#H5F_LIBVER_EARLIEST
\p high=#H5F_LIBVER_V110\li The library will create objects with the earliest possible format versions. \li The library will allow objects to be created with the latest format versions available to library release 1.10.x. Since 1.10.x is also #H5F_LIBVER_LATEST, there is no upper limit on the format versions to use. For example, if a newer format version is required to support a feature e.g. virtual dataset, this setting will allow the object to be created. \li This is the library default setting and provides the greatest format compatibility. \p low=#H5F_LIBVER_V18
\p high=#H5F_LIBVER_V18\li The library will create objects with the latest format versions available to library release 1.8.x. \li API calls that create objects or features that are available to versions of the library greater than 1.8.x release will fail. \li Earlier versions of the library may not be able to access objects created with this setting. \p low=#H5F_LIBVER_V18
\p high=#H5F_LIBVER_V110\li The library will create objects with the latest format versions available to library release 1.8.x. \li The library will allow objects to be created with the latest format versions available to library release 1.10.x. Since 1.10.x is also #H5F_LIBVER_LATEST, there is no upper limit on the format versions to use. For example, if a newer format version is required to support a feature e.g. virtual dataset, this setting will allow the object to be created. \li Earlier versions of the library may not be able to access objects created with this setting. \p low=#H5F_LIBVER_V110
\p high=#H5F_LIBVER_V110\li The library will create objects with the latest format versions available to library release 1.10.x. \li The library will allow objects to be created with the latest format versions available to library release 1.10.x. Since 1.10.x is also #H5F_LIBVER_LATEST, there is no upper limit on the format versions to use. For example, if a newer format version is required to support a feature e.g. virtual dataset, this setting will allow the object to be created. \li This setting allows users to take advantage of the latest features and performance enhancements in the library. However, objects written with this setting may be accessible to a smaller range of library versions than would be the case if low is set to #H5F_LIBVER_EARLIEST. \li Earlier versions of the library may not be able to access objects created with this setting. - Since:
- 1.8.0
-
H5Pset_mdc_config
@Cast("herr_t") public static int H5Pset_mdc_config(@Cast("hid_t") long plist_id, H5AC_cache_config_t config_ptr)
\ingroup FAPL \brief Set the initial metadata cache configuration in the indicated File Access Property List to the supplied value \fapl_id{plist_id}- Parameters:
config_ptr- [in] Pointer to the instance of \p H5AC_cache_config_t containing the desired configuration- Returns:
- \herr_t \details The fields of the #H5AC_cache_config_t structure are shown below: \snippet H5ACpublic.h H5AC_cache_config_t_snip \click4more \details H5Pset_mdc_config() attempts to set the initial metadata cache configuration to the supplied value. It will fail if an invalid configuration is detected. This configuration is used when the file is opened. See the overview of the metadata cache in the special topics section of the user manual for details on what is being configured. If you have not read and understood that documentation, you really should not be using this API call.
- Since:
- 1.8.0
-
H5Pset_mdc_log_options
@Cast("herr_t") public static int H5Pset_mdc_log_options(@Cast("hid_t") long plist_id, @Cast("hbool_t") boolean is_enabled, @Cast("const char*") BytePointer location, @Cast("hbool_t") boolean start_on_access)
\ingroup FAPL \brief Sets metadata cache logging options \fapl_id{plist_id}- Parameters:
is_enabled- [in] Whether logging is enabledlocation- [in] Location of log in UTF-8/ASCII (file path/name) (On Windows, this must be ASCII)start_on_access- [in] Whether the logging will begin as soon as the file is opened or created- Returns:
- \herr_t \details The metadata cache is a central part of the HDF5 library through which all file metadata reads and writes take place. File metadata is normally invisible to the user and is used by the library for purposes such as locating and indexing data. File metadata should not be confused with user metadata, which consists of attributes created by users and attached to HDF5 objects such as datasets via H5A API calls. Due to the complexity of the cache, a trace/logging feature has been created that can be used by HDF5 developers for debugging and performance analysis. The functions that control this functionality will normally be of use to a very limited number of developers outside of The HDF Group. The functions have been documented to help users create logs that can be sent with bug reports. Control of the log functionality is straightforward. Logging is enabled via the H5Pset_mdc_log_options() function, which will modify the file access property list used to open or create a file. This function has a flag that determines whether logging begins at file open or starts in a paused state. Log messages can then be controlled via the H5Fstart_mdc_logging() and H5Fstop_mdc_logging() function. H5Pget_mdc_log_options() can be used to examine a file access property list, and H5Fget_mdc_logging_status() will return the current state of the logging flags. The log format is described in [Metadata Cache Logging] (https://portal.hdfgroup.org/display/HDF5/Fine-tuning+the+Metadata+Cache).
- Since:
- 1.10.0
-
H5Pset_mdc_log_options
@Cast("herr_t") public static int H5Pset_mdc_log_options(@Cast("hid_t") long plist_id, @Cast("hbool_t") boolean is_enabled, String location, @Cast("hbool_t") boolean start_on_access)
-
H5Pset_meta_block_size
@Cast("herr_t") public static int H5Pset_meta_block_size(@Cast("hid_t") long fapl_id, @Cast("hsize_t") long size)
\ingroup FAPL \brief Sets the minimum metadata block size \fapl_id{fapl_id}- Parameters:
size- [in] Minimum size, in bytes, of metadata block allocations- Returns:
- \herr_t
\details H5Pset_meta_block_size() sets the minimum size, in bytes, of
metadata block allocations when #H5FD_FEAT_AGGREGATE_METADATA is set by a VFL
driver.
Each raw metadata block is initially allocated to be of the given size. Specific metadata objects (e.g., object headers, local heaps, B-trees) are then sub-allocated from this block. The default setting is 2048 bytes, meaning that the library will attempt to aggregate metadata in at least 2K blocks in the file. Setting the value to zero (\Code{0}) with this function will turn off metadata aggregation, even if the VFL driver attempts to use the metadata aggregation strategy. Metadata aggregation reduces the number of small data objects in the file that would otherwise be required for metadata. The aggregated block of metadata is usually written in a single write action and always in a contiguous block, potentially significantly improving library and application performance.
- Since:
- 1.4.0
-
H5Pset_metadata_read_attempts
@Cast("herr_t") public static int H5Pset_metadata_read_attempts(@Cast("hid_t") long plist_id, @Cast("unsigned") int attempts)
\ingroup FAPL \brief Sets the number of read attempts in a file access property list \fapl_id{plist_id}- Parameters:
attempts- [in] The number of read attempts. Must be a value greater than \Code{0}- Returns:
- \herr_t
- Since:
- 1.10.0
-
H5Pset_multi_type
@Cast("herr_t") public static int H5Pset_multi_type(@Cast("hid_t") long fapl_id, @Cast("H5FD_mem_t") int type)
\ingroup FAPL \brief Specifies type of data to be accessed via the \Code{MULTI} driver, enabling more direct access \fapl_id{fapl_id}- Parameters:
type- [in] Type of data to be accessed- Returns:
- \herr_t
\details H5Pset_multi_type() sets the \Emph{type of data} property in the file
access property list \p fapl_id. This setting enables a user
application to specify the type of data the application wishes to
access so that the application can retrieve a file handle for
low-level access to the particular member of a set of \Code{MULTI}
files in which that type of data is stored. The file handle is
retrieved with a separate call to H5Fget_vfd_handle() (or, in special
circumstances, to H5FDget_vfd_handle(); see \ref VFL.
The type of data specified in \p type may be one of the following:
This function is for use only when accessing an HDF5 file written as a set of files with the \Code{MULTI} file driver.#H5FD_MEM_SUPER Super block data #H5FD_MEM_BTREE B-tree data #H5FD_MEM_DRAW Dataset raw data #H5FD_MEM_GHEAP Global heap data #H5FD_MEM_LHEAP Local Heap data #H5FD_MEM_OHDR Object header data - Since:
- 1.6.0
-
H5Pset_object_flush_cb
@Cast("herr_t") public static int H5Pset_object_flush_cb(@Cast("hid_t") long plist_id, H5F_flush_cb_t func, Pointer udata)
\ingroup FAPL \brief Sets a callback function to invoke when an object flush occurs in the file \fapl_id{plist_id} \op{func} \op_data_in{udata}- Returns:
- \herr_t
\details H5Pset_object_flush_cb() sets the callback function to invoke in the
file access property list \p plist_id whenever an object flush occurs in
the file. Library objects are group, dataset, and committed
datatype.
The callback function \p func must conform to the prototype defined below:
The parameters of the callback function, per the above prototypes, are defined as follows: - \Code{object_id} is the identifier of the object which has just been flushed. - \Code{user_data} is the user-defined input data for the callback function. \b Example: The example below illustrates the usage of this routine to set the callback function to invoke when an object flush occurs. \include H5Pset_object_flush_cb.ctypedef herr_t (*H5F_flush_cb_t)(hid_t object_id, void *user_data) - Since:
- 1.10.0
-
H5Pset_sieve_buf_size
@Cast("herr_t") public static int H5Pset_sieve_buf_size(@Cast("hid_t") long fapl_id, @Cast("size_t") long size)
\ingroup FAPL \brief Sets the maximum size of the data sieve buffer \fapl_id{fapl_id}- Parameters:
size- [in] Maximum size, in bytes, of data sieve buffer- Returns:
- \herr_t \details H5Pset_sieve_buf_size() sets \p size, the maximum size in bytes of the data sieve buffer, which is used by file drivers that are capable of using data sieving. The data sieve buffer is used when performing I/O on datasets in the file. Using a buffer which is large enough to hold several pieces of the dataset being read in for hyperslab selections boosts performance by quite a bit. The default value is set to 64KB, indicating that file I/O for raw data reads and writes will occur in at least 64KB blocks. Setting the value to zero (\Code{0}) with this API function will turn off the data sieving, even if the VFL driver attempts to use that strategy. Internally, the library checks the storage sizes of the datasets in the file. It picks the smaller one between the size from the file access property and the size of the dataset to allocate the sieve buffer for the dataset in order to save memory usage.
- Since:
- 1.4.0
-
H5Pset_small_data_block_size
@Cast("herr_t") public static int H5Pset_small_data_block_size(@Cast("hid_t") long fapl_id, @Cast("hsize_t") long size)
\ingroup FAPL \brief Sets the size of a contiguous block reserved for small data \fapl_id{fapl_id}- Parameters:
size- [in] Maximum size, in bytes, of the small data block. The default size is \Code{2048}.- Returns:
- \herr_t \details H5Pset_small_data_block_size() reserves blocks of \p size bytes for the contiguous storage of the raw data portion of \Emph{small} datasets. The HDF5 library then writes the raw data from small datasets to this reserved space, thus reducing unnecessary discontinuities within blocks of meta data and improving I/O performance. A small data block is actually allocated the first time a qualifying small dataset is written to the file. Space for the raw data portion of this small dataset is suballocated within the small data block. The raw data from each subsequent small dataset is also written to the small data block until it is filled; additional small data blocks are allocated as required. The HDF5 library employs an algorithm that determines whether I/O performance is likely to benefit from the use of this mechanism with each dataset as storage space is allocated in the file. A larger \p size will result in this mechanism being employed with larger datasets. The small data block size is set as an allocation property in the file access property list identified by \p fapl_id. Setting \p size to zero (\Code{0}) disables the small data block mechanism.
- Since:
- 1.4.4
-
H5Pset_vol
@Cast("herr_t") public static int H5Pset_vol(@Cast("hid_t") long plist_id, @Cast("hid_t") long new_vol_id, @Const Pointer new_vol_info)
\ingroup FAPL \brief Set the file VOL connector for a file access property list \fapl_id{plist_id}- Parameters:
new_vol_id- [in] VOL connector identifiernew_vol_info- [in] Optional VOL information- Returns:
- \herr_t \details H5Pset_vol() sets the VOL connector \p new_vol_id for a file access property list \p plist_id using the (optional) VOL information in \p new_vol_info.
- Since:
- 1.12.0
-
H5Pget_vol_cap_flags
@Cast("herr_t") public static int H5Pget_vol_cap_flags(@Cast("hid_t") long plist_id, @Cast("uint64_t*") LongPointer cap_flags)
\ingroup FAPL \brief Query the capability flags for the VOL connector that will be used with this file access property list (FAPL). \fapl_id{plist_id}- Parameters:
cap_flags- [out] Flags that indicate the VOL connector capabilities- Returns:
- \herr_t \details H5Pget_vol_cap_flags() queries the current VOL connector information for a FAPL to retrieve the capability flags for the VOL connector stack, as will be used by a file open or create operation that uses this FAPL. \note This routine supports the use of the HDF5_VOL_CONNECTOR environment variable to override the VOL connector set programmatically for the FAPL (with H5Pset_vol). \note The H5VL_CAP_FLAG_ASYNC flag can be checked to see if asynchronous operations are supported by the VOL connector stack.
- Since:
- 1.14.0
-
H5Pget_vol_cap_flags
@Cast("herr_t") public static int H5Pget_vol_cap_flags(@Cast("hid_t") long plist_id, @Cast("uint64_t*") LongBuffer cap_flags)
-
H5Pget_vol_cap_flags
@Cast("herr_t") public static int H5Pget_vol_cap_flags(@Cast("hid_t") long plist_id, @Cast("uint64_t*") long[] cap_flags)
-
H5Pset_mdc_image_config
@Cast("herr_t") public static int H5Pset_mdc_image_config(@Cast("hid_t") long plist_id, H5AC_cache_image_config_t config_ptr)
\ingroup FAPL \brief Sets the metadata cache image option for a file access property list \fapl_id{plist_id}- Parameters:
config_ptr- [out] Pointer to metadata cache image configuration values- Returns:
- \herr_t \details H5Pset_mdc_image_config() sets the metadata cache image option with configuration values specified by \p config_ptr for the file access property list specified in \p plist_id. #H5AC_cache_image_config_t is defined as follows: \snippet H5ACpublic.h H5AC_cache_image_config_t_snip \click4more \par Limitations: While it is an obvious error to request a cache image when opening the file read only, it is not in general possible to test for this error in the H5Pset_mdc_image_config() call. Rather than fail the subsequent file open, the library silently ignores the file image request in this case.\n It is also an error to request a cache image on a file that does not support superblock extension messages (i.e. a superblock version less than 2). As above, it is not always possible to detect this error in the H5Pset_mdc_image_config() call, and thus the request for a cache image will fail silently in this case as well.\n Creation of cache images is currently disabled in parallel -- as above, any request for a cache image in this context will fail silently.\n Files with cache images may be read in parallel applications, but note that the load of the cache image is a collective operation triggered by the first operation that accesses metadata after file open (or, if persistent free space managers are enabled, on the first allocation or deallocation of file space, or read of file space manager status, whichever comes first). Thus the parallel process may deadlock if any process does not participate in this access.\n In long sequences of file closes and opens, infrequently accessed metadata can accumulate in the cache image to the point where the cost of storing and restoring this metadata exceeds the benefit of retaining frequently used metadata in the cache image. When implemented, the #H5AC_cache_image_config_t::entry_ageout should address this problem. In the interim, not requesting a cache image every n file close/open cycles may be an acceptable work around. The choice of \c n will be driven by application behavior, but \Code{n = 10} seems a good starting point.
- Since:
- 1.10.1
-
H5Pset_page_buffer_size
@Cast("herr_t") public static int H5Pset_page_buffer_size(@Cast("hid_t") long plist_id, @Cast("size_t") long buf_size, @Cast("unsigned") int min_meta_per, @Cast("unsigned") int min_raw_per)
\ingroup FAPL \brief Sets the maximum size for the page buffer and the minimum percentage for metadata and raw data pages \fapl_id{plist_id}- Parameters:
buf_size- [in] Maximum size, in bytes, of the page buffermin_meta_per- [in] Minimum metadata percentage to keep in the page buffer before allowing pages containing metadata to be evicted (Default is 0)min_raw_per- [in] Minimum raw data percentage to keep in the page buffer before allowing pages containing raw data to be evicted (Default is 0)- Returns:
- \herr_t \details H5Pset_page_buffer_size() sets buf_size, the maximum size in bytes of the page buffer. The default value is zero, meaning that page buffering is disabled. When a non-zero page buffer size is set, the library will enable page buffering if that size is larger or equal than a single page size if a paged file space strategy is enabled using the functions H5Pset_file_space_strategy() and H5Pset_file_space_page_size(). The page buffer layer captures all I/O requests before they are issued to the VFD and "caches" them in fixed sized pages. Once the total number of pages exceeds the page buffer size, the library evicts pages from the page buffer by writing them to the VFD. At file close, the page buffer is flushed writing all the pages to the file. If a non-zero page buffer size is set, and the file space strategy is not set to paged or the page size for the file space strategy is larger than the page buffer size, the subsequent call to H5Fcreate() or H5Fopen() using the \p plist_id will fail. The function also allows setting the minimum percentage of pages for metadata and raw data to prevent a certain type of data to evict hot data of the other type.
- Since:
- 1.10.1
-
H5Pfill_value_defined
@Cast("herr_t") public static int H5Pfill_value_defined(@Cast("hid_t") long plist, @Cast("H5D_fill_value_t*") IntPointer status)
\ingroup DCPL \brief Determines whether fill value is defined \dcpl_id{plist}- Parameters:
status- [out] Status of fill value in property list- Returns:
- \herr_t
\details H5Pfill_value_defined() determines whether a fill value is
defined in the dataset creation property list \p plist. Valid
values returned in status are as follows:
#H5D_FILL_VALUE_UNDEFINED Fill value is undefined. #H5D_FILL_VALUE_DEFAULT Fill value is the library default. #H5D_FILL_VALUE_USER_DEFINED Fill value is defined by the application. - Since:
- 1.6.0
-
H5Pfill_value_defined
@Cast("herr_t") public static int H5Pfill_value_defined(@Cast("hid_t") long plist, @Cast("H5D_fill_value_t*") IntBuffer status)
-
H5Pfill_value_defined
@Cast("herr_t") public static int H5Pfill_value_defined(@Cast("hid_t") long plist, @Cast("H5D_fill_value_t*") int[] status)
-
H5Pget_alloc_time
@Cast("herr_t") public static int H5Pget_alloc_time(@Cast("hid_t") long plist_id, @Cast("H5D_alloc_time_t*") IntPointer alloc_time)
\ingroup DCPL \brief Retrieves the timing for storage space allocation \dcpl_id{plist_id}- Parameters:
alloc_time- [out] The timing setting for allocating dataset storage space- Returns:
- \herr_t
\details H5Pget_alloc_time() retrieves the timing for allocating storage
space for a dataset's raw data. This property is set in the
dataset creation property list \p plist_id. The timing setting
is returned in \p alloc_time as one of the following values:
\note H5Pget_alloc_time() is designed to work in concert with the dataset fill value and fill value write time properties, set with the functions H5Pget_fill_value() and H5Pget_fill_time().#H5D_ALLOC_TIME_DEFAULT
Uses the default allocation time, based on the dataset storage method.
See the \p alloc_time description in H5Pset_alloc_time() for default allocation times for various storage methods.#H5D_ALLOC_TIME_EARLY All space is allocated when the dataset is created. #H5D_ALLOC_TIME_INCR Space is allocated incrementally as data is written to the dataset. #H5D_ALLOC_TIME_LATE All space is allocated when data is first written to the dataset. - Since:
- 1.6.0
-
H5Pget_alloc_time
@Cast("herr_t") public static int H5Pget_alloc_time(@Cast("hid_t") long plist_id, @Cast("H5D_alloc_time_t*") IntBuffer alloc_time)
-
H5Pget_alloc_time
@Cast("herr_t") public static int H5Pget_alloc_time(@Cast("hid_t") long plist_id, @Cast("H5D_alloc_time_t*") int[] alloc_time)
-
H5Pget_chunk
public static int H5Pget_chunk(@Cast("hid_t") long plist_id, int max_ndims, @Cast("hsize_t*") LongPointer dim)
\ingroup DCPL \brief Retrieves the size of chunks for the raw data of a chunked layout dataset \dcpl_id{plist_id}- Parameters:
max_ndims- [in] Size of the \p dims arraydim- [out] Array to store the chunk dimensions- Returns:
- Returns chunk dimensionality if successful; otherwise returns a negative value. \details H5Pget_chunk() retrieves the size of chunks for the raw data of a chunked layout dataset. This function is only valid for dataset creation property lists. At most, \p max_ndims elements of \p dim will be initialized.
- Since:
- 1.0.0
-
H5Pget_chunk
public static int H5Pget_chunk(@Cast("hid_t") long plist_id, int max_ndims, @Cast("hsize_t*") LongBuffer dim)
-
H5Pget_chunk
public static int H5Pget_chunk(@Cast("hid_t") long plist_id, int max_ndims, @Cast("hsize_t*") long... dim)
-
H5Pget_chunk_opts
@Cast("herr_t") public static int H5Pget_chunk_opts(@Cast("hid_t") long plist_id, @Cast("unsigned*") IntPointer opts)
\ingroup DCPL \brief Retrieves the edge chunk option setting from a dataset creation property list \dcpl_id{plist_id}- Parameters:
opts- [out] Edge chunk option flag. Valid values are described in H5Pset_chunk_opts(). The option status can be retrieved using the bitwise AND operator ( & ). For example, the expression (opts&#H5D_CHUNK_DONT_FILTER_PARTIAL_CHUNKS) will evaluate to #H5D_CHUNK_DONT_FILTER_PARTIAL_CHUNKS if that option has been enabled. Otherwise, it will evaluate to 0 (zero).- Returns:
- \herr_t \details H5Pget_chunk_opts() retrieves the edge chunk option setting stored in the dataset creation property list \p plist_id.
- Since:
- 1.10.0
-
H5Pget_chunk_opts
@Cast("herr_t") public static int H5Pget_chunk_opts(@Cast("hid_t") long plist_id, @Cast("unsigned*") IntBuffer opts)
-
H5Pget_chunk_opts
@Cast("herr_t") public static int H5Pget_chunk_opts(@Cast("hid_t") long plist_id, @Cast("unsigned*") int[] opts)
-
H5Pget_dset_no_attrs_hint
@Cast("herr_t") public static int H5Pget_dset_no_attrs_hint(@Cast("hid_t") long dcpl_id, @Cast("hbool_t*") BoolPointer minimize)
\ingroup DCPL \brief Retrieves the setting for whether or not to create minimized dataset object headers \dcpl_id- Parameters:
minimize- [out] Flag indicating whether the library will or will not create minimized dataset object headers- Returns:
- \herr_t \details H5Pget_dset_no_attrs_hint() retrieves the no dataset attributes hint setting for the dataset creation property list \p dcpl_id. This setting is used to inform the library to create minimized dataset object headers when TRUE. The setting value is returned in the boolean pointer \p minimize.
- Since:
- 1.10.5
-
H5Pget_dset_no_attrs_hint
@Cast("herr_t") public static int H5Pget_dset_no_attrs_hint(@Cast("hid_t") long dcpl_id, @Cast("hbool_t*") boolean[] minimize)
-
H5Pget_external
@Cast("herr_t") public static int H5Pget_external(@Cast("hid_t") long plist_id, @Cast("unsigned") int idx, @Cast("size_t") long name_size, @Cast("char*") BytePointer name, @Cast("off_t*") SizeTPointer offset, @Cast("hsize_t*") LongPointer size)
\ingroup DCPL \brief Returns information about an external file \dcpl_id{plist_id}- Parameters:
idx- [in] External file indexname_size- [in] Maximum length of \p name arrayname- [out] Name of the external fileoffset- [out] Pointer to a location to return an offset valuesize- [out] Pointer to a location to return the size of the external file data- Returns:
- \herr_t \details H5Pget_external() returns information about an external file. The external file is specified by its index, \p idx, which is a number from zero to N-1, where N is the value returned by H5Pget_external_count(). At most \p name_size characters are copied into the \p name array. If the external file name is longer than \p name_size with the null terminator, the return value is not null terminated (similar to strncpy()). If \p name_size is zero or \p name is the null pointer, the external file name is not returned. If \p offset or \p size are null pointers then the corresponding information is not returned. \note On Windows, off_t is typically a 32-bit signed long value, which limits the valid offset that can be returned to 2 GiB.
- Since:
- 1.0.0
-
H5Pget_external
@Cast("herr_t") public static int H5Pget_external(@Cast("hid_t") long plist_id, @Cast("unsigned") int idx, @Cast("size_t") long name_size, @Cast("char*") ByteBuffer name, @Cast("off_t*") SizeTPointer offset, @Cast("hsize_t*") LongBuffer size)
-
H5Pget_external
@Cast("herr_t") public static int H5Pget_external(@Cast("hid_t") long plist_id, @Cast("unsigned") int idx, @Cast("size_t") long name_size, @Cast("char*") byte[] name, @Cast("off_t*") SizeTPointer offset, @Cast("hsize_t*") long... size)
-
H5Pget_external_count
public static int H5Pget_external_count(@Cast("hid_t") long plist_id)
\ingroup DCPL \brief Returns the number of external files for a dataset \dcpl_id{plist_id}- Returns:
- Returns the number of external files if successful; otherwise returns a negative value. \details H5Pget_external_count() returns the number of external files for the specified dataset.
- Since:
- 1.0.0
-
H5Pget_fill_time
@Cast("herr_t") public static int H5Pget_fill_time(@Cast("hid_t") long plist_id, @Cast("H5D_fill_time_t*") IntPointer fill_time)
\ingroup DCPL \brief Retrieves the time when fill values are written to a dataset \dcpl_id{plist_id}- Parameters:
fill_time- [out] Setting for the timing of writing fill values to the dataset- Returns:
- \herr_t
\details H5Pget_fill_time() examines the dataset creation property list
\p plist_id to determine when fill values are to be written to
a dataset. Valid values returned in \p fill_time are as
follows:
\note H5Pget_fill_time() is designed to work in coordination with the dataset fill value and dataset storage allocation time properties, retrieved with the functions H5Pget_fill_value() and H5Pget_alloc_time().#H5D_FILL_TIME_IFSET Fill values are written to the dataset when storage space is allocated only if there is a user-defined fill value, i.e., one set with H5Pset_fill_value(). (Default) #H5D_FILL_TIME_ALLOC Fill values are written to the dataset when storage space is allocated. #H5D_FILL_TIME_NEVER Fill values are never written to the dataset. - Since:
- 1.6.0
-
H5Pget_fill_time
@Cast("herr_t") public static int H5Pget_fill_time(@Cast("hid_t") long plist_id, @Cast("H5D_fill_time_t*") IntBuffer fill_time)
-
H5Pget_fill_time
@Cast("herr_t") public static int H5Pget_fill_time(@Cast("hid_t") long plist_id, @Cast("H5D_fill_time_t*") int[] fill_time)
-
H5Pget_fill_value
@Cast("herr_t") public static int H5Pget_fill_value(@Cast("hid_t") long plist_id, @Cast("hid_t") long type_id, Pointer value)
\ingroup DCPL \brief Retrieves a dataset fill value \dcpl_id{plist_id}- Parameters:
type_id- [in] Datatype identifier for the value passed via \p valuevalue- [out] Pointer to buffer to contain the returned fill value- Returns:
- \herr_t \details H5Pget_fill_value() returns the dataset fill value defined in the dataset creation property list \p plist_id. The fill value is returned through the \p value pointer and will be converted to the datatype specified by \p type_id. This datatype may differ from the fill value datatype in the property list, but the HDF5 library must be able to convert between the two datatypes. If the fill value is undefined, i.e., set to NULL in the property list, H5Pget_fill_value() will return an error. H5Pfill_value_defined() should be used to check for this condition before H5Pget_fill_value() is called. Memory must be allocated by the calling application. \note H5Pget_fill_value() is designed to coordinate with the dataset storage allocation time and fill value write time properties, which can be retrieved with the functions H5Pget_alloc_time() and H5Pget_fill_time(), respectively.
- Since:
- 1.0.0
-
H5Pget_layout
@Cast("H5D_layout_t") public static int H5Pget_layout(@Cast("hid_t") long plist_id)
\ingroup DCPL \brief Returns the layout of the raw data for a dataset \dcpl_id{plist_id}- Returns:
- Returns the layout type (a non-negative value) of a dataset creation property list if successful. Valid return values are: - #H5D_COMPACT: Raw data is stored in the object header in the file. - #H5D_CONTIGUOUS: Raw data is stored separately from the object header in one contiguous chunk in the file. - #H5D_CHUNKED: Raw data is stored separately from the object header in chunks in separate locations in the file. - #H5D_VIRTUAL: Raw data is drawn from multiple datasets in different files.
- Since:
- 1.0.0
-
H5Pget_virtual_count
@Cast("herr_t") public static int H5Pget_virtual_count(@Cast("hid_t") long dcpl_id, @Cast("size_t*") SizeTPointer count)
\ingroup DCPL \brief Gets the number of mappings for the virtual dataset \dcpl_id- Parameters:
count- [out] The number of mappings- Returns:
- \herr_t \details H5Pget_virtual_count() gets the number of mappings for a virtual dataset that has the creation property list specified by \p dcpl_id. \see_virtual
- Since:
- 1.10.0
-
H5Pget_virtual_dsetname
@Cast("ssize_t") public static long H5Pget_virtual_dsetname(@Cast("hid_t") long dcpl_id, @Cast("size_t") long index, @Cast("char*") BytePointer name, @Cast("size_t") long size)
\ingroup DCPL \brief Gets the name of a source dataset used in the mapping \dcpl_id- Parameters:
index- [in] Mapping index. The value of \p index is 0 (zero) or greater and less than \p count (0 ⤠\p index < \p count), where \p count is the number of mappings returned by H5Pget_virtual_count().name- [out] A buffer containing the name of the source datasetsize- [in] The size, in bytes, of the name buffer. Must be the size of the dataset name in bytes plus 1 for a NULL terminator- Returns:
- Returns the length of the dataset name if successful; otherwise returns a negative value. \details H5Pget_virtual_dsetname() takes the dataset creation property list for the virtual dataset, \p dcpl_id, the mapping index, \p index, the size of the dataset name for a source dataset, \p size, and retrieves the name of the source dataset used in the mapping. Up to \p size characters of the dataset name are returned in \p name; additional characters, if any, are not returned to the user application. If the length of the dataset name, which determines the required value of \p size, is unknown, a preliminary call to H5Pget_virtual_dsetname() with the last two parameters set to NULL and zero respectively can be made. The return value of this call will be the size in bytes of the dataset name. That value, plus 1 for a NULL terminator, must then be assigned to \p size for a second H5Pget_virtual_dsetname() call, which will retrieve the actual dataset name. \see_virtual
- Since:
- 1.10.0
-
H5Pget_virtual_dsetname
@Cast("ssize_t") public static long H5Pget_virtual_dsetname(@Cast("hid_t") long dcpl_id, @Cast("size_t") long index, @Cast("char*") ByteBuffer name, @Cast("size_t") long size)
-
H5Pget_virtual_dsetname
@Cast("ssize_t") public static long H5Pget_virtual_dsetname(@Cast("hid_t") long dcpl_id, @Cast("size_t") long index, @Cast("char*") byte[] name, @Cast("size_t") long size)
-
H5Pget_virtual_filename
@Cast("ssize_t") public static long H5Pget_virtual_filename(@Cast("hid_t") long dcpl_id, @Cast("size_t") long index, @Cast("char*") BytePointer name, @Cast("size_t") long size)
\ingroup DCPL \brief Gets the filename of a source dataset used in the mapping \dcpl_id- Parameters:
index- [in] Mapping index. The value of \p index is 0 (zero) or greater and less than \p count (0 ⤠\p index < \p count), where \p count is the number of mappings returned by H5Pget_virtual_count().name- [out] A buffer containing the name of the file containing the source datasetsize- [in] The size, in bytes, of the name buffer. Must be the size of the filename in bytes plus 1 for a NULL terminator- Returns:
- Returns the length of the filename if successful; otherwise returns a negative value. \details H5Pget_virtual_filename() takes the dataset creation property list for the virtual dataset, \p dcpl_id, the mapping index, \p index, the size of the filename for a source dataset, \p size, and retrieves the name of the file for a source dataset used in the mapping. Up to \p size characters of the filename are returned in \p name; additional characters, if any, are not returned to the user application. If the length of the filename, which determines the required value of \p size, is unknown, a preliminary call to H5Pget_virtual_filename() with the last two parameters set to NULL and zero respectively can be made. The return value of this call will be the size in bytes of the filename. That value, plus 1 for a NULL terminator, must then be assigned to \p size for a second H5Pget_virtual_filename() call, which will retrieve the actual filename. \see_virtual
- Since:
- 1.10.0
-
H5Pget_virtual_filename
@Cast("ssize_t") public static long H5Pget_virtual_filename(@Cast("hid_t") long dcpl_id, @Cast("size_t") long index, @Cast("char*") ByteBuffer name, @Cast("size_t") long size)
-
H5Pget_virtual_filename
@Cast("ssize_t") public static long H5Pget_virtual_filename(@Cast("hid_t") long dcpl_id, @Cast("size_t") long index, @Cast("char*") byte[] name, @Cast("size_t") long size)
-
H5Pget_virtual_srcspace
@Cast("hid_t") public static long H5Pget_virtual_srcspace(@Cast("hid_t") long dcpl_id, @Cast("size_t") long index)
\ingroup DCPL \brief Gets a dataspace identifier for the selection within the source dataset used in the mapping \dcpl_id- Parameters:
index- [in] Mapping index. The value of \p index is 0 (zero) or greater and less than \p count (0 ⤠\p index < \p count), where \p count is the number of mappings returned by H5Pget_virtual_count().- Returns:
- \hid_t{valid dataspace identifier} \details H5Pget_virtual_srcspace() takes the dataset creation property list for the virtual dataset, \p dcpl_id, and the mapping index, \p index, and returns a dataspace identifier for the selection within the source dataset used in the mapping. \see_virtual
- Since:
- 1.10.0
-
H5Pget_virtual_vspace
@Cast("hid_t") public static long H5Pget_virtual_vspace(@Cast("hid_t") long dcpl_id, @Cast("size_t") long index)
\ingroup DCPL \brief Gets a dataspace identifier for the selection within the virtual dataset used in the mapping \dcpl_id- Parameters:
index- [in] Mapping index. The value of \p index is 0 (zero) or greater and less than \p count (0 ⤠\p index < \p count), where \p count is the number of mappings returned by H5Pget_virtual_count()- Returns:
- \hid_t{valid dataspace identifier} \details H5Pget_virtual_vspace() takes the dataset creation property list for the virtual dataset, \p dcpl_id, and the mapping index, \p index, and returns a dataspace identifier for the selection within the virtual dataset used in the mapping. \see_virtual
- Since:
- 1.10.0
-
H5Pset_alloc_time
@Cast("herr_t") public static int H5Pset_alloc_time(@Cast("hid_t") long plist_id, @Cast("H5D_alloc_time_t") int alloc_time)
\ingroup DCPL \brief Sets the timing for storage space allocation \dcpl_id{plist_id}- Parameters:
alloc_time- [in] When to allocate dataset storage space- Returns:
- \herr_t
\details H5Pset_alloc_time() sets up the timing for the allocation of
storage space for a dataset's raw data. This property is set
in the dataset creation property list \p plist_id. Timing is
specified in \p alloc_time with one of the following values:
\note H5Pset_alloc_time() is designed to work in concert with the dataset fill value and fill value write time properties, set with the functions H5Pset_fill_value() and H5Pset_fill_time(). \note See H5Dcreate() for further cross-references.#H5D_ALLOC_TIME_DEFAULT Allocate dataset storage space at the default time
(Defaults differ by storage method.)#H5D_ALLOC_TIME_EARLY Allocate all space when the dataset is created
(Default for compact datasets.)#H5D_ALLOC_TIME_INCR Allocate space incrementally, as data is written to the dataset
(Default for chunked storage datasets.) \li Chunked datasets: Storage space allocation for each chunk is deferred until data is written to the chunk. \li Contiguous datasets: Incremental storage space allocation for contiguous data is treated as late allocation. \li Compact datasets: Incremental allocation is not allowed with compact datasets; H5Pset_alloc_time() will return an error.#H5D_ALLOC_TIME_LATE Allocate all space when data is first written to the dataset
(Default for contiguous datasets.) - Since:
- 1.6.0
-
H5Pset_chunk
@Cast("herr_t") public static int H5Pset_chunk(@Cast("hid_t") long plist_id, int ndims, @Cast("const hsize_t*") LongPointer dim)
\ingroup DCPL \brief Sets the size of the chunks used to store a chunked layout dataset \dcpl_id{plist_id}- Parameters:
ndims- [in] The number of dimensions of each chunkdim- [in] An array defining the size, in dataset elements, of each chunk- Returns:
- \herr_t \details H5Pset_chunk() sets the size of the chunks used to store a chunked layout dataset. This function is only valid for dataset creation property lists. The \p ndims parameter currently must be the same size as the rank of the dataset. The values of the \p dim array define the size of the chunks to store the dataset's raw data. The unit of measure for \p dim values is dataset elements. As a side-effect of this function, the layout of the dataset is changed to #H5D_CHUNKED, if it is not already so set. \note Chunk size cannot exceed the size of a fixed-size dataset. For example, a dataset consisting of a 5x4 fixed-size array cannot be defined with 10x10 chunks. Chunk maximums: - The maximum number of elements in a chunk is 232-1 which is equal to 4,294,967,295. If the number of elements in a chunk is set via H5Pset_chunk() to a value greater than 232-1, then H5Pset_chunk() will fail. - The maximum size for any chunk is 4GB. If a chunk that is larger than 4GB attempts to be written with H5Dwrite(), then H5Dwrite() will fail.
- Since:
- 1.0.0
-
H5Pset_chunk
@Cast("herr_t") public static int H5Pset_chunk(@Cast("hid_t") long plist_id, int ndims, @Cast("const hsize_t*") LongBuffer dim)
-
H5Pset_chunk
@Cast("herr_t") public static int H5Pset_chunk(@Cast("hid_t") long plist_id, int ndims, @Cast("const hsize_t*") long... dim)
-
H5Pset_chunk_opts
@Cast("herr_t") public static int H5Pset_chunk_opts(@Cast("hid_t") long plist_id, @Cast("unsigned") int opts)
\ingroup DCPL \brief Sets the edge chunk option in a dataset creation property list \dcpl_id{plist_id}- Parameters:
opts- [in] Edge chunk option flag. Valid values are: \li #H5D_CHUNK_DONT_FILTER_PARTIAL_CHUNKS When enabled, filters are not applied to partial edge chunks. When disabled, partial edge chunks are filtered. Enabling this option will improve performance when appending to the dataset and, when compression filters are used, prevent reallocation of these chunks. Datasets created with this option enabled will be inaccessible with HDF5 library versions before Release 1.10. Default: \e Disabled \li 0 (zero) Disables option; partial edge chunks will be compressed.- Returns:
- \herr_t \details H5Pset_chunk_opts() sets the edge chunk option in the dataset creation property list \p dcpl_id. The available option is detailed in the parameters section. Only chunks that are not completely filled by the datasetâs dataspace are affected by this option. Such chunks are referred to as partial edge chunks. \b Motivation: H5Pset_chunk_opts() is used to specify storage options for chunks on the edge of a datasetâs dataspace. This capability allows the user to tune performance in cases where the dataset size may not be a multiple of the chunk size and the handling of partial edge chunks can impact performance.
- Since:
- 1.10.0
-
H5Pset_dset_no_attrs_hint
@Cast("herr_t") public static int H5Pset_dset_no_attrs_hint(@Cast("hid_t") long dcpl_id, @Cast("hbool_t") boolean minimize)
\ingroup DCPL \brief Sets the flag to create minimized dataset object headers \dcpl_id- Parameters:
minimize- [in] Flag for indicating whether or not a dataset's object header will be minimized- Returns:
- \herr_t \details H5Pset_dset_no_attrs_hint() sets the no dataset attributes hint setting for the dataset creation property list \p dcpl_id. Datasets created with the dataset creation property list \p dcpl_id will have their object headers minimized if the boolean flag \p minimize is set to TRUE. By setting \p minimize to TRUE, the library expects that no attributes will be added to the dataset. Attributes can be added, but they are appended with a continuation message, which can reduce performance. This setting interacts with H5Fset_dset_no_attrs_hint(): if either is set to TRUE, then the created dataset's object header will be minimized.
- Since:
- 1.10.5
-
H5Pset_external
@Cast("herr_t") public static int H5Pset_external(@Cast("hid_t") long plist_id, @Cast("const char*") BytePointer name, @Cast("off_t") long offset, @Cast("hsize_t") long size)
\ingroup DCPL \brief Adds an external file to the list of external files \dcpl_id{plist_id}- Parameters:
name- [in] Name of an external fileoffset- [in] Offset, in bytes, from the beginning of the file to the location in the file where the data startssize- [in] Number of bytes reserved in the file for the data- Returns:
- \herr_t \details The first call to H5Pset_external() sets the external storage property in the property list, thus designating that the dataset will be stored in one or more non-HDF5 file(s) external to the HDF5 file. This call also adds the file \p name as the first file in the list of external files. Subsequent calls to the function add the named file as the next file in the list. If a dataset is split across multiple files, then the files should be defined in order. The total size of the dataset is the sum of the \p size arguments for all the external files. If the total size is larger than the size of a dataset then the dataset can be extended (provided the data space also allows the extending). The \p size argument specifies the number of bytes reserved for data in the external file. If \p size is set to #H5F_UNLIMITED, the external file can be of unlimited size and no more files can be added to the external files list. If \p size is set to 0 (zero), no external file will actually be created. All of the external files for a given dataset must be specified with H5Pset_external() before H5Dcreate() is called to create the dataset. If one these files does not exist on the system when H5Dwrite() is called to write data to it, the library will create the file.
- Since:
- 1.0.0
-
H5Pset_external
@Cast("herr_t") public static int H5Pset_external(@Cast("hid_t") long plist_id, String name, @Cast("off_t") long offset, @Cast("hsize_t") long size)
-
H5Pset_fill_time
@Cast("herr_t") public static int H5Pset_fill_time(@Cast("hid_t") long plist_id, @Cast("H5D_fill_time_t") int fill_time)
\ingroup DCPL \brief Sets the time when fill values are written to a dataset \dcpl_id{plist_id}- Parameters:
fill_time- [in] When to write fill values to a dataset- Returns:
- \herr_t
\details H5Pset_fill_time() sets up the timing for writing fill values
to a dataset. This property is set in the dataset creation
property list \p plist_id. Timing is specified in \p fill_time
with one of the following values:
\note H5Pset_fill_time() is designed for coordination with the dataset fill value and dataset storage allocation time properties, set with the functions H5Pset_fill_value() and H5Pset_alloc_time(). See H5Dcreate() for further cross-references.#H5D_FILL_TIME_IFSET Write fill values to the dataset when storage space is allocated only if there is a user-defined fill value, i.e.,one set with H5Pset_fill_value(). (Default) #H5D_FILL_TIME_ALLOC Write fill values to the dataset when storage space is allocated. #H5D_FILL_TIME_NEVER Never write fill values to the dataset. - Since:
- 1.6.0
-
H5Pset_fill_value
@Cast("herr_t") public static int H5Pset_fill_value(@Cast("hid_t") long plist_id, @Cast("hid_t") long type_id, @Const Pointer value)
\ingroup DCPL \brief Sets the fill value for a dataset \dcpl_id{plist_id}- Parameters:
type_id- [in] Datatype of \p valuevalue- [in] Pointer to buffer containing value to use as fill value- Returns:
- \herr_t \details H5Pset_fill_value() sets the fill value for a dataset in the dataset creation property list. \p value is interpreted as being of datatype \p type_id. This datatype may differ from that of the dataset, but the HDF5 library must be able to convert \p value to the dataset datatype when the dataset is created. The default fill value is 0 (zero), which is interpreted according to the actual dataset datatype. Setting \p value to NULL indicates that the fill value is to be undefined. \note Applications sometimes write data only to portions of an allocated dataset. It is often useful in such cases to fill the unused space with a known fill value. This function allows the user application to set that fill value; the functions H5Dfill() and H5Pset_fill_time(), respectively, provide the ability to apply the fill value on demand or to set up its automatic application. \note A fill value should be defined so that it is appropriate for the application. While the HDF5 default fill value is 0 (zero), it is often appropriate to use another value. It might be useful, for example, to use a value that is known to be impossible for the application to legitimately generate. \note H5Pset_fill_value() is designed to work in concert with H5Pset_alloc_time() and H5Pset_fill_time(). H5Pset_alloc_time() and H5Pset_fill_time() govern the timing of dataset storage allocation and fill value write operations and can be important in tuning application performance. \note See H5Dcreate() for further cross-references.
- Since:
- 1.0.0
-
H5Pset_shuffle
@Cast("herr_t") public static int H5Pset_shuffle(@Cast("hid_t") long plist_id)
\ingroup DCPL \brief Sets up use of the shuffle filter \dcpl_id{plist_id}- Returns:
- \herr_t \par_compr_note \details H5Pset_shuffle() sets the shuffle filter, #H5Z_FILTER_SHUFFLE, in the dataset creation property list \p plist_id. The shuffle filter de-interlaces a block of data by reordering the bytes. All the bytes from one consistent byte position of each data element are placed together in one block; all bytes from a second consistent byte position of each data element are placed together a second block; etc. For example, given three data elements of a 4-byte datatype stored as 012301230123, shuffling will re-order data as 000111222333. This can be a valuable step in an effective compression algorithm because the bytes in each byte position are often closely related to each other and putting them together can increase the compression ratio. As implied above, the primary value of the shuffle filter lies in its coordinated use with a compression filter; it does not provide data compression when used alone. When the shuffle filter is applied to a dataset immediately prior to the use of a compression filter, the compression ratio achieved is often superior to that achieved by the use of a compression filter without the shuffle filter.
- Since:
- 1.6.0
-
H5Pset_layout
@Cast("herr_t") public static int H5Pset_layout(@Cast("hid_t") long plist_id, @Cast("H5D_layout_t") int layout)
\ingroup DCPL \brief Sets the type of storage used to store the raw data for a dataset \dcpl_id{plist_id}- Parameters:
layout- [in] Type of storage layout for raw data- Returns:
- \herr_t \details H5Pset_layout() sets the type of storage used to store the raw data for a dataset. This function is only valid for dataset creation property lists. Valid values for \p layout are: - #H5D_COMPACT: Store raw data in the dataset object header in file. This should only be used for datasets with small amounts of raw data. The raw data size limit is 64K (65520 bytes). Attempting to create a dataset with raw data larger than this limit will cause the H5Dcreate() call to fail. - #H5D_CONTIGUOUS: Store raw data separately from the object header in one large chunk in the file. - #H5D_CHUNKED: Store raw data separately from the object header as chunks of data in separate locations in the file. - #H5D_VIRTUAL: Draw raw data from multiple datasets in different files. Note that a compact storage layout may affect writing data to the dataset with parallel applications. See the note in H5Dwrite() documentation for details.
- Since:
- 1.0.0
-
H5Pset_nbit
@Cast("herr_t") public static int H5Pset_nbit(@Cast("hid_t") long plist_id)
\ingroup DCPL \brief Sets up the use of the N-Bit filter \dcpl_id{plist_id}- Returns:
- \herr_t
\par_compr_note
\details H5Pset_nbit() sets the N-Bit filter, #H5Z_FILTER_NBIT, in the
dataset creation property list \p plist_id.
The HDF5 user can create an N-Bit datatype with the following
code:
hid_t nbit_datatype = H5Tcopy(H5T_STD_I32LE); H5Tset_precision(nbit_datatype, 16); H5Tset_offset(nbit_datatype, 4);In memory, one value of the N-Bit datatype in the above example will be stored on a little-endian machine as follows:
Note: S - sign bit, P - significant bit, ? - padding bit; For signed integer, the sign bit is included in the precision. When data of the above datatype is stored on disk using the N-bit filter, all padding bits are chopped off and only significant bits are stored. The values on disk will be something like:byte 3 byte 2 byte 1 byte 0 ???????? ????SPPP PPPPPPPP PPPP????
The N-Bit filter is used effectively for compressing data of an N-Bit datatype as well as a compound and an array datatype with N-Bit fields. However, the datatype classes of the N-Bit datatype or the N-Bit field of the compound datatype or the array datatype are limited to integer or floating-point. The N-Bit filter supports complex situations where a compound datatype contains member(s) of a compound datatype or an array datatype that has a compound datatype as the base type. However, it does not support the situation where an array datatype has a variable-length or variable-length string as its base datatype. The filter does support the situation where a variable-length or variable-length string is a member of a compound datatype. The N-Bit filter allows all other HDF5 datatypes (such as time, string, bitfield, opaque, reference, enum, and variable length) to pass through as a no-op. Like other I/O filters supported by the HDF5 library, application using the N-Bit filter must store data with chunked storage. By nature, the N-Bit filter should not be used together with other I/O filters.1st value 2nd value ... SPPPPPPPPPPPPPPP SPPPPPPPPPPPPPPP ... - Since:
- 1.8.0
-
H5Pset_scaleoffset
@Cast("herr_t") public static int H5Pset_scaleoffset(@Cast("hid_t") long plist_id, @Cast("H5Z_SO_scale_type_t") int scale_type, int scale_factor)
\ingroup DCPL \brief Sets up the use of the scale-offset filter \dcpl_id{plist_id}- Parameters:
scale_type- [in] Flag indicating compression methodscale_factor- [in] Parameter related to scale. Must be non-negative- Returns:
- \herr_t
\par_compr_note
\details H5Pset_scaleoffset() sets the scale-offset filter,
#H5Z_FILTER_SCALEOFFSET, for a dataset.
Generally speaking, scale-offset compression performs a scale and/or
offset operation on each data value and truncates the resulting
value to a minimum number of bits (MinBits) before storing it. The
current scale-offset filter supports integer and floating-point
datatypes.
For an integer datatype, the parameter \p scale_type should be set
to #H5Z_SO_INT (2). The parameter \p scale_factor denotes MinBits.
If the user sets it to H5Z_SO_INT_MINBITS_DEFAULT (0), the filter
will calculate MinBits. If \p scale_factor is set to a positive
integer, the filter does not do any calculation and just uses the
number as MinBits. However, if the user gives a MinBits that is less
than what would be generated by the filter, the compression will be
lossy. Also, the MinBits supplied by the user cannot exceed the
number of bits to store one value of the dataset datatype.
For a floating-point datatype, the filter adopts the GRiB data
packing mechanism, which offers two alternate methods: E-scaling and
D-scaling. Both methods are lossy compression. If the parameter
\p scale_type is set to #H5Z_SO_FLOAT_DSCALE (0), the filter will
use the D-scaling method; if it is set to #H5Z_SO_FLOAT_ESCALE (1),
the filter will use the E-scaling method. Since only the D-scaling
method is implemented, \p scale_type should be set to
#H5Z_SO_FLOAT_DSCALE or 0.
When the D-scaling method is used, the original data is "D" scaled
â multiplied by 10 to the power of \p scale_factor, and the
"significant" part of the value is moved to the left of the decimal
point. Care should be taken in setting the decimal \p scale_factor
so that the integer part will have enough precision to contain the
appropriate information of the data value. For example, if
\p scale_factor is set to 2, the number 104.561 will be 10456.1
after "D" scaling. The last digit 1 is not "significant" and is
thrown off in the process of rounding. The user should make sure that
after "D" scaling and rounding, the data values are within the range
that can be represented by the integer (same size as the
floating-point type).
Valid values for scale_type are as follows:
The meaning of \p scale_factor varies according to the value assigned to \p scale_type:#H5Z_SO_FLOAT_DSCALE (0) Floating-point type, using variable MinBits method #H5Z_SO_FLOAT_ESCALE (1) Floating-point type, using fixed MinBits method #H5Z_SO_INT (2) Integer type
Like other I/O filters supported by the HDF5 library, an application using the scale-offset filter must store data with chunked storage.\p scale_type value \p scale_factor description #H5Z_SO_FLOAT_DSCALE Denotes the decimal scale factor for D-scaling and can be positive, negative or zero. This is the current implementation of the library. #H5Z_SO_FLOAT_ESCALE Denotes MinBits for E-scaling and must be a positive integer. This is not currently implemented by the library. #H5Z_SO_INT Denotes MinBits and it should be a positive integer or #H5Z_SO_INT_MINBITS_DEFAULT (0). If it is less than 0, the library will reset it to 0 since it is not implemented. - Since:
- 1.8.0
-
H5Pset_szip
@Cast("herr_t") public static int H5Pset_szip(@Cast("hid_t") long plist_id, @Cast("unsigned") int options_mask, @Cast("unsigned") int pixels_per_block)
\ingroup DCPL \brief Sets up use of the SZIP compression filter \dcpl_id{plist_id}- Parameters:
options_mask- [in] A bit-mask conveying the desired SZIP options; Valid values are #H5_SZIP_EC_OPTION_MASK and #H5_SZIP_NN_OPTION_MASK.pixels_per_block- [in] The number of pixels or data elements in each data block- Returns:
- \herr_t
\par_compr_note
\details H5Pset_szip() sets an SZIP compression filter, #H5Z_FILTER_SZIP,
for a dataset. SZIP is a compression method designed for use with
scientific data.
Before proceeding, all users should review the âLimitationsâ
section below.
Users familiar with SZIP outside the HDF5 context may benefit
from reviewing the Note âFor Users Familiar with SZIP in Other
Contextsâ below.
In the text below, the term pixel refers to an HDF5 data element.
This terminology derives from SZIP compression's use with image
data, where pixel referred to an image pixel.
The SZIP \p bits_per_pixel value (see Note, below) is automatically
set, based on the HDF5 datatype. SZIP can be used with atomic
datatypes that may have size of 8, 16, 32, or 64 bits.
Specifically, a dataset with a datatype that is 8-, 16-, 32-, or
64-bit signed or unsigned integer; char; or 32- or 64-bit float
can be compressed with SZIP. See Note, below, for further
discussion of the the SZIP \p bits_per_pixel setting.
SZIP options are passed in an options mask, \p options_mask,
as follows.
The following guidelines can be used in determining which option to select: - The entropy coding method, the EC option specified by #H5_SZIP_EC_OPTION_MASK, is best suited for data that has been processed. The EC method works best for small numbers. - The nearest neighbor coding method, the NN option specified by #H5_SZIP_NN_OPTION_MASK, preprocesses the data then the applies EC method as above. Other factors may affect results, but the above criteria provides a good starting point for optimizing data compression. SZIP compresses data block by block, with a user-tunable block size. This block size is passed in the parameter \p pixels_per_block and must be even and not greater than 32, with typical values being 8, 10, 16, or 32. This parameter affects compression ratio; the more pixel values vary, the smaller this number should be to achieve better performance. In HDF5, compression can be applied only to chunked datasets. If \p pixels_per_block is bigger than the total number of elements in a dataset chunk, H5Pset_szip() will succeed but the subsequent call to H5Dcreate() will fail; the conflict can be detected only when the property list is used. To achieve optimal performance for SZIP compression, it is recommended that a chunk's fastest-changing dimension be equal to N times \p pixels_per_block where N is the maximum number of blocks per scan line allowed by the SZIP library. In the current version of SZIP, N is set to 128. SZIP compression is an optional HDF5 filter. \b Limitations: - SZIP compression cannot be applied to compound, array, variable-length, enumeration, or any other user-defined datatypes. If an SZIP filter is set in a dataset creation property list used to create a dataset containing a non-allowed datatype, the call to H5Dcreate() will fail; the conflict can be detected only when the property list is used. - Users should be aware that there are factors that affect oneâs rights and ability to use SZIP compression by reviewing the SZIP copyright notice. \note \b For \b Users \b Familiar \b with \b SZIP \b in \b Other \b Contexts: \note The following notes are of interest primarily to those who have used SZIP compression outside of the HDF5 context. In non-HDF5 applications, SZIP typically requires that the user application supply additional parameters: - \p pixels_in_object, the number of pixels in the object to be compressed - \p bits_per_pixel, the number of bits per pixel - \p pixels_per_scanline, the number of pixels per scan line \note These values need not be independently supplied in the HDF5 environment as they are derived from the datatype and dataspace, which are already known. In particular, HDF5 sets \p pixels_in_object to the number of elements in a chunk and \p bits_per_pixel to the size of the element or pixel datatype. \note The following algorithm is used to set \p pixels_per_scanline: - If the size of a chunk's fastest-changing dimension, size, is greater than 4K, set \p pixels_per_scanline to 128 times \p pixels_per_block. - If size is less than 4K but greater than \p pixels_per_block, set \p pixels_per_scanline to the minimum of size and 128 times \p pixels_per_block. - If size is less than \p pixels_per_block but greater than the number elements in the chunk, set \p pixels_per_scanline to the minimum of the number elements in the chunk and 128 times \p pixels_per_block. \note The HDF5 datatype may have precision that is less than the full size of the data element, e.g., an 11-bit integer can be defined using H5Tset_precision(). To a certain extent, SZIP can take advantage of the precision of the datatype to improve compression: - If the HDF5 datatype size is 24-bit or less and the offset of the bits in the HDF5 datatype is zero (see H5Tset_offset() or H5Tget_offset()), the data is the in lowest N bits of the data element. In this case, the SZIP \p bits_per_pixel is set to the precision of the HDF5 datatype. - If the offset is not zero, the SZIP \p bits_per_pixel will be set to the number of bits in the full size of the data element. - If the HDF5 datatype precision is 25-bit to 32-bit, the SZIP \p bits_per_pixel will be set to 32. - If the HDF5 datatype precision is 33-bit to 64-bit, the SZIP \p bits_per_pixel will be set to 64. \note HDF5 always modifies the options mask provided by the user to set up usage of RAW_OPTION_MASK, ALLOW_K13_OPTION_MASK, and one of LSB_OPTION_MASK or MSB_OPTION_MASK, depending on endianness of the datatype.Option Description (Mutually exclusive; select one.) #H5_SZIP_EC_OPTION_MASK Selects entropy coding method #H5_SZIP_NN_OPTION_MASK Selects nearest neighbor coding method - Since:
- 1.6.0
-
H5Pset_virtual
@Cast("herr_t") public static int H5Pset_virtual(@Cast("hid_t") long dcpl_id, @Cast("hid_t") long vspace_id, @Cast("const char*") BytePointer src_file_name, @Cast("const char*") BytePointer src_dset_name, @Cast("hid_t") long src_space_id)
\ingroup DCPL \brief Sets the mapping between virtual and source datasets \dcpl_id- Parameters:
vspace_id- [in] The dataspace identifier with the selection within the virtual dataset applied, possibly an unlimited selectionsrc_file_name- [in] The name of the HDF5 file where the source dataset is located or a \Code{"."} (period) for a source dataset in the same file. The file might not exist yet. The name can be specified using a C-style \c printf statement as described below.src_dset_name- [in] The path to the HDF5 dataset in the file specified by \p src_file_name. The dataset might not exist yet. The dataset name can be specified using a C-style \c printf statement as described below.src_space_id- [in] The source datasetâs dataspace identifier with a selection applied, possibly an unlimited selection- Returns:
- \herr_t
\details H5Pset_virtual() maps elements of the virtual dataset (VDS)
described by the virtual dataspace identifier \p vspace_id to the
elements of the source dataset described by the source dataset
dataspace identifier \p src_space_id. The source dataset is
identified by the name of the file where it is located,
\p src_file_name, and the name of the dataset, \p src_dset_name.
\par C-style \c printf Formatting Statements:
C-style \c printf formatting allows a pattern to be specified in the name
of a source file or dataset. Strings for the file and dataset names are
treated as literals except for the following substitutions:
If the printf form is used for the source file or dataset names, the selection in the source datasetâs dataspace must be fixed-size. \par Source File Resolutions: When a source dataset residing in a different file is accessed, the library will search for the source file \p src_file_name as described below: \li If \p src_file_name is a \Code{"."} (period) then it refers to the file containing the virtual dataset. \li If \p src_file_name is a relative pathname, the following steps are performed: - The library will get the prefix(es) set in the environment variable \c HDF5_VDS_PREFIX and will try to prepend each prefix to \p src_file_name to form a new \p src_file_name. If the new \p src_file_name does not exist or if \c HDF5_VDS_PREFIX is not set, the library will get the prefix set via H5Pset_virtual_prefix() and prepend it to \p src_file_name to form a new \p src_file_name. If the new \p src_file_name does not exist or no prefix is being set by H5Pset_virtual_prefix() then the path of the file containing the virtual dataset is obtained. This path can be the absolute path or the current working directory plus the relative path of that file when it is created/opened. The library will prepend this path to \p src_file_name to form a new \p src_file_name. - If the new \p src_file_name does not exist, then the library will look for \p src_file_name and will return failure/success accordingly. \li If \p src_file_name is an absolute pathname, the library will first try to find \p src_file_name. If \p src_file_name does not exist, \p src_file_name is stripped of directory paths to form a new \p src_file_name. The search for the new \p src_file_name then follows the same steps as described above for a relative pathname. See examples below illustrating how \p src_file_name is stripped to form a new \p src_file_name. \par Note that \p src_file_name is considered to be an absolute pathname when the following condition is true: \li For Unix, the first character of \p src_file_name is a slash (\Code{/}).\n For example, consider a \p src_file_name of \Code{/tmp/A.h5}. If that source file does not exist, the new \p src_file_name after stripping will be \Code{A.h5}. \li For Windows, there are 6 cases: 1. \p src_file_name is an absolute drive with absolute pathname.\n For example, consider a \p src_file_name of \Code{/tmp/A.h5}. If that source file does not exist, the new \p src_file_name after stripping will be \Code{A.h5}. 2. \p src_file_name is an absolute pathname without specifying drive name.\n For example, consider a \p src_file_name of \Code{/tmp/A.h5}. If that source file does not exist, the new \p src_file_name after stripping will be \Code{A.h5}. 3. \p src_file_name is an absolute drive with relative pathname.\n For example, consider a \p src_file_name of \Code{/tmp/A.h5}. If that source file does not exist, the new \p src_file_name after stripping will be \Code{tmp/A.h5}. 4. \p src_file_name is in UNC (Uniform Naming Convention) format with server name, share name, and pathname.\n For example, consider a \p src_file_name of \Code{/tmp/A.h5}. If that source file does not exist, the new \p src_file_name after stripping will be \Code{A.h5}. 5. \p src_file_name is in Long UNC (Uniform Naming Convention) format with server name, share name, and pathname.\n For example, consider a \p src_file_name of \Code{/tmp/A.h5}. If that source file does not exist, the new \p src_file_name after stripping will be \Code{A.h5}. 6. \p src_file_name is in Long UNC (Uniform Naming Convention) format with an absolute drive and an absolute pathname.\n For example, consider a \p src_file_name of \Code{/tmp/A.h5}. If that source file does not exist, the new \p src_file_name after stripping will be \Code{A.h5}\Code{"%%"} Replaced with a single \Code{"%"} (percent) character. "%b" Where "is the virtual dataset dimension axis (0-based) and \Code{"b"} indicates that the block count of the selection in that dimension should be used. The full expression (for example, \Code{"%0b"}) is replaced with a single numeric value when the mapping is evaluated at VDS access time. Example code for many source and virtual dataset mappings is available in the "Examples of Source to Virtual Dataset Mapping" chapter in the RFC: HDF5 Virtual Dataset." - Since:
- 1.10.0
- See Also:
- Virtual Dataset Overview \see_virtual
-
H5Pset_virtual
@Cast("herr_t") public static int H5Pset_virtual(@Cast("hid_t") long dcpl_id, @Cast("hid_t") long vspace_id, String src_file_name, String src_dset_name, @Cast("hid_t") long src_space_id)
-
H5Pget_append_flush
@Cast("herr_t") public static int H5Pget_append_flush(@Cast("hid_t") long dapl_id, @Cast("unsigned") int dims, @Cast("hsize_t*") LongPointer boundary, @ByPtrPtr H5D_append_cb_t func, @Cast("void**") PointerPointer udata)
\ingroup DAPL \brief Retrieves the values of the append property that is set up in the dataset access property list \dapl_id- Parameters:
dims- [in] The number of elements for \p boundaryboundary- [in] The dimension sizes used to determine the boundaryfunc- [in] The user-defined callback functionudata- [in] The user-defined input data- Returns:
- \herr_t \details H5Pget_append_flush() obtains the following information from the dataset access property list, \p dapl_id. \p boundary consists of the sizes set up in the access property list that are used to determine when a dataset dimension size hits the boundary. Only at most \p dims boundary sizes are retrieved, and \p dims will not exceed the corresponding value that is set in the property list. \p func is the user-defined callback function to invoke when a datasetâs appended dimension size reaches a boundary and \p udata is the user-defined input data for the callback function.
- Since:
- 1.10.0
-
H5Pget_append_flush
@Cast("herr_t") public static int H5Pget_append_flush(@Cast("hid_t") long dapl_id, @Cast("unsigned") int dims, @Cast("hsize_t*") LongPointer boundary, @ByPtrPtr H5D_append_cb_t func, @Cast("void**") @ByPtrPtr Pointer udata)
-
H5Pget_append_flush
@Cast("herr_t") public static int H5Pget_append_flush(@Cast("hid_t") long dapl_id, @Cast("unsigned") int dims, @Cast("hsize_t*") LongBuffer boundary, @ByPtrPtr H5D_append_cb_t func, @Cast("void**") @ByPtrPtr Pointer udata)
-
H5Pget_append_flush
@Cast("herr_t") public static int H5Pget_append_flush(@Cast("hid_t") long dapl_id, @Cast("unsigned") int dims, @Cast("hsize_t*") long[] boundary, @ByPtrPtr H5D_append_cb_t func, @Cast("void**") @ByPtrPtr Pointer udata)
-
H5Pget_chunk_cache
@Cast("herr_t") public static int H5Pget_chunk_cache(@Cast("hid_t") long dapl_id, @Cast("size_t*") SizeTPointer rdcc_nslots, @Cast("size_t*") SizeTPointer rdcc_nbytes, DoublePointer rdcc_w0)
\ingroup DAPL \brief Retrieves the raw data chunk cache parameters \dapl_id- Parameters:
rdcc_nslots- [out] Number of chunk slots in the raw data chunk cache hash tablerdcc_nbytes- [out] Total size of the raw data chunk cache, in bytesrdcc_w- [out] 0 Preemption policy- Returns:
- \herr_t \details H5Pget_chunk_cache() retrieves the number of chunk slots in the raw data chunk cache hash table, the maximum possible number of bytes in the raw data chunk cache, and the preemption policy value. These values are retrieved from a dataset access property list. If the values have not been set on the property list, then values returned will be the corresponding values from a default file access property list. Any (or all) pointer arguments may be null pointers, in which case the corresponding data is not returned.
- Since:
- 1.8.3
-
H5Pget_chunk_cache
@Cast("herr_t") public static int H5Pget_chunk_cache(@Cast("hid_t") long dapl_id, @Cast("size_t*") SizeTPointer rdcc_nslots, @Cast("size_t*") SizeTPointer rdcc_nbytes, DoubleBuffer rdcc_w0)
-
H5Pget_chunk_cache
@Cast("herr_t") public static int H5Pget_chunk_cache(@Cast("hid_t") long dapl_id, @Cast("size_t*") SizeTPointer rdcc_nslots, @Cast("size_t*") SizeTPointer rdcc_nbytes, double[] rdcc_w0)
-
H5Pget_efile_prefix
@Cast("ssize_t") public static long H5Pget_efile_prefix(@Cast("hid_t") long dapl_id, @Cast("char*") BytePointer prefix, @Cast("size_t") long size)
\ingroup DAPL \brief Retrieves the prefix for external raw data storage files as set in the dataset access property list \dapl_id- Parameters:
prefix- [in,out] Dataset external storage prefix in UTF-8 or ASCII (\em Path and \em filename must be ASCII on Windows systems.)size- [in] Size of prefix buffer in bytes- Returns:
- Returns the size of \p prefix and the prefix string will be stored in \p prefix if successful. Otherwise returns a negative value and the contents of \p prefix will be undefined. \details H5Pget_efile_prefix() retrieves the file system path prefix for locating external files associated with a dataset that uses external storage. This will be the value set with H5Pset_efile_prefix() or the HDF5 libraryâs default. The value of \p size is the size in bytes of the prefix, including the NULL terminator. If the size is unknown, a preliminary H5Pget_elink_prefix() call with the pointer \p prefix set to NULL will return the size of the prefix without the NULL terminator. The \p prefix buffer must be allocated by the caller. In a call that retrieves the actual prefix, that buffer must be of the size specified in \p size. \note See H5Pset_efile_prefix() for a more complete description of file location behavior and for notes on the use of the HDF5_EXTFILE_PREFIX environment variable.
- Since:
- 1.10.0, 1.8.17
-
H5Pget_efile_prefix
@Cast("ssize_t") public static long H5Pget_efile_prefix(@Cast("hid_t") long dapl_id, @Cast("char*") ByteBuffer prefix, @Cast("size_t") long size)
-
H5Pget_efile_prefix
@Cast("ssize_t") public static long H5Pget_efile_prefix(@Cast("hid_t") long dapl_id, @Cast("char*") byte[] prefix, @Cast("size_t") long size)
-
H5Pget_virtual_prefix
@Cast("ssize_t") public static long H5Pget_virtual_prefix(@Cast("hid_t") long dapl_id, @Cast("char*") BytePointer prefix, @Cast("size_t") long size)
\ingroup DAPL \brief Retrieves prefix applied to VDS source file paths \dapl_id- Parameters:
prefix- [out] Prefix applied to VDS source file pathssize- [in] Size of prefix, including null terminator- Returns:
- If successful, returns a non-negative value specifying the size in bytes of the prefix without the NULL terminator; otherwise returns a negative value. \details H5Pget_virtual_prefix() retrieves the prefix applied to the path of any VDS source files traversed. When an VDS source file is traversed, the prefix is retrieved from the dataset access property list \p dapl_id, returned in the user-allocated buffer pointed to by \p prefix, and prepended to the filename stored in the VDS virtual file, set with H5Pset_virtual(). The size in bytes of the prefix, including the NULL terminator, is specified in \p size. If \p size is unknown, a preliminary H5Pget_virtual_prefix() call with the pointer \p prefix set to NULL will return the size of the prefix without the NULL terminator. \see_virtual
- Since:
- 1.10.2
-
H5Pget_virtual_prefix
@Cast("ssize_t") public static long H5Pget_virtual_prefix(@Cast("hid_t") long dapl_id, @Cast("char*") ByteBuffer prefix, @Cast("size_t") long size)
-
H5Pget_virtual_prefix
@Cast("ssize_t") public static long H5Pget_virtual_prefix(@Cast("hid_t") long dapl_id, @Cast("char*") byte[] prefix, @Cast("size_t") long size)
-
H5Pget_virtual_printf_gap
@Cast("herr_t") public static int H5Pget_virtual_printf_gap(@Cast("hid_t") long dapl_id, @Cast("hsize_t*") LongPointer gap_size)
\ingroup DAPL \brief Returns the maximum number of missing source files and/or datasets with the printf-style names when getting the extent for an unlimited virtual dataset \dapl_id- Parameters:
gap_size- [out] Maximum number of the files and/or datasets allowed to be missing for determining the extent of an unlimited virtual dataset with printf-style mappings. (\em Default: 0)- Returns:
- \herr_t \details H5Pget_virtual_printf_gap() returns the maximum number of missing printf-style files and/or datasets for determining the extent of an unlimited virtual dataaset, \p gap_size, using the access property list for the virtual dataset, \p dapl_id. The default library value for \p gap_size is 0 (zero).
- Since:
- 1.10.0
-
H5Pget_virtual_printf_gap
@Cast("herr_t") public static int H5Pget_virtual_printf_gap(@Cast("hid_t") long dapl_id, @Cast("hsize_t*") LongBuffer gap_size)
-
H5Pget_virtual_printf_gap
@Cast("herr_t") public static int H5Pget_virtual_printf_gap(@Cast("hid_t") long dapl_id, @Cast("hsize_t*") long... gap_size)
-
H5Pget_virtual_view
@Cast("herr_t") public static int H5Pget_virtual_view(@Cast("hid_t") long dapl_id, @Cast("H5D_vds_view_t*") IntPointer view)
\ingroup DAPL \brief Retrieves the view of a virtual dataset accessed with \p dapl_id \dapl_id- Parameters:
view- [out] The flag specifying the view of the virtual dataset.- Returns:
- \herr_t \details H5Pget_virtual_view() takes the virtual dataset access property list, \p dapl_id, and retrieves the flag, \p view, set by the H5Pset_virtual_view() call. \see_virtual
- Since:
- 1.10.0
-
H5Pget_virtual_view
@Cast("herr_t") public static int H5Pget_virtual_view(@Cast("hid_t") long dapl_id, @Cast("H5D_vds_view_t*") IntBuffer view)
-
H5Pget_virtual_view
@Cast("herr_t") public static int H5Pget_virtual_view(@Cast("hid_t") long dapl_id, @Cast("H5D_vds_view_t*") int[] view)
-
H5Pset_append_flush
@Cast("herr_t") public static int H5Pset_append_flush(@Cast("hid_t") long dapl_id, @Cast("unsigned") int ndims, @Cast("const hsize_t*") LongPointer boundary, H5D_append_cb_t func, Pointer udata)
\ingroup DAPL \brief Sets two actions to perform when the size of a datasetâs dimension being appended reaches a specified boundary \dapl_id- Parameters:
ndims- [in] The number of elements for boundaryboundary- [in] The dimension sizes used to determine the boundaryfunc- [in] The user-defined callback functionudata- [in] The user-defined input data- Returns:
- \herr_t \details H5Pset_append_flush() sets the following two actions to perform for a dataset associated with the dataset access property list \p dapl_id: \li Call the callback function \p func set in the property list \li Flush the dataset associated with the dataset access property list When a user is appending data to a dataset via H5DOappend() and the datasetâs newly extended dimension size hits a specified boundary, the library will perform the first action listed above. Upon return from the callback function, the library will then perform the second action listed above and return to the user. If no boundary is hit or set, the two actions above are not invoked. The specified boundary is indicated by the parameter \p boundary. It is a 1-dimensional array with \p ndims elements, which should be the same as the rank of the datasetâs dataspace. While appending to a dataset along a particular dimension index via H5Dappend(), the library determines a boundary is reached when the resulting dimension size is divisible by \p boundary[index]. A zero value for \p boundary[index] indicates no boundary is set for that dimension index. The setting of this property will apply only for a chunked dataset with an extendible dataspace. A dataspace is extendible when it is defined with either one of the following: \li A dataspace with fixed current and maximum dimension sizes \li A dataspace with at least one unlimited dimension for its maximum dimension size When creating or opening a chunked dataset, the library will check whether the boundary as specified in the access property list is set up properly. The library will fail the dataset create or open if the following conditions are true: \li \p ndims, the number of elements for boundary, is not the same as the rank of the datasetâs dataspace. \li A non-zero boundary value is specified for a non-extendible dimension. The callback function \p func must conform to the following prototype: \snippet H5Dpublic.h H5D_append_cb_t_snip The parameters of the callback function, per the above prototype, are defined as follows: \li \p dataset_id is the dataset identifier. \li \p cur_dims is the datasetâs current dimension sizes when a boundary is hit. \li \p user_data is the user-defined input data.
- Since:
- 1.10.0
-
H5Pset_append_flush
@Cast("herr_t") public static int H5Pset_append_flush(@Cast("hid_t") long dapl_id, @Cast("unsigned") int ndims, @Cast("const hsize_t*") LongBuffer boundary, H5D_append_cb_t func, Pointer udata)
-
H5Pset_append_flush
@Cast("herr_t") public static int H5Pset_append_flush(@Cast("hid_t") long dapl_id, @Cast("unsigned") int ndims, @Cast("const hsize_t*") long[] boundary, H5D_append_cb_t func, Pointer udata)
-
H5Pset_chunk_cache
@Cast("herr_t") public static int H5Pset_chunk_cache(@Cast("hid_t") long dapl_id, @Cast("size_t") long rdcc_nslots, @Cast("size_t") long rdcc_nbytes, double rdcc_w0)
\ingroup DAPL \brief Sets the raw data chunk cache parameters \dapl_id- Parameters:
rdcc_nslots- [in] The number of chunk slots in the raw data chunk cache for this dataset. Increasing this value reduces the number of cache collisions, but slightly increases the memory used. Due to the hashing strategy, this value should ideally be a prime number. As a rule of thumb, this value should be at least 10 times the number of chunks that can fit in \p rdcc_nbytes bytes. For maximum performance, this value should be set approximately 100 times that number of chunks. The default value is 521. If the value passed is #H5D_CHUNK_CACHE_NSLOTS_DEFAULT, then the property will not be set on \p dapl_id and the parameter will come from the file access property list used to open the file.rdcc_nbytes- [in] The total size of the raw data chunk cache for this dataset. In most cases increasing this number will improve performance, as long as you have enough free memory. The default size is 1 MB. If the value passed is #H5D_CHUNK_CACHE_NBYTES_DEFAULT, then the property will not be set on \p dapl_id and the parameter will come from the file access property list.rdcc_w- [in] 0 The chunk preemption policy for this dataset. This must be between 0 and 1 inclusive and indicates the weighting according to which chunks which have been fully read or written are penalized when determining which chunks to flush from cache. A value of 0 means fully read or written chunks are treated no differently than other chunks (the preemption is strictly LRU) while a value of 1 means fully read or written chunks are always preempted before other chunks. If your application only reads or writes data once, this can be safely set to 1. Otherwise, this should be set lower, depending on how often you re-read or re-write the same data. The default value is 0.75. If the value passed is #H5D_CHUNK_CACHE_W0_DEFAULT, then the property will not be set on \p dapl_id and the parameter will come from the file access property list.- Returns:
- \herr_t \details H5Pset_chunk_cache() sets the number of elements, the total number of bytes, and the preemption policy value in the raw data chunk cache on a dataset access property list. After calling this function, the values set in the property list will override the values in the file's file access property list. The raw data chunk cache inserts chunks into the cache by first computing a hash value using the address of a chunk, then using that hash value as the chunk's index into the table of cached chunks. The size of this hash table, i.e., and the number of possible hash values, is determined by the \p rdcc_nslots parameter. If a different chunk in the cache has the same hash value, this causes a collision, which reduces efficiency. If inserting the chunk into cache would cause the cache to be too big, then the cache is pruned according to the \p rdcc_w0 parameter. \b Motivation: H5Pset_chunk_cache() is used to adjust the chunk cache parameters on a per-dataset basis, as opposed to a global setting for the file using H5Pset_cache(). The optimum chunk cache parameters may vary widely with different data layout and access patterns, so for optimal performance they must be set individually for each dataset. It may also be beneficial to reduce the size of the chunk cache for datasets whose performance is not important in order to save memory space. \b Example \b Usage: The following code sets the chunk cache to use a hash table with 12421 elements and a maximum size of 16 MB, while using the preemption policy specified for the entire file: \Code{ H5Pset_chunk_cache(dapl_id, 12421, 16*1024*1024, H5D_CHUNK_CACHE_W0_DEFAULT);} \b Usage \b Notes: The chunk cache size is a property for accessing a dataset and is not stored with a dataset or a file. To guarantee the same chunk cache settings each time the dataset is opened, call H5Dopen() with a dataset access property list where the chunk cache size is set by calling H5Pset_chunk_cache() for that property list. The property list can be used for multiple accesses in the same application. For files where the same chunk cache size will be appropriate for all or most datasets, H5Pset_cache() can be called with a file access property list to set the chunk cache size for accessing all datasets in the file. Both methods can be used in combination, in which case the chunk cache size set by H5Pset_cache() will apply except for specific datasets where H5Dopen() is called with dataset property list with the chunk cache size set by H5Pset_chunk_cache(). In the absence of any cache settings, H5Dopen() will by default create a 1 MB chunk cache for the opened dataset. If this size happens to be appropriate, no call will be needed to either function to set the chunk cache size. It is also possible that a change in access pattern for later access to a dataset will change the appropriate chunk cache size.
- Since:
- 1.8.3
-
H5Pset_efile_prefix
@Cast("herr_t") public static int H5Pset_efile_prefix(@Cast("hid_t") long dapl_id, @Cast("const char*") BytePointer prefix)
\ingroup DAPL \brief Sets the external dataset storage file prefix in the dataset access property list \dapl_id- Parameters:
prefix- [in] Dataset external storage prefix in UTF-8 or ASCII (Path and filename must be ASCII on Windows systems.)- Returns:
- \herr_t \details H5Pset_efile_prefix() sets the prefix used to locate raw data files for a dataset that uses external storage. This prefix can provide either an absolute path or a relative path to the external files. H5Pset_efile_prefix() is used in conjunction with H5Pset_external() to control the behavior of the HDF5 library when searching for the raw data files associated with a dataset that uses external storage: \li The default behavior of the library is to search for the datasetâs external storage raw data files in the same directory as the HDF5 file which contains the dataset. \li If the prefix is set to an absolute path, the target directory will be searched for the datasetâs external storage raw data files. \li If the prefix is set to a relative path, the target directory, relative to the current working directory, will be searched for the datasetâs external storage raw data files. \li If the prefix is set to a relative path that begins with the special token ${ORIGIN}, that directory, relative to the HDF5 file containing the dataset, will be searched for the datasetâs external storage raw data files. The HDF5_EXTFILE_PREFIX environment variable can be used to override the above behavior (the environment variable supersedes the API call). Setting the variable to a path string and calling H5Dcreate() or H5Dopen() is the equivalent of calling H5Pset_efile_prefix() and calling the same create or open function. The environment variable is checked at the time of the create or open action and copied so it can be safely changed after the H5Dcreate() or H5Dopen() call. Calling H5Pset_efile_prefix() with \p prefix set to NULL or the empty string returns the search path to the default. The result would be the same as if H5Pset_efile_prefix() had never been called. \note If the external file prefix is not an absolute path and the HDF5 file is moved, the external storage files will also need to be moved so they can be accessed at the new location. \note As stated above, the use of the HDF5_EXTFILE_PREFIX environment variable overrides any property list setting. H5Pset_efile_prefix() and H5Pget_efile_prefix(), being property functions, set and retrieve only the property list setting; they are unaware of the environment variable. \note On Windows, the prefix must be an ASCII string since the Windows standard C libraryâs I/O functions cannot handle UTF-8 file names.
- Since:
- 1.10.0, 1.8.17
-
H5Pset_efile_prefix
@Cast("herr_t") public static int H5Pset_efile_prefix(@Cast("hid_t") long dapl_id, String prefix)
-
H5Pset_virtual_prefix
@Cast("herr_t") public static int H5Pset_virtual_prefix(@Cast("hid_t") long dapl_id, @Cast("const char*") BytePointer prefix)
\ingroup DAPL \brief Sets prefix to be applied to VDS source file paths \dapl_id- Parameters:
prefix- [in] Prefix to be applied to VDS source file paths- Returns:
- \herr_t \details H5Pset_virtual_prefix() sets the prefix to be applied to the path of any VDS source files traversed. The prefix is prepended to the filename stored in the VDS virtual file, set with H5Pset_virtual(). The prefix is specified in the user-allocated buffer \p prefix and set in the dataset access property list \p dapl_id. The buffer should not be freed until the property list has been closed. \see_virtual
- Since:
- 1.10.2
-
H5Pset_virtual_prefix
@Cast("herr_t") public static int H5Pset_virtual_prefix(@Cast("hid_t") long dapl_id, String prefix)
-
H5Pset_virtual_printf_gap
@Cast("herr_t") public static int H5Pset_virtual_printf_gap(@Cast("hid_t") long dapl_id, @Cast("hsize_t") long gap_size)
\ingroup DAPL \brief Sets the maximum number of missing source files and/or datasets with the printf-style names when getting the extent of an unlimited virtual dataset \dapl_id- Parameters:
gap_size- [in] Maximum number of files and/or datasets allowed to be missing for determining the extent of an unlimited virtual dataset with printf-style mappings (Default value: 0)- Returns:
- \herr_t \details H5Pset_virtual_printf_gap() sets the access property list for the virtual dataset, \p dapl_id, to instruct the library to stop looking for the mapped data stored in the files and/or datasets with the printf-style names after not finding \p gap_size files and/or datasets. The found source files and datasets will determine the extent of the unlimited virtual dataset with the printf-style mappings. Consider the following examples where the regularly spaced blocks of a virtual dataset are mapped to datasets with the names d-1, d-2, d-3, ..., d-N, ... : \li If the dataset d-2 is missing and \p gap_size is set to 0, then the virtual dataset will contain only data found in d-1. \li If d-2 and d-3 are missing and \p gap_size is set to 2, then the virtual dataset will contain the data from d-1, d-3, ..., d-N, ... . The blocks that are mapped to d-2 and d-3 will be filled according to the virtual datasetâs fill value setting. \see_virtual
- Since:
- 1.10.0
-
H5Pset_virtual_view
@Cast("herr_t") public static int H5Pset_virtual_view(@Cast("hid_t") long dapl_id, @Cast("H5D_vds_view_t") int view)
\ingroup DAPL \brief Sets the view of the virtual dataset (VDS) to include or exclude missing mapped elements \dapl_id- Parameters:
view- [in] Flag specifying the extent of the data to be included in the view.- Returns:
- \herr_t \details H5Pset_virtual_view() takes the access property list for the virtual dataset, \p dapl_id, and the flag, \p view, and sets the VDS view according to the flag value. If \p view is set to #H5D_VDS_FIRST_MISSING, the view includes all data before the first missing mapped data. This setting provides a view containing only the continuous data starting with the datasetâs first data element. Any break in continuity terminates the view. If \p view is set to #H5D_VDS_LAST_AVAILABLE, the view includes all available mapped data. Missing mapped data is filled with the fill value set in the VDS creation property list. \see_virtual
- Since:
- 1.10.0
-
H5Pget_btree_ratios
@Cast("herr_t") public static int H5Pget_btree_ratios(@Cast("hid_t") long plist_id, DoublePointer left, DoublePointer middle, DoublePointer right)
\ingroup DXPL \brief Gets B-tree split ratios for a dataset transfer property list \dxpl_id{plist_id}- Parameters:
left- [out] The B-tree split ratio for left-most nodesmiddle- [out] The B-tree split ratio for right-most nodes and lone nodesright- [out] The B-tree split ratio for all other nodes- Returns:
- \herr_t \details H5Pget_btree_ratios() returns the B-tree split ratios for a dataset transfer property list. The B-tree split ratios are returned through the non-NULL arguments \p left, \p middle, and \p right, as set by the H5Pset_btree_ratios() function.
-
H5Pget_btree_ratios
@Cast("herr_t") public static int H5Pget_btree_ratios(@Cast("hid_t") long plist_id, DoubleBuffer left, DoubleBuffer middle, DoubleBuffer right)
-
H5Pget_btree_ratios
@Cast("herr_t") public static int H5Pget_btree_ratios(@Cast("hid_t") long plist_id, double[] left, double[] middle, double[] right)
-
H5Pget_buffer
@Cast("size_t") public static long H5Pget_buffer(@Cast("hid_t") long plist_id, @Cast("void**") PointerPointer tconv, @Cast("void**") PointerPointer bkg)
\ingroup DXPL \brief Reads buffer settings- Parameters:
plist_id- [in] Identifier for the dataset transfer property listtconv- [out] Address of the pointer to application-allocated type conversion bufferbkg- [out] Address of the pointer to application-allocated background buffer- Returns:
- Returns buffer size, in bytes, if successful; otherwise 0 on failure. \details H5Pget_buffer() reads values previously set with H5Pset_buffer().
-
H5Pget_buffer
@Cast("size_t") public static long H5Pget_buffer(@Cast("hid_t") long plist_id, @Cast("void**") @ByPtrPtr Pointer tconv, @Cast("void**") @ByPtrPtr Pointer bkg)
-
H5Pget_data_transform
@Cast("ssize_t") public static long H5Pget_data_transform(@Cast("hid_t") long plist_id, @Cast("char*") BytePointer expression, @Cast("size_t") long size)
\ingroup DXPL \brief Retrieves a data transform expression- Parameters:
plist_id- [in] Identifier of the property list or classexpression- [out] Pointer to memory where the transform expression will be copiedsize- [in] Number of bytes of the transform expression to copy to- Returns:
- Success: the size of the transform expression. Failure: a negative value. \details H5Pget_data_transform() retrieves the data transform expression previously set in the dataset transfer property list \p plist_id by H5Pset_data_transform(). H5Pget_data_transform() can be used to both retrieve the transform expression and query its size. If \p expression is non-NULL, up to \p size bytes of the data transform expression are written to the buffer. If \p expression is NULL, \p size is ignored, and the function does not write anything to the buffer. The function always returns the size of the data transform expression. If 0 is returned for the size of the expression, no data transform expression exists for the property list. If an error occurs, the buffer pointed to by \p expression is unchanged, and the function returns a negative value.
- Since:
- 1.8.0
-
H5Pget_data_transform
@Cast("ssize_t") public static long H5Pget_data_transform(@Cast("hid_t") long plist_id, @Cast("char*") ByteBuffer expression, @Cast("size_t") long size)
-
H5Pget_data_transform
@Cast("ssize_t") public static long H5Pget_data_transform(@Cast("hid_t") long plist_id, @Cast("char*") byte[] expression, @Cast("size_t") long size)
-
H5Pget_edc_check
@Cast("H5Z_EDC_t") public static int H5Pget_edc_check(@Cast("hid_t") long plist_id)
\ingroup DXPL \brief Determines whether error-detection is enabled for dataset reads- Parameters:
plist_id- [in] Dataset transfer property list identifier- Returns:
- Returns \p H5Z_ENABLE_EDC or \p H5Z_DISABLE_EDC if successful; otherwise returns a negative value. \details H5Pget_edc_check() queries the dataset transfer property list \p plist to determine whether error detection is enabled for data read operations.
- Since:
- 1.6.0
-
H5Pget_hyper_vector_size
@Cast("herr_t") public static int H5Pget_hyper_vector_size(@Cast("hid_t") long fapl_id, @Cast("size_t*") SizeTPointer size)
\ingroup DXPL \brief Retrieves number of I/O vectors to be read/written in hyperslab I/O- Parameters:
fapl_id- [in] Dataset transfer property list identifiersize- [out] Number of I/O vectors to accumulate in memory for I/O operations- Returns:
- \herr_t \details H5Pget_hyper_vector_size() retrieves the number of I/O vectors to be accumulated in memory before being issued to the lower levels of the HDF5 library for reading or writing the actual data. The number of I/O vectors set in the dataset transfer property list \p fapl_id is returned in \p size. Unless the default value is in use, \p size was previously set with a call to H5Pset_hyper_vector_size().
- Since:
- 1.6.0
-
H5Pget_preserve
public static int H5Pget_preserve(@Cast("hid_t") long plist_id)
Deprecated.{H5Pget_preserve() is deprecated as it is no longer useful; compound datatype field preservation is now core functionality in the HDF5 library.}\ingroup DXPL \brief Checks status of the dataset transfer property list (\b DEPRECATED)- Parameters:
plist_id- [in] Identifier for the dataset transfer property list- Returns:
- Returns 1 or 0 if successful; otherwise returns a negative value. \details H5Pget_preserve() checks the status of the dataset transfer property list.
- Since:
- 1.0.0
-
H5Pget_type_conv_cb
@Cast("herr_t") public static int H5Pget_type_conv_cb(@Cast("hid_t") long dxpl_id, @ByPtrPtr H5T_conv_except_func_t op, @Cast("void**") PointerPointer operate_data)
\ingroup DXPL \brief Gets user-defined datatype conversion callback function- Parameters:
dxpl_id- [in] Dataset transfer property list identifierop- [out] User-defined type conversion callback functionoperate_data- [out] User-defined input data for the callback function- Returns:
- \herr_t \details H5Pget_type_conv_cb() gets the user-defined datatype conversion callback function \p op in the dataset transfer property list \p dxpl_id. The parameter \p operate_data is a pointer to user-defined input data for the callback function. The callback function \p op defines the actions an application is to take when there is an exception during datatype conversion. Please refer to the function H5Pset_type_conv_cb() for more details.
- Since:
- 1.8.0
-
H5Pget_type_conv_cb
@Cast("herr_t") public static int H5Pget_type_conv_cb(@Cast("hid_t") long dxpl_id, @ByPtrPtr H5T_conv_except_func_t op, @Cast("void**") @ByPtrPtr Pointer operate_data)
-
H5Pget_vlen_mem_manager
@Cast("herr_t") public static int H5Pget_vlen_mem_manager(@Cast("hid_t") long plist_id, @ByPtrPtr H5MM_allocate_t alloc_func, @Cast("void**") PointerPointer alloc_info, @ByPtrPtr H5MM_free_t free_func, @Cast("void**") PointerPointer free_info)
\ingroup DXPL \brief Gets the memory manager for variable-length datatype allocation in H5Dread() and H5Dvlen_reclaim()- Parameters:
plist_id- [in] Identifier for the dataset transfer property listalloc_func- [out] User's allocate routine, or NULL for system mallocalloc_info- [out] Extra parameter for userâs allocation routine. Contents are ignored if preceding parameter is NULL @param free_func [out] User's free routine, or NULL for system free @param free_info [out] Extra parameter for userâs free routine. Contents are ignored if preceding parameter is NULL- Returns:
- \herr_t \details H5Pget_vlen_mem_manager() is the companion function to H5Pset_vlen_mem_manager(), returning the parameters set by that function.
- Since:
- 1.0.0
-
H5Pget_vlen_mem_manager
@Cast("herr_t") public static int H5Pget_vlen_mem_manager(@Cast("hid_t") long plist_id, @ByPtrPtr H5MM_allocate_t alloc_func, @Cast("void**") @ByPtrPtr Pointer alloc_info, @ByPtrPtr H5MM_free_t free_func, @Cast("void**") @ByPtrPtr Pointer free_info)
-
H5Pset_btree_ratios
@Cast("herr_t") public static int H5Pset_btree_ratios(@Cast("hid_t") long plist_id, double left, double middle, double right)
\ingroup DXPL \brief Sets B-tree split ratios for a dataset transfer property list- Parameters:
plist_id- [in] The dataset transfer property list identifierleft- [in] The B-tree split ratio for left-most nodesmiddle- [in] The B-tree split ratio for all other nodesright- [in] The B-tree split ratio for right-most nodes and lone nodes- Returns:
- \herr_t \details H5Pset_btree_ratios() sets the B-tree split ratios for a dataset transfer property list. The split ratios determine what percent of children go in the first node when a node splits. The ratio \p left is used when the splitting node is the left-most node at its level in the tree; the ratio \p right is used when the splitting node is the right-most node at its level; and the ratio \p middle is used for all other cases. A node that is the only node at its level in the tree uses the ratio \p right when it splits. All ratios are real numbers between 0 and 1, inclusive.
-
H5Pset_buffer
@Cast("herr_t") public static int H5Pset_buffer(@Cast("hid_t") long plist_id, @Cast("size_t") long size, Pointer tconv, Pointer bkg)
\ingroup DXPL \brief Sets type conversion and background buffers \dxpl_id{plist_id}- Parameters:
size- [in] Size, in bytes, of the type conversion and background bufferstconv- [in] Pointer to application-allocated type conversion bufferbkg- [in] Pointer to application-allocated background buffer- Returns:
- \herr_t \details Given a dataset transfer property list, H5Pset_buffer() sets the maximum size for the type conversion buffer and background buffer and optionally supplies pointers to application-allocated buffers. If the buffer size is smaller than the entire amount of data being transferred between the application and the file, and a type conversion buffer or background buffer is required, then strip mining will be used. Note that there are minimum size requirements for the buffer. Strip mining can only break the data up along the first dimension, so the buffer must be large enough to accommodate a complete slice that encompasses all of the remaining dimensions. For example, when strip mining a \Code{100x200x300} hyperslab of a simple data space, the buffer must be large enough to hold \Code{1x200x300} data elements. When strip mining a \Code{100x200x300x150} hyperslab of a simple data space, the buffer must be large enough to hold \Code{1x200x300x150} data elements. If \p tconv and/or \p bkg are null pointers, then buffers will be allocated and freed during the data transfer. The default value for the maximum buffer is 1 MiB.
-
H5Pset_data_transform
@Cast("herr_t") public static int H5Pset_data_transform(@Cast("hid_t") long plist_id, @Cast("const char*") BytePointer expression)
\ingroup DXPL \brief Sets a data transform expression \dxpl_id{plist_id}- Parameters:
expression- [in] Pointer to the null-terminated data transform expression- Returns:
- \herr_t \details H5Pset_data_transform() sets the data transform to be used for reading and writing data. This function operates on the dataset transfer property list \p plist_id. The \p expression parameter is a string containing an algebraic expression, such as \Code{(5/9.0)*(x-32)} or \Code{x*(x-5)}. When a dataset is read or written with this property list, the transform expression is applied with the \c x being replaced by the values in the dataset. When reading data, the values in the file are not changed and the transformed data is returned to the user. Data transforms can only be applied to integer or floating-point datasets. Order of operations is obeyed and the only supported operations are +, -, *, and /. Parentheses can be nested arbitrarily and can be used to change precedence. When writing data back to the dataset, the transformed data is written to the file and there is no way to recover the original values to which the transform was applied.
- Since:
- 1.8.0
-
H5Pset_data_transform
@Cast("herr_t") public static int H5Pset_data_transform(@Cast("hid_t") long plist_id, String expression)
-
H5Pset_edc_check
@Cast("herr_t") public static int H5Pset_edc_check(@Cast("hid_t") long plist_id, @Cast("H5Z_EDC_t") int check)
\ingroup DXPL \brief Sets the dataset transfer property list to enable or disable error detection when reading data \dxpl_id{plist_id}- Parameters:
check- [in] Specifies whether error checking is enabled or disabled for dataset read operations- Returns:
- \herr_t \details H5Pset_edc_check() sets the dataset transfer property list \p plist to enable or disable error detection when reading data. Whether error detection is enabled or disabled is specified in the \p check parameter. Valid values are #H5Z_ENABLE_EDC (default) and #H5Z_DISABLE_EDC. \note The initial error detection implementation, Fletcher32 checksum, supports error detection for chunked datasets only. \attention The Fletcher32 EDC checksum filter, set with H5Pset_fletcher32(), was added in HDF5 Release 1.6.0. In the original implementation, however, the checksum value was calculated incorrectly on little-endian systems. The error was fixed in HDF5 Release 1.6.3.\n As a result of this fix, an HDF5 library of Release 1.6.0 through Release 1.6.2 cannot read a dataset created or written with Release 1.6.3 or later if the dataset was created with the checksum filter and the filter is enabled in the reading library. (Libraries of Release 1.6.3 and later understand the earlier error and compensate appropriately.)\n \Bold{Work-around:} An HDF5 library of Release 1.6.2 or earlier will be able to read a dataset created or written with the checksum filter by an HDF5 library of Release 1.6.3 or later if the checksum filter is disabled for the read operation. This can be accomplished via an H5Pset_edc_check() call with the value #H5Z_DISABLE_EDC in the second parameter. This has the obvious drawback that the application will be unable to verify the checksum, but the data does remain accessible.
- Since:
- 1.6.0
-
H5Pset_filter_callback
@Cast("herr_t") public static int H5Pset_filter_callback(@Cast("hid_t") long plist_id, H5Z_filter_func_t func, Pointer op_data)
\ingroup DXPL \brief Sets user-defined filter callback function \dxpl_id{plist_id}- Parameters:
func- [in] User-defined filter callback functionop_data- [in] User-defined input data for the callback function- Returns:
- \herr_t \details H5Pset_filter_callback() sets the user-defined filter callback function \p func in the dataset transfer property list \p plist_id. The parameter \p op_data is a pointer to user-defined input data for the callback function and will be passed through to the callback function. The callback function \p func defines the actions an application is to take when a filter fails. The function prototype is as follows: \snippet H5Zpublic.h H5Z_filter_func_t_snip where \c filter indicates which filter has failed, \c buf and \c buf_size are used to pass in the failed data, and op_data is the required input data for this callback function. Valid callback function return values are #H5Z_CB_FAIL and #H5Z_CB_CONT.
- Since:
- 1.6.0
-
H5Pset_hyper_vector_size
@Cast("herr_t") public static int H5Pset_hyper_vector_size(@Cast("hid_t") long plist_id, @Cast("size_t") long size)
\ingroup DXPL \brief Sets number of I/O vectors to be read/written in hyperslab I/O \dxpl_id{plist_id}- Parameters:
size- [in] Number of I/O vectors to accumulate in memory for I/O operations\n Must be greater than 1 (one)\n Default value: 1024- Returns:
- \herr_t \details H5Pset_hyper_vector_size() sets the number of I/O vectors to be accumulated in memory before being issued to the lower levels of the HDF5 library for reading or writing the actual data. The I/O vectors are hyperslab offset and length pairs and are generated during hyperslab I/O. The number of I/O vectors is passed in \p size to be set in the dataset transfer property list \p plist_id. \p size must be greater than 1 (one). H5Pset_hyper_vector_size() is an I/O optimization function; increasing vector_size should provide better performance, but the library will use more memory during hyperslab I/O. The default value of \p size is 1024.
- Since:
- 1.6.0
-
H5Pset_preserve
@Cast("herr_t") public static int H5Pset_preserve(@Cast("hid_t") long plist_id, @Cast("hbool_t") boolean status)
Deprecated.This function is deprecated as it no longer has any effect; compound datatype field preservation is now core functionality in the HDF5 library. \details H5Pset_preserve() sets the dataset transfer property list status to \c 1 or \c 0. When reading or writing compound datatypes and the destination is partially initialized and the read/write is intended to initialize the other members, one must set this property to \c 1. Otherwise the I/O pipeline treats the destination datapoints as completely uninitialized.\ingroup DXPL \brief Sets the dataset transfer property list \p status \dxpl_id{plist_id}- Parameters:
status- [in] Status toggle of the dataset transfer property list- Returns:
- \herr_t
- Since:
- 1.0.0
-
H5Pset_type_conv_cb
@Cast("herr_t") public static int H5Pset_type_conv_cb(@Cast("hid_t") long dxpl_id, H5T_conv_except_func_t op, Pointer operate_data)
\ingroup DXPL \brief Sets user-defined datatype conversion callback function \dxpl_id- Parameters:
op- [in] User-defined type conversion callback functionoperate_data- [in] User-defined input data for the callback function- Returns:
- \herr_t \details H5Pset_type_conv_cb() sets the user-defined datatype conversion callback function \p op in the dataset transfer property list \p dxpl_id The parameter operate_data is a pointer to user-defined input data for the callback function and will be passed through to the callback function. The callback function \p op defines the actions an application is to take when there is an exception during datatype conversion. The function prototype is as follows: \snippet H5Tpublic.h H5T_conv_except_func_t_snip
- Since:
- 1.8.0
-
H5Pset_vlen_mem_manager
@Cast("herr_t") public static int H5Pset_vlen_mem_manager(@Cast("hid_t") long plist_id, H5MM_allocate_t alloc_func, Pointer alloc_info, H5MM_free_t free_func, Pointer free_info)
\ingroup DXPL \brief Sets the memory manager for variable-length datatype allocation in H5Dread() and H5Dvlen_reclaim() \dxpl_id{plist_id}- Parameters:
alloc_func- [in] User's allocate routine, or \c NULL for system \c mallocalloc_info- [in] Extra parameter for user's allocation routine. Contents are ignored if preceding parameter is \c NULL.free_func- [in] User's free routine, or \c NULL for system \c freefree_info- [in] Extra parameter for user's free routine. Contents are ignored if preceding parameter is \c NULL- Returns:
- \herr_t \details H5Pset_vlen_mem_manager() sets the memory manager for variable-length datatype allocation in H5Dread() and free in H5Dvlen_reclaim(). The \p alloc_func and \p free_func parameters identify the memory management routines to be used. If the user has defined custom memory management routines, \p alloc_func and/or free_func should be set to make those routine calls (i.e., the name of the routine is used as the value of the parameter); if the user prefers to use the system's \c malloc and/or \c free, the \p alloc_func and \p free_func parameters, respectively, should be set to \c NULL The prototypes for these user-defined functions are as follows: \snippet H5MMpublic.h H5MM_allocate_t_snip \snippet H5MMpublic.h H5MM_free_t_snip The \p alloc_info and \p free_info parameters can be used to pass along any required information to the user's memory management routines. In summary, if the user has defined custom memory management routines, the name(s) of the routines are passed in the \p alloc_func and \p free_func parameters and the custom routines' parameters are passed in the \p alloc_info and \p free_info parameters. If the user wishes to use the system \c malloc and \c free functions, the \p alloc_func and/or \p free_func parameters are set to \c NULL and the \p alloc_info and \p free_info parameters are ignored.
- Since:
- 1.0.0
-
H5Pset_dataset_io_hyperslab_selection
@Cast("herr_t") public static int H5Pset_dataset_io_hyperslab_selection(@Cast("hid_t") long plist_id, @Cast("unsigned") int rank, @Cast("H5S_seloper_t") int op, @Cast("const hsize_t*") LongPointer start, @Cast("const hsize_t*") LongPointer stride, @Cast("const hsize_t*") LongPointer count, @Cast("const hsize_t*") LongPointer block)
\ingroup DXPL \brief Sets a hyperslab file selection for a dataset I/O operation- Parameters:
plist_id- [in] Property list identifierrank- [in] Number of dimensions of selectionop- [in] Operation to perform on current selectionstart- [in] Offset of start of hyperslabstride- [in] Hyperslab stridecount- [in] Number of blocks included in hyperslabblock- [in] Size of block in hyperslab- Returns:
- \herr_t \details H5Pset_dataset_io_hyperslab_selection() is designed to be used in conjunction with using #H5S_PLIST for the file dataspace ID when making a call to H5Dread() or H5Dwrite(). When used with #H5S_PLIST, the selection created by one or more calls to this routine is used for determining which dataset elements to access. \p rank is the dimensionality of the selection and determines the size of the \p start, \p stride, \p count, and \p block arrays. \p rank must be between 1 and #H5S_MAX_RANK, inclusive. The \p op, \p start, \p stride, \p count, and \p block parameters behave identically to their behavior for H5Sselect_hyperslab(), please see the documentation for that routine for details about their use.
- Since:
- 1.14.0
-
H5Pset_dataset_io_hyperslab_selection
@Cast("herr_t") public static int H5Pset_dataset_io_hyperslab_selection(@Cast("hid_t") long plist_id, @Cast("unsigned") int rank, @Cast("H5S_seloper_t") int op, @Cast("const hsize_t*") LongBuffer start, @Cast("const hsize_t*") LongBuffer stride, @Cast("const hsize_t*") LongBuffer count, @Cast("const hsize_t*") LongBuffer block)
-
H5Pset_dataset_io_hyperslab_selection
@Cast("herr_t") public static int H5Pset_dataset_io_hyperslab_selection(@Cast("hid_t") long plist_id, @Cast("unsigned") int rank, @Cast("H5S_seloper_t") int op, @Cast("const hsize_t*") long[] start, @Cast("const hsize_t*") long[] stride, @Cast("const hsize_t*") long[] count, @Cast("const hsize_t*") long... block)
-
H5Pget_create_intermediate_group
@Cast("herr_t") public static int H5Pget_create_intermediate_group(@Cast("hid_t") long plist_id, @Cast("unsigned*") IntPointer crt_intmd)
\ingroup LCPL \brief Determines whether property is set to enable creating missing intermediate groups \lcpl_id{plist_id}- Parameters:
crt_intmd- [out] Flag specifying whether to create intermediate groups upon creation of an object- Returns:
- \herr_t \details H5Pget_create_intermediate_group() determines whether the link creation property list \p plist_id is set to allow functions that create objects in groups different from the current working group to create intermediate groups that may be missing in the path of a new or moved object. Functions that create objects in or move objects to a group other than the current working group make use of this property. H5Gcreate_anon() and H5Lmove() are examples of such functions. If \p crt_intmd is positive, missing intermediate groups will be created; if \p crt_intmd is non-positive, missing intermediate groups will not be created.
- Since:
- 1.8.0
-
H5Pget_create_intermediate_group
@Cast("herr_t") public static int H5Pget_create_intermediate_group(@Cast("hid_t") long plist_id, @Cast("unsigned*") IntBuffer crt_intmd)
-
H5Pget_create_intermediate_group
@Cast("herr_t") public static int H5Pget_create_intermediate_group(@Cast("hid_t") long plist_id, @Cast("unsigned*") int[] crt_intmd)
-
H5Pset_create_intermediate_group
@Cast("herr_t") public static int H5Pset_create_intermediate_group(@Cast("hid_t") long plist_id, @Cast("unsigned") int crt_intmd)
\ingroup LCPL \brief Specifies in property list whether to create missing intermediate groups \lcpl_id{plist_id}- Parameters:
crt_intmd- [in] Flag specifying whether to create intermediate groups upon the creation of an object- Returns:
- \herr_t \details H5Pset_create_intermediate_group()
- Since:
-
H5Pget_est_link_info
@Cast("herr_t") public static int H5Pget_est_link_info(@Cast("hid_t") long plist_id, @Cast("unsigned*") IntPointer est_num_entries, @Cast("unsigned*") IntPointer est_name_len)
\ingroup GCPL \brief Returns the estimated link count and average link name length in a group \gcpl_id{plist_id}- Parameters:
est_num_entries- [out] The estimated number of links in the group referenced by \p plist_idest_name_len- [out] The estimated average length of line names in the group referenced by \p plist_id- Returns:
- \herr_t \details H5Pget_est_link_info() retrieves two settings from the group creation property list \p plist_id: the estimated number of links that are expected to be inserted into a group created with the property list and the estimated average length of those link names. The estimated number of links is returned in \p est_num_entries. The limit for \p est_num_entries is 64 K. The estimated average length of the anticipated link names is returned in \p est_name_len. The limit for \p est_name_len is 64 K. See \ref_group_impls for a discussion of the available types of HDF5 group structures.
- Since:
- 1.8.0
-
H5Pget_est_link_info
@Cast("herr_t") public static int H5Pget_est_link_info(@Cast("hid_t") long plist_id, @Cast("unsigned*") IntBuffer est_num_entries, @Cast("unsigned*") IntBuffer est_name_len)
-
H5Pget_est_link_info
@Cast("herr_t") public static int H5Pget_est_link_info(@Cast("hid_t") long plist_id, @Cast("unsigned*") int[] est_num_entries, @Cast("unsigned*") int[] est_name_len)
-
H5Pget_link_creation_order
@Cast("herr_t") public static int H5Pget_link_creation_order(@Cast("hid_t") long plist_id, @Cast("unsigned*") IntPointer crt_order_flags)
\ingroup GCPL \brief Queries whether link creation order is tracked and/or indexed in a group- Parameters:
plist_id- [in] Group or file creation property list identifiercrt_order_flags- [out] Creation order flag(s)- Returns:
- \herr_t \details H5Pget_link_creation_order() queries the group or file creation property list, \p plist_id, and returns a flag indicating whether link creation order is tracked and/or indexed in a group. See H5Pset_link_creation_order() for a list of valid creation order flags, as passed in \p crt_order_flags, and their meanings.
- Since:
- 1.8.0
-
H5Pget_link_creation_order
@Cast("herr_t") public static int H5Pget_link_creation_order(@Cast("hid_t") long plist_id, @Cast("unsigned*") IntBuffer crt_order_flags)
-
H5Pget_link_creation_order
@Cast("herr_t") public static int H5Pget_link_creation_order(@Cast("hid_t") long plist_id, @Cast("unsigned*") int[] crt_order_flags)
-
H5Pget_link_phase_change
@Cast("herr_t") public static int H5Pget_link_phase_change(@Cast("hid_t") long plist_id, @Cast("unsigned*") IntPointer max_compact, @Cast("unsigned*") IntPointer min_dense)
\ingroup GCPL \brief Queries the settings for conversion between compact and dense groups \gcpl_id{plist_id}- Parameters:
max_compact- [out] Maximum number of links for compact storagemin_dense- [out] Minimum number of links for dense storage- Returns:
- \herr_t \details H5Pget_link_phase_change() queries the maximum number of entries for a compact group and the minimum number of links to require before converting a group to a dense form. In the compact format, links are stored as messages in the groupâs header. In the dense format, links are stored in a fractal heap and indexed with a version 2 B-tree. \p max_compact is the maximum number of links to store as header messages in the group header before converting the group to the dense format. Groups that are in the compact format and exceed this number of links are automatically converted to the dense format. \p min_dense is the minimum number of links to store in the dense format. Groups which are in dense format and in which the number of links falls below this number are automatically converted back to the compact format. In the compact format, links are stored as messages in the groupâs header. In the dense format, links are stored in a fractal heap and indexed with a version 2 B-tree. See H5Pset_link_phase_change() for a discussion of traditional, compact, and dense group storage.
- Since:
- 1.8.0
-
H5Pget_link_phase_change
@Cast("herr_t") public static int H5Pget_link_phase_change(@Cast("hid_t") long plist_id, @Cast("unsigned*") IntBuffer max_compact, @Cast("unsigned*") IntBuffer min_dense)
-
H5Pget_link_phase_change
@Cast("herr_t") public static int H5Pget_link_phase_change(@Cast("hid_t") long plist_id, @Cast("unsigned*") int[] max_compact, @Cast("unsigned*") int[] min_dense)
-
H5Pget_local_heap_size_hint
@Cast("herr_t") public static int H5Pget_local_heap_size_hint(@Cast("hid_t") long plist_id, @Cast("size_t*") SizeTPointer size_hint)
\ingroup GCPL \brief Retrieves the anticipated size of the local heap for original-style groups \gcpl_id{plist_id}- Parameters:
size_hint- [out] Anticipated size of local heap- Returns:
- \herr_t \details H5Pget_local_heap_size_hint() queries the group creation property list, \p plist_id, for the anticipated size of the local heap, \p size_hint, for original-style groups, i.e., for groups of the style used prior to HDF5 Release 1.8.0. See H5Pset_local_heap_size_hint() for further discussion.
- Since:
- 1.8.0
-
H5Pset_est_link_info
@Cast("herr_t") public static int H5Pset_est_link_info(@Cast("hid_t") long plist_id, @Cast("unsigned") int est_num_entries, @Cast("unsigned") int est_name_len)
\ingroup GCPL \brief Sets estimated number of links and length of link names in a group \gcpl_id{plist_id}- Parameters:
est_num_entries- [in] Estimated number of links to be inserted into groupest_name_len- [in] Estimated average length of link names- Returns:
- \herr_t \details H5Pset_est_link_info() inserts two settings into the group creation property list plist_id: the estimated number of links that are expected to be inserted into a group created with the property list and the estimated average length of those link names. The estimated number of links is passed in \p est_num_entries. The limit for \p est_num_entries is 64 K. The estimated average length of the anticipated link names is passed in \p est_name_len. The limit for \p est_name_len is 64 K. The values for these two settings are multiplied to compute the initial local heap size (for old-style groups, if the local heap size hint is not set) or the initial object header size for (new-style compact groups; see \ref_group_impls). Accurately setting these parameters will help reduce wasted file space. If a group is expected to have many links and to be stored in dense format, set \p est_num_entries to 0 (zero) for maximum efficiency. This will prevent the group from being created in the compact format. See \ref_group_impls for a discussion of the available types of HDF5 group structures.
- Since:
- 1.8.0
-
H5Pset_link_creation_order
@Cast("herr_t") public static int H5Pset_link_creation_order(@Cast("hid_t") long plist_id, @Cast("unsigned") int crt_order_flags)
\ingroup GCPL \brief Sets creation order tracking and indexing for links in a group- Parameters:
plist_id- [in] Group or file creation property list identifiercrt_order_flags- [out] Creation order flag(s)- Returns:
- \herr_t
\details H5Pset_link_creation_order() sets flags for tracking and
indexing links on creation order in groups created with the
group (or file) creation property list \p plist_id.
\p crt_order_flags contains flags with the following meanings:
The default behavior is that links are tracked and indexed by name, and link creation order is neither tracked nor indexed. The name is always the primary index for links in a group. H5Pset_link_creation_order() can be used to set link creation order tracking, or to set link creation order tracking and indexing. If (#H5P_CRT_ORDER_TRACKED | #H5P_CRT_ORDER_INDEXED) is specified for \p crt_order_flags, then links will be tracked and indexed by creation order. The creation order is added as a secondary index and enables faster queries and iterations by creation order. If just #H5P_CRT_ORDER_TRACKED is specified for \p crt_order_flags, then links will be tracked by creation order, but not indexed by creation order. Queries and iterations by creation order will work but will be much slower for large groups than if #H5P_CRT_ORDER_INDEXED had been included. \note If a creation order index is to be built, it must be specified in the group creation property list. HDF5 currently provides no mechanism to turn on link creation order tracking at group creation time and to build the index later.#H5P_CRT_ORDER_TRACKED Link creation order is tracked but not necessarily indexed #H5P_CRT_ORDER_INDEXED Link creation order is indexed (requires #H5P_CRT_ORDER_TRACKED) - Since:
- 1.8.0
-
H5Pset_link_phase_change
@Cast("herr_t") public static int H5Pset_link_phase_change(@Cast("hid_t") long plist_id, @Cast("unsigned") int max_compact, @Cast("unsigned") int min_dense)
\ingroup GCPL \brief Sets the parameters for conversion between compact and dense groups \gcpl_id{plist_id}- Parameters:
max_compact- [in] Maximum number of links for compact storage (\a Default: 8)min_dense- [in] Minimum number of links for dense storage (\a Default: 6)- Returns:
- \herr_t \details H5Pset_link_phase_change() sets the maximum number of entries for a compact group and the minimum number of links to allow before converting a dense group back to the compact format. \p max_compact is the maximum number of links to store as header messages in the group header before converting the group to the dense format. Groups that are in compact format and which exceed this number of links are automatically converted to dense format. \p min_dense is the minimum number of links to store in the dense format. Groups which are in dense format and in which the number of links falls below this threshold are automatically converted to compact format.
- Since:
- 1.8.0
-
H5Pset_local_heap_size_hint
@Cast("herr_t") public static int H5Pset_local_heap_size_hint(@Cast("hid_t") long plist_id, @Cast("size_t") long size_hint)
\ingroup GCPL \brief Specifies the anticipated maximum size of a local heap \gcpl_id{plist_id}- Parameters:
size_hint- [in] Anticipated maximum size in bytes of local heap- Returns:
- \herr_t
\details H5Pset_local_heap_size_hint() is used with original-style HDF5
groups (see âMotivationâ below) to specify the anticipated maximum
local heap size, size_hint, for groups created with the group
creation property list \p plist_id. The HDF5 library then uses \p
size_hint to allocate contiguous local heap space in the file for
each group created with \p plist_id.
For groups with many members or very few members, an appropriate
initial value of \p size_hint would be the anticipated number of
group members times the average length of group member names, plus a
small margin:
If it is known that there will be groups with zero members, the use of a group creation property list with \p size_hint set to to 1 (one) will guarantee the smallest possible local heap for each of those groups. Setting \p size_hint to zero (0) causes the library to make a reasonable estimate for the default local heap size. \par Motivation: In situations where backward-compatibility is required, specifically, when libraries prior to HDF5 Release 1.8.0 may be used to read the file, groups must be created and maintained in the original style. This is HDF5âs default behavior. If backward compatibility with pre-1.8.0 libraries is not a concern, greater efficiencies can be obtained with the new-format compact and indexed groups. See Group implementations in HDF5 in the \ref H5G API introduction (at the bottom).\n H5Pset_local_heap_size_hint() is useful for tuning file size when files contain original-style groups with either zero members or very large numbers of members.\n The original style of HDF5 groups, the only style available prior to HDF5 Release 1.8.0, was well-suited for moderate-sized groups but was not optimized for either very small or very large groups. This original style remains the default, but two new group implementations were introduced in HDF5 Release 1.8.0: compact groups to accommodate zero to small numbers of members and indexed groups for thousands or tens of thousands of members ... or millions, if that's what your application requires.\n The local heap size hint, \p size_hint, is a performance tuning parameter for original-style groups. As indicated above, an HDF5 group may have zero, a handful, or tens of thousands of members. Since the original style of HDF5 groups stores the metadata for all of these group members in a uniform format in a local heap, the size of that metadata (and hence, the size of the local heap) can vary wildly from group to group. To intelligently allocate space and to avoid unnecessary fragmentation of the local heap, it can be valuable to provide the library with a hint as to the local heapâs likely eventual size. This can be particularly valuable when it is known that a group will eventually have a great many members. It can also be useful in conserving space in a file when it is known that certain groups will never have any members.size_hint = max_number_of_group_members * (average_length_of_group_member_link_names + 2) - Since:
- 1.8.0
-
H5Pget_char_encoding
@Cast("herr_t") public static int H5Pget_char_encoding(@Cast("hid_t") long plist_id, @Cast("H5T_cset_t*") IntPointer encoding)
\ingroup ACPL \brief Retrieves the character encoding used to create a link or attribute name- Parameters:
plist_id- [in] Link creation or attribute creation property list identifierencoding- [out] String encoding character set- Returns:
- \herr_t \details H5Pget_char_encoding() retrieves the character encoding used to encode link or attribute names that are created with the property list \p plist_id. Valid values for \p encoding are defined in H5Tpublic.h and include the following: \csets \note H5Pget_char_encoding() retrieves the character set used for an HDF5 link or attribute name while H5Tget_cset() retrieves the character set used in a character or string datatype.
- Since:
- 1.8.0
-
H5Pget_char_encoding
@Cast("herr_t") public static int H5Pget_char_encoding(@Cast("hid_t") long plist_id, @Cast("H5T_cset_t*") IntBuffer encoding)
-
H5Pget_char_encoding
@Cast("herr_t") public static int H5Pget_char_encoding(@Cast("hid_t") long plist_id, @Cast("H5T_cset_t*") int[] encoding)
-
H5Pset_char_encoding
@Cast("herr_t") public static int H5Pset_char_encoding(@Cast("hid_t") long plist_id, @Cast("H5T_cset_t") int encoding)
\ingroup ACPL \brief Sets the character encoding used to encode link and attribute names- Parameters:
plist_id- [in] Link creation or attribute creation property list identifierencoding- [in] String encoding character set- Returns:
- \herr_t \details H5Pset_char_encoding() sets the character encoding used for the names of links (which provide the names by which objects are referenced) or attributes created with the property list \p plist_id. Valid values for encoding include the following: \csets \details For example, if the character set for the property list \p plist_id is set to #H5T_CSET_UTF8, link names pointing to objects created with the link creation property list \p plist_id will be encoded using the UTF-8 character set. Similarly, names of attributes created with the attribute creation property list \p plist_id will be encoded as UTF-8. ASCII and UTF-8 Unicode are the only currently supported character encodings. Extended ASCII encodings (for example, ISO 8859) are not supported. This encoding policy is not enforced by the HDF5 library. Using encodings other than ASCII and UTF-8 can lead to compatibility and usability problems. \note H5Pset_char_encoding() sets the character set used for an HDF5 link or attribute name while H5Tset_cset() sets the character set used in a character or string datatype.
- Since:
- 1.8.0
-
H5Pget_elink_acc_flags
@Cast("herr_t") public static int H5Pget_elink_acc_flags(@Cast("hid_t") long lapl_id, @Cast("unsigned*") IntPointer flags)
\ingroup LAPL \brief Retrieves the external link traversal file access flag from the specified link access property list \lapl_id- Parameters:
flags- [out] File access flag for link traversal- Returns:
- \herr_t
\details H5Pget_elink_acc_flags() retrieves the file access flag used
to open an external link target file from the specified link
access property list.
Valid values for \p flags include:
\li #H5F_ACC_RDWR - Files opened through external links will
be opened with write access
\li #H5F_ACC_RDONLY - Files opened through external links will
be opened with read-only access
\li #H5F_ACC_DEFAULT - Files opened through external links will
be opened with the same access flag as
the parent file
The value returned, if it is not #H5F_ACC_DEFAULT, will
override the default access flag, which is the access flag
used to open the parent file.
Example Usage:
The following code retrieves the external link access flag
settings on the link access property list \p lapl_id into a
local variable:
unsigned acc_flags; status = H5Pget_elink_acc_flags(lapl_id, &acc_flags); - Since:
- 1.8.3
-
H5Pget_elink_acc_flags
@Cast("herr_t") public static int H5Pget_elink_acc_flags(@Cast("hid_t") long lapl_id, @Cast("unsigned*") IntBuffer flags)
-
H5Pget_elink_acc_flags
@Cast("herr_t") public static int H5Pget_elink_acc_flags(@Cast("hid_t") long lapl_id, @Cast("unsigned*") int[] flags)
-
H5Pget_elink_cb
@Cast("herr_t") public static int H5Pget_elink_cb(@Cast("hid_t") long lapl_id, @ByPtrPtr H5L_elink_traverse_t func, @Cast("void**") PointerPointer op_data)
\ingroup LAPL \brief Retrieves the external link traversal callback function from the specified link access property list \lapl_id- Parameters:
func- [out] User-defined external link traversal callback functionop_data- [out] User-defined input data for the callback function- Returns:
- \herr_t
\details H5Pget_elink_cb() retrieves the user-defined external link
traversal callback function defined in the specified link
access property list.
The callback function may adjust the file access property
list and file access flag to use when opening a file through
an external link. The callback will be executed by the HDF5
library immediately before opening the target file.
Failure Modes: H5Pget_elink_cb() will fail if the link
access property list identifier, \p lapl_id, is invalid.
An invalid function pointer or data pointer, \p func or
\p op_data respectively, may cause a segmentation fault or an
invalid memory access.
Example Usage: The following code retrieves the external
link callback settings on the link access property list
\p lapl_id into local variables:
H5L_elink_traverse_t elink_callback_func; void *elink_callback_udata; status = H5Pget_elink_cb (lapl_id, &elink_callback_func, &elink_callback_udata); - Since:
- 1.8.3
-
H5Pget_elink_cb
@Cast("herr_t") public static int H5Pget_elink_cb(@Cast("hid_t") long lapl_id, @ByPtrPtr H5L_elink_traverse_t func, @Cast("void**") @ByPtrPtr Pointer op_data)
-
H5Pget_elink_fapl
@Cast("hid_t") public static long H5Pget_elink_fapl(@Cast("hid_t") long lapl_id)
\ingroup LAPL \brief Retrieves the file access property list identifier associated with the link access property list \lapl_id- Returns:
- \hid_t{file access property list} \details H5Pget_elink_fapl() retrieves the file access property list identifier that is set for the link access property list identifier, \p lapl_id. The library uses this file access property list identifier to open the target file for the external link access. When no such identifier is set, this routine returns #H5P_DEFAULT.
- Since:
- 1.8.0
- See Also:
and H5Lcreate_external().
-
H5Pget_elink_prefix
@Cast("ssize_t") public static long H5Pget_elink_prefix(@Cast("hid_t") long plist_id, @Cast("char*") BytePointer prefix, @Cast("size_t") long size)
\ingroup LAPL \brief Retrieves prefix applied to external link paths \lapl_id{plist_id}- Parameters:
prefix- [out] Prefix applied to external link pathssize- [in] Size of prefix, including null terminator- Returns:
- If successful, returns a non-negative value specifying the size in bytes of the prefix without the NULL terminator; otherwise returns a negative value. \details H5Pget_elink_prefix() retrieves the prefix applied to the path of any external links traversed. When an external link is traversed, the prefix is retrieved from the link access property list \p plist_id, returned in the user-allocated buffer pointed to by \p prefix, and prepended to the filename stored in the external link. The size in bytes of the prefix, including the NULL terminator, is specified in \p size. If size is unknown, a preliminary H5Pget_elink_prefix() call with the pointer \p prefix set to NULL will return the size of the prefix without the NULL terminator.
- Since:
- 1.8.0
-
H5Pget_elink_prefix
@Cast("ssize_t") public static long H5Pget_elink_prefix(@Cast("hid_t") long plist_id, @Cast("char*") ByteBuffer prefix, @Cast("size_t") long size)
-
H5Pget_elink_prefix
@Cast("ssize_t") public static long H5Pget_elink_prefix(@Cast("hid_t") long plist_id, @Cast("char*") byte[] prefix, @Cast("size_t") long size)
-
H5Pget_nlinks
@Cast("herr_t") public static int H5Pget_nlinks(@Cast("hid_t") long plist_id, @Cast("size_t*") SizeTPointer nlinks)
\ingroup LAPL \brief Retrieves the maximum number of link traversals \lapl_id{plist_id}- Parameters:
nlinks- [out] Maximum number of links to traverse- Returns:
- \herr_t \details H5Pget_nlinks() retrieves the maximum number of soft or user-defined link traversals allowed, \p nlinks, before the library assumes it has found a cycle and aborts the traversal. This value is retrieved from the link access property list \p plist_id. The limit on the number of soft or user-defined link traversals is designed to terminate link traversal if one or more links form a cycle. User control is provided because some files may have legitimate paths formed of large numbers of soft or user-defined links. This property can be used to allow traversal of as many links as desired.
- Since:
- 1.8.0
-
H5Pset_elink_acc_flags
@Cast("herr_t") public static int H5Pset_elink_acc_flags(@Cast("hid_t") long lapl_id, @Cast("unsigned") int flags)
\ingroup LAPL \brief Sets the external link traversal file access flag in a link access property list \lapl_id- Parameters:
flags- [in] The access flag for external link traversal- Returns:
- \herr_t
\details H5Pset_elink_acc_flags() specifies the file access flag to use
to open the target file of an external link. This allows
read-only access of files reached through an external link in
a file opened with write access, or vice-versa.
Valid values for \p flags include:
\li #H5F_ACC_RDWR - Causes files opened through external links
to be opened with write access
\li #H5F_ACC_RDONLY - Causes files opened through external
links to be opened with read-only access
\li #H5F_ACC_DEFAULT - Removes any external link file access
flag setting from \p lapl_id, causing the file access flag
setting to be taken from the parent file
The library will normally use the file access flag used to
open the parent file as the file access flag for the target
file. This function provides a way to override that behavior.
The external link traversal callback function set by
H5Pset_elink_cb() can override the setting from
H5Pset_elink_acc_flags().
Motivation: H5Pset_elink_acc_flags() is used to adjust the
file access flag used to open files reached through external links.
This may be useful to, for example, prevent modifying files
accessed through an external link. Otherwise, the target file is
opened with whatever flag was used to open the parent.
Example Usage: The following code sets the link access
property list \p lapl_id to open external link target files with
read-only access:
status = H5Pset_elink_acc_flags(lapl_id, H5F_ACC_RDONLY); - Since:
- 1.8.3
-
H5Pset_elink_cb
@Cast("herr_t") public static int H5Pset_elink_cb(@Cast("hid_t") long lapl_id, H5L_elink_traverse_t func, Pointer op_data)
\ingroup LAPL \brief Sets the external link traversal callback function in a link access property list \lapl_id- Parameters:
func- [in] User-defined external link traversal callback functionop_data- [in] User-defined input data for the callback function- Returns:
- \herr_t
\details H5Pset_elink_cb() sets a user-defined external link traversal
callback function in the link access property list \p lapl_id.
The callback function \p func must conform to the prototype
specified in #H5L_elink_traverse_t.
The callback function may adjust the file access property
list and file access flags to use when opening a file through
an external link. The callback will be executed by the HDF5
library immediately before opening the target file.
The callback will be made after the file access property list
set by H5Pset_elink_fapl() and the file access flag set by
H5Pset_elink_acc_flags() are applied, so changes made by this
callback function will take precedence.
\attention A file close degree property setting (H5Pset_fclose_degree())
in this callback function or an associated property list will
be ignored. A file opened by means of traversing an external
link is always opened with the weak file close degree
property setting, #H5F_CLOSE_WEAK.
Motivation: H5Pset_elink_cb() is used to specify a
callback function that is executed by the HDF5 library when
traversing an external link. This provides a mechanism to set
specific access permissions, modify the file access property
list, modify the parent or target file, or take any other
user-defined action. This callback function is used in
situations where the HDF5 library's default behavior is not
suitable.
Failure Modes: H5Pset_elink_cb() will fail if the link
access property list identifier, \p lapl_id, is invalid or if
the function pointer, \p func, is NULL.
An invalid function pointer, \p func, will cause a segmentation
fault or other failure when an attempt is subsequently made to
traverse an external link.
Example Usage:
This example defines a callback function that prints the name
of the target file every time an external link is followed, and
sets this callback function on \p lapl_id.
herr_t elink_callback(const char *parent_file_name, const char *parent_group_name, const char *child_file_name, const char *child_object_name, unsigned *acc_flags, hid_t fapl_id, void *op_data) { puts(child_file_name); return 0; } int main(void) { hid_t lapl_id = H5Pcreate(H5P_LINK_ACCESS); H5Pset_elink_cb(lapl_id, elink_callback, NULL); ... } - Since:
- 1.8.3
-
H5Pset_elink_fapl
@Cast("herr_t") public static int H5Pset_elink_fapl(@Cast("hid_t") long lapl_id, @Cast("hid_t") long fapl_id)
\ingroup LAPL \brief Sets a file access property list for use in accessing a file pointed to by an external link \lapl_id \fapl_id- Returns:
- \herr_t \details H5Pset_elink_fapl() sets the file access property list, \p fapl_id, to be used when accessing the target file of an external link associated with \p lapl_id.
- Since:
- 1.8.0
-
H5Pset_elink_prefix
@Cast("herr_t") public static int H5Pset_elink_prefix(@Cast("hid_t") long plist_id, @Cast("const char*") BytePointer prefix)
\ingroup LAPL \brief Sets prefix to be applied to external link paths \lapl_id{plist_id}- Parameters:
prefix- [in] Prefix to be applied to external link paths- Returns:
- \herr_t \details H5Pset_elink_prefix() sets the prefix to be applied to the path of any external links traversed. The prefix is prepended to the filename stored in the external link. The prefix is specified in the user-allocated buffer \p prefix and set in the link access property list \p plist_id. The buffer should not be freed until the property list has been closed.
- Since:
- 1.8.0
-
H5Pset_elink_prefix
@Cast("herr_t") public static int H5Pset_elink_prefix(@Cast("hid_t") long plist_id, String prefix)
-
H5Pset_nlinks
@Cast("herr_t") public static int H5Pset_nlinks(@Cast("hid_t") long plist_id, @Cast("size_t") long nlinks)
\ingroup LAPL \brief Sets maximum number of soft or user-defined link traversals \lapl_id{plist_id}- Parameters:
nlinks- [in] Maximum number of links to traverse- Returns:
- \herr_t \details H5Pset_nlinks() sets the maximum number of soft or user-defined link traversals allowed, \p nlinks, before the library assumes it has found a cycle and aborts the traversal. This value is set in the link access property list \p plist_id. The limit on the number of soft or user-defined link traversals is designed to terminate link traversal if one or more links form a cycle. User control is provided because some files may have legitimate paths formed of large numbers of soft or user-defined links. This property can be used to allow traversal of as many links as desired.
- Since:
- 1.8.0
-
H5Padd_merge_committed_dtype_path
@Cast("herr_t") public static int H5Padd_merge_committed_dtype_path(@Cast("hid_t") long plist_id, @Cast("const char*") BytePointer path)
\ingroup OCPYPL \brief Adds a path to the list of paths that will be searched in the destination file for a matching committed datatype- Parameters:
plist_id- [in] Object copy property list identifierpath- [in] The path to be added- Returns:
- \herr_t
\details H5Padd_merge_committed_dtype_path() adds a path, \p path,
which points to a committed datatype, to the current list of
suggested paths stored in the object copy property list
\p plist_id. The search as described in the next paragraph is
effective only if the #H5O_COPY_MERGE_COMMITTED_DTYPE_FLAG is
enabled in the object copy property list via
H5Pset_copy_object().
When copying a committed datatype, a dataset with a committed
datatype, or an object with an attribute of a committed
datatype, the default behavior of H5Ocopy() is to search for
a matching committed datatype:
- First search the list of suggested paths in the object copy property list.
- Then, if no match has been found, search all the committed datatypes in the destination file.
int main(void) { hid_t ocpypl_id = H5Pcreate(H5P_OBJECT_COPY); H5Pset_copy_object(ocpypl_id, H5O_COPY_MERGE_COMMITTED_DTYPE_FLAG); H5Padd_merge_committed_dtype_path(ocpypl_id, "/group/committed_dtypeA"); H5Padd_merge_committed_dtype_path(ocpypl_id, "/group2/committed_dset"); H5Ocopy(...ocpypl_id...); ... ... }\note H5Padd_merge_committed_dtype_path() will fail if the object copy property list is invalid. It will also fail if there is insufficient memory when duplicating \p path. - Since:
- 1.8.9
-
H5Padd_merge_committed_dtype_path
@Cast("herr_t") public static int H5Padd_merge_committed_dtype_path(@Cast("hid_t") long plist_id, String path)
-
H5Pfree_merge_committed_dtype_paths
@Cast("herr_t") public static int H5Pfree_merge_committed_dtype_paths(@Cast("hid_t") long plist_id)
\ingroup OCPYPL \brief Clears the list of paths stored in the object copy property list- Parameters:
plist_id- [in] Object copy property list identifier- Returns:
- \herr_t
\details H5Pfree_merge_committed_dtype_paths() clears the suggested
paths stored in the object copy property list \p plist_id.
These are the suggested paths previously set with
H5Padd_merge_committed_dtype_path().
\b Example \b Usage: This example adds a suggested path to the
object copy property list, does the copy, clears the list, and
then adds a new suggested path to the list for another copy.
int main(void) { hid_t ocpypl_id = H5Pcreate(H5P_OBJECT_COPY); H5Pset_copy_object(ocpypl_id, H5O_COPY_MERGE_COMMITTED_DTYPE_FLAG); H5Padd_merge_committed_dtype_path(ocpypl_id, "/group/committed_dtypeA"); H5Ocopy(...ocpypl_id...); ... ... H5Pfree_merge_committed_dtype_paths(ocpypl_id); H5Padd_merge_committed_dtype_path(ocpypl_id, "/group2/committed_dtypeB"); H5Ocopy(...ocpypl_id...); ... ... }\note H5Pfree_merge_committed_dtype_paths() will fail if the object copy property list is invalid. - Since:
- 1.8.9
-
H5Pget_copy_object
@Cast("herr_t") public static int H5Pget_copy_object(@Cast("hid_t") long plist_id, @Cast("unsigned*") IntPointer copy_options)
\ingroup OCPYPL \brief Retrieves the properties to be used when an object is copied- Parameters:
plist_id- [in] Object copy property list identifiercopy_options- [out] Copy option(s) set in the object copy property list- Returns:
- \herr_t \details H5Pget_copy_object() retrieves the properties currently specified in the object copy property list \p plist_id, which will be invoked when a new copy is made of an existing object. \p copy_options is a bit map indicating the flags, or properties, governing object copying that are set in the property list \p plist_id. The available flags are described in H5Pset_copy_object().
- Since:
- 1.8.0
-
H5Pget_copy_object
@Cast("herr_t") public static int H5Pget_copy_object(@Cast("hid_t") long plist_id, @Cast("unsigned*") IntBuffer copy_options)
-
H5Pget_copy_object
@Cast("herr_t") public static int H5Pget_copy_object(@Cast("hid_t") long plist_id, @Cast("unsigned*") int[] copy_options)
-
H5Pget_mcdt_search_cb
@Cast("herr_t") public static int H5Pget_mcdt_search_cb(@Cast("hid_t") long plist_id, @ByPtrPtr H5O_mcdt_search_cb_t func, @Cast("void**") PointerPointer op_data)
\ingroup OCPYPL \brief Retrieves the callback function from the specified object copy property list- Parameters:
plist_id- [in] Object copy property list identifierfunc- [out] User-defined callback functionop_data- [out] User-defined data for the callback function- Returns:
- \herr_t \details H5Pget_mcdt_search_cb() retrieves the user-defined callback function and the user data that are set via H5Pset_mcdt_search_cb() in the object copy property list \p plist_id. The callback function will be returned in the parameter \p func and the user data will be returned in the parameter \p op_data. \note H5Pget_mcdt_search_cb() will fail if the object copy property list is invalid.
- Since:
- 1.8.9
-
H5Pget_mcdt_search_cb
@Cast("herr_t") public static int H5Pget_mcdt_search_cb(@Cast("hid_t") long plist_id, @ByPtrPtr H5O_mcdt_search_cb_t func, @Cast("void**") @ByPtrPtr Pointer op_data)
-
H5Pset_copy_object
@Cast("herr_t") public static int H5Pset_copy_object(@Cast("hid_t") long plist_id, @Cast("unsigned") int copy_options)
\ingroup OCPYPL \brief Sets properties to be used when an object is copied- Parameters:
plist_id- [in] Object copy property list identifiercopy_options- [out] Copy option(s) to be set- Returns:
- \herr_t
\details H5Pset_copy_object() sets properties in the object copy
property list \p plist_id. When an existing object is copied,
that property list will determine how the new copy is created.
The following flags are available for use in an object copy
property list:
#H5O_COPY_SHALLOW_HIERARCHY_FLAG Copy only immediate members of a group
Default behavior, without flag: Recursively copy all objects in and below the group.#H5O_COPY_EXPAND_SOFT_LINK_FLAG Expand soft links into new objects
Default behavior, without flag: Copy soft links as they are.#H5O_COPY_EXPAND_EXT_LINK_FLAG Expand external link into new objects
Default behavior, without flag: Copy external links as they are.#H5O_COPY_EXPAND_REFERENCE_FLAG Copy objects that are pointed to by references and update reference values in destination file
Default behavior, without flag: Set reference values in destination file to zero (0)#H5O_COPY_WITHOUT_ATTR_FLAG Copy object without copying attributes
Default behavior, without flag: Copy object with all its attributes#H5O_COPY_MERGE_COMMITTED_DTYPE_FLAG Use a matching committed datatype in the destination file when copying a committed datatype, a dataset with a committed datatype, or an object with an attribute of committed datatype
Default behavior without flag: \li A committed datatype in the source will be copied to the destination as a committed datatype. \li If a dataset in the source uses a committed datatype or an object in the source has an attribute of a committed datatype, that committed datatype will be written to the destination as an anonymous committed datatype. If copied in a single H5Ocopy() operation, objects that share a committed datatype in the source will share an anonymous committed dataype in the destination copy. Subsequent H5Ocopy() operations, however, will be unaware of prior anonymous committed dataypes and will create new ones. See the âSee Alsoâ section immediately below for functions related to the use of this flag. - Since:
- 1.8.0
- See Also:
and a callback function used to tune committed datatype copying behavior: \li #H5O_mcdt_search_cb_t \li H5Padd_merge_committed_dtype_path() \li H5Pfree_merge_committed_dtype_paths() \li H5Pget_mcdt_search_cb() \li H5Pset_copy_object() \li H5Pset_mcdt_search_cb() \li \ref_h5ocopy
-
H5Pset_mcdt_search_cb
@Cast("herr_t") public static int H5Pset_mcdt_search_cb(@Cast("hid_t") long plist_id, H5O_mcdt_search_cb_t func, Pointer op_data)
\ingroup OCPYPL \brief Sets the callback function that H5Ocopy() will invoke before searching the entire destination file for a matching committed datatype- Parameters:
plist_id- [in] Object copy property list identifierfunc- [in] User-defined callback functionop_data- [in] User-defined input data for the callback function- Returns:
- \herr_t
\details H5Pset_mcdt_search_cb() allows an application to set a
callback function, \p func, that will be invoked before
searching the destination file for a matching committed
datatype. The default, global search process is described in
H5Padd_merge_committed_dtype_path().
The callback function must conform to the #H5O_mcdt_search_cb_t
prototype and will return an instruction for one of the
following actions:
\li Continue the search for a matching committed datatype in
the destination file.
\li Discontinue the search for a matching committed datatype.
H5Ocopy() will then apply the default behavior of creating
an anonymous committed datatype.
\li Abort the copy operation and exit H5Ocopy().
\b Motivation: H5Pset_mcdt_search_cb() provides the means to
define a callback function. An application can then use that
callback to take an additional action before the default search
of all committed datatypes in the destination file or to take an
action that replaces the default search. This mechanism is
intended to improve performance when the global search might
take a long time.
\b Example \b Usage: This example defines a callback function in
the object copy property list.
static H5O_mcdt_search_ret_t mcdt_search_cb(void *_udata) { H5O_mcdt_search_ret_t action = *((H5O_mcdt_search_ret_t *)_udata); return(action); } int main(void) { hid_t ocpypl_id = H5Pcreate(H5P_OBJECT_COPY); H5Pset_copy_object(ocpypl_id, H5O_COPY_MERGE_COMMITTED_DTYPE_FLAG); H5Padd_merge_committed_dtype_path(ocpypl_id, "/group/committed_dtypeA"); action = H5O_MCDT_SEARCH_STOP; H5Pset_mcdt_search_cb(ocpypl_id, mcdt_search_cb, &action); H5Ocopy(...ocpypl_id...); ... ... }\note H5Pset_mcdt_search_cb() will fail if the object copy property list is invalid. \warning If the callback function return value causes H5Ocopy() to abort, the destination file may be left in an inconsistent or corrupted state. - Since:
- 1.8.9
-
H5PLset_loading_state
@Cast("herr_t") public static int H5PLset_loading_state(@Cast("unsigned int") int plugin_control_mask)
\ingroup H5PL \brief Controls the loadability of dynamic plugin types- Parameters:
plugin_control_mask- [in] The list of dynamic plugin types to enable or disable.\n A plugin bit set to 0 (zero) prevents use of that dynamic plugin.\n A plugin bit set to 1 (one) enables use of that dynamic plugin.\n Setting \p plugin_control_mask to a negative value enables all dynamic plugin types.\n Setting \p plugin_control_mask to 0 (zero) disables all dynamic plugin\n types.- Returns:
- \herr_t \details H5PLset_loading_state() uses one argument to enable or disable individual plugin types. \details The \p plugin_control_mask parameter is an encoded integer in which each bit controls a specific plugin type. Bit positions allocated to date are specified in \ref H5PL_type_t as follows: \snippet this H5PL_type_t_snip A plugin bit set to 0 (zero) prevents the use of the dynamic plugin type corresponding to that bit position. A plugin bit set to 1 (one) allows the use of that dynamic plugin type. All dynamic plugin types can be enabled by setting \p plugin_control_mask to a negative value. A value of 0 (zero) will disable all dynamic plugin types. The loading of external dynamic plugins can be controlled during runtime with an environment variable, \c HDF5_PLUGIN_PRELOAD. H5PLset_loading_state() inspects the \c HDF5_PLUGIN_PRELOAD environment variable every time it is called. If the environment variable is set to the special \c :: string, all dynamic plugins are disabled. \warning The environment variable \c HDF5_PLUGIN_PRELOAD controls the loading of dynamic plugin types at runtime. If it is set to disable all plugin types, then it will disable them for \Emph{all} running programs that access the same variable instance.
- Since:
- 1.8.15
-
H5PLget_loading_state
@Cast("herr_t") public static int H5PLget_loading_state(@Cast("unsigned int*") IntPointer plugin_control_mask)
\ingroup H5PL \brief Queries the loadability of dynamic plugin types- Parameters:
plugin_control_mask- [out] List of dynamic plugin types that are enabled or disabled.\n A plugin bit set to 0 (zero) indicates that that the dynamic plugin type is disabled.\n A plugin bit set to 1 (one) indicates that that the dynamic plugin type is enabled.\n If the value of \p plugin_control_mask is negative, all dynamic plugin types are enabled.\n If the value of \p plugin_control_mask is 0 (zero), all dynamic plugins are disabled.- Returns:
- \herr_t \details H5PLget_loading_state() retrieves the bitmask that controls whether a certain type of plugins (e.g.: filters, VOL drivers) will be loaded by the HDF5 library. Bit positions allocated to date are specified in \ref H5PL_type_t as follows: \snippet this H5PL_type_t_snip
- Since:
- 1.8.15
-
H5PLget_loading_state
@Cast("herr_t") public static int H5PLget_loading_state(@Cast("unsigned int*") IntBuffer plugin_control_mask)
-
H5PLget_loading_state
@Cast("herr_t") public static int H5PLget_loading_state(@Cast("unsigned int*") int[] plugin_control_mask)
-
H5PLappend
@Cast("herr_t") public static int H5PLappend(@Cast("const char*") BytePointer search_path)
\ingroup H5PL \brief Inserts a plugin path at the end of the plugin search path list- Parameters:
search_path- [in] A plugin path- Returns:
- \herr_t \details H5PLappend() inserts a plugin path at the end of the plugin search path list.
- Since:
- 1.10.1
-
H5PLprepend
@Cast("herr_t") public static int H5PLprepend(@Cast("const char*") BytePointer search_path)
\ingroup H5PL \brief Inserts a plugin path at the beginning of the plugin search path list- Parameters:
search_path- [in] A plugin path- Returns:
- \herr_t \details H5PLprepend() inserts a plugin path at the end of the plugin search path list.
- Since:
- 1.10.1
-
H5PLreplace
@Cast("herr_t") public static int H5PLreplace(@Cast("const char*") BytePointer search_path, @Cast("unsigned int") int index)
\ingroup H5PL \brief Replaces the path at the specified index in the plugin search path list- Parameters:
search_path- [in] A plugin pathindex- [in] Index- Returns:
- \herr_t \details H5PLreplace() replaces a plugin path at the specified index in the plugin search path list.
- Since:
- 1.10.1
-
H5PLreplace
@Cast("herr_t") public static int H5PLreplace(String search_path, @Cast("unsigned int") int index)
-
H5PLinsert
@Cast("herr_t") public static int H5PLinsert(@Cast("const char*") BytePointer search_path, @Cast("unsigned int") int index)
\ingroup H5PL \brief Inserts a path at the specified index in the plugin search path list- Parameters:
search_path- [in] A plugin pathindex- [in] Index- Returns:
- \herr_t \details H5PLinsert() inserts a plugin path at the specified index in the plugin search path list, moving other paths after \p index.
- Since:
- 1.10.1
-
H5PLinsert
@Cast("herr_t") public static int H5PLinsert(String search_path, @Cast("unsigned int") int index)
-
H5PLremove
@Cast("herr_t") public static int H5PLremove(@Cast("unsigned int") int index)
\ingroup H5PL \brief Removes a plugin path at a specified index from the plugin search path list- Parameters:
index- [in] Index- Returns:
- \herr_t \details H5PLremove() removes a plugin path at the specified \p index and compacts the plugin search path list.
- Since:
- 1.10.1
-
H5PLget
@Cast("ssize_t") public static long H5PLget(@Cast("unsigned int") int index, @Cast("char*") BytePointer path_buf, @Cast("size_t") long buf_size)
\ingroup H5PL \brief Queries the plugin search path list at the specified index- Parameters:
index- [in] Indexpath_buf- [out] Pathnamebuf_size- [in] Size of \p path_buf- Returns:
- Returns the length of the path, a non-negative value, if successful; otherwise returns a negative value. \details H5PLget() queries the plugin path at a specified index. If \p path_buf is non-NULL then it writes up to \p buf_size bytes into that buffer and always returns the length of the path name. If \p path_buf is NULL, this function will simply return the number of characters required to store the path name, ignoring \p path_buf and \p buf_size. If an error occurs then the buffer pointed to by \p path_buf (NULL or non-NULL) is unchanged and the function returns a negative value. If a zero is returned for the name's length, then there is no path name associated with the index. and the \p path_buf buffer will be unchanged.
- Since:
- 1.10.1
-
H5PLget
@Cast("ssize_t") public static long H5PLget(@Cast("unsigned int") int index, @Cast("char*") ByteBuffer path_buf, @Cast("size_t") long buf_size)
-
H5PLget
@Cast("ssize_t") public static long H5PLget(@Cast("unsigned int") int index, @Cast("char*") byte[] path_buf, @Cast("size_t") long buf_size)
-
H5PLsize
@Cast("herr_t") public static int H5PLsize(@Cast("unsigned int*") IntPointer num_paths)
\ingroup H5PL \brief Retrieves the number of stored plugin paths- Parameters:
num_paths- [out] Current length of the plugin search path list- Returns:
- \herr_t \details H5PLsize() retrieves the number of paths stored in the plugin search path list.
- Since:
- 1.10.1
-
H5R_OBJ_REF_BUF_SIZE
@MemberGetter public static int H5R_OBJ_REF_BUF_SIZE()
-
H5R_DSET_REG_REF_BUF_SIZE
@MemberGetter public static int H5R_DSET_REG_REF_BUF_SIZE()
-
H5Rcreate_object
@Cast("herr_t") public static int H5Rcreate_object(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer name, @Cast("hid_t") long oapl_id, H5R_ref_t ref_ptr)
Deprecated.-------------------------------------------------------------------------- \ingroup H5R \brief Creates an object reference \fgdta_loc_id- Parameters:
name- [in] Name of object \oapl_idref_ptr- [out] Pointer to reference- Returns:
- \herr_t \details H5Rcreate_object() creates a reference pointing to the object named \p name located at \p loc_id. The parameters \p loc_id and \p name are used to locate the object. The parameter \p oapl_id is an object access property list identifier for the referenced object. The access property list must be of the same type as the object being referenced, that is a group, dataset or committed datatype property list. \ref H5R_ref_t is defined in H5Rpublic.h as: \snippet this H5R_ref_t_snip H5Rdestroy() should be used to release the resource from the reference.
-
H5Rcreate_object
@Cast("herr_t") public static int H5Rcreate_object(@Cast("hid_t") long loc_id, String name, @Cast("hid_t") long oapl_id, H5R_ref_t ref_ptr)
-
H5Rcreate_region
@Cast("herr_t") public static int H5Rcreate_region(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer name, @Cast("hid_t") long space_id, @Cast("hid_t") long oapl_id, H5R_ref_t ref_ptr)
-------------------------------------------------------------------------- \ingroup H5R \brief Creates a region reference \fgdta_loc_id- Parameters:
name- [in] Name of object \space_id \oapl_idref_ptr- [out] Pointer to reference- Returns:
- \herr_t \details H5Rcreate_region() creates the reference, \p ref_ptr, pointing to the region represented by \p space_id within the object named name located at \p loc_id. The parameters \p loc_id and \p name are used to locate the object. The parameter \p space_id identifies the dataset region that a dataset region reference points to. The parameter \p oapl_id is an object access property list identifier for the referenced object. The access property list must be of the same type as the object being referenced, that is a dataset property list in this case. \ref H5R_ref_t is defined in H5Rpublic.h as: \snippet this H5R_ref_t_snip H5Rdestroy() should be used to release the resource from the reference.
-
H5Rcreate_region
@Cast("herr_t") public static int H5Rcreate_region(@Cast("hid_t") long loc_id, String name, @Cast("hid_t") long space_id, @Cast("hid_t") long oapl_id, H5R_ref_t ref_ptr)
-
H5Rcreate_attr
@Cast("herr_t") public static int H5Rcreate_attr(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer name, @Cast("const char*") BytePointer attr_name, @Cast("hid_t") long oapl_id, H5R_ref_t ref_ptr)
-------------------------------------------------------------------------- \ingroup H5R \brief Creates an attribute reference \fgdta_loc_id- Parameters:
name- [in] Name of objectattr_name- [in] Name of attribute \oapl_idref_ptr- [out] Pointer to reference- Returns:
- \herr_t \details H5Rcreate_attr() creates the reference, \p ref_ptr, pointing to the attribute named \p attr_name and attached to the object named \p name located at \p loc_id. The parameters \p loc_id and \p name locate the object. The parameter \p attr_name specifies the attribute within the object. The parameter \p oapl_id is an object access property list identifier for the object that the referenced attribute is attached to. The access property list must be of the same type as that object, that is a group, dataset or committed datatype property list. \ref H5R_ref_t is defined in H5Rpublic.h as: \snippet this H5R_ref_t_snip H5Rdestroy() should be used to release the resource from the reference.
-
H5Rcreate_attr
@Cast("herr_t") public static int H5Rcreate_attr(@Cast("hid_t") long loc_id, String name, String attr_name, @Cast("hid_t") long oapl_id, H5R_ref_t ref_ptr)
-
H5Rdestroy
@Cast("herr_t") public static int H5Rdestroy(H5R_ref_t ref_ptr)
-------------------------------------------------------------------------- \ingroup H5R \brief Closes a reference- Parameters:
ref_ptr- [in] Pointer to reference- Returns:
- \herr_t \details Given a reference, \p ref_ptr, to an object, region or attribute attached to an object, H5Rdestroy() releases allocated resources from a previous create call. \ref H5R_ref_t is defined in H5Rpublic.h as: \snippet this H5R_ref_t_snip
-
H5Rget_type
@Cast("H5R_type_t") public static int H5Rget_type(@Const H5R_ref_t ref_ptr)
-------------------------------------------------------------------------- \ingroup H5R \brief Retrieves the type of a reference- Parameters:
ref_ptr- [in] Pointer to reference- Returns:
- Returns a valid reference type if successful; otherwise returns #H5R_BADTYPE . \details Given a reference, \p ref_ptr, H5Rget_type() returns the type of the reference. Valid returned reference types are: \snippet this H5R_type_t_snip Note that #H5R_OBJECT1 and #H5R_DATASET_REGION1 can never be associated to an \ref H5R_ref_t reference and can therefore never be returned through that function. \ref H5R_ref_t is defined in H5Rpublic.h as: \snippet this H5R_ref_t_snip
-
H5Requal
@Cast("htri_t") public static int H5Requal(@Const H5R_ref_t ref1_ptr, @Const H5R_ref_t ref2_ptr)
-------------------------------------------------------------------------- \ingroup H5R \brief Determines whether two references are equal- Parameters:
ref- [in] 1_ptr Pointer to reference to compareref- [in] 2_ptr Pointer to reference to compare- Returns:
- Returns a positive value if the references are equal. Returns 0 if the references are not equal. Returns a negative value when the function fails. \details H5Requal() determines whether two references point to the same object, region or attribute. \ref H5R_ref_t is defined in H5Rpublic.h as: \snippet this H5R_ref_t_snip
-
H5Rcopy
@Cast("herr_t") public static int H5Rcopy(@Const H5R_ref_t src_ref_ptr, H5R_ref_t dst_ref_ptr)
-------------------------------------------------------------------------- \ingroup H5R \brief Copies an existing reference- Parameters:
src_ref_ptr- [in] Pointer to reference to copydst_ref_ptr- [out] Pointer to output reference- Returns:
- \herr_t \details H5Rcopy() creates a copy of an existing reference. \p src_ref_ptr points to the reference to copy and \p dst_ref_ptr is the pointer to the destination reference.
-
H5Ropen_object
@Cast("hid_t") public static long H5Ropen_object(H5R_ref_t ref_ptr, @Cast("hid_t") long rapl_id, @Cast("hid_t") long oapl_id)
-------------------------------------------------------------------------- \ingroup H5R \brief Opens the HDF5 object referenced- Parameters:
ref_ptr- [in] Pointer to reference to open \rapl_id \oapl_id- Returns:
- \hid_t{object} \details Given a reference, \p ref_ptr, to an object, a region in an object, or an attribute attached to an object, H5Ropen_object() opens that object and returns an identifier. The parameter \p oapl_id is an object access property list identifier for the referenced object. The access property list must be of the same type as the object being referenced, that is a group or dataset property list. \ref H5R_ref_t is defined in H5Rpublic.h as: \snippet this H5R_ref_t_snip The object opened with this function should be closed when it is no longer needed so that resource leaks will not develop. Use the appropriate close function such as H5Oclose() or H5Dclose() for datasets.
-
H5Ropen_object_async
@Cast("hid_t") public static long H5Ropen_object_async(@Cast("const char*") BytePointer app_file, @Cast("const char*") BytePointer app_func, @Cast("unsigned") int app_line, H5R_ref_t ref_ptr, @Cast("hid_t") long rapl_id, @Cast("hid_t") long oapl_id, @Cast("hid_t") long es_id)
-------------------------------------------------------------------------- \ingroup ASYNC \async_variant_of{H5Ropen_object}
-
H5Ropen_object_async
@Cast("hid_t") public static long H5Ropen_object_async(String app_file, String app_func, @Cast("unsigned") int app_line, H5R_ref_t ref_ptr, @Cast("hid_t") long rapl_id, @Cast("hid_t") long oapl_id, @Cast("hid_t") long es_id)
-
H5Ropen_region
@Cast("hid_t") public static long H5Ropen_region(H5R_ref_t ref_ptr, @Cast("hid_t") long rapl_id, @Cast("hid_t") long oapl_id)
-------------------------------------------------------------------------- \ingroup H5R \brief Sets up a dataspace and selection as specified by a region reference.- Parameters:
ref_ptr- [in] Pointer to reference to open \rapl_id \oapl_id- Returns:
- \hid_t{dataspace} \details H5Ropen_region() creates a copy of the dataspace of the dataset pointed to by a region reference, \p ref_ptr, and defines a selection matching the selection pointed to by \p ref_ptr within the dataspace copy. The parameter \p rapl id is a reference access property list identifier for the reference. The access property list can be used to access external files that the reference points to (through a file access property list). The parameter \p oapl id is an object access property list identifier for the referenced object. The access property list must be of the same type as the object being referenced, that is a dataset property list in that case. Use H5Sclose() to release the dataspace identifier returned by this function when the identifier is no longer needed.
-
H5Ropen_region_async
@Cast("hid_t") public static long H5Ropen_region_async(@Cast("const char*") BytePointer app_file, @Cast("const char*") BytePointer app_func, @Cast("unsigned") int app_line, H5R_ref_t ref_ptr, @Cast("hid_t") long rapl_id, @Cast("hid_t") long oapl_id, @Cast("hid_t") long es_id)
-------------------------------------------------------------------------- \ingroup ASYNC \async_variant_of{H5Ropen_region}
-
H5Ropen_region_async
@Cast("hid_t") public static long H5Ropen_region_async(String app_file, String app_func, @Cast("unsigned") int app_line, H5R_ref_t ref_ptr, @Cast("hid_t") long rapl_id, @Cast("hid_t") long oapl_id, @Cast("hid_t") long es_id)
-
H5Ropen_attr
@Cast("hid_t") public static long H5Ropen_attr(H5R_ref_t ref_ptr, @Cast("hid_t") long rapl_id, @Cast("hid_t") long aapl_id)
-------------------------------------------------------------------------- \ingroup H5R \brief Opens the HDF5 attribute referenced- Parameters:
ref_ptr- [in] Pointer to reference to open \rapl_id \aapl_id- Returns:
- \hid_t{attribute} \details Given a reference, \p ref_ptr, to an attribute attached to an object, H5Ropen_attr() opens the attribute attached to that object and returns an identifier. The parameter \p rapl id is a reference access property list identifier for the reference. The access property list can be used to access external files that the reference points to (through a file access property list). The parameter \p aapl_id is an attribute access property list identifier for the referenced attribute. The attribute opened with this function should be closed with H5Aclose() when it is no longer needed.
-
H5Ropen_attr_async
@Cast("hid_t") public static long H5Ropen_attr_async(@Cast("const char*") BytePointer app_file, @Cast("const char*") BytePointer app_func, @Cast("unsigned") int app_line, H5R_ref_t ref_ptr, @Cast("hid_t") long rapl_id, @Cast("hid_t") long aapl_id, @Cast("hid_t") long es_id)
-------------------------------------------------------------------------- \ingroup ASYNC \async_variant_of{H5Ropen_attr}
-
H5Ropen_attr_async
@Cast("hid_t") public static long H5Ropen_attr_async(String app_file, String app_func, @Cast("unsigned") int app_line, H5R_ref_t ref_ptr, @Cast("hid_t") long rapl_id, @Cast("hid_t") long aapl_id, @Cast("hid_t") long es_id)
-
H5Rget_obj_type3
@Cast("herr_t") public static int H5Rget_obj_type3(H5R_ref_t ref_ptr, @Cast("hid_t") long rapl_id, @Cast("H5O_type_t*") IntPointer obj_type)
-------------------------------------------------------------------------- \ingroup H5R \brief Retrieves the type of object that an object reference points to- Parameters:
ref_ptr- [in] Pointer to reference to query \rapl_idobj_type- [out] Type of referenced object- Returns:
- \herr_t \details Given a reference, \p ref_ptr, H5Rget_obj_type3() retrieves the type of the referenced object in \p obj_type. The parameter \p rapl id is a reference access property list identifier for the reference. The access property list can be used to access external files that the reference points to (through a file access property list). Upon success, the function returns in \p obj_type the type of the object that the reference points to. Valid values for this referenced object type are as followed (defined in H5Opublic.h): \snippet H5Opublic.h H5O_type_t_snip
-
H5Rget_obj_type3
@Cast("herr_t") public static int H5Rget_obj_type3(H5R_ref_t ref_ptr, @Cast("hid_t") long rapl_id, @Cast("H5O_type_t*") IntBuffer obj_type)
-
H5Rget_obj_type3
@Cast("herr_t") public static int H5Rget_obj_type3(H5R_ref_t ref_ptr, @Cast("hid_t") long rapl_id, @Cast("H5O_type_t*") int[] obj_type)
-
H5Rget_file_name
@Cast("ssize_t") public static long H5Rget_file_name(@Const H5R_ref_t ref_ptr, @Cast("char*") BytePointer name, @Cast("size_t") long size)
-------------------------------------------------------------------------- \ingroup H5R \brief Retrieves the file name for a referenced object- Parameters:
ref_ptr- [in] Pointer to reference to queryname- [in,out] Buffer to place the file name of the referencesize- [in] Size of the \p name buffer- Returns:
- Returns the length of the name if successful, otherwise, a negative value. \details H5Rget_file_name() retrieves the file name for the object, region or attribute reference pointed to by \p ref_ptr. Up to \p size characters of the name are returned in \p name; additional characters, if any, are not returned to the user application. If the length of the name, which determines the required value of size, is unknown, a preliminary H5Rget_file_name() call can be made. The return value of this call will be the size of the file name. That value can then be passed in for size in the second call to H5Rget_file_name(), which will retrieve the actual name.
-
H5Rget_file_name
@Cast("ssize_t") public static long H5Rget_file_name(@Const H5R_ref_t ref_ptr, @Cast("char*") ByteBuffer name, @Cast("size_t") long size)
-
H5Rget_file_name
@Cast("ssize_t") public static long H5Rget_file_name(@Const H5R_ref_t ref_ptr, @Cast("char*") byte[] name, @Cast("size_t") long size)
-
H5Rget_obj_name
@Cast("ssize_t") public static long H5Rget_obj_name(H5R_ref_t ref_ptr, @Cast("hid_t") long rapl_id, @Cast("char*") BytePointer name, @Cast("size_t") long size)
-------------------------------------------------------------------------- \ingroup H5R \brief Retrieves the object name for a referenced object- Parameters:
ref_ptr- [in] Pointer to reference to query \rapl_idname- [in,out] Buffer to place the file name of the referencesize- [in] Size of the \p name buffer- Returns:
- Returns the length of the name if successful, returning 0 (zero) if no name is associated with the identifier. Otherwise returns a negative value. \details H5Rget_obj_name() retrieves the object name for the object, region or attribute reference pointed to by \p ref_ptr. The parameter \p rapl_id is a reference access property list identifier for the reference. The access property list can be used to access external files that the reference points to (through a file access property list). Up to size characters of the name are returned in \p name; additional characters, if any, are not returned to the user application. If the length of the name, which determines the required value of \p size, is unknown, a preliminary call to H5Rget_obj_name() call can be made. The return value of this call will be the size of the object name. That value can then be passed in for \p size in the second call to H5Rget_obj_name(), which will retrieve the actual name. If there is no name associated with the object identifier or if the name is NULL, H5Rget_obj_name() returns the size of the name buffer (the size does not include the \c \0 terminator). If \p ref_ptr is an object reference, \p name will be returned with a name for the referenced object. If \p ref_ptr is a dataset region reference, \p name will contain a name for the object containing the referenced region. If \p ref_ptr is an attribute reference, \p name will contain a name for the object the attribute is attached to. Note that an object in an HDF5 file may have multiple paths if there are multiple links pointing to it. This function may return any one of these paths.
-
H5Rget_obj_name
@Cast("ssize_t") public static long H5Rget_obj_name(H5R_ref_t ref_ptr, @Cast("hid_t") long rapl_id, @Cast("char*") ByteBuffer name, @Cast("size_t") long size)
-
H5Rget_obj_name
@Cast("ssize_t") public static long H5Rget_obj_name(H5R_ref_t ref_ptr, @Cast("hid_t") long rapl_id, @Cast("char*") byte[] name, @Cast("size_t") long size)
-
H5Rget_attr_name
@Cast("ssize_t") public static long H5Rget_attr_name(@Const H5R_ref_t ref_ptr, @Cast("char*") BytePointer name, @Cast("size_t") long size)
-------------------------------------------------------------------------- \ingroup H5R \brief Retrieves the attribute name for a referenced object- Parameters:
ref_ptr- [in] Pointer to reference to queryname- [in,out] Buffer to place the attribute name of the referencesize- [in] Size of the \p name buffer- Returns:
- Returns the length of the name if successful, otherwise, a negative value. \details H5Rget_attr_name() retrieves the attribute name for the attribute reference pointed to by \p ref_ptr. Up to size characters of the name are returned in \p name; additional characters, if any, are not returned to the user application. If the length of the name, which determines the required value of \p size, is unknown, a preliminary H5Rget_attr_name() call can be made. The return value of this call will be the size of the attribute name. That value can then be passed in for size in the second call to H5Rget_attr_name(), which will retrieve the actual name.
-
H5Rget_attr_name
@Cast("ssize_t") public static long H5Rget_attr_name(@Const H5R_ref_t ref_ptr, @Cast("char*") ByteBuffer name, @Cast("size_t") long size)
-
H5Rget_attr_name
@Cast("ssize_t") public static long H5Rget_attr_name(@Const H5R_ref_t ref_ptr, @Cast("char*") byte[] name, @Cast("size_t") long size)
-
H5Rcreate
@Cast("herr_t") public static int H5Rcreate(Pointer ref, @Cast("hid_t") long loc_id, @Cast("const char*") BytePointer name, @Cast("H5R_type_t") int ref_type, @Cast("hid_t") long space_id)
-------------------------------------------------------------------------- \ingroup H5R \brief Creates a reference- Parameters:
ref- [out] Reference created by the function callloc_id- [in] Location identifier used to locate the object being pointed toname- [in] Name of object at location \p loc_idref_type- [in] Type of referencespace_id- [in] Dataspace identifier with selection. Used only for dataset region references; pass as -1 if reference is an object reference, i.e., of type #H5R_OBJECT- Returns:
- \herr_t \details H5Rcreate() creates the reference, \p ref, of the type specified in \p ref_type, pointing to the object \p name located at \p loc_id. The HDF5 library maps the void type specified above for \p ref to the type specified in \p ref_type, which will be one of the following: \snippet this H5R_type_t_snip The parameters \p loc_id and \p name are used to locate the object. The parameter \p space_id identifies the dataset region that a dataset region reference points to. This parameter is used only with dataset region references and should be set to -1 if the reference is an object reference, #H5R_OBJECT.
- Since:
- 1.8.0
-
H5Rcreate
@Cast("herr_t") public static int H5Rcreate(Pointer ref, @Cast("hid_t") long loc_id, String name, @Cast("H5R_type_t") int ref_type, @Cast("hid_t") long space_id)
-
H5Rget_obj_type2
@Cast("herr_t") public static int H5Rget_obj_type2(@Cast("hid_t") long id, @Cast("H5R_type_t") int ref_type, @Const Pointer ref, @Cast("H5O_type_t*") IntPointer obj_type)
-------------------------------------------------------------------------- \ingroup H5R \brief Retrieves the type of object that an object reference points to- Parameters:
id- [in] The dataset containing the reference object or the group containing that datasetref_type- [in] Type of reference to queryref- [in] Reference to queryobj_type- [out] Type of referenced object- Returns:
- \herr_t \details Given an object reference, \p ref, H5Rget_obj_type2() returns the type of the referenced object in \p obj_type. A \Emph{reference type} is the type of reference, either an object reference or a dataset region reference. An \Emph{object reference} points to an HDF5 object while a \Emph{dataset region reference} points to a defined region within a dataset. The \Emph{referenced object} is the object the reference points to. The \Emph{referenced object type}, or the type of the referenced object, is the type of the object that the reference points to. The location identifier, \p id, is the identifier for either the dataset containing the object reference or the group containing that dataset. Valid reference types, to pass in as \p ref_type, include the following: \snippet this H5R_type_t_snip If the application does not already know the object reference type, that can be determined with three preliminary calls: \li Call H5Dget_type() on the dataset containing the reference to get a datatype identifier for the datasetâs datatype. \li Using that datatype identifier, H5Tget_class() returns a datatype class.\n If the datatype class is #H5T_REFERENCE, H5Tequal() can then be used to determine whether the referenceâs datatype is #H5T_STD_REF_OBJ or #H5T_STD_REF_DSETREG: - If the datatype is #H5T_STD_REF_OBJ, the reference object type is #H5R_OBJECT. - If the datatype is #H5T_STD_REF_DSETREG, the reference object type is #H5R_DATASET_REGION. When the function completes successfully, it returns one of the following valid object type values (defined in H5Opublic.h): \snippet H5Opublic.h H5O_type_t_snip
- Since:
- 1.8.0
-
H5Rget_obj_type2
@Cast("herr_t") public static int H5Rget_obj_type2(@Cast("hid_t") long id, @Cast("H5R_type_t") int ref_type, @Const Pointer ref, @Cast("H5O_type_t*") IntBuffer obj_type)
-
H5Rget_obj_type2
@Cast("herr_t") public static int H5Rget_obj_type2(@Cast("hid_t") long id, @Cast("H5R_type_t") int ref_type, @Const Pointer ref, @Cast("H5O_type_t*") int[] obj_type)
-
H5Rdereference2
@Cast("hid_t") public static long H5Rdereference2(@Cast("hid_t") long obj_id, @Cast("hid_t") long oapl_id, @Cast("H5R_type_t") int ref_type, @Const Pointer ref)
-------------------------------------------------------------------------- \ingroup H5R \brief Opens the HDF5 object referenced \obj_id \oapl_id- Parameters:
ref_type- [in] The reference type of \p refref- [in] Reference to open- Returns:
- Returns identifier of referenced object if successful; otherwise returns a negative value. \details Given a reference, \p ref, to an object or a region in an object, H5Rdereference2() opens that object and returns an identifier. The parameter \p obj_id must be a valid identifier for the HDF5 file containing the referenced object or for any object in that HDF5 file. The parameter \p oapl_id is an object access property list identifier for the referenced object. The access property list must be of the same type as the object being referenced, that is a group, dataset, or datatype property list. The parameter \p ref_type specifies the reference type of the reference \p ref. \p ref_type may contain either of the following values: - #H5R_OBJECT - #H5R_DATASET_REGION The object opened with this function should be closed when it is no longer needed so that resource leaks will not develop. Use the appropriate close function such as H5Oclose() or H5Dclose() for datasets.
- Since:
- 1.10.0
-
H5Rget_region
@Cast("hid_t") public static long H5Rget_region(@Cast("hid_t") long dataset, @Cast("H5R_type_t") int ref_type, @Const Pointer ref)
-------------------------------------------------------------------------- \ingroup H5R \brief Sets up a dataspace and selection as specified by a region reference- Parameters:
dataset- [in] File identifier or identifier for any object in the file containing the referenced regionref_type- [in] Reference type of \p ref, which must be #H5R_DATASET_REGIONref- [in] Region reference to open- Returns:
- Returns a valid dataspace identifier if successful; otherwise returns a negative value. \details H5Rget_region() creates a copy of the dataspace of the dataset pointed to by a region reference, \p ref, and defines a selection matching the selection pointed to by ref within the dataspace copy. \p dataset is used to identify the file containing the referenced region; it can be a file identifier or an identifier for any object in the file. The parameter \p ref_type specifies the reference type of \p ref and must contain the value #H5R_DATASET_REGION. Use H5Sclose() to release the dataspace identifier returned by this function when the identifier is no longer needed.
-
H5Rget_name
@Cast("ssize_t") public static long H5Rget_name(@Cast("hid_t") long loc_id, @Cast("H5R_type_t") int ref_type, @Const Pointer ref, @Cast("char*") BytePointer name, @Cast("size_t") long size)
-------------------------------------------------------------------------- \ingroup H5R \brief Retrieves a name for a referenced object- Parameters:
loc_id- [in] Identifier for the file containing the reference or for any object in that fileref_type- [in] Type of referenceref- [in] An object or dataset region referencename- [out] A buffer to place the name of the referenced object or dataset region. If \c NULL, then this call will return the size in bytes of the name.size- [in] The size of the \p name buffer. When the size is passed in, the \c NULL terminator needs to be included.- Returns:
- Returns the length of the name if successful, returning 0 (zero) if no name is associated with the identifier. Otherwise returns a negative value. \details H5Rget_name() retrieves a name for the object identified by \p ref.\n \p loc_id is used to identify the file containing the reference. It can be the file identifier for the file containing the reference or an identifier for any object in that file. \ref H5R_type_t is the reference type of \p ref. Valid values include the following: \snippet this H5R_type_t_snip \p ref is the reference for which the target objectâs name is sought. If \p ref is an object reference, \p name will be returned with a name for the referenced object. If \p ref is a dataset region reference, \p name will contain a name for the object containing the referenced region. Up to \p size characters of the name are returned in \p name; additional characters, if any, are not returned to the user application. If the length of the name, which determines the required value of \p size, is unknown, a preliminary H5Rget_name() call can be made. The return value of this call will be the size of the object name. That value can then be assigned to \p size for a second H5Rget_name() call, which will retrieve the actual name. If there is no name associated with the object identifier or if the \p name is \c NULL, H5Rget_name() returns the size of the \p name buffer (the size does not include the \p NULL terminator). Note that an object in an HDF5 file may have multiple paths if there are multiple links pointing to it. This function may return any one of these paths.
- Since:
- 1.8.0
-
H5Rget_name
@Cast("ssize_t") public static long H5Rget_name(@Cast("hid_t") long loc_id, @Cast("H5R_type_t") int ref_type, @Const Pointer ref, @Cast("char*") ByteBuffer name, @Cast("size_t") long size)
-
H5Rget_name
@Cast("ssize_t") public static long H5Rget_name(@Cast("hid_t") long loc_id, @Cast("H5R_type_t") int ref_type, @Const Pointer ref, @Cast("char*") byte[] name, @Cast("size_t") long size)
-
H5S_ALL
@MemberGetter public static int H5S_ALL()
-
H5Sclose
@Cast("herr_t") public static int H5Sclose(@Cast("hid_t") long space_id)
\ingroup H5S \brief Releases and terminates access to a dataspace \space_id- Returns:
- \herr_t \details H5Sclose() releases a dataspace. Further access through the dataspace identifier is illegal. Failure to release a dataspace with this call will result in resource leaks.
- Since:
- 1.0.0
-
H5Scombine_hyperslab
@Cast("hid_t") public static long H5Scombine_hyperslab(@Cast("hid_t") long space_id, @Cast("H5S_seloper_t") int op, @Cast("const hsize_t*") LongPointer start, @Cast("const hsize_t*") LongPointer stride, @Cast("const hsize_t*") LongPointer count, @Cast("const hsize_t*") LongPointer block)
\ingroup H5S \brief Performs an operation on a hyperslab and an existing selection and returns the resulting selection \space_id- Parameters:
op- [in] Operation to perform on the current selectionstart- [in] Offset of the start of of the hyperslabstride- [in] Hyperslab stridecount- [in] Number of blocks included in the hyperslabblock- [in] Size of a block in the hyperslab- Returns:
- \hid_tv{dataspace} \details H5Scombine_hyperslab() combines a hyperslab selection specified by \p start, \p stride, \p count and \p block with the current selection for the dataspace \p space_id, creating a new dataspace to return the generated selection. If the current selection is not a hyperslab, it is freed and the hyperslab parameters passed in are combined with the #H5S_SEL_ALL hyperslab (ie. a selection composing the entire current extent). If either \p stride or \p block is NULL, then it will be set to \p 1.
- Since:
- 1.10.6
-
H5Scombine_hyperslab
@Cast("hid_t") public static long H5Scombine_hyperslab(@Cast("hid_t") long space_id, @Cast("H5S_seloper_t") int op, @Cast("const hsize_t*") LongBuffer start, @Cast("const hsize_t*") LongBuffer stride, @Cast("const hsize_t*") LongBuffer count, @Cast("const hsize_t*") LongBuffer block)
-
H5Scombine_hyperslab
@Cast("hid_t") public static long H5Scombine_hyperslab(@Cast("hid_t") long space_id, @Cast("H5S_seloper_t") int op, @Cast("const hsize_t*") long[] start, @Cast("const hsize_t*") long[] stride, @Cast("const hsize_t*") long[] count, @Cast("const hsize_t*") long... block)
-
H5Scombine_select
@Cast("hid_t") public static long H5Scombine_select(@Cast("hid_t") long space1_id, @Cast("H5S_seloper_t") int op, @Cast("hid_t") long space2_id)
\ingroup H5S \brief Combine two hyperslab selections with an operation, returning a dataspace with the resulting selection \space_id{space1_id}- Parameters:
op- [in] Selection operator \space_id{space2_id}- Returns:
- \hid_t{dataspace} \details H5Scombine_select() combines two hyperslab selections \p space1_id and \p space2_id with an operation, returning a new dataspace with the resulting selection. The dataspace extent from \p space1_id is copied for the dataspace extent of the newly created dataspace.
- Since:
- 1.10.6
-
H5Scopy
@Cast("hid_t") public static long H5Scopy(@Cast("hid_t") long space_id)
\ingroup H5S \brief Creates an exact copy of a dataspace \space_id- Returns:
- \hid_tv{dataspace} \details H5Scopy() creates a new dataspace which is an exact copy of the dataspace identified by \p space_id. The dataspace identifier returned from this function should be released with H5Sclose() or resource leaks will occur.
- Since:
- 1.0.0
-
H5Screate
@Cast("hid_t") public static long H5Screate(@Cast("H5S_class_t") int type)
\ingroup H5S \brief Creates a new dataspace of a specified type- Parameters:
type- [in] Type of dataspace to be created- Returns:
- \hid_t{dataspace} \details H5Screate() creates a new dataspace of a particular type. Currently supported types are #H5S_SCALAR, #H5S_SIMPLE, and #H5S_NULL. Further dataspace types may be added later. A scalar dataspace, #H5S_SCALAR, has a single element, though that element may be of a complex datatype, such as a compound or array datatype. By convention, the rank of a scalar dataspace is always \p 0 (zero); think of it geometrically as a single, dimensionless point, though that point can be complex. A simple dataspace, #H5S_SIMPLE, consists of a regular array of elements. A null dataspace, #H5S_NULL, has no data elements. The dataspace identifier returned by this function can be released with H5Sclose() so that resource leaks will not occur.
- Since:
- 1.0.0
-
H5Screate_simple
@Cast("hid_t") public static long H5Screate_simple(int rank, @Cast("const hsize_t*") LongPointer dims, @Cast("const hsize_t*") LongPointer maxdims)
\ingroup H5S \brief Creates a new simple dataspace and opens it for access- Parameters:
rank- [in] Number of dimensions of dataspacedims- [in] Array specifying the size of each dimensionmaxdims- [in] Array specifying the maximum size of each dimension- Returns:
- \hid_t{dataspace} \details H5Screate_simple() creates a new simple dataspace and opens it for access, returning a dataspace identifier. \p rank is the number of dimensions used in the dataspace. \p dims is a one-dimensional array of size rank specifying the size of each dimension of the dataset. \p maxdims is an array of the same size specifying the upper limit on the size of each dimension. Any element of \p dims can be \p 0 (zero). Note that no data can be written to a dataset if the size of any dimension of its current dataspace is \p 0. This is sometimes a useful initial state for a dataset. \p maxdims may be the null pointer, in which case the upper limit is the same as \p dims. Otherwise, no element of \p maxdims should be smaller than the corresponding element of \p dims. If an element of \p maxdims is #H5S_UNLIMITED, the maximum size of the corresponding dimension is unlimited. Any dataset with an unlimited dimension must also be chunked; see H5Pset_chunk(). Similarly, a dataset must be chunked if \p dims does not equal \p maxdims. The dataspace identifier returned from this function must be released with H5Sclose() or resource leaks will occur. \note Once a dataspace has been created, specific regions or elements in the dataspace can be selected and selections can be removed, as well. For example, H5Sselect_hyperslab() selects a region in a dataspace and H5Sselect_elements() selects array elements in a dataspace. These functions are used for subsetting. H5Sselect_none() removes all selections from a dataspace and is used in Parallel HDF5 when a process does not have or need to write data.
- Since:
- 1.0.0
-
H5Screate_simple
@Cast("hid_t") public static long H5Screate_simple(int rank, @Cast("const hsize_t*") LongBuffer dims, @Cast("const hsize_t*") LongBuffer maxdims)
-
H5Screate_simple
@Cast("hid_t") public static long H5Screate_simple(int rank, @Cast("const hsize_t*") long[] dims, @Cast("const hsize_t*") long... maxdims)
-
H5Sdecode
@Cast("hid_t") public static long H5Sdecode(@Const Pointer buf)
\ingroup H5S \brief Decodes a binary object description of data space and returns a new object handle- Parameters:
buf- [in] Buffer for the data space object to be decoded- Returns:
- \hid_t{dataspace} \details Given an object description of a dataspace in binary in a buffer, H5Sdecode() reconstructs the HDF5 data type object and returns a new object handle for it. The binary description of the object is encoded by H5Sencode(). The user is responsible for passing in the right buffer. The types of dataspace addressed in this function are null, scalar, and simple space. For a simple dataspace, the selection information (for example, hyperslab selection) is also encoded and decoded. A complex dataspace has not been implemented in the library.
- Since:
- 1.8.0
-
H5Sencode2
@Cast("herr_t") public static int H5Sencode2(@Cast("hid_t") long obj_id, Pointer buf, @Cast("size_t*") SizeTPointer nalloc, @Cast("hid_t") long fapl)
\ingroup H5S \brief Encodes a data space object description into a binary buffer \space_id{obj_id}- Parameters:
buf- [in,out] Buffer for the object to be encoded into; If the provided buffer is NULL, only the size of buffer needed is returned through \p nalloc.nalloc- [in,out] The size of the allocated buffer \fapl_id{fapl}- Returns:
- \herr_t \details Given the data space identifier \p obj_id, H5Sencode2() converts a data space description into binary form in a buffer. Using this binary form in the buffer, a data space object can be reconstructed with H5Sdecode() to return a new object handle (#hid_t) for this data space. A preliminary H5Sencode2() call can be made to determine the size of the buffer needed. This value is returned in \p nalloc. That value can then be assigned to \p nalloc for a second H5Sencode2() call, which will retrieve the actual encoded object. If the library determines that \p nalloc is not big enough for the object, it simply returns the size of the buffer needed through \p nalloc without encoding the provided buffer. The file access property list \p fapl_id is used to control the encoding via the \a libver_bounds property (see H5Pset_libver_bounds()). If the \a libver_bounds property is missing, H5Sencode2() proceeds as if the \a libver_bounds property were set to (#H5F_LIBVER_EARLIEST, #H5F_LIBVER_LATEST). (Functionally, H5Sencode1() is identical to H5Sencode2() with \a libver_bounds set to (#H5F_LIBVER_EARLIEST, #H5F_LIBVER_LATEST).) The types of data space that are addressed in this function are null, scalar, and simple space. For a simple data space, the information on the selection, for example, hyperslab selection, is also encoded and decoded. A complex data space has not been implemented in the library. \note Motivation: This function was introduced in HDF5-1.12 as part of the H5Sencode() format change to enable 64-bit selection encodings and a dataspace selection that is tied to a file. See the \ref_news_112 as well as the \ref_sencode_fmt_change.
- Since:
- 1.12.0
-
H5Sextent_copy
@Cast("herr_t") public static int H5Sextent_copy(@Cast("hid_t") long dst_id, @Cast("hid_t") long src_id)
\ingroup H5S \brief Copies the extent of a dataspace \space_id{dst_id} \space_id{src_id}- Returns:
- \herr_t \details H5Sextent_copy() copies the extent from \p src_id to \p dst_id. This action may change the type of the dataspace.
- Since:
- 1.0.0
-
H5Sextent_equal
@Cast("htri_t") public static int H5Sextent_equal(@Cast("hid_t") long space1_id, @Cast("hid_t") long space2_id)
\ingroup H5S \brief Determines whether two dataspace extents are equal \space_id{space1_id} \space_id{space2_id}- Returns:
- \htri_t \details H5Sextent_equal() determines whether the dataspace extents of two dataspaces, \p space1_id and \p space2_id, are equal.
- Since:
- 1.8.0
-
H5Sget_regular_hyperslab
@Cast("htri_t") public static int H5Sget_regular_hyperslab(@Cast("hid_t") long spaceid, @Cast("hsize_t*") LongPointer start, @Cast("hsize_t*") LongPointer stride, @Cast("hsize_t*") LongPointer count, @Cast("hsize_t*") LongPointer block)
\ingroup H5S \brief Retrieves a regular hyperslab selection \space_id{spaceid}- Parameters:
start- [out] Offset of the start of the regular hyperslabstride- [out] Stride of the regular hyperslabcount- [out] Number of blocks in the regular hyperslabblock- [out] Size of a block in the regular hyperslab- Returns:
- \herr_t \details H5Sget_regular_hyperslab() takes the dataspace identifier, \p spaceid, and retrieves the values of \p start, \p stride, \p count, and \p block for the regular hyperslab selection. A regular hyperslab selection is a hyperslab selection described by setting the \p offset, \p stride, \p count, and \p block parameters to the H5Sselect_hyperslab() call. If several calls to H5Sselect_hyperslab() are needed, the hyperslab selection is irregular. See H5Sselect_hyperslab() for descriptions of \p offset, \p stride, \p count, and \p block. \note If a hyperslab selection is originally regular, then becomes irregular through selection operations, and then becomes regular again, the final regular selection may be equivalent but not identical to the original regular selection.
- Since:
- 1.10.0
-
H5Sget_regular_hyperslab
@Cast("htri_t") public static int H5Sget_regular_hyperslab(@Cast("hid_t") long spaceid, @Cast("hsize_t*") LongBuffer start, @Cast("hsize_t*") LongBuffer stride, @Cast("hsize_t*") LongBuffer count, @Cast("hsize_t*") LongBuffer block)
-
H5Sget_regular_hyperslab
@Cast("htri_t") public static int H5Sget_regular_hyperslab(@Cast("hid_t") long spaceid, @Cast("hsize_t*") long[] start, @Cast("hsize_t*") long[] stride, @Cast("hsize_t*") long[] count, @Cast("hsize_t*") long... block)
-
H5Sget_select_bounds
@Cast("herr_t") public static int H5Sget_select_bounds(@Cast("hid_t") long spaceid, @Cast("hsize_t*") LongPointer start, @Cast("hsize_t*") LongPointer end)
\ingroup H5S \brief Gets the bounding box containing the current selection \space_id{spaceid}- Parameters:
start- [out] Starting coordinates of the bounding boxend- [out] Ending coordinates of the bounding box, i.e., the coordinates of the diagonally opposite corner- Returns:
- \herr_t \details H5Sget_select_bounds() retrieves the coordinates of the bounding box containing the current selection and places them into user-supplied buffers. The \p start and \p end buffers must be large enough to hold the dataspace rank number of coordinates. The bounding box exactly contains the selection. I.e., if a 2-dimensional element selection is currently defined as containing the points (4,5), (6,8), and (10,7), then the bounding box will be (4, 5), (10, 8). The bounding box calculation includes the current offset of the selection within the dataspace extent. Calling this function on a \a none selection will fail.
- Since:
- 1.2.0
-
H5Sget_select_bounds
@Cast("herr_t") public static int H5Sget_select_bounds(@Cast("hid_t") long spaceid, @Cast("hsize_t*") LongBuffer start, @Cast("hsize_t*") LongBuffer end)
-
H5Sget_select_bounds
@Cast("herr_t") public static int H5Sget_select_bounds(@Cast("hid_t") long spaceid, @Cast("hsize_t*") long[] start, @Cast("hsize_t*") long... end)
-
H5Sget_select_elem_npoints
@Cast("hssize_t") public static long H5Sget_select_elem_npoints(@Cast("hid_t") long spaceid)
\ingroup H5S \brief Gets the number of element points in the current selection \space_id{spaceid}- Returns:
- Returns the number of element points in the current dataspace selection if successful. Otherwise returns a negative value. \details H5Sget_select_elem_npoints() returns the number of element points in the current dataspace selection, so that the element points can be retrieved with H5Sget_select_elem_pointlist(). (This is similar to the way that H5Sget_select_hyper_nblocks() and H5Sget_select_hyper_blocklist() work with hyperslab selections.) Coincidentally, H5Sget_select_npoints() and H5Sget_select_elem_npoints() will always return the same value when an element selection is queried, but H5Sget_select_elem_npoints() does not work with other selection types.
- Since:
- 1.2.0
-
H5Sget_select_elem_pointlist
@Cast("herr_t") public static int H5Sget_select_elem_pointlist(@Cast("hid_t") long spaceid, @Cast("hsize_t") long startpoint, @Cast("hsize_t") long numpoints, @Cast("hsize_t*") LongPointer buf)
\ingroup H5S \brief Gets the list of element points currently selected \space_id{spaceid}- Parameters:
startpoint- [in] Element point to start withnumpoints- [in] Number of element points to getbuf- [out] List of element points selected \details H5Sget_select_elem_pointlist() returns the list of element points in the current dataspace selection \p space_id. Starting with the \p startpoint in the list of points, \p numpoints points are put into the user's buffer. If the user's buffer fills up before \p numpoints points are inserted, the buffer will contain only as many points as fit. The element point coordinates have the same dimensionality (rank) as the dataspace they are located within. The list of element points is formatted as follows:\n \- Since:
- 1.2.0
-
H5Sget_select_elem_pointlist
@Cast("herr_t") public static int H5Sget_select_elem_pointlist(@Cast("hid_t") long spaceid, @Cast("hsize_t") long startpoint, @Cast("hsize_t") long numpoints, @Cast("hsize_t*") LongBuffer buf)
-
H5Sget_select_elem_pointlist
@Cast("herr_t") public static int H5Sget_select_elem_pointlist(@Cast("hid_t") long spaceid, @Cast("hsize_t") long startpoint, @Cast("hsize_t") long numpoints, @Cast("hsize_t*") long... buf)
-
H5Sget_select_hyper_blocklist
@Cast("herr_t") public static int H5Sget_select_hyper_blocklist(@Cast("hid_t") long spaceid, @Cast("hsize_t") long startblock, @Cast("hsize_t") long numblocks, @Cast("hsize_t*") LongPointer buf)
\ingroup H5S \brief Gets the list of hyperslab blocks currently selected \space_id{spaceid}- Parameters:
startblock- [in] Hyperslab block to start withnumblocks- [in] Number of hyperslab blocks to getbuf- [out] List of hyperslab blocks selected- Returns:
- \herr_t \details H5Sget_select_hyper_blocklist() returns a list of the hyperslab blocks currently selected. Starting with the \p startblock-th block in the list of blocks, \p numblocks blocks are put into the user's buffer. If the user's buffer fills up before \p numblocks blocks are inserted, the buffer will contain only as many blocks as fit. The block coordinates have the same dimensionality (rank) as the dataspace they are located within. The list of blocks is formatted as follows:\n \<"start" coordinate\>, immediately followed by\n \<"opposite" corner coordinate\>, followed by\n the next "start" and "opposite" coordinates,\n etc. until all of the selected blocks have been listed.\n No guarantee of any order of the blocks is implied.
- Since:
- 1.2.0
-
H5Sget_select_hyper_blocklist
@Cast("herr_t") public static int H5Sget_select_hyper_blocklist(@Cast("hid_t") long spaceid, @Cast("hsize_t") long startblock, @Cast("hsize_t") long numblocks, @Cast("hsize_t*") LongBuffer buf)
-
H5Sget_select_hyper_blocklist
@Cast("herr_t") public static int H5Sget_select_hyper_blocklist(@Cast("hid_t") long spaceid, @Cast("hsize_t") long startblock, @Cast("hsize_t") long numblocks, @Cast("hsize_t*") long... buf)
-
H5Sget_select_hyper_nblocks
@Cast("hssize_t") public static long H5Sget_select_hyper_nblocks(@Cast("hid_t") long spaceid)
\ingroup H5S \brief Get number of hyperslab blocks \space_id{spaceid}- Returns:
- Returns the number of hyperslab blocks in the current dataspace selection if successful. Otherwise returns a negative value. \details H5Sget_select_hyper_nblocks() returns the number of hyperslab blocks in the current dataspace selection.
- Since:
- 1.2.0
-
H5Sget_select_npoints
@Cast("hssize_t") public static long H5Sget_select_npoints(@Cast("hid_t") long spaceid)
\ingroup H5S \brief Determines the number of elements in a dataspace selection \space_id{spaceid}- Returns:
- Returns the number of elements in the selection if successful; otherwise returns a negative value. \details H5Sget_select_npoints() determines the number of elements in the current selection of a dataspace. It works with any selection type, and is the correct way to retrieve the number of elements in a selection.
- Since:
- 1.0.0
-
H5Sget_select_type
@Cast("H5S_sel_type") public static int H5Sget_select_type(@Cast("hid_t") long spaceid)
\ingroup H5S \brief Determines the type of the dataspace selection \space_id{spaceid}- Returns:
- Returns the dataspace selection type, a value of the enumerated
datatype #H5S_sel_type, if successful.
\details H5Sget_select_type() retrieves the type of dataspace selection
currently defined for the dataspace \p space_id. Valid values
for the dataspace selection type are:
Otherwise returns a negative value.#H5S_SEL_NONE No selection is defined #H5S_SEL_POINTS A sequence of points is selected #H5S_SEL_HYPERSLABS A hyperslab or compound hyperslab is selected #H5S_SEL_ALL The entire dataset is selected - Since:
- 1.6.0
-
H5Sget_simple_extent_dims
public static int H5Sget_simple_extent_dims(@Cast("hid_t") long space_id, @Cast("hsize_t*") LongPointer dims, @Cast("hsize_t*") LongPointer maxdims)
\ingroup H5S \brief Retrieves dataspace dimension size and maximum size \space_id- Parameters:
dims- [out] Pointer to array to store the size of each dimensionmaxdims- [out] Pointer to array to store the maximum size of each dimension- Returns:
- Returns the number of dimensions in the dataspace if successful; otherwise returns a negative value. \details H5Sget_simple_extent_dims() returns the size and maximum sizes of each dimension of a dataspace \p space_id through the \p dims and \p maxdims parameters. Either or both of \p dims and \p maxdims may be NULL. If a value in the returned array \p maxdims is #H5S_UNLIMITED (-1), the maximum size of that dimension is unlimited.
- Since:
- 1.0.0
-
H5Sget_simple_extent_dims
public static int H5Sget_simple_extent_dims(@Cast("hid_t") long space_id, @Cast("hsize_t*") LongBuffer dims, @Cast("hsize_t*") LongBuffer maxdims)
-
H5Sget_simple_extent_dims
public static int H5Sget_simple_extent_dims(@Cast("hid_t") long space_id, @Cast("hsize_t*") long[] dims, @Cast("hsize_t*") long... maxdims)
-
H5Sget_simple_extent_ndims
public static int H5Sget_simple_extent_ndims(@Cast("hid_t") long space_id)
\ingroup H5S \brief Determines the dimensionality of a dataspace \space_id- Returns:
- Returns the number of dimensions in the dataspace if successful; otherwise returns a negative value. \details H5Sget_simple_extent_ndims() determines the dimensionality (or rank) of a dataspace.
- Since:
- 1.0.0
-
H5Sget_simple_extent_npoints
@Cast("hssize_t") public static long H5Sget_simple_extent_npoints(@Cast("hid_t") long space_id)
\ingroup H5S \brief Determines the number of elements in a dataspace \space_id- Returns:
- Returns the number of elements in the dataspace if successful; otherwise returns a negative value. \details H5Sget_simple_extent_npoints() determines the number of elements in a dataspace \p space_id. For example, a simple 3-dimensional dataspace with dimensions 2, 3, and 4 would have 24 elements.
- Since:
- 1.0.0
-
H5Sget_simple_extent_type
@Cast("H5S_class_t") public static int H5Sget_simple_extent_type(@Cast("hid_t") long space_id)
\ingroup H5S \brief Determines the current class of a dataspace \space_id- Returns:
- Returns a dataspace class name if successful; otherwise #H5S_NO_CLASS (-1). \details H5Sget_simple_extent_type() determines the current class of a dataspace \p space_id.
- Since:
- 1.0.0
-
H5Sis_regular_hyperslab
@Cast("htri_t") public static int H5Sis_regular_hyperslab(@Cast("hid_t") long spaceid)
\ingroup H5S \brief Determines if a hyperslab selection is regular \space_id{spaceid}- Returns:
- \htri_t \details H5Sis_regular_hyperslab() takes the dataspace identifier, \p spaceid, and queries the type of the hyperslab selection. A regular hyperslab selection is a hyperslab selection described by setting the offset, stride, count, and block parameters for a single H5Sselect_hyperslab() call. If several calls to H5Sselect_hyperslab() are needed, then the hyperslab selection is irregular.
- Since:
- 1.10.0
-
H5Sis_simple
@Cast("htri_t") public static int H5Sis_simple(@Cast("hid_t") long space_id)
\ingroup H5S \brief Determines whether a dataspace is a simple dataspace \space_id- Returns:
- \htri_t \details H5Sis_simple() determines whether or not a dataspace is a simple dataspace. \note Currently, all dataspace objects are simple dataspaces; complex dataspace support will be added in the future.
- Since:
- 1.0.0
-
H5Smodify_select
@Cast("herr_t") public static int H5Smodify_select(@Cast("hid_t") long space1_id, @Cast("H5S_seloper_t") int op, @Cast("hid_t") long space2_id)
\ingroup H5S \brief Refines a hyperslab selection with an operation, using a second hyperslab to modify it \space_id{space1_id}- Parameters:
op- [in] Selection operator \space_id{space2_id}- Returns:
- \herr_t \details H5Smodify_select() refines an existing hyperslab selection \p space1_id with an operation \p op, using a second hyperslab \p space2_id. The first selection is modified to contain the result of \p space1_id operated on by \p space2_id.
- Since:
- 1.10.6
-
H5Soffset_simple
@Cast("herr_t") public static int H5Soffset_simple(@Cast("hid_t") long space_id, @Cast("const hssize_t*") LongPointer offset)
\ingroup H5S \brief Sets the offset of a simple dataspace \space_id- Parameters:
offset- [in] The offset at which to position the selection- Returns:
- \herr_t \details H5Soffset_simple() sets the offset of a simple dataspace \p space_id. The offset array must be the same number of elements as the number of dimensions for the dataspace. If the \p offset array is set to NULL, the offset for the dataspace is reset to 0. This function allows the same shaped selection to be moved to different locations within a dataspace without requiring it to be redefined.
- Since:
- 1.0.0
-
H5Soffset_simple
@Cast("herr_t") public static int H5Soffset_simple(@Cast("hid_t") long space_id, @Cast("const hssize_t*") LongBuffer offset)
-
H5Soffset_simple
@Cast("herr_t") public static int H5Soffset_simple(@Cast("hid_t") long space_id, @Cast("const hssize_t*") long... offset)
-
H5Ssel_iter_close
@Cast("herr_t") public static int H5Ssel_iter_close(@Cast("hid_t") long sel_iter_id)
\ingroup H5S \brief Closes a dataspace selection iterator \space_id{sel_iter_id}- Returns:
- \herr_t \details H5Ssel_iter_close() closes a dataspace selection iterator specified by \p sel_iter_id, releasing its state.
- Since:
- 1.12.0
-
H5Ssel_iter_create
@Cast("hid_t") public static long H5Ssel_iter_create(@Cast("hid_t") long spaceid, @Cast("size_t") long elmt_size, @Cast("unsigned") int flags)
\ingroup H5S \brief Creates a dataspace selection iterator for a dataspace's selection \space_id{spaceid}- Parameters:
elmt_size- [in] Size of element in the selectionflags- [in] Selection iterator flag- Returns:
- \hid_t{valid dataspace selection iterator} \details H5Ssel_iter_create() creates a selection iterator and initializes it to start at the first element selected in the dataspace.
- Since:
- 1.12.0
-
H5Ssel_iter_get_seq_list
@Cast("herr_t") public static int H5Ssel_iter_get_seq_list(@Cast("hid_t") long sel_iter_id, @Cast("size_t") long maxseq, @Cast("size_t") long maxbytes, @Cast("size_t*") SizeTPointer nseq, @Cast("size_t*") SizeTPointer nbytes, @Cast("hsize_t*") LongPointer off, @Cast("size_t*") SizeTPointer len)
\ingroup H5S \brief Retrieves a list of offset / length sequences for the elements in an iterator \space_id{sel_iter_id}- Parameters:
maxseq- [in] Maximum number of sequences to retrievemaxbytes- [in] Maximum number of bytes to retrieve in sequencesnseq- [out] Number of sequences retrievednbytes- [out] Number of bytes retrieved, in all sequencesoff- [out] Array of sequence offsetslen- [out] Array of sequence lengths- Returns:
- \herr_t \details H5Ssel_iter_get_seq_list() retrieves a list of offset / length pairs (a list of "sequences") matching the selected elements for an iterator \p sel_iter_id, according to the iteration order for the iterator. The lengths returned are in bytes, not elements. Note that the iteration order for "all" and "hyperslab" selections is row-major (i.e. "C-ordered"), but the iteration order for "point" selections is "in order selected", unless the #H5S_SEL_ITER_GET_SEQ_LIST_SORTED flag is passed to H5Ssel_iter_create() for a point selection. \p maxseq and \p maxbytes specify the most sequences or bytes possible to place into the \p off and \p len arrays. \p nseq and \p nbytes return the actual number of sequences and bytes put into the arrays. Each call to H5Ssel_iter_get_seq_list() will retrieve the next set of sequences for the selection being iterated over. The total number of bytes possible to retrieve from a selection iterator is the \p elmt_size passed to H5Ssel_iter_create() multiplied by the number of elements selected in the dataspace the iterator was created from (which can be retrieved with H5Sget_select_npoints(). When there are no further sequences of elements to retrieve, calls to this routine will set \p nseq and \p nbytes to zero.
- Since:
- 1.12.0
-
H5Ssel_iter_get_seq_list
@Cast("herr_t") public static int H5Ssel_iter_get_seq_list(@Cast("hid_t") long sel_iter_id, @Cast("size_t") long maxseq, @Cast("size_t") long maxbytes, @Cast("size_t*") SizeTPointer nseq, @Cast("size_t*") SizeTPointer nbytes, @Cast("hsize_t*") LongBuffer off, @Cast("size_t*") SizeTPointer len)
-
H5Ssel_iter_get_seq_list
@Cast("herr_t") public static int H5Ssel_iter_get_seq_list(@Cast("hid_t") long sel_iter_id, @Cast("size_t") long maxseq, @Cast("size_t") long maxbytes, @Cast("size_t*") SizeTPointer nseq, @Cast("size_t*") SizeTPointer nbytes, @Cast("hsize_t*") long[] off, @Cast("size_t*") SizeTPointer len)
-
H5Ssel_iter_reset
@Cast("herr_t") public static int H5Ssel_iter_reset(@Cast("hid_t") long sel_iter_id, @Cast("hid_t") long space_id)
\ingroup H5S \brief Resets a dataspace selection iterator back to an initial state- Parameters:
sel_iter_id- [in] Identifier of the dataspace selection iterator to resetspace_id- [in] Identifier of the dataspace with selection to iterate over- Returns:
- \herr_t \details H5Ssel_iter_reset() resets a dataspace selection iterator back to an initial state so that the iterator may be used for iteration once again.
- Since:
- 1.12.1
-
H5Sselect_adjust
@Cast("herr_t") public static int H5Sselect_adjust(@Cast("hid_t") long spaceid, @Cast("const hssize_t*") LongPointer offset)
\ingroup H5S \brief Adjusts a selection by subtracting an offset \space_id{spaceid}- Parameters:
offset- [in] Offset to subtract- Returns:
- \herr_t \details H5Sselect_adjust() shifts a dataspace selection by a specified logical offset within the dataspace extent. \note This can be useful for VOL developers to implement chunked datasets.
- Since:
- 1.10.6
-
H5Sselect_adjust
@Cast("herr_t") public static int H5Sselect_adjust(@Cast("hid_t") long spaceid, @Cast("const hssize_t*") LongBuffer offset)
-
H5Sselect_adjust
@Cast("herr_t") public static int H5Sselect_adjust(@Cast("hid_t") long spaceid, @Cast("const hssize_t*") long... offset)
-
H5Sselect_all
@Cast("herr_t") public static int H5Sselect_all(@Cast("hid_t") long spaceid)
\ingroup H5S \brief Selects an entire dataspace \space_id{spaceid}- Returns:
- \herr_t \details H5Sselect_all() selects the entire extent of the dataspace \p dspace_id. More specifically, H5Sselect_all() sets the selection type to #H5S_SEL_ALL, which specifies the entire dataspace anywhere it is applied.
- Since:
- 1.0.0
-
H5Sselect_copy
@Cast("herr_t") public static int H5Sselect_copy(@Cast("hid_t") long dst_id, @Cast("hid_t") long src_id)
\ingroup H5S \brief Copies a selection from one dataspace to another \space_id{dst_id} \space_id{src_id}- Returns:
- \herr_t \details H5Sselect_copy() copies all selection information (including offset) from the source dataspace \p src_id to the destination dataspace \p dst_id.
- Since:
- 1.10.6
-
H5Sselect_elements
@Cast("herr_t") public static int H5Sselect_elements(@Cast("hid_t") long space_id, @Cast("H5S_seloper_t") int op, @Cast("size_t") long num_elem, @Cast("const hsize_t*") LongPointer coord)
\ingroup H5S \brief Selects array elements to be included in the selection for a dataspace \space_id- Parameters:
op- [in] Operator specifying how the new selection is to be combined with the existing selection for the dataspacenum_elem- [in] Number of elements to be selectedcoord- [in] A pointer to a buffer containing a serialized copy of a 2-dimensional array of zero-based values specifying the coordinates of the elements in the point selection- Returns:
- \herr_t
\details H5Sselect_elements() selects array elements to be included in
the selection for the \p space_id dataspace. This is referred
to as a point selection.
The number of elements selected is set in the \p num_elements
parameter.
The \p coord parameter is a pointer to a buffer containing a
serialized 2-dimensional array of size \p num_elements by the
rank of the dataspace. The array lists dataset elements in the
point selection; that is, itâs a list of of zero-based values
specifying the coordinates in the dataset of the selected
elements. The order of the element coordinates in the \p coord
array specifies the order in which the array elements are
iterated through when I/O is performed. Duplicate coordinate
locations are not checked for. See below for examples of the
mapping between the serialized contents of the buffer and the
point selection array that it represents.
The selection operator \p op determines how the new selection
is to be combined with the previously existing selection for
the dataspace. The following operators are supported:
Mapping the serialized \p coord buffer to a 2-dimensional point selection array: To illustrate the construction of the contents of the \p coord buffer, consider two simple examples: a selection of 5 points in a 1-dimensional array and a selection of 3 points in a 4-dimensional array. In the 1D case, we will be selecting five points and a 1D dataspace has rank 1, so the selection will be described in a 5-by-1 array. To select the 1st, 14th, 17th, 23rd, 8th elements of the dataset, the selection array would be as follows (remembering that point coordinates are zero-based): \n 0 \n 13 \n 16 \n 22 \n 7 This point selection array will be serialized in the \p coord buffer as: \n 0 13 16 22 7 In the 4D case, we will be selecting three points and a 4D dataspace has rank 4, so the selection will be described in a 3-by-4 array. To select the points (1,1,1,1), (14,6,12,18), and (8,22,30,22), the point selection array would be as follows: \n 0 0 0 0 \n 13 5 11 17 \n 7 21 29 21 This point selection array will be serialized in the \p coord buffer as: \n 0 0 0 0 13 5 11 17 7 21 29 21#H5S_SELECT_SET Replaces the existing selection with the parameters from this call. Overlapping blocks are not supported with this operator. Adds the new selection to the existing selection. #H5S_SELECT_APPEND Adds the new selection following the last element of the existing selection. #H5S_SELECT_PREPEND Adds the new selection preceding the first element of the existing selection. - Since:
- 1.0.0
-
H5Sselect_elements
@Cast("herr_t") public static int H5Sselect_elements(@Cast("hid_t") long space_id, @Cast("H5S_seloper_t") int op, @Cast("size_t") long num_elem, @Cast("const hsize_t*") LongBuffer coord)
-
H5Sselect_elements
@Cast("herr_t") public static int H5Sselect_elements(@Cast("hid_t") long space_id, @Cast("H5S_seloper_t") int op, @Cast("size_t") long num_elem, @Cast("const hsize_t*") long... coord)
-
H5Sselect_hyperslab
@Cast("herr_t") public static int H5Sselect_hyperslab(@Cast("hid_t") long space_id, @Cast("H5S_seloper_t") int op, @Cast("const hsize_t*") LongPointer start, @Cast("const hsize_t*") LongPointer stride, @Cast("const hsize_t*") LongPointer count, @Cast("const hsize_t*") LongPointer block)
\ingroup H5S \brief Selects a hyperslab region to add to the current selected region \space_id- Parameters:
op- [in] Operation to perform on current selectionstart- [in] Offset of start of hyperslabstride- [in] Hyperslab stridecount- [in] Number of blocks included in hyperslabblock- [in] Size of block in hyperslab- Returns:
- \herr_t
\details H5Sselect_hyperslab() selects a hyperslab region to add to the
current selected region for the dataspace specified by
\p space_id.
The \p start, \p stride, \p count, and \p block arrays must be the
same size as the rank of the dataspace. For example, if the
dataspace is 4-dimensional, each of these parameters must be a
1-dimensional array of size 4.
The selection operator \p op determines how the new selection
is to be combined with the already existing selection for the
dataspace. The following operators are supported:
The \p start array specifies the offset of the starting element of the specified hyperslab. The \p stride array chooses array locations from the dataspace with each value in the \p stride array determining how many elements to move in each dimension. Setting a value in the \p stride array to \p 1 moves to each element in that dimension of the dataspace; setting a value of \p 2 in allocation in the \p stride array moves to every other element in that dimension of the dataspace. In other words, the \p stride determines the number of elements to move from the \p start location in each dimension. Stride values of \p 0 are not allowed. If the \p stride parameter is NULL, a contiguous hyperslab is selected (as if each value in the \p stride array were set to \p 1). The \p count array determines how many blocks to select from the dataspace, in each dimension. The \p block array determines the size of the element block selected from the dataspace. If the \p block parameter is set to NULL, the block size defaults to a single element in each dimension (as if each value in the \p block array were set to \p 1). For example, consider a 2-dimensional dataspace with hyperslab selection settings as follows: the \p start offset is specified as [1,1], \p stride is [4,4], \p count is [3,7], and \p block is [2,2]. In C, these settings will specify a hyperslab consisting of 21 2x2 blocks of array elements starting with location (1,1) with the selected blocks at locations (1,1), (5,1), (9,1), (1,5), (5,5), etc.; in Fortran, they will specify a hyperslab consisting of 21 2x2 blocks of array elements starting with location (2,2) with the selected blocks at locations (2,2), (6,2), (10,2), (2,6), (6,6), etc. Regions selected with this function call default to C order iteration when I/O is performed.#H5S_SELECT_SET Replaces the existing selection with the parameters from this call. Overlapping blocks are not supported with this operator. #H5S_SELECT_OR Adds the new selection to the existing selection. (Binary OR) #H5S_SELECT_AND Retains only the overlapping portions of the new selection and the existing selection. (Binary AND) #H5S_SELECT_XOR Retains only the elements that are members of the new selection or the existing selection, excluding elements that are members of both selections. (Binary exclusive-OR, XOR) #H5S_SELECT_NOTB Retains only elements of the existing selection that are not in the new selection. #H5S_SELECT_NOTA Retains only elements of the new selection that are not in the existing selection. - Since:
- 1.0.0
-
H5Sselect_hyperslab
@Cast("herr_t") public static int H5Sselect_hyperslab(@Cast("hid_t") long space_id, @Cast("H5S_seloper_t") int op, @Cast("const hsize_t*") LongBuffer start, @Cast("const hsize_t*") LongBuffer stride, @Cast("const hsize_t*") LongBuffer count, @Cast("const hsize_t*") LongBuffer block)
-
H5Sselect_hyperslab
@Cast("herr_t") public static int H5Sselect_hyperslab(@Cast("hid_t") long space_id, @Cast("H5S_seloper_t") int op, @Cast("const hsize_t*") long[] start, @Cast("const hsize_t*") long[] stride, @Cast("const hsize_t*") long[] count, @Cast("const hsize_t*") long... block)
-
H5Sselect_intersect_block
@Cast("htri_t") public static int H5Sselect_intersect_block(@Cast("hid_t") long space_id, @Cast("const hsize_t*") LongPointer start, @Cast("const hsize_t*") LongPointer end)
\ingroup H5S \brief Checks if current selection intersects with a block \space_id- Parameters:
start- [in] Starting coordinate of blockend- [in] Opposite ("ending") coordinate of block- Returns:
- \htri_t \details H5Sselect_intersect_block() checks to see if the current selection \p space_id in the dataspace intersects with the block specified by \p start and \p end. \note Assumes that \p start & \p end block bounds are inclusive, so \p start == \p end value is OK.
- Since:
- 1.10.6
-
H5Sselect_intersect_block
@Cast("htri_t") public static int H5Sselect_intersect_block(@Cast("hid_t") long space_id, @Cast("const hsize_t*") LongBuffer start, @Cast("const hsize_t*") LongBuffer end)
-
H5Sselect_intersect_block
@Cast("htri_t") public static int H5Sselect_intersect_block(@Cast("hid_t") long space_id, @Cast("const hsize_t*") long[] start, @Cast("const hsize_t*") long... end)
-
H5Sselect_none
@Cast("herr_t") public static int H5Sselect_none(@Cast("hid_t") long spaceid)
\ingroup H5S \brief Resets the selection region to include no elements \space_id{spaceid}- Returns:
- \herr_t \details H5Sselect_none() resets the selection region for the dataspace \p space_id to include no elements.
- Since:
- 1.0.0
-
H5Sselect_project_intersection
@Cast("hid_t") public static long H5Sselect_project_intersection(@Cast("hid_t") long src_space_id, @Cast("hid_t") long dst_space_id, @Cast("hid_t") long src_intersect_space_id)
\ingroup H5S \brief Projects the intersection of two source selections to a destination selection \space_id{src_space_id} \space_id{dst_space_id} \space_id{src_intersect_space_id}- Returns:
- Returns a dataspace with a selection equal to the intersection of \p src_intersect_space_id and \p src_space_id projected from \p src_space to \p dst_space on success, negative on failure. \details H5Sselect_project_intersection() computes the intersection between two dataspace selections and projects that intersection into a third selection.This can be useful for VOL developers to implement chunked or virtual datasets.
- Since:
- 1.10.6
-
H5Sselect_shape_same
@Cast("htri_t") public static int H5Sselect_shape_same(@Cast("hid_t") long space1_id, @Cast("hid_t") long space2_id)
\ingroup H5S \brief Checks if two selections are the same shape \space_id{space1_id} \space_id{space2_id}- Returns:
- \htri_t \details H5Sselect_shape_same() checks to see if the current selection in the dataspaces are the same dimensionality and shape. This is primarily used for reading the entire selection in one swoop.
- Since:
- 1.10.6
-
H5Sselect_valid
@Cast("htri_t") public static int H5Sselect_valid(@Cast("hid_t") long spaceid)
\ingroup H5S \brief Verifies that the selection is within the extent of the dataspace \space_id{spaceid}- Returns:
- \htri_t \details H5Sselect_valid() verifies that the selection for the dataspace \p space_id is within the extent of the dataspace if the current offset for the dataspace is used.
- Since:
- 1.0.0
-
H5Sset_extent_none
@Cast("herr_t") public static int H5Sset_extent_none(@Cast("hid_t") long space_id)
\ingroup H5S \brief Resets the extent of a dataspace back to "none" \space_id- Returns:
- \herr_t \details H5Sset_extent_none() resets the type of a dataspace to #H5S_NULL with no extent information stored for the dataspace.
- Since:
- 1.0.0
-
H5Sset_extent_simple
@Cast("herr_t") public static int H5Sset_extent_simple(@Cast("hid_t") long space_id, int rank, @Cast("const hsize_t*") LongPointer dims, @Cast("const hsize_t*") LongPointer max)
\ingroup H5S \brief Sets or resets the size of an existing dataspace \space_id- Parameters:
rank- [in] Rank, or dimensionality, of the dataspacedims- [in] Array containing current size of dataspacemax- [in] Array containing maximum size of dataspace- Returns:
- \herr_t \details H5Sset_extent_simple() sets or resets the size of an existing dataspace. \p dims is an array of size \p rank which contains the new size of each dimension in the dataspace. \p max is an array of size \p rank which contains the maximum size of each dimension in the dataspace. Any previous extent is removed from the dataspace, the dataspace type is set to #H5S_SIMPLE, and the extent is set as specified.
- Since:
- 1.0.0
-
H5Sset_extent_simple
@Cast("herr_t") public static int H5Sset_extent_simple(@Cast("hid_t") long space_id, int rank, @Cast("const hsize_t*") LongBuffer dims, @Cast("const hsize_t*") LongBuffer max)
-
H5Sset_extent_simple
@Cast("herr_t") public static int H5Sset_extent_simple(@Cast("hid_t") long space_id, int rank, @Cast("const hsize_t*") long[] dims, @Cast("const hsize_t*") long... max)
-
H5FD_CORE
@MemberGetter public static int H5FD_CORE()
-
H5FD_core_init
@Cast("hid_t") public static long H5FD_core_init()
-
H5Pset_fapl_core
@Cast("herr_t") public static int H5Pset_fapl_core(@Cast("hid_t") long fapl_id, @Cast("size_t") long increment, @Cast("hbool_t") boolean backing_store)
\ingroup FAPL \brief Modifies the file access property list to use the #H5FD_CORE driver \fapl_id- Parameters:
increment- [in] Size, in bytes, of memory incrementsbacking_store- [in] Boolean flag indicating whether to write the file contents to disk when the file is closed- Returns:
- \herr_t \details H5Pset_fapl_core() modifies the file access property list to use the #H5FD_CORE driver. The #H5FD_CORE driver enables an application to work with a file in memory, speeding reads and writes as no disk access is made. File contents are stored only in memory until the file is closed. The \p backing_store parameter determines whether file contents are ever written to disk. \p increment specifies the increment by which allocated memory is to be increased each time more memory is required. While using H5Fcreate() to create a core file, if the \p backing_store is set to 1 (TRUE), the file contents are flushed to a file with the same name as this core file when the file is closed or access to the file is terminated in memory. The application is allowed to open an existing file with #H5FD_CORE driver. While using H5Fopen() to open an existing file, if the \p backing_store is set to 1 (TRUE) and the \c flags for H5Fopen() is set to #H5F_ACC_RDWR, any change to the file contents are saved to the file when the file is closed. If \p backing_store is set to 0 (FALSE) and the \c flags for H5Fopen() is set to #H5F_ACC_RDWR, any change to the file contents will be lost when the file is closed. If the flags for H5Fopen() is set to #H5F_ACC_RDONLY, no change to the file is allowed either in memory or on file. \note Currently this driver cannot create or open family or multi files.
- Since:
- 1.4.0
-
H5Pget_fapl_core
@Cast("herr_t") public static int H5Pget_fapl_core(@Cast("hid_t") long fapl_id, @Cast("size_t*") SizeTPointer increment, @Cast("hbool_t*") BoolPointer backing_store)
\ingroup FAPL \brief Queries core file driver properties \fapl_id- Parameters:
increment- [out] Size, in bytes, of memory incrementsbacking_store- [out] Boolean flag indicating whether to write the file contents to disk when the file is closed- Returns:
- \herr_t \details H5Pget_fapl_core() queries the #H5FD_CORE driver properties as set by H5Pset_fapl_core().
- Since:
- 1.4.0
-
H5Pget_fapl_core
@Cast("herr_t") public static int H5Pget_fapl_core(@Cast("hid_t") long fapl_id, @Cast("size_t*") SizeTPointer increment, @Cast("hbool_t*") boolean[] backing_store)
-
H5FD_FAMILY
@MemberGetter public static int H5FD_FAMILY()
-
H5FD_family_init
@Cast("hid_t") public static long H5FD_family_init()
-
H5Pset_fapl_family
@Cast("herr_t") public static int H5Pset_fapl_family(@Cast("hid_t") long fapl_id, @Cast("hsize_t") long memb_size, @Cast("hid_t") long memb_fapl_id)
\ingroup FAPL \brief Sets the file access property list to use the family driver \fapl_id- Parameters:
memb_size- [in] Size in bytes of each file membermemb_fapl_id- [in] Identifier of file access property list for each family member- Returns:
- \herr_t \details H5Pset_fapl_family() sets the file access property list identifier, \p fapl_id, to use the family driver. \p memb_size is the size in bytes of each file member. This size will be saved in file when the property list \p fapl_id is used to create a new file. If \p fapl_id is used to open an existing file, \p memb_size has to be equal to the original size saved in file. A failure with an error message indicating the correct member size will be returned if \p memb_size does not match the size saved. If any user does not know the original size, #H5F_FAMILY_DEFAULT can be passed in. The library will retrieve the saved size. \p memb_fapl_id is the identifier of the file access property list to be used for each family member.
- Since:
- 1.4.0
-
H5Pget_fapl_family
@Cast("herr_t") public static int H5Pget_fapl_family(@Cast("hid_t") long fapl_id, @Cast("hsize_t*") LongPointer memb_size, @Cast("hid_t*") LongPointer memb_fapl_id)
\ingroup FAPL \brief Returns file access property list information \fapl_id- Parameters:
memb_size- [out] Size in bytes of each file membermemb_fapl_id- [out] Identifier of file access property list for each family member- Returns:
- \herr_t \details H5Pget_fapl_family() returns file access property list for use with the family driver. This information is returned through the output parameters.
- Since:
- 1.4.0
-
H5Pget_fapl_family
@Cast("herr_t") public static int H5Pget_fapl_family(@Cast("hid_t") long fapl_id, @Cast("hsize_t*") LongBuffer memb_size, @Cast("hid_t*") LongBuffer memb_fapl_id)
-
H5Pget_fapl_family
@Cast("herr_t") public static int H5Pget_fapl_family(@Cast("hid_t") long fapl_id, @Cast("hsize_t*") long[] memb_size, @Cast("hid_t*") long... memb_fapl_id)
-
H5FD_LOG
@MemberGetter public static int H5FD_LOG()
-
H5FD_log_init
@Cast("hid_t") public static long H5FD_log_init()
-
H5Pset_fapl_log
@Cast("herr_t") public static int H5Pset_fapl_log(@Cast("hid_t") long fapl_id, @Cast("const char*") BytePointer logfile, @Cast("unsigned long long") long flags, @Cast("size_t") long buf_size)
\ingroup FAPL \brief Sets up the logging virtual file driver (#H5FD_LOG) for use \fapl_id- Parameters:
logfile- [in] Name of the log fileflags- [in] Flags specifying the types of logging activitybuf_size- [in] The size of the logging buffers, in bytes (see description)- Returns:
- \herr_t
\details H5Pset_fapl_log() modifies the file access property list to use the
logging driver, #H5FD_LOG. The logging virtual file driver (VFD) is
a clone of the standard SEC2 (#H5FD_SEC2) driver with additional
facilities for logging VFD metrics and activity to a file.
\p logfile is the name of the file in which the logging entries are
to be recorded.
The actions to be logged are specified in the parameter \p flags
using the pre-defined constants described in the following
table. Multiple flags can be set through the use of a logical \c OR
contained in parentheses. For example, logging read and write
locations would be specified as
\Code{(H5FD_LOG_LOC_READ|H5FD_LOG_LOC_WRITE)}.
The logging driver can track the number of times each byte in the file is read from or written to (using #H5FD_LOG_FILE_READ and #H5FD_LOG_FILE_WRITE) and what kind of data is at that location (e.g., metadata, raw data; using #H5FD_LOG_FLAVOR). This information is tracked in internal buffers of size buf_size, which must be at least the maximum size in bytes of the file to be logged while the log driver is in use.\n One buffer of size buf_size will be created for each of #H5FD_LOG_FILE_READ, #H5FD_LOG_FILE_WRITE and #H5FD_LOG_FLAVOR when those flags are set; these buffers will not grow as the file increases in size. \par Output: This section describes the logging driver (LOG VFD) output.\n The table, immediately below, describes output of the various logging driver flags and function calls. A list of valid flavor values, describing the type of data stored, follows the table.Table1: Logging Flags #H5FD_LOG_LOC_READ Track the location and length of every read, write, or seek operation. #H5FD_LOG_LOC_WRITE #H5FD_LOG_LOC_SEEK #H5FD_LOG_LOC_IO Track all I/O locations and lengths. The logical equivalent of the following: \Code{(#H5FD_LOG_LOC_READ | #H5FD_LOG_LOC_WRITE | #H5FD_LOG_LOC_SEEK)} #H5FD_LOG_FILE_READ Track the number of times each byte is read or written. #H5FD_LOG_FILE_WRITE #H5FD_LOG_FILE_IO Track the number of times each byte is read and written. The logical equivalent of the following: \Code{(#H5FD_LOG_FILE_READ | #H5FD_LOG_FILE_WRITE)} #H5FD_LOG_FLAVOR Track the type, or flavor, of information stored at each byte. #H5FD_LOG_NUM_READ Track the total number of read, write, seek, or truncate operations that occur. #H5FD_LOG_NUM_WRITE #H5FD_LOG_NUM_SEEK #H5FD_LOG_NUM_TRUNCATE #H5FD_LOG_NUM_IO Track the total number of all types of I/O operations. The logical equivalent of the following: \Code{(#H5FD_LOG_NUM_READ | #H5FD_LOG_NUM_WRITE | #H5FD_LOG_NUM_SEEK | #H5FD_LOG_NUM_TRUNCATE)} #H5FD_LOG_TIME_OPEN Track the time spent in open, stat, read, write, seek, or close operations. #H5FD_LOG_TIME_STAT #H5FD_LOG_TIME_READ #H5FD_LOG_TIME_WRITE #H5FD_LOG_TIME_SEEK #H5FD_LOG_TIME_CLOSE #H5FD_LOG_TIME_IO Track the time spent in each of the above operations. The logical equivalent of the following: \Code{(#H5FD_LOG_TIME_OPEN | #H5FD_LOG_TIME_STAT | #H5FD_LOG_TIME_READ | #H5FD_LOG_TIME_WRITE | #H5FD_LOG_TIME_SEEK | #H5FD_LOG_TIME_CLOSE)} #H5FD_LOG_ALLOC Track the allocation of space in the file. #H5FD_LOG_ALL Track everything. The logical equivalent of the following: \Code{(#H5FD_LOG_ALLOC | #H5FD_LOG_TIME_IO | #H5FD_LOG_NUM_IO | #H5FD_LOG_FLAVOR | #H5FD_LOG_FILE_IO | #H5FD_LOG_LOC_IO)}
\par Flavors: The \Emph{flavor} describes the type of stored information. The following table lists the flavors that appear in log output and briefly describes each. These terms are provided here to aid in the construction of log message parsers; a full description is beyond the scope of this document.Table2: Logging Output Flag VFD Call Output and Comments #H5FD_LOG_LOC_READ Read \Code{%10a-%10a (%10Zu bytes) (%s) Read}\n\n Start position\n End position\n Number of bytes\n Flavor of read\n\n Adds \Code{(\%f s)} and seek time if #H5FD_LOG_TIME_SEEK is also set. #H5FD_LOG_LOC_READ Read Error \Code{Error! Reading: %10a-%10a (%10Zu bytes)}\n\n Same parameters as non-error entry. #H5FD_LOG_LOC_WRITE Write \Code{%10a-%10a (%10Zu bytes) (%s) Written}\n\n Start position\n End position\n Number of bytes\n Flavor of write\n\n Adds \Code{(\%f s)} and seek time if #H5FD_LOG_TIME_SEEK is also set. #H5FD_LOG_LOC_WRITE Write Error \Code{Error! Writing: %10a-%10a (%10Zu bytes)}\n\n Same parameters as non-error entry. #H5FD_LOG_LOC_SEEK Read, Write \Code{Seek: From %10a-%10a}\n\n Start position\n End position\n\n Adds \Code{(\%f s)} and seek time if #H5FD_LOG_TIME_SEEK is also set. #H5FD_LOG_FILE_READ Close Begins with:\n Dumping read I/O information\n\n Then, for each range of identical values, there is this line:\n \Code{Addr %10-%10 (%10lu bytes) read from %3d times}\n\n Start address\n End address\n Number of bytes\n Number of times read\n\n Note: The data buffer is scanned and each range of identical values gets one entry in the log file to save space and make it easier to read. #H5FD_LOG_FILE_WRITE Close Begins with:\n Dumping read I/O information\n\n Then, for each range of identical values, there is this line:\n \Code{Addr %10-%10 (%10lu bytes) written to %3d times}\n\n Start address\n End address\n Number of bytes\n Number of times written\n\n Note: The data buffer is scanned and each range of identical values gets one entry in the log file to save space and make it easier to read. #H5FD_LOG_FLAVOR Close Begins with:\n Dumping I/O flavor information\n\n Then, for each range of identical values, there is this line:\n \Code{Addr %10-%10 (%10lu bytes) flavor is %s}\n\n Start address\n End address\n Number of bytes\n Flavor\n\n Note: The data buffer is scanned and each range of identical values gets one entry in the log file to save space and make it easier to read. #H5FD_LOG_NUM_READ Close Total number of read operations: \Code{%11u} #H5FD_LOG_NUM_WRITE Close Total number of write operations: \Code{%11u} #H5FD_LOG_NUM_SEEK Close Total number of seek operations: \Code{%11u} #H5FD_LOG_NUM_TRUNCATE Close Total number of truncate operations: \Code{%11u} #H5FD_LOG_TIME_OPEN Open Open took: \Code{(\%f s)} #H5FD_LOG_TIME_READ Close, Read Total time in read operations: \Code{\%f s}\n\n See also: #H5FD_LOG_LOC_READ #H5FD_LOG_TIME_WRITE Close, Write Total time in write operations: \Code{\%f s}\n\n See also: #H5FD_LOG_LOC_WRITE #H5FD_LOG_TIME_SEEK Close, Read, Write Total time in write operations: \Code{\%f s}\n\n See also: #H5FD_LOG_LOC_SEEK or #H5FD_LOG_LOC_WRITE #H5FD_LOG_TIME_CLOSE Close Close took: \Code{(\%f s)} #H5FD_LOG_TIME_STAT Open Stat took: \Code{(\%f s)} #H5FD_LOG_ALLOC Alloc \Code{%10-%10 (%10Hu bytes) (\%s) Allocated}\n\n Start of address space\n End of address space\n Total size allocation\n Flavor of allocation Table3: Flavors of logged data Flavor Description #H5FD_MEM_NOLIST Error value #H5FD_MEM_DEFAULT Value not yet set.\n May also be a datatype set in a larger allocation that will be suballocated by the library. #H5FD_MEM_SUPER Superblock data #H5FD_MEM_BTREE B-tree data #H5FD_MEM_DRAW Raw data (for example, contents of a dataset) #H5FD_MEM_GHEAP Global heap data #H5FD_MEM_LHEAP Local heap data #H5FD_MEM_OHDR Object header data - Since:
- 1.4.0
-
H5Pset_fapl_log
@Cast("herr_t") public static int H5Pset_fapl_log(@Cast("hid_t") long fapl_id, String logfile, @Cast("unsigned long long") long flags, @Cast("size_t") long buf_size)
-
H5FD_MULTI
@MemberGetter public static int H5FD_MULTI()
-
H5FD_multi_init
@Cast("hid_t") public static long H5FD_multi_init()
-
H5Pset_fapl_multi
@Cast("herr_t") public static int H5Pset_fapl_multi(@Cast("hid_t") long fapl_id, @Cast("const H5FD_mem_t*") IntPointer memb_map, @Cast("const hid_t*") LongPointer memb_fapl, @Cast("const char*const*") PointerPointer memb_name, @Cast("const haddr_t*") LongPointer memb_addr, @Cast("hbool_t") boolean relax)
\ingroup FAPL \brief Sets up use of the multi-file driver \fapl_id- Parameters:
memb_map- [in] Maps memory usage types to other memory usage typesmemb_fapl- [in] Property list for each memory usage typememb_name- [in] Name generator for names of member filesmemb_addr- [in] The offsets within the virtual address space, from 0 (zero) to #HADDR_MAX, at which each type of data storage beginsrelax- [in] Allows read-only access to incomplete file sets when \c TRUE- Returns:
- \herr_t
\details H5Pset_fapl_multi() sets the file access property list \p fapl_id to
use the multi-file driver.
The multi-file driver enables different types of HDF5 data and
metadata to be written to separate files. These files are viewed by
the HDF5 library and the application as a single virtual HDF5 file
with a single HDF5 file address space. The types of data that can be
broken out into separate files include raw data, the superblock,
B-tree data, global heap data, local heap data, and object
headers. At the programmer's discretion, two or more types of data
can be written to the same file while other types of data are
written to separate files.
The array \p memb_map maps memory usage types to other memory usage
types and is the mechanism that allows the caller to specify how
many files are created. The array contains #H5FD_MEM_NTYPES entries,
which are either the value #H5FD_MEM_DEFAULT or a memory usage
type. The number of unique values determines the number of files
that are opened.
The array \p memb_fapl contains a property list for each memory
usage type that will be associated with a file.
The array \p memb_name should be a name generator (a
\Code{printf}-style format with a \Code{%s} which will be replaced
with the name passed to H5FDopen(), usually from H5Fcreate() or
H5Fopen()).
The array \p memb_addr specifies the offsets within the virtual
address space, from 0 (zero) to #HADDR_MAX, at which each type of
data storage begins.
If \p relax is set to 1 (TRUE), then opening an existing file for
read-only access will not fail if some file members are
missing. This allows a file to be accessed in a limited sense if
just the meta data is available.
Default values for each of the optional arguments are as follows:
\par Example: The following code sample sets up a multi-file access property list that partitions data into meta and raw files, each being one-half of the address:\n\p memb_map The default member map contains the value #H5FD_MEM_DEFAULT for each element. \p memb_fapl The default value is #H5P_DEFAULT for each element. \p memb_name The default string is \Code{%s-X.h5} where \c X is one of the following letters: - \c s for #H5FD_MEM_SUPER - \c b for #H5FD_MEM_BTREE - \c r for #H5FD_MEM_DRAW - \c g for #H5FD_MEM_GHEAP - \c l for #H5FD_MEM_LHEAP - \c o for #H5FD_MEM_OHDR \p memb_addr The default setting is that the address space is equally divided among all of the elements: - #H5FD_MEM_SUPER \Code{-> 0 * (HADDR_MAX/6)} - #H5FD_MEM_BTREE \Code{-> 1 * (HADDR_MAX/6)} - #H5FD_MEM_DRAW \Code{-> 2 * (HADDR_MAX/6)} - #H5FD_MEM_GHEAP \Code{-> 3 * (HADDR_MAX/6)} - #H5FD_MEM_LHEAP \Code{-> 4 * (HADDR_MAX/6)} - #H5FD_MEM_OHDR \Code{-> 5 * (HADDR_MAX/6)} H5FD_mem_t mt, memb_map[H5FD_MEM_NTYPES]; hid_t memb_fapl[H5FD_MEM_NTYPES]; const char *memb[H5FD_MEM_NTYPES]; haddr_t memb_addr[H5FD_MEM_NTYPES]; // The mapping... for (mt=0; mt<H5FD_MEM_NTYPES; mt++) { memb_map[mt] = H5FD_MEM_SUPER; } memb_map[H5FD_MEM_DRAW] = H5FD_MEM_DRAW; // Member information memb_fapl[H5FD_MEM_SUPER] = H5P_DEFAULT; memb_name[H5FD_MEM_SUPER] = "%s.meta"; memb_addr[H5FD_MEM_SUPER] = 0; memb_fapl[H5FD_MEM_DRAW] = H5P_DEFAULT; memb_name[H5FD_MEM_DRAW] = "%s.raw"; memb_addr[H5FD_MEM_DRAW] = HADDR_MAX/2; hid_t fapl = H5Pcreate(H5P_FILE_ACCESS); H5Pset_fapl_multi(fapl, memb_map, memb_fapl, memb_name, memb_addr, TRUE); - Since:
- 1.4.0
-
H5Pset_fapl_multi
@Cast("herr_t") public static int H5Pset_fapl_multi(@Cast("hid_t") long fapl_id, @Cast("const H5FD_mem_t*") IntPointer memb_map, @Cast("const hid_t*") LongPointer memb_fapl, @Cast("const char*const*") @ByPtrPtr BytePointer memb_name, @Cast("const haddr_t*") LongPointer memb_addr, @Cast("hbool_t") boolean relax)
-
H5Pset_fapl_multi
@Cast("herr_t") public static int H5Pset_fapl_multi(@Cast("hid_t") long fapl_id, @Cast("const H5FD_mem_t*") IntBuffer memb_map, @Cast("const hid_t*") LongBuffer memb_fapl, @Cast("const char*const*") @ByPtrPtr ByteBuffer memb_name, @Cast("const haddr_t*") LongBuffer memb_addr, @Cast("hbool_t") boolean relax)
-
H5Pset_fapl_multi
@Cast("herr_t") public static int H5Pset_fapl_multi(@Cast("hid_t") long fapl_id, @Cast("const H5FD_mem_t*") int[] memb_map, @Cast("const hid_t*") long[] memb_fapl, @Cast("const char*const*") @ByPtrPtr byte[] memb_name, @Cast("const haddr_t*") long[] memb_addr, @Cast("hbool_t") boolean relax)
-
H5Pget_fapl_multi
@Cast("herr_t") public static int H5Pget_fapl_multi(@Cast("hid_t") long fapl_id, @Cast("H5FD_mem_t*") IntPointer memb_map, @Cast("hid_t*") LongPointer memb_fapl, @Cast("char**") PointerPointer memb_name, @Cast("haddr_t*") LongPointer memb_addr, @Cast("hbool_t*") BoolPointer relax)
\ingroup FAPL \brief Returns information about the multi-file access property list \fapl_id- Parameters:
memb_map- [out] Maps memory usage types to other memory usage typesmemb_fapl- [out] Property list for each memory usage typememb_name- [out] Name generator for names of member filesmemb_addr- [out] The offsets within the virtual address space, from 0 (zero) to #HADDR_MAX, at which each type of data storage beginsrelax- [out] Allows read-only access to incomplete file sets when \c TRUE- Returns:
- \herr_t \details H5Pget_fapl_multi() returns information about the multi-file access property list.
- Since:
- 1.4.0
-
H5Pget_fapl_multi
@Cast("herr_t") public static int H5Pget_fapl_multi(@Cast("hid_t") long fapl_id, @Cast("H5FD_mem_t*") IntPointer memb_map, @Cast("hid_t*") LongPointer memb_fapl, @Cast("char**") @ByPtrPtr BytePointer memb_name, @Cast("haddr_t*") LongPointer memb_addr, @Cast("hbool_t*") BoolPointer relax)
-
H5Pget_fapl_multi
@Cast("herr_t") public static int H5Pget_fapl_multi(@Cast("hid_t") long fapl_id, @Cast("H5FD_mem_t*") IntBuffer memb_map, @Cast("hid_t*") LongBuffer memb_fapl, @Cast("char**") @ByPtrPtr ByteBuffer memb_name, @Cast("haddr_t*") LongBuffer memb_addr, @Cast("hbool_t*") boolean[] relax)
-
H5Pget_fapl_multi
@Cast("herr_t") public static int H5Pget_fapl_multi(@Cast("hid_t") long fapl_id, @Cast("H5FD_mem_t*") int[] memb_map, @Cast("hid_t*") long[] memb_fapl, @Cast("char**") @ByPtrPtr byte[] memb_name, @Cast("haddr_t*") long[] memb_addr, @Cast("hbool_t*") BoolPointer relax)
-
H5Pget_fapl_multi
@Cast("herr_t") public static int H5Pget_fapl_multi(@Cast("hid_t") long fapl_id, @Cast("H5FD_mem_t*") IntPointer memb_map, @Cast("hid_t*") LongPointer memb_fapl, @Cast("char**") @ByPtrPtr BytePointer memb_name, @Cast("haddr_t*") LongPointer memb_addr, @Cast("hbool_t*") boolean[] relax)
-
H5Pget_fapl_multi
@Cast("herr_t") public static int H5Pget_fapl_multi(@Cast("hid_t") long fapl_id, @Cast("H5FD_mem_t*") IntBuffer memb_map, @Cast("hid_t*") LongBuffer memb_fapl, @Cast("char**") @ByPtrPtr ByteBuffer memb_name, @Cast("haddr_t*") LongBuffer memb_addr, @Cast("hbool_t*") BoolPointer relax)
-
H5Pget_fapl_multi
@Cast("herr_t") public static int H5Pget_fapl_multi(@Cast("hid_t") long fapl_id, @Cast("H5FD_mem_t*") int[] memb_map, @Cast("hid_t*") long[] memb_fapl, @Cast("char**") @ByPtrPtr byte[] memb_name, @Cast("haddr_t*") long[] memb_addr, @Cast("hbool_t*") boolean[] relax)
-
H5Pset_fapl_split
@Cast("herr_t") public static int H5Pset_fapl_split(@Cast("hid_t") long fapl, @Cast("const char*") BytePointer meta_ext, @Cast("hid_t") long meta_plist_id, @Cast("const char*") BytePointer raw_ext, @Cast("hid_t") long raw_plist_id)
\ingroup FAPL \brief Emulates the old split file driver \fapl_id{fapl}- Parameters:
meta_ext- [in] Metadata filename extensionmeta_plist_id- [in] File access property list identifier for the metadata fileraw_ext- [in] Raw data filename extensionraw_plist_id- [in]- Returns:
- \herr_t
\details H5Pset_fapl_split() is a compatibility function that enables the
multi-file driver to emulate the split driver from HDF5 Releases 1.0
and 1.2. The split file driver stored metadata and raw data in
separate files but provided no mechanism for separating types of
metadata.
\p fapl is a file access property list identifier.
\p meta_ext is the filename extension for the metadata file. The
extension is appended to the name passed to H5FDopen(), usually from
H5Fcreate() or H5Fopen(), to form the name of the metadata file. If
the string \Code{%s} is used in the extension, it works like the
name generator as in H5Pset_fapl_multi().
\p meta_plist_id is the file access property list identifier for the
metadata file.
\p raw_ext is the filename extension for the raw data file. The
extension is appended to the name passed to H5FDopen(), usually from
H5Fcreate() or H5Fopen(), to form the name of the raw data file. If
the string \Code{%s} is used in the extension, it works like the
name generator as in H5Pset_fapl_multi().
\p raw_plist_id is the file access property list identifier for the
raw data file.
If a user wishes to check to see whether this driver is in use, the
user must call H5Pget_driver() and compare the returned value to the
string #H5FD_MULTI. A positive match will confirm that the multi
driver is in use; HDF5 provides no mechanism to determine whether it
was called as the special case invoked by H5Pset_fapl_split().
\par Example:
// Example 1: Both metadata and rawdata files are in the same // directory. Use Station1-m.h5 and Station1-r.h5 as // the metadata and rawdata files. hid_t fapl, fid; fapl = H5Pcreate(H5P_FILE_ACCESS); H5Pset_fapl_split(fapl, "-m.h5", H5P_DEFAULT, "-r.h5", H5P_DEFAULT); fid=H5Fcreate("Station1",H5F_ACC_TRUNC,H5P_DEFAULT,fapl); // Example 2: metadata and rawdata files are in different // directories. Use PointA-m.h5 and /pfs/PointA-r.h5 as // the metadata and rawdata files. hid_t fapl, fid; fapl = H5Pcreate(H5P_FILE_ACCESS); H5Pset_fapl_split(fapl, "-m.h5", H5P_DEFAULT, "/pfs/%s-r.h5", H5P_DEFAULT); fid=H5Fcreate("PointA",H5F_ACC_TRUNC,H5P_DEFAULT,fapl); - Since:
- 1.4.0
-
H5Pset_fapl_split
@Cast("herr_t") public static int H5Pset_fapl_split(@Cast("hid_t") long fapl, String meta_ext, @Cast("hid_t") long meta_plist_id, String raw_ext, @Cast("hid_t") long raw_plist_id)
-
H5FD_SEC2
@MemberGetter public static int H5FD_SEC2()
-
H5FD_sec2_init
@Cast("hid_t") public static long H5FD_sec2_init()
-
H5FD_STDIO
@MemberGetter public static int H5FD_STDIO()
-
H5FD_stdio_init
@Cast("hid_t") public static long H5FD_stdio_init()
-
H5Pset_fapl_stdio
@Cast("herr_t") public static int H5Pset_fapl_stdio(@Cast("hid_t") long fapl_id)
\ingroup FAPL \brief Sets the standard I/O driver \fapl_id- Returns:
- \herr_t \details H5Pset_fapl_stdio() modifies the file access property list to use the standard I/O driver, H5FDstdio().
- Since:
- 1.4.0
-
H5DOappend
@Cast("herr_t") public static int H5DOappend(@Cast("hid_t") long dset_id, @Cast("hid_t") long dxpl_id, @Cast("unsigned") int axis, @Cast("size_t") long extension, @Cast("hid_t") long memtype, @Const Pointer buf)
-------------------------------------------------------------------------- \ingroup H5DO \brief Appends data to a dataset along a specified dimension.- Parameters:
dset_id- [in] Dataset identifierdxpl_id- [in] Dataset transfer property list identifieraxis- [in] Dataset Dimension (0-based) for the appendextension- [in] Number of elements to append for the axis-th dimensionmemtype- [in] The memory datatype identifierbuf- [in] Buffer with data for the append- Returns:
- \herr_t \details The H5DOappend() routine extends a dataset by \p extension number of elements along a dimension specified by a dimension \p axis and writes \p buf of elements to the dataset. Dimension \p axis is 0-based. Elementsâ type is described by \p memtype. This routine combines calling H5Dset_extent(), H5Sselect_hyperslab(), and H5Dwrite() into a single routine that simplifies application development for the common case of appending elements to an existing dataset. For a multi-dimensional dataset, appending to one dimension will write a contiguous hyperslab over the other dimensions. For example, if a 3-D dataset has dimension sizes (3, 5, 8), extending the 0th dimension (currently of size 3) by 3 will append 3*5*8 = 120 elements (which must be pointed to by the \p buffer parameter) to the dataset, making its final dimension sizes (6, 5, 8). If a dataset has more than one unlimited dimension, any of those dimensions may be appended to, although only along one dimension per call to H5DOappend().
- Since:
- 1.10.0
-
H5DSwith_new_ref
@Cast("herr_t") public static int H5DSwith_new_ref(@Cast("hid_t") long obj_id, @Cast("hbool_t*") BoolPointer with_new_ref)
-------------------------------------------------------------------------- \ingroup H5DS \brief Determines if new references are used with dimension scales.- Parameters:
obj_id- [in] Object identifierwith_new_ref- [out] New references are used or not- Returns:
- \herr_t \details H5DSwith_new_ref() takes any object identifier and checks if new references are used for dimension scales. Currently, new references are used when non-native VOL connector is used or when H5_DIMENSION_SCALES_WITH_NEW_REF is set up via configure option.
-
H5DSwith_new_ref
@Cast("herr_t") public static int H5DSwith_new_ref(@Cast("hid_t") long obj_id, @Cast("hbool_t*") boolean[] with_new_ref)
-
H5DSattach_scale
@Cast("herr_t") public static int H5DSattach_scale(@Cast("hid_t") long did, @Cast("hid_t") long dsid, @Cast("unsigned int") int idx)
-------------------------------------------------------------------------- \ingroup H5DS \brief Attach dimension scale \p dsid to dimension \p idx of dataset did.- Parameters:
did- [in] The datasetdsid- [in] The scale to be attachedidx- [in] The dimension of \p did that \p dsid is associated with- Returns:
- \herr_t \details Define Dimension Scale \p dsid to be associated with dimension \p idx of dataset \p did. Entries are created in the #DIMENSION_LIST and #REFERENCE_LIST attributes, as defined in section 4.2 of HDF5 Dimension Scale Specification. Fails if: - Bad arguments - If \p dsid is not a Dimension Scale - If \p did is a Dimension Scale (A Dimension Scale cannot have scales.) \note The Dimension Scale \p dsid can be attached to the same dimension more than once, which has no effect.
-
H5DSdetach_scale
@Cast("herr_t") public static int H5DSdetach_scale(@Cast("hid_t") long did, @Cast("hid_t") long dsid, @Cast("unsigned int") int idx)
-------------------------------------------------------------------------- \ingroup H5DS \brief Detach dimension scale \p dsid from the dimension \p idx of dataset \p did.- Parameters:
did- [in] The datasetdsid- [in] The scale to be detachedidx- [in] The dimension of \p did to detach- Returns:
- \herr_t \details If possible, deletes association of Dimension Scale \p dsid with dimension \p idx of dataset \p did. This deletes the entries in the #DIMENSION_LIST and #REFERENCE_LIST attributes, as defined in section 4.2 of HDF5 Dimension Scale Specification. Fails if: - Bad arguments - The dataset \p did or \p dsid do not exist - The \p dsid is not a Dimension Scale - \p dsid is not attached to \p did \note A scale may be associated with more than dimension of the same dataset. If so, the detach operation only deletes one of the associations, for \p did.
-
H5DSset_scale
@Cast("herr_t") public static int H5DSset_scale(@Cast("hid_t") long dsid, @Cast("const char*") BytePointer dimname)
-------------------------------------------------------------------------- \ingroup H5DS \brief Convert dataset \p dsid to a dimension scale, with optional name, \p dimname.- Parameters:
dsid- [in] The dataset to be made a Dimemsion Scaledimname- [in] The dimension name (optional), NULL if the dimension has no name.- Returns:
- \herr_t \details The dataset \p dsid is converted to a Dimension Scale dataset, as defined above. Creates the CLASS attribute, set to the value "DIMENSION_SCALE" and an empty #REFERENCE_LIST attribute, as described in HDF5 Dimension Scale Specification. (PDF, see section 4.2). If \p dimname is specified, then an attribute called NAME is created, with the value \p dimname. Fails if: - Bad arguments - If \p dsid is already a scale - If \p dsid is a dataset which already has dimension scales If the dataset was created with the Table, Image, or Palette interface [9], it is not recommended to convert to a Dimension Scale. (These Datasets will have a CLASS Table, Image, or Palette.) \todo what is [9] after Palette interface?
-
H5DSset_scale
@Cast("herr_t") public static int H5DSset_scale(@Cast("hid_t") long dsid, String dimname)
-
H5DSget_num_scales
public static int H5DSget_num_scales(@Cast("hid_t") long did, @Cast("unsigned int") int idx)
-------------------------------------------------------------------------- \ingroup H5DS \brief Determines how many Dimension Scales are attached to dimension \p idx of \p did.- Parameters:
did- [in] The dataset to queryidx- [in] The dimension of \p did to query- Returns:
- Returns the number of Dimension Scales associated with \p did, if successful, otherwise returns a negative value. \details H5DSget_num_scales() determines how many Dimension Scales are attached to dimension \p idx of dataset \p did.
-
H5DSset_label
@Cast("herr_t") public static int H5DSset_label(@Cast("hid_t") long did, @Cast("unsigned int") int idx, @Cast("const char*") BytePointer label)
-------------------------------------------------------------------------- \ingroup H5DS \brief Set label for the dimension \p idx of \p did to the value \p label.- Parameters:
did- [in] The datasetidx- [in] The dimensionlabel- [in] The label- Returns:
- \herr_t \details Sets the #DIMENSION_LABELS for dimension \p idx of dataset \p did. If the dimension had a label, the new value replaces the old. Fails if: - Bad arguments
-
H5DSset_label
@Cast("herr_t") public static int H5DSset_label(@Cast("hid_t") long did, @Cast("unsigned int") int idx, String label)
-
H5DSget_label
@Cast("ssize_t") public static long H5DSget_label(@Cast("hid_t") long did, @Cast("unsigned int") int idx, @Cast("char*") BytePointer label, @Cast("size_t") long size)
-------------------------------------------------------------------------- \ingroup H5DS \brief Read the label for dimension \p idx of \p did into buffer \p label.- Parameters:
did- [in] The datasetidx- [in] The dimensionlabel- [out] The labelsize- [in] The length of the label buffer- Returns:
- Upon success, size of label or zero if no label found. Negative if fail. \details Returns the value of the #DIMENSION_LABELS for dimension \p idx of dataset \p did, if set. Up to \p size characters of the name are copied into the buffer \p label. If the label is longer than \p size, it will be truncated to fit. The parameter \p size is set to the size of the returned \p label. If \p did has no label, the return value of \p label is NULL. Fails if: - Bad arguments
-
H5DSget_label
@Cast("ssize_t") public static long H5DSget_label(@Cast("hid_t") long did, @Cast("unsigned int") int idx, @Cast("char*") ByteBuffer label, @Cast("size_t") long size)
-
H5DSget_label
@Cast("ssize_t") public static long H5DSget_label(@Cast("hid_t") long did, @Cast("unsigned int") int idx, @Cast("char*") byte[] label, @Cast("size_t") long size)
-
H5DSget_scale_name
@Cast("ssize_t") public static long H5DSget_scale_name(@Cast("hid_t") long did, @Cast("char*") BytePointer name, @Cast("size_t") long size)
-------------------------------------------------------------------------- \ingroup H5DS \brief Retrieves name of scale \p did into buffer \p name.- Parameters:
did- [in] Dimension scale identifiername- [out] Buffer to contain the returned namesize- [in] Size in bytes, of the \p name buffer- Returns:
- Upon success, the length of the scale name or zero if no name found. Negative if fail. \details H5DSget_scale_name() retrieves the name attribute for scale \p did. Up to \p size characters of the scale name are returned in \p name; additional characters, if any, are not returned to the user application. If the length of the name, which determines the required value of \p size, is unknown, a preliminary H5DSget_scale_name() call can be made by setting \p name to NULL. The return value of this call will be the size of the scale name; that value plus one (1) can then be assigned to \p size for a second H5DSget_scale_name() call, which will retrieve the actual name. (The value passed in with the parameter \p size must be one greater than size in bytes of the actual name in order to accommodate the null terminator; if \p size is set to the exact size of the name, the last byte passed back will contain the null terminator and the last character will be missing from the name passed back to the calling application.)
-
H5DSget_scale_name
@Cast("ssize_t") public static long H5DSget_scale_name(@Cast("hid_t") long did, @Cast("char*") ByteBuffer name, @Cast("size_t") long size)
-
H5DSget_scale_name
@Cast("ssize_t") public static long H5DSget_scale_name(@Cast("hid_t") long did, @Cast("char*") byte[] name, @Cast("size_t") long size)
-
H5DSis_scale
@Cast("htri_t") public static int H5DSis_scale(@Cast("hid_t") long did)
-------------------------------------------------------------------------- \ingroup H5DS \brief Determines whether \p did is a Dimension Scale.- Parameters:
did- [in] The dataset to query- Returns:
- \htri_t \details H5DSis_scale() determines if \p did is a Dimension Scale, i.e., has class="DIMENSION_SCALE").
-
H5DSiterate_scales
@Cast("herr_t") public static int H5DSiterate_scales(@Cast("hid_t") long did, @Cast("unsigned int") int dim, IntPointer idx, H5DS_iterate_t visitor, Pointer visitor_data)
-------------------------------------------------------------------------- \ingroup H5DS \brief Iterates the operation visitor through the scales attached to dimension \p dim.- Parameters:
did- [in] The datasetdim- [in] The dimension of dataset \p dididx- [in,out] Input the index to start iterating, output the next index to visit. If NULL, start at the first position.visitor- [in] The visitor functionvisitor_data- [in] Arbitrary data to pass to the visitor function- Returns:
- Returns the return value of the last operator if it was non-zero, or zero if all scales were processed. \details H5DSiterate_scales() iterates over the scales attached to dimension \p dim of dataset \p did. For each scale in the list, the \p visitor_data and some additional information, specified below, are passed to the \p visitor function. The iteration begins with the \p idx object in the group and the next element to be processed by the operator is returned in \p idx. If \p idx is NULL, then the iterator starts at the first group member; since no stopping point is returned in this case, the iterator cannot be restarted if one of the calls to its operator returns non-zero. The prototype for \ref H5DS_iterate_t is: \snippet this H5DS_iterate_t_snip The operation receives the Dimension Scale dataset identifier, \p scale, and the pointer to the operator data passed in to H5DSiterate_scales(), \p visitor_data. The return values from an operator are: - Zero causes the iterator to continue, returning zero when all group members have been processed. - Positive causes the iterator to immediately return that positive value, indicating short-circuit success. The iterator can be restarted at the next group member. - Negative causes the iterator to immediately return that value, indicating failure. The iterator can be restarted at the next group member. H5DSiterate_scales() assumes that the scales of the dimension identified by \p dim remain unchanged through the iteration. If the membership changes during the iteration, the function's behavior is undefined.
-
H5DSiterate_scales
@Cast("herr_t") public static int H5DSiterate_scales(@Cast("hid_t") long did, @Cast("unsigned int") int dim, IntBuffer idx, H5DS_iterate_t visitor, Pointer visitor_data)
-
H5DSiterate_scales
@Cast("herr_t") public static int H5DSiterate_scales(@Cast("hid_t") long did, @Cast("unsigned int") int dim, int[] idx, H5DS_iterate_t visitor, Pointer visitor_data)
-
H5DSis_attached
@Cast("htri_t") public static int H5DSis_attached(@Cast("hid_t") long did, @Cast("hid_t") long dsid, @Cast("unsigned int") int idx)
-------------------------------------------------------------------------- \ingroup H5DS \brief Report if dimension scale \p dsid is currently attached to dimension \p idx of dataset \p did.- Parameters:
did- [in] The datasetdsid- [in] The scale to be attachedidx- [in] The dimension of \p did that \p dsid is associated with- Returns:
- \htri_t \details Report if dimension scale \p dsid is currently attached to dimension \p idx of dataset \p did. Fails if: - Bad arguments - If \p dsid is not a Dimension Scale - The \p dsid is not a Dimension Scale - If \p did is a Dimension Scale (A Dimension Scale cannot have scales.)
-
H5LTmake_dataset
@Cast("herr_t") public static int H5LTmake_dataset(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer dset_name, int rank, @Cast("const hsize_t*") LongPointer dims, @Cast("hid_t") long type_id, @Const Pointer buffer)
------------------------------------------------------------------------- \ingroup H5LT \brief Creates and writes a dataset of a type \p type_id. \fg_loc_id- Parameters:
dset_name- [in] The Name of the dataset to createrank- [in] Number of dimensions of dataspacedims- [in] An array of the size of each dimensiontype_id- [in] Identifier of the datatype to use when creating the datasetbuffer- [in] Buffer with data to be written to the dataset- Returns:
- \herr_t \details H5LTmake_dataset() creates and writes a dataset named \p dset_name attached to the object specified by the identifier \p loc_id. The parameter \p type_id can be any valid HDF5 Prdefined \ref PDTNAT; For example, setting \p type_id to #H5T_NATIVE_INT will result in a dataset of signed \e integer datatype.
-
H5LTmake_dataset
@Cast("herr_t") public static int H5LTmake_dataset(@Cast("hid_t") long loc_id, String dset_name, int rank, @Cast("const hsize_t*") LongBuffer dims, @Cast("hid_t") long type_id, @Const Pointer buffer)
-
H5LTmake_dataset
@Cast("herr_t") public static int H5LTmake_dataset(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer dset_name, int rank, @Cast("const hsize_t*") long[] dims, @Cast("hid_t") long type_id, @Const Pointer buffer)
-
H5LTmake_dataset
@Cast("herr_t") public static int H5LTmake_dataset(@Cast("hid_t") long loc_id, String dset_name, int rank, @Cast("const hsize_t*") LongPointer dims, @Cast("hid_t") long type_id, @Const Pointer buffer)
-
H5LTmake_dataset
@Cast("herr_t") public static int H5LTmake_dataset(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer dset_name, int rank, @Cast("const hsize_t*") LongBuffer dims, @Cast("hid_t") long type_id, @Const Pointer buffer)
-
H5LTmake_dataset
@Cast("herr_t") public static int H5LTmake_dataset(@Cast("hid_t") long loc_id, String dset_name, int rank, @Cast("const hsize_t*") long[] dims, @Cast("hid_t") long type_id, @Const Pointer buffer)
-
H5LTmake_dataset_char
@Cast("herr_t") public static int H5LTmake_dataset_char(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer dset_name, int rank, @Cast("const hsize_t*") LongPointer dims, @Cast("const char*") BytePointer buffer)
------------------------------------------------------------------------- \ingroup H5LT \brief Creates and writes a dataset. \fg_loc_id- Parameters:
dset_name- [in] The Name of the dataset to createrank- [in] Number of dimensions of dataspacedims- [in] An array of the size of each dimensionbuffer- [in] Buffer with data to be written to the dataset- Returns:
- \herr_t \details H5LTmake_dataset_char() creates and writes a dataset named \p dset_name attached to the object specified by the identifier \p loc_id. The datasetâs datatype will be \e character, #H5T_NATIVE_CHAR.
-
H5LTmake_dataset_char
@Cast("herr_t") public static int H5LTmake_dataset_char(@Cast("hid_t") long loc_id, String dset_name, int rank, @Cast("const hsize_t*") LongBuffer dims, String buffer)
-
H5LTmake_dataset_char
@Cast("herr_t") public static int H5LTmake_dataset_char(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer dset_name, int rank, @Cast("const hsize_t*") long[] dims, @Cast("const char*") BytePointer buffer)
-
H5LTmake_dataset_char
@Cast("herr_t") public static int H5LTmake_dataset_char(@Cast("hid_t") long loc_id, String dset_name, int rank, @Cast("const hsize_t*") LongPointer dims, String buffer)
-
H5LTmake_dataset_char
@Cast("herr_t") public static int H5LTmake_dataset_char(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer dset_name, int rank, @Cast("const hsize_t*") LongBuffer dims, @Cast("const char*") BytePointer buffer)
-
H5LTmake_dataset_char
@Cast("herr_t") public static int H5LTmake_dataset_char(@Cast("hid_t") long loc_id, String dset_name, int rank, @Cast("const hsize_t*") long[] dims, String buffer)
-
H5LTmake_dataset_short
@Cast("herr_t") public static int H5LTmake_dataset_short(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer dset_name, int rank, @Cast("const hsize_t*") LongPointer dims, @Const ShortPointer buffer)
------------------------------------------------------------------------- \ingroup H5LT \brief Creates and writes a dataset. \fg_loc_id- Parameters:
dset_name- [in] The Name of the dataset to createrank- [in] Number of dimensions of dataspacedims- [in] An array of the size of each dimensionbuffer- [in] Buffer with data to be written to the dataset- Returns:
- \herr_t \details H5LTmake_dataset_short() creates and writes a dataset named \p dset_name attached to the object specified by the identifier \p loc_id. The datasetâs datatype will be short signed integer, #H5T_NATIVE_SHORT.
-
H5LTmake_dataset_short
@Cast("herr_t") public static int H5LTmake_dataset_short(@Cast("hid_t") long loc_id, String dset_name, int rank, @Cast("const hsize_t*") LongBuffer dims, @Const ShortBuffer buffer)
-
H5LTmake_dataset_short
@Cast("herr_t") public static int H5LTmake_dataset_short(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer dset_name, int rank, @Cast("const hsize_t*") long[] dims, @Const short[] buffer)
-
H5LTmake_dataset_short
@Cast("herr_t") public static int H5LTmake_dataset_short(@Cast("hid_t") long loc_id, String dset_name, int rank, @Cast("const hsize_t*") LongPointer dims, @Const ShortPointer buffer)
-
H5LTmake_dataset_short
@Cast("herr_t") public static int H5LTmake_dataset_short(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer dset_name, int rank, @Cast("const hsize_t*") LongBuffer dims, @Const ShortBuffer buffer)
-
H5LTmake_dataset_short
@Cast("herr_t") public static int H5LTmake_dataset_short(@Cast("hid_t") long loc_id, String dset_name, int rank, @Cast("const hsize_t*") long[] dims, @Const short[] buffer)
-
H5LTmake_dataset_int
@Cast("herr_t") public static int H5LTmake_dataset_int(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer dset_name, int rank, @Cast("const hsize_t*") LongPointer dims, @Const IntPointer buffer)
------------------------------------------------------------------------- \ingroup H5LT \brief Creates and writes a dataset. \fg_loc_id- Parameters:
dset_name- [in] The Name of the dataset to createrank- [in] Number of dimensions of dataspacedims- [in] An array of the size of each dimensionbuffer- [in] Buffer with data to be written to the dataset- Returns:
- \herr_t \details H5LTmake_dataset_int() creates and writes a dataset named \p dset_name attached to the object specified by the identifier \p loc_id. The datasetâs datatype will be native signed integer, #H5T_NATIVE_INT.
-
H5LTmake_dataset_int
@Cast("herr_t") public static int H5LTmake_dataset_int(@Cast("hid_t") long loc_id, String dset_name, int rank, @Cast("const hsize_t*") LongBuffer dims, @Const IntBuffer buffer)
-
H5LTmake_dataset_int
@Cast("herr_t") public static int H5LTmake_dataset_int(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer dset_name, int rank, @Cast("const hsize_t*") long[] dims, @Const int[] buffer)
-
H5LTmake_dataset_int
@Cast("herr_t") public static int H5LTmake_dataset_int(@Cast("hid_t") long loc_id, String dset_name, int rank, @Cast("const hsize_t*") LongPointer dims, @Const IntPointer buffer)
-
H5LTmake_dataset_int
@Cast("herr_t") public static int H5LTmake_dataset_int(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer dset_name, int rank, @Cast("const hsize_t*") LongBuffer dims, @Const IntBuffer buffer)
-
H5LTmake_dataset_int
@Cast("herr_t") public static int H5LTmake_dataset_int(@Cast("hid_t") long loc_id, String dset_name, int rank, @Cast("const hsize_t*") long[] dims, @Const int[] buffer)
-
H5LTmake_dataset_long
@Cast("herr_t") public static int H5LTmake_dataset_long(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer dset_name, int rank, @Cast("const hsize_t*") LongPointer dims, @Const CLongPointer buffer)
------------------------------------------------------------------------- \ingroup H5LT \brief Creates and writes a dataset. \fg_loc_id- Parameters:
dset_name- [in] The Name of the dataset to createrank- [in] Number of dimensions of dataspacedims- [in] An array of the size of each dimensionbuffer- [in] Buffer with data to be written to the dataset- Returns:
- \herr_t \details H5LTmake_dataset_long() creates and writes a dataset named \p dset_name attached to the object specified by the identifier \p loc_id. The datasetâs datatype will be long signed integer, #H5T_NATIVE_LONG.
-
H5LTmake_dataset_long
@Cast("herr_t") public static int H5LTmake_dataset_long(@Cast("hid_t") long loc_id, String dset_name, int rank, @Cast("const hsize_t*") LongBuffer dims, @Const CLongPointer buffer)
-
H5LTmake_dataset_long
@Cast("herr_t") public static int H5LTmake_dataset_long(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer dset_name, int rank, @Cast("const hsize_t*") long[] dims, @Const CLongPointer buffer)
-
H5LTmake_dataset_long
@Cast("herr_t") public static int H5LTmake_dataset_long(@Cast("hid_t") long loc_id, String dset_name, int rank, @Cast("const hsize_t*") LongPointer dims, @Const CLongPointer buffer)
-
H5LTmake_dataset_long
@Cast("herr_t") public static int H5LTmake_dataset_long(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer dset_name, int rank, @Cast("const hsize_t*") LongBuffer dims, @Const CLongPointer buffer)
-
H5LTmake_dataset_long
@Cast("herr_t") public static int H5LTmake_dataset_long(@Cast("hid_t") long loc_id, String dset_name, int rank, @Cast("const hsize_t*") long[] dims, @Const CLongPointer buffer)
-
H5LTmake_dataset_float
@Cast("herr_t") public static int H5LTmake_dataset_float(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer dset_name, int rank, @Cast("const hsize_t*") LongPointer dims, @Const FloatPointer buffer)
------------------------------------------------------------------------- \ingroup H5LT \brief Creates and writes a dataset. \fg_loc_id- Parameters:
dset_name- [in] The Name of the dataset to createrank- [in] Number of dimensions of dataspacedims- [in] An array of the size of each dimensionbuffer- [in] Buffer with data to be written to the dataset- Returns:
- \herr_t \details H5LTmake_dataset_float() creates and writes a dataset named \p dset_name attached to the object specified by the identifier \p loc_id. The datasetâs datatype will be native floating point, #H5T_NATIVE_FLOAT.
-
H5LTmake_dataset_float
@Cast("herr_t") public static int H5LTmake_dataset_float(@Cast("hid_t") long loc_id, String dset_name, int rank, @Cast("const hsize_t*") LongBuffer dims, @Const FloatBuffer buffer)
-
H5LTmake_dataset_float
@Cast("herr_t") public static int H5LTmake_dataset_float(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer dset_name, int rank, @Cast("const hsize_t*") long[] dims, @Const float[] buffer)
-
H5LTmake_dataset_float
@Cast("herr_t") public static int H5LTmake_dataset_float(@Cast("hid_t") long loc_id, String dset_name, int rank, @Cast("const hsize_t*") LongPointer dims, @Const FloatPointer buffer)
-
H5LTmake_dataset_float
@Cast("herr_t") public static int H5LTmake_dataset_float(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer dset_name, int rank, @Cast("const hsize_t*") LongBuffer dims, @Const FloatBuffer buffer)
-
H5LTmake_dataset_float
@Cast("herr_t") public static int H5LTmake_dataset_float(@Cast("hid_t") long loc_id, String dset_name, int rank, @Cast("const hsize_t*") long[] dims, @Const float[] buffer)
-
H5LTmake_dataset_double
@Cast("herr_t") public static int H5LTmake_dataset_double(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer dset_name, int rank, @Cast("const hsize_t*") LongPointer dims, @Const DoublePointer buffer)
------------------------------------------------------------------------- \ingroup H5LT \brief Creates and writes a dataset. \fg_loc_id- Parameters:
dset_name- [in] The Name of the dataset to createrank- [in] Number of dimensions of dataspacedims- [in] An array of the size of each dimensionbuffer- [in] Buffer with data to be written to the dataset- Returns:
- \herr_t \details H5LTmake_dataset_double() creates and writes a dataset named \p dset_name attached to the object specified by the identifier \p loc_id. The datasetâs datatype will be native floating-point double, #H5T_NATIVE_DOUBLE.
-
H5LTmake_dataset_double
@Cast("herr_t") public static int H5LTmake_dataset_double(@Cast("hid_t") long loc_id, String dset_name, int rank, @Cast("const hsize_t*") LongBuffer dims, @Const DoubleBuffer buffer)
-
H5LTmake_dataset_double
@Cast("herr_t") public static int H5LTmake_dataset_double(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer dset_name, int rank, @Cast("const hsize_t*") long[] dims, @Const double[] buffer)
-
H5LTmake_dataset_double
@Cast("herr_t") public static int H5LTmake_dataset_double(@Cast("hid_t") long loc_id, String dset_name, int rank, @Cast("const hsize_t*") LongPointer dims, @Const DoublePointer buffer)
-
H5LTmake_dataset_double
@Cast("herr_t") public static int H5LTmake_dataset_double(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer dset_name, int rank, @Cast("const hsize_t*") LongBuffer dims, @Const DoubleBuffer buffer)
-
H5LTmake_dataset_double
@Cast("herr_t") public static int H5LTmake_dataset_double(@Cast("hid_t") long loc_id, String dset_name, int rank, @Cast("const hsize_t*") long[] dims, @Const double[] buffer)
-
H5LTmake_dataset_string
@Cast("herr_t") public static int H5LTmake_dataset_string(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer dset_name, @Cast("const char*") BytePointer buf)
------------------------------------------------------------------------- \ingroup H5LT \brief Creates and writes a dataset with string datatype. \fg_loc_id- Parameters:
dset_name- [in] The name of the dataset to createbuf- [in] Buffer with data to be written to the dataset- Returns:
- \herr_t \details H5LTmake_dataset_string() creates and writes a dataset named \p dset_name attached to the object specified by the identifier \p loc_id. The datasetâs datatype will be C string, #H5T_C_S1.
-
H5LTmake_dataset_string
@Cast("herr_t") public static int H5LTmake_dataset_string(@Cast("hid_t") long loc_id, String dset_name, String buf)
-
H5LTread_dataset
@Cast("herr_t") public static int H5LTread_dataset(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer dset_name, @Cast("hid_t") long type_id, Pointer buffer)
------------------------------------------------------------------------- \ingroup H5LT \brief Reads a dataset from disk. \fg_loc_id- Parameters:
dset_name- [in] The name of the dataset to readtype_id- [in] Identifier of the datatype to use when reading the datasetbuffer- [out] Buffer with data- Returns:
- \herr_t \details H5LTread_dataset() reads a dataset named \p dset_name attached to the object specified by the identifier \p loc_id.
-
H5LTread_dataset
@Cast("herr_t") public static int H5LTread_dataset(@Cast("hid_t") long loc_id, String dset_name, @Cast("hid_t") long type_id, Pointer buffer)
-
H5LTread_dataset_char
@Cast("herr_t") public static int H5LTread_dataset_char(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer dset_name, @Cast("char*") BytePointer buffer)
------------------------------------------------------------------------- \ingroup H5LT \brief Reads a dataset from disk. \fg_loc_id- Parameters:
dset_name- [in] The name of the dataset to readbuffer- [out] Buffer with data- Returns:
- \herr_t \details H5LTread_dataset_char() reads a dataset named \p dset_name attached to the object specified by the identifier \p loc_id. The HDF5 datatype is #H5T_NATIVE_CHAR.
-
H5LTread_dataset_char
@Cast("herr_t") public static int H5LTread_dataset_char(@Cast("hid_t") long loc_id, String dset_name, @Cast("char*") ByteBuffer buffer)
-
H5LTread_dataset_char
@Cast("herr_t") public static int H5LTread_dataset_char(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer dset_name, @Cast("char*") byte[] buffer)
-
H5LTread_dataset_char
@Cast("herr_t") public static int H5LTread_dataset_char(@Cast("hid_t") long loc_id, String dset_name, @Cast("char*") BytePointer buffer)
-
H5LTread_dataset_char
@Cast("herr_t") public static int H5LTread_dataset_char(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer dset_name, @Cast("char*") ByteBuffer buffer)
-
H5LTread_dataset_char
@Cast("herr_t") public static int H5LTread_dataset_char(@Cast("hid_t") long loc_id, String dset_name, @Cast("char*") byte[] buffer)
-
H5LTread_dataset_short
@Cast("herr_t") public static int H5LTread_dataset_short(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer dset_name, ShortPointer buffer)
------------------------------------------------------------------------- \ingroup H5LT \brief Reads a dataset from disk. \fg_loc_id- Parameters:
dset_name- [in] The name of the dataset to readbuffer- [out] Buffer with data- Returns:
- \herr_t \details H5LTread_dataset_short() reads a dataset named \p dset_name attached to the object specified by the identifier \p loc_id. The HDF5 datatype is #H5T_NATIVE_SHORT.
-
H5LTread_dataset_short
@Cast("herr_t") public static int H5LTread_dataset_short(@Cast("hid_t") long loc_id, String dset_name, ShortBuffer buffer)
-
H5LTread_dataset_short
@Cast("herr_t") public static int H5LTread_dataset_short(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer dset_name, short[] buffer)
-
H5LTread_dataset_short
@Cast("herr_t") public static int H5LTread_dataset_short(@Cast("hid_t") long loc_id, String dset_name, ShortPointer buffer)
-
H5LTread_dataset_short
@Cast("herr_t") public static int H5LTread_dataset_short(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer dset_name, ShortBuffer buffer)
-
H5LTread_dataset_short
@Cast("herr_t") public static int H5LTread_dataset_short(@Cast("hid_t") long loc_id, String dset_name, short[] buffer)
-
H5LTread_dataset_int
@Cast("herr_t") public static int H5LTread_dataset_int(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer dset_name, IntPointer buffer)
------------------------------------------------------------------------- \ingroup H5LT \brief Reads a dataset from disk. \fg_loc_id- Parameters:
dset_name- [in] The name of the dataset to readbuffer- [out] Buffer with data- Returns:
- \herr_t \details H5LTread_dataset_int() reads a dataset named \p dset_name attached to the object specified by the identifier \p loc_id. The HDF5 datatype is #H5T_NATIVE_INT.
-
H5LTread_dataset_int
@Cast("herr_t") public static int H5LTread_dataset_int(@Cast("hid_t") long loc_id, String dset_name, IntBuffer buffer)
-
H5LTread_dataset_int
@Cast("herr_t") public static int H5LTread_dataset_int(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer dset_name, int[] buffer)
-
H5LTread_dataset_int
@Cast("herr_t") public static int H5LTread_dataset_int(@Cast("hid_t") long loc_id, String dset_name, IntPointer buffer)
-
H5LTread_dataset_int
@Cast("herr_t") public static int H5LTread_dataset_int(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer dset_name, IntBuffer buffer)
-
H5LTread_dataset_int
@Cast("herr_t") public static int H5LTread_dataset_int(@Cast("hid_t") long loc_id, String dset_name, int[] buffer)
-
H5LTread_dataset_long
@Cast("herr_t") public static int H5LTread_dataset_long(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer dset_name, CLongPointer buffer)
------------------------------------------------------------------------- \ingroup H5LT \brief Reads a dataset from disk. \fg_loc_id- Parameters:
dset_name- [in] The name of the dataset to readbuffer- [out] Buffer with data- Returns:
- \herr_t \details H5LTread_dataset_long() reads a dataset named \p dset_name attached to the object specified by the identifier \p loc_id. The HDF5 datatype is #H5T_NATIVE_LONG.
-
H5LTread_dataset_long
@Cast("herr_t") public static int H5LTread_dataset_long(@Cast("hid_t") long loc_id, String dset_name, CLongPointer buffer)
-
H5LTread_dataset_float
@Cast("herr_t") public static int H5LTread_dataset_float(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer dset_name, FloatPointer buffer)
------------------------------------------------------------------------- \ingroup H5LT \brief Reads a dataset from disk. \fg_loc_id- Parameters:
dset_name- [in] The name of the dataset to readbuffer- [out] Buffer with data- Returns:
- \herr_t \details H5LTread_dataset_float() reads a dataset named \p dset_name attached to the object specified by the identifier \p loc_id. The HDF5 datatype is #H5T_NATIVE_FLOAT.
-
H5LTread_dataset_float
@Cast("herr_t") public static int H5LTread_dataset_float(@Cast("hid_t") long loc_id, String dset_name, FloatBuffer buffer)
-
H5LTread_dataset_float
@Cast("herr_t") public static int H5LTread_dataset_float(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer dset_name, float[] buffer)
-
H5LTread_dataset_float
@Cast("herr_t") public static int H5LTread_dataset_float(@Cast("hid_t") long loc_id, String dset_name, FloatPointer buffer)
-
H5LTread_dataset_float
@Cast("herr_t") public static int H5LTread_dataset_float(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer dset_name, FloatBuffer buffer)
-
H5LTread_dataset_float
@Cast("herr_t") public static int H5LTread_dataset_float(@Cast("hid_t") long loc_id, String dset_name, float[] buffer)
-
H5LTread_dataset_double
@Cast("herr_t") public static int H5LTread_dataset_double(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer dset_name, DoublePointer buffer)
------------------------------------------------------------------------- \ingroup H5LT \brief Reads a dataset from disk. \fg_loc_id- Parameters:
dset_name- [in] The name of the dataset to readbuffer- [out] Buffer with data- Returns:
- \herr_t \details H5LTread_dataset_double() reads a dataset named \p dset_name attached to the object specified by the identifier \p loc_id. The HDF5 datatype is #H5T_NATIVE_DOUBLE.
-
H5LTread_dataset_double
@Cast("herr_t") public static int H5LTread_dataset_double(@Cast("hid_t") long loc_id, String dset_name, DoubleBuffer buffer)
-
H5LTread_dataset_double
@Cast("herr_t") public static int H5LTread_dataset_double(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer dset_name, double[] buffer)
-
H5LTread_dataset_double
@Cast("herr_t") public static int H5LTread_dataset_double(@Cast("hid_t") long loc_id, String dset_name, DoublePointer buffer)
-
H5LTread_dataset_double
@Cast("herr_t") public static int H5LTread_dataset_double(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer dset_name, DoubleBuffer buffer)
-
H5LTread_dataset_double
@Cast("herr_t") public static int H5LTread_dataset_double(@Cast("hid_t") long loc_id, String dset_name, double[] buffer)
-
H5LTread_dataset_string
@Cast("herr_t") public static int H5LTread_dataset_string(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer dset_name, @Cast("char*") BytePointer buf)
------------------------------------------------------------------------- \ingroup H5LT \brief Reads a dataset from disk. \fg_loc_id- Parameters:
dset_name- [in] The name of the dataset to readbuf- [out] Buffer with data- Returns:
- \herr_t \details H5LTread_dataset_string() reads a dataset named \p dset_name attached to the object specified by the identifier \p loc_id. The HDF5 datatype is #H5T_C_S1.
-
H5LTread_dataset_string
@Cast("herr_t") public static int H5LTread_dataset_string(@Cast("hid_t") long loc_id, String dset_name, @Cast("char*") ByteBuffer buf)
-
H5LTread_dataset_string
@Cast("herr_t") public static int H5LTread_dataset_string(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer dset_name, @Cast("char*") byte[] buf)
-
H5LTread_dataset_string
@Cast("herr_t") public static int H5LTread_dataset_string(@Cast("hid_t") long loc_id, String dset_name, @Cast("char*") BytePointer buf)
-
H5LTread_dataset_string
@Cast("herr_t") public static int H5LTread_dataset_string(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer dset_name, @Cast("char*") ByteBuffer buf)
-
H5LTread_dataset_string
@Cast("herr_t") public static int H5LTread_dataset_string(@Cast("hid_t") long loc_id, String dset_name, @Cast("char*") byte[] buf)
-
H5LTget_dataset_ndims
@Cast("herr_t") public static int H5LTget_dataset_ndims(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer dset_name, IntPointer rank)
------------------------------------------------------------------------- \ingroup H5LT \brief Gets the dimensionality of a dataset- Parameters:
loc_id- [in] Identifier of the object to locate the dataset withindset_name- [in] The dataset namerank- [out] The dimensionality of the dataset- Returns:
- \herr_t \details H5LTget_dataset_ndims() gets the dimensionality of a dataset named \p dset_name exists attached to the object \p loc_id.
-
H5LTget_dataset_ndims
@Cast("herr_t") public static int H5LTget_dataset_ndims(@Cast("hid_t") long loc_id, String dset_name, IntBuffer rank)
-
H5LTget_dataset_ndims
@Cast("herr_t") public static int H5LTget_dataset_ndims(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer dset_name, int[] rank)
-
H5LTget_dataset_ndims
@Cast("herr_t") public static int H5LTget_dataset_ndims(@Cast("hid_t") long loc_id, String dset_name, IntPointer rank)
-
H5LTget_dataset_ndims
@Cast("herr_t") public static int H5LTget_dataset_ndims(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer dset_name, IntBuffer rank)
-
H5LTget_dataset_ndims
@Cast("herr_t") public static int H5LTget_dataset_ndims(@Cast("hid_t") long loc_id, String dset_name, int[] rank)
-
H5LTget_dataset_info
@Cast("herr_t") public static int H5LTget_dataset_info(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer dset_name, @Cast("hsize_t*") LongPointer dims, @Cast("H5T_class_t*") IntPointer type_class, @Cast("size_t*") SizeTPointer type_size)
------------------------------------------------------------------------- \ingroup H5LT \brief Retrieves information about a dataset- Parameters:
loc_id- [in] Identifier of the object to locate the dataset withindset_name- [in] The dataset namedims- [out] The dimensions of the datasettype_class- [out] The class identifier. #H5T_class_t is defined in H5Tpublic.h. See H5Tget_class() for a list of class types.type_size- [out] The size of the datatype in bytes- Returns:
- \herr_t \details H5LTget_dataset_info() retrieves information about a dataset named \p dset_name attached to the object \p loc_id.
-
H5LTget_dataset_info
@Cast("herr_t") public static int H5LTget_dataset_info(@Cast("hid_t") long loc_id, String dset_name, @Cast("hsize_t*") LongBuffer dims, @Cast("H5T_class_t*") IntBuffer type_class, @Cast("size_t*") SizeTPointer type_size)
-
H5LTget_dataset_info
@Cast("herr_t") public static int H5LTget_dataset_info(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer dset_name, @Cast("hsize_t*") long[] dims, @Cast("H5T_class_t*") int[] type_class, @Cast("size_t*") SizeTPointer type_size)
-
H5LTget_dataset_info
@Cast("herr_t") public static int H5LTget_dataset_info(@Cast("hid_t") long loc_id, String dset_name, @Cast("hsize_t*") LongPointer dims, @Cast("H5T_class_t*") IntPointer type_class, @Cast("size_t*") SizeTPointer type_size)
-
H5LTget_dataset_info
@Cast("herr_t") public static int H5LTget_dataset_info(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer dset_name, @Cast("hsize_t*") LongBuffer dims, @Cast("H5T_class_t*") IntBuffer type_class, @Cast("size_t*") SizeTPointer type_size)
-
H5LTget_dataset_info
@Cast("herr_t") public static int H5LTget_dataset_info(@Cast("hid_t") long loc_id, String dset_name, @Cast("hsize_t*") long[] dims, @Cast("H5T_class_t*") int[] type_class, @Cast("size_t*") SizeTPointer type_size)
-
H5LTfind_dataset
@Cast("herr_t") public static int H5LTfind_dataset(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer name)
------------------------------------------------------------------------- \ingroup H5LT \brief Determines whether a dataset exists.- Parameters:
loc_id- [in] Identifier of the group containing the datasetname- [in] Dataset name- Returns:
- \htri_t \details H5LTfind_dataset() determines whether a dataset named \p name exists in the group specified by \p loc_id. \p loc_id must be a group identifier and \p name must specify a dataset that is a member of that group.
-
H5LTfind_dataset
@Cast("herr_t") public static int H5LTfind_dataset(@Cast("hid_t") long loc_id, String name)
-
H5LTset_attribute_string
@Cast("herr_t") public static int H5LTset_attribute_string(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer obj_name, @Cast("const char*") BytePointer attr_name, @Cast("const char*") BytePointer attr_data)
------------------------------------------------------------------------- \ingroup H5LT \brief Creates and writes a string attribute.- Parameters:
loc_id- [in] Identifier of the object (dataset or group) to create the attribute withinobj_name- [in] The name of the object to attach the attributeattr_name- [in] The attribute nameattr_data- [in] Buffer with data to be written to the attribute- Returns:
- \herr_t \details H5LTset_attribute_string() creates and writes a string attribute named \p attr_name and attaches it to the object specified by the name \p obj_name. If the attribute already exists, it is overwritten.
-
H5LTset_attribute_string
@Cast("herr_t") public static int H5LTset_attribute_string(@Cast("hid_t") long loc_id, String obj_name, String attr_name, String attr_data)
-
H5LTset_attribute_char
@Cast("herr_t") public static int H5LTset_attribute_char(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer obj_name, @Cast("const char*") BytePointer attr_name, @Cast("const char*") BytePointer buffer, @Cast("size_t") long size)
------------------------------------------------------------------------- \ingroup H5LT \brief Creates and writes an attribute.- Parameters:
loc_id- [in] Identifier of the object (dataset or group) to create the attribute withinobj_name- [in] The name of the object to attach the attributeattr_name- [in] The attribute namebuffer- [in] Buffer with data to be written to the attributesize- [in] The size of the 1D array (one in the case of a scalar attribute). This value is used by H5Screate_simple() to create the dataspace.- Returns:
- \herr_t \details H5LTset_attribute_char() creates and writes a numerical attribute named \p attr_name and attaches it to the object specified by the name \p obj_name. The attribute has a dimensionality of 1. The HDF5 datatype of the attribute is #H5T_NATIVE_CHAR.
-
H5LTset_attribute_char
@Cast("herr_t") public static int H5LTset_attribute_char(@Cast("hid_t") long loc_id, String obj_name, String attr_name, String buffer, @Cast("size_t") long size)
-
H5LTset_attribute_uchar
@Cast("herr_t") public static int H5LTset_attribute_uchar(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer obj_name, @Cast("const char*") BytePointer attr_name, @Cast("const unsigned char*") BytePointer buffer, @Cast("size_t") long size)
------------------------------------------------------------------------- \ingroup H5LT \brief Creates and writes an attribute.- Parameters:
loc_id- [in] Identifier of the object (dataset or group) to create the attribute withinobj_name- [in] The name of the object to attach the attributeattr_name- [in] The attribute namebuffer- [in] Buffer with data to be written to the attributesize- [in] The size of the 1D array (one in the case of a scalar attribute). This value is used by H5Screate_simple() to create the dataspace.- Returns:
- \herr_t \details H5LTset_attribute_uchar() creates and writes a numerical attribute named \p attr_name and attaches it to the object specified by the name \p obj_name. The attribute has a dimensionality of 1. The HDF5 datatype of the attribute is #H5T_NATIVE_UCHAR.
-
H5LTset_attribute_uchar
@Cast("herr_t") public static int H5LTset_attribute_uchar(@Cast("hid_t") long loc_id, String obj_name, String attr_name, @Cast("const unsigned char*") ByteBuffer buffer, @Cast("size_t") long size)
-
H5LTset_attribute_uchar
@Cast("herr_t") public static int H5LTset_attribute_uchar(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer obj_name, @Cast("const char*") BytePointer attr_name, @Cast("const unsigned char*") byte[] buffer, @Cast("size_t") long size)
-
H5LTset_attribute_uchar
@Cast("herr_t") public static int H5LTset_attribute_uchar(@Cast("hid_t") long loc_id, String obj_name, String attr_name, @Cast("const unsigned char*") BytePointer buffer, @Cast("size_t") long size)
-
H5LTset_attribute_uchar
@Cast("herr_t") public static int H5LTset_attribute_uchar(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer obj_name, @Cast("const char*") BytePointer attr_name, @Cast("const unsigned char*") ByteBuffer buffer, @Cast("size_t") long size)
-
H5LTset_attribute_uchar
@Cast("herr_t") public static int H5LTset_attribute_uchar(@Cast("hid_t") long loc_id, String obj_name, String attr_name, @Cast("const unsigned char*") byte[] buffer, @Cast("size_t") long size)
-
H5LTset_attribute_short
@Cast("herr_t") public static int H5LTset_attribute_short(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer obj_name, @Cast("const char*") BytePointer attr_name, @Const ShortPointer buffer, @Cast("size_t") long size)
------------------------------------------------------------------------- \ingroup H5LT \brief Creates and writes an attribute.- Parameters:
loc_id- [in] Identifier of the object (dataset or group) to create the attribute withinobj_name- [in] The name of the object to attach the attributeattr_name- [in] The attribute namebuffer- [in] Buffer with data to be written to the attributesize- [in] The size of the 1D array (one in the case of a scalar attribute). This value is used by H5Screate_simple() to create the dataspace.- Returns:
- \herr_t \details H5LTset_attribute_short() creates and writes a numerical attribute named \p attr_name and attaches it to the object specified by the name \p obj_name. The attribute has a dimensionality of 1. The HDF5 datatype of the attribute is #H5T_NATIVE_SHORT.
-
H5LTset_attribute_short
@Cast("herr_t") public static int H5LTset_attribute_short(@Cast("hid_t") long loc_id, String obj_name, String attr_name, @Const ShortBuffer buffer, @Cast("size_t") long size)
-
H5LTset_attribute_short
@Cast("herr_t") public static int H5LTset_attribute_short(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer obj_name, @Cast("const char*") BytePointer attr_name, @Const short[] buffer, @Cast("size_t") long size)
-
H5LTset_attribute_short
@Cast("herr_t") public static int H5LTset_attribute_short(@Cast("hid_t") long loc_id, String obj_name, String attr_name, @Const ShortPointer buffer, @Cast("size_t") long size)
-
H5LTset_attribute_short
@Cast("herr_t") public static int H5LTset_attribute_short(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer obj_name, @Cast("const char*") BytePointer attr_name, @Const ShortBuffer buffer, @Cast("size_t") long size)
-
H5LTset_attribute_short
@Cast("herr_t") public static int H5LTset_attribute_short(@Cast("hid_t") long loc_id, String obj_name, String attr_name, @Const short[] buffer, @Cast("size_t") long size)
-
H5LTset_attribute_ushort
@Cast("herr_t") public static int H5LTset_attribute_ushort(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer obj_name, @Cast("const char*") BytePointer attr_name, @Cast("const unsigned short*") ShortPointer buffer, @Cast("size_t") long size)
------------------------------------------------------------------------- \ingroup H5LT \brief Creates and writes an attribute.- Parameters:
loc_id- [in] Identifier of the object (dataset or group) to create the attribute withinobj_name- [in] The name of the object to attach the attributeattr_name- [in] The attribute namebuffer- [in] Buffer with data to be written to the attributesize- [in] The size of the 1D array (one in the case of a scalar attribute). This value is used by H5Screate_simple() to create the dataspace.- Returns:
- \herr_t \details H5LTset_attribute_ushort() creates and writes a numerical attribute named \p attr_name and attaches it to the object specified by the name \p obj_name. The attribute has a dimensionality of 1. The HDF5 datatype of the attribute is #H5T_NATIVE_USHORT.
-
H5LTset_attribute_ushort
@Cast("herr_t") public static int H5LTset_attribute_ushort(@Cast("hid_t") long loc_id, String obj_name, String attr_name, @Cast("const unsigned short*") ShortBuffer buffer, @Cast("size_t") long size)
-
H5LTset_attribute_ushort
@Cast("herr_t") public static int H5LTset_attribute_ushort(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer obj_name, @Cast("const char*") BytePointer attr_name, @Cast("const unsigned short*") short[] buffer, @Cast("size_t") long size)
-
H5LTset_attribute_ushort
@Cast("herr_t") public static int H5LTset_attribute_ushort(@Cast("hid_t") long loc_id, String obj_name, String attr_name, @Cast("const unsigned short*") ShortPointer buffer, @Cast("size_t") long size)
-
H5LTset_attribute_ushort
@Cast("herr_t") public static int H5LTset_attribute_ushort(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer obj_name, @Cast("const char*") BytePointer attr_name, @Cast("const unsigned short*") ShortBuffer buffer, @Cast("size_t") long size)
-
H5LTset_attribute_ushort
@Cast("herr_t") public static int H5LTset_attribute_ushort(@Cast("hid_t") long loc_id, String obj_name, String attr_name, @Cast("const unsigned short*") short[] buffer, @Cast("size_t") long size)
-
H5LTset_attribute_int
@Cast("herr_t") public static int H5LTset_attribute_int(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer obj_name, @Cast("const char*") BytePointer attr_name, @Const IntPointer buffer, @Cast("size_t") long size)
------------------------------------------------------------------------- \ingroup H5LT \brief Creates and writes an attribute.- Parameters:
loc_id- [in] Identifier of the object (dataset or group) to create the attribute withinobj_name- [in] The name of the object to attach the attributeattr_name- [in] The attribute namebuffer- [in] Buffer with data to be written to the attributesize- [in] The size of the 1D array (one in the case of a scalar attribute). This value is used by H5Screate_simple() to create the dataspace.- Returns:
- \herr_t \details H5LTset_attribute_int() creates and writes a numerical integer attribute named \p attr_name and attaches it to the object specified by the name \p obj_name. The attribute has a dimensionality of 1. The HDF5 datatype of the attribute is #H5T_NATIVE_INT.
-
H5LTset_attribute_int
@Cast("herr_t") public static int H5LTset_attribute_int(@Cast("hid_t") long loc_id, String obj_name, String attr_name, @Const IntBuffer buffer, @Cast("size_t") long size)
-
H5LTset_attribute_int
@Cast("herr_t") public static int H5LTset_attribute_int(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer obj_name, @Cast("const char*") BytePointer attr_name, @Const int[] buffer, @Cast("size_t") long size)
-
H5LTset_attribute_int
@Cast("herr_t") public static int H5LTset_attribute_int(@Cast("hid_t") long loc_id, String obj_name, String attr_name, @Const IntPointer buffer, @Cast("size_t") long size)
-
H5LTset_attribute_int
@Cast("herr_t") public static int H5LTset_attribute_int(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer obj_name, @Cast("const char*") BytePointer attr_name, @Const IntBuffer buffer, @Cast("size_t") long size)
-
H5LTset_attribute_int
@Cast("herr_t") public static int H5LTset_attribute_int(@Cast("hid_t") long loc_id, String obj_name, String attr_name, @Const int[] buffer, @Cast("size_t") long size)
-
H5LTset_attribute_uint
@Cast("herr_t") public static int H5LTset_attribute_uint(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer obj_name, @Cast("const char*") BytePointer attr_name, @Cast("const unsigned int*") IntPointer buffer, @Cast("size_t") long size)
------------------------------------------------------------------------- \ingroup H5LT \brief Creates and writes an attribute.- Parameters:
loc_id- [in] Identifier of the object (dataset or group) to create the attribute withinobj_name- [in] The name of the object to attach the attributeattr_name- [in] The attribute namebuffer- [in] Buffer with data to be written to the attributesize- [in] The size of the 1D array (one in the case of a scalar attribute). This value is used by H5Screate_simple() to create the dataspace.- Returns:
- \herr_t \details H5LTset_attribute_uint() creates and writes a numerical integer attribute named \p attr_name and attaches it to the object specified by the name \p obj_name. The attribute has a dimensionality of 1. The HDF5 datatype of the attribute is #H5T_NATIVE_UINT.
-
H5LTset_attribute_uint
@Cast("herr_t") public static int H5LTset_attribute_uint(@Cast("hid_t") long loc_id, String obj_name, String attr_name, @Cast("const unsigned int*") IntBuffer buffer, @Cast("size_t") long size)
-
H5LTset_attribute_uint
@Cast("herr_t") public static int H5LTset_attribute_uint(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer obj_name, @Cast("const char*") BytePointer attr_name, @Cast("const unsigned int*") int[] buffer, @Cast("size_t") long size)
-
H5LTset_attribute_uint
@Cast("herr_t") public static int H5LTset_attribute_uint(@Cast("hid_t") long loc_id, String obj_name, String attr_name, @Cast("const unsigned int*") IntPointer buffer, @Cast("size_t") long size)
-
H5LTset_attribute_uint
@Cast("herr_t") public static int H5LTset_attribute_uint(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer obj_name, @Cast("const char*") BytePointer attr_name, @Cast("const unsigned int*") IntBuffer buffer, @Cast("size_t") long size)
-
H5LTset_attribute_uint
@Cast("herr_t") public static int H5LTset_attribute_uint(@Cast("hid_t") long loc_id, String obj_name, String attr_name, @Cast("const unsigned int*") int[] buffer, @Cast("size_t") long size)
-
H5LTset_attribute_long
@Cast("herr_t") public static int H5LTset_attribute_long(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer obj_name, @Cast("const char*") BytePointer attr_name, @Const CLongPointer buffer, @Cast("size_t") long size)
------------------------------------------------------------------------- \ingroup H5LT \brief Creates and writes an attribute.- Parameters:
loc_id- [in] Identifier of the object (dataset or group) to create the attribute withinobj_name- [in] The name of the object to attach the attributeattr_name- [in] The attribute namebuffer- [in] Buffer with data to be written to the attributesize- [in] The size of the 1D array (one in the case of a scalar attribute). This value is used by H5Screate_simple() to create the dataspace.- Returns:
- \herr_t \details H5LTset_attribute_long() creates and writes a numerical attribute named \p attr_name and attaches it to the object specified by the name \p obj_name. The attribute has a dimensionality of 1. The HDF5 datatype of the attribute is #H5T_NATIVE_LONG.
-
H5LTset_attribute_long
@Cast("herr_t") public static int H5LTset_attribute_long(@Cast("hid_t") long loc_id, String obj_name, String attr_name, @Const CLongPointer buffer, @Cast("size_t") long size)
-
H5LTset_attribute_long_long
@Cast("herr_t") public static int H5LTset_attribute_long_long(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer obj_name, @Cast("const char*") BytePointer attr_name, @Const LongPointer buffer, @Cast("size_t") long size)
------------------------------------------------------------------------- \ingroup H5LT \brief Creates and writes an attribute.- Parameters:
loc_id- [in] Location of the object to which the attribute is to be attachedobj_name- [in] That object's nameattr_name- [in] Attribute namebuffer- [in] Attribute valuesize- [in] Attribute size- Returns:
- \herr_t \details H5LTset_attribute_long_long() creates and writes a numerical attribute named \p attr_name and attaches it to the object specified by the name \p obj_name. The attribute has a dimensionality of 1 and its HDF5 datatype is #H5T_NATIVE_LLONG.
-
H5LTset_attribute_long_long
@Cast("herr_t") public static int H5LTset_attribute_long_long(@Cast("hid_t") long loc_id, String obj_name, String attr_name, @Const LongBuffer buffer, @Cast("size_t") long size)
-
H5LTset_attribute_long_long
@Cast("herr_t") public static int H5LTset_attribute_long_long(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer obj_name, @Cast("const char*") BytePointer attr_name, @Const long[] buffer, @Cast("size_t") long size)
-
H5LTset_attribute_long_long
@Cast("herr_t") public static int H5LTset_attribute_long_long(@Cast("hid_t") long loc_id, String obj_name, String attr_name, @Const LongPointer buffer, @Cast("size_t") long size)
-
H5LTset_attribute_long_long
@Cast("herr_t") public static int H5LTset_attribute_long_long(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer obj_name, @Cast("const char*") BytePointer attr_name, @Const LongBuffer buffer, @Cast("size_t") long size)
-
H5LTset_attribute_long_long
@Cast("herr_t") public static int H5LTset_attribute_long_long(@Cast("hid_t") long loc_id, String obj_name, String attr_name, @Const long[] buffer, @Cast("size_t") long size)
-
H5LTset_attribute_ulong
@Cast("herr_t") public static int H5LTset_attribute_ulong(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer obj_name, @Cast("const char*") BytePointer attr_name, @Cast("const unsigned long*") CLongPointer buffer, @Cast("size_t") long size)
------------------------------------------------------------------------- \ingroup H5LT \brief Creates and writes an attribute.- Parameters:
loc_id- [in] Identifier of the object (dataset or group) to create the attribute withinobj_name- [in] The name of the object to attach the attributeattr_name- [in] The attribute namebuffer- [in] Buffer with data to be written to the attributesize- [in] The size of the 1D array (one in the case of a scalar attribute). This value is used by H5Screate_simple() to create the dataspace.- Returns:
- \herr_t \details H5LTset_attribute_ulong() creates and writes a numerical attribute named \p attr_name and attaches it to the object specified by the name \p obj_name. The attribute has a dimensionality of 1. The HDF5 datatype of the attribute is #H5T_NATIVE_ULONG.
-
H5LTset_attribute_ulong
@Cast("herr_t") public static int H5LTset_attribute_ulong(@Cast("hid_t") long loc_id, String obj_name, String attr_name, @Cast("const unsigned long*") CLongPointer buffer, @Cast("size_t") long size)
-
H5LTset_attribute_ullong
@Cast("herr_t") public static int H5LTset_attribute_ullong(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer obj_name, @Cast("const char*") BytePointer attr_name, @Cast("const unsigned long long*") LongPointer buffer, @Cast("size_t") long size)
------------------------------------------------------------------------- \ingroup H5LT \brief Creates and writes an attribute.- Parameters:
loc_id- [in] Location of the object to which the attribute is to be attachedobj_name- [in] That object's nameattr_name- [in] Attribute namebuffer- [in] Attribute valuesize- [in] Attribute size- Returns:
- \herr_t \details H5LTset_attribute_ullong() creates and writes a numerical attribute named \p attr_name and attaches it to the object specified by the name \p obj_name. The attribute has a dimensionality of 1 and its HDF5 datatype is #H5T_NATIVE_ULLONG.
-
H5LTset_attribute_ullong
@Cast("herr_t") public static int H5LTset_attribute_ullong(@Cast("hid_t") long loc_id, String obj_name, String attr_name, @Cast("const unsigned long long*") LongBuffer buffer, @Cast("size_t") long size)
-
H5LTset_attribute_ullong
@Cast("herr_t") public static int H5LTset_attribute_ullong(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer obj_name, @Cast("const char*") BytePointer attr_name, @Cast("const unsigned long long*") long[] buffer, @Cast("size_t") long size)
-
H5LTset_attribute_ullong
@Cast("herr_t") public static int H5LTset_attribute_ullong(@Cast("hid_t") long loc_id, String obj_name, String attr_name, @Cast("const unsigned long long*") LongPointer buffer, @Cast("size_t") long size)
-
H5LTset_attribute_ullong
@Cast("herr_t") public static int H5LTset_attribute_ullong(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer obj_name, @Cast("const char*") BytePointer attr_name, @Cast("const unsigned long long*") LongBuffer buffer, @Cast("size_t") long size)
-
H5LTset_attribute_ullong
@Cast("herr_t") public static int H5LTset_attribute_ullong(@Cast("hid_t") long loc_id, String obj_name, String attr_name, @Cast("const unsigned long long*") long[] buffer, @Cast("size_t") long size)
-
H5LTset_attribute_float
@Cast("herr_t") public static int H5LTset_attribute_float(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer obj_name, @Cast("const char*") BytePointer attr_name, @Const FloatPointer buffer, @Cast("size_t") long size)
------------------------------------------------------------------------- \ingroup H5LT \brief Creates and writes an attribute.- Parameters:
loc_id- [in] Identifier of the object (dataset or group) to create the attribute withinobj_name- [in] The name of the object to attach the attributeattr_name- [in] The attribute namebuffer- [in] Buffer with data to be written to the attributesize- [in] The size of the 1D array (one in the case of a scalar attribute). This value is used by H5Screate_simple() to create the dataspace.- Returns:
- \herr_t \details H5LTset_attribute_float() creates and writes a numerical floating point attribute named \p attr_name and attaches it to the object specified by the name \p obj_name. The attribute has a dimensionality of 1. The HDF5 datatype of the attribute is #H5T_NATIVE_FLOAT.
-
H5LTset_attribute_float
@Cast("herr_t") public static int H5LTset_attribute_float(@Cast("hid_t") long loc_id, String obj_name, String attr_name, @Const FloatBuffer buffer, @Cast("size_t") long size)
-
H5LTset_attribute_float
@Cast("herr_t") public static int H5LTset_attribute_float(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer obj_name, @Cast("const char*") BytePointer attr_name, @Const float[] buffer, @Cast("size_t") long size)
-
H5LTset_attribute_float
@Cast("herr_t") public static int H5LTset_attribute_float(@Cast("hid_t") long loc_id, String obj_name, String attr_name, @Const FloatPointer buffer, @Cast("size_t") long size)
-
H5LTset_attribute_float
@Cast("herr_t") public static int H5LTset_attribute_float(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer obj_name, @Cast("const char*") BytePointer attr_name, @Const FloatBuffer buffer, @Cast("size_t") long size)
-
H5LTset_attribute_float
@Cast("herr_t") public static int H5LTset_attribute_float(@Cast("hid_t") long loc_id, String obj_name, String attr_name, @Const float[] buffer, @Cast("size_t") long size)
-
H5LTset_attribute_double
@Cast("herr_t") public static int H5LTset_attribute_double(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer obj_name, @Cast("const char*") BytePointer attr_name, @Const DoublePointer buffer, @Cast("size_t") long size)
------------------------------------------------------------------------- \ingroup H5LT \brief Creates and writes an attribute.- Parameters:
loc_id- [in] Identifier of the object (dataset or group) to create the attribute withinobj_name- [in] The name of the object to attach the attributeattr_name- [in] The attribute namebuffer- [in] Buffer with data to be written to the attributesize- [in] The size of the 1D array (one in the case of a scalar attribute). This value is used by H5Screate_simple() to create the dataspace.- Returns:
- \herr_t \details H5LTset_attribute_double() creates and writes a numerical attribute named \p attr_name and attaches it to the object specified by the name \p obj_name. The attribute has a dimensionality of 1. The HDF5 datatype of the attribute is #H5T_NATIVE_DOUBLE.
-
H5LTset_attribute_double
@Cast("herr_t") public static int H5LTset_attribute_double(@Cast("hid_t") long loc_id, String obj_name, String attr_name, @Const DoubleBuffer buffer, @Cast("size_t") long size)
-
H5LTset_attribute_double
@Cast("herr_t") public static int H5LTset_attribute_double(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer obj_name, @Cast("const char*") BytePointer attr_name, @Const double[] buffer, @Cast("size_t") long size)
-
H5LTset_attribute_double
@Cast("herr_t") public static int H5LTset_attribute_double(@Cast("hid_t") long loc_id, String obj_name, String attr_name, @Const DoublePointer buffer, @Cast("size_t") long size)
-
H5LTset_attribute_double
@Cast("herr_t") public static int H5LTset_attribute_double(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer obj_name, @Cast("const char*") BytePointer attr_name, @Const DoubleBuffer buffer, @Cast("size_t") long size)
-
H5LTset_attribute_double
@Cast("herr_t") public static int H5LTset_attribute_double(@Cast("hid_t") long loc_id, String obj_name, String attr_name, @Const double[] buffer, @Cast("size_t") long size)
-
H5LTget_attribute
@Cast("herr_t") public static int H5LTget_attribute(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer obj_name, @Cast("const char*") BytePointer attr_name, @Cast("hid_t") long mem_type_id, Pointer data)
------------------------------------------------------------------------- \ingroup H5LT \brief Reads an attribute from disk.- Parameters:
loc_id- [in] Identifier of the object (dataset or group) to read the attribute fromobj_name- [in] The name of the object that the attribute is attached toattr_name- [in] The attribute namemem_type_id- [in] Identifier of the memory datatypedata- [out] Buffer with data- Returns:
- \herr_t \details H5LTget_attribute() reads an attribute named \p attr_name with the memory type \p mem_type_id.
-
H5LTget_attribute
@Cast("herr_t") public static int H5LTget_attribute(@Cast("hid_t") long loc_id, String obj_name, String attr_name, @Cast("hid_t") long mem_type_id, Pointer data)
-
H5LTget_attribute_string
@Cast("herr_t") public static int H5LTget_attribute_string(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer obj_name, @Cast("const char*") BytePointer attr_name, @Cast("char*") BytePointer data)
------------------------------------------------------------------------- \ingroup H5LT \brief Reads an attribute from disk.- Parameters:
loc_id- [in] Identifier of the object (dataset or group) to read the attribute fromobj_name- [in] The name of the object that the attribute is attached toattr_name- [in] The attribute namedata- [out] Buffer with data- Returns:
- \herr_t \details H5LTget_attribute_string() reads an attribute named \p attr_name that is attached to the object specified by the name \p obj_name. The datatype is a string.
-
H5LTget_attribute_string
@Cast("herr_t") public static int H5LTget_attribute_string(@Cast("hid_t") long loc_id, String obj_name, String attr_name, @Cast("char*") ByteBuffer data)
-
H5LTget_attribute_string
@Cast("herr_t") public static int H5LTget_attribute_string(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer obj_name, @Cast("const char*") BytePointer attr_name, @Cast("char*") byte[] data)
-
H5LTget_attribute_string
@Cast("herr_t") public static int H5LTget_attribute_string(@Cast("hid_t") long loc_id, String obj_name, String attr_name, @Cast("char*") BytePointer data)
-
H5LTget_attribute_string
@Cast("herr_t") public static int H5LTget_attribute_string(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer obj_name, @Cast("const char*") BytePointer attr_name, @Cast("char*") ByteBuffer data)
-
H5LTget_attribute_string
@Cast("herr_t") public static int H5LTget_attribute_string(@Cast("hid_t") long loc_id, String obj_name, String attr_name, @Cast("char*") byte[] data)
-
H5LTget_attribute_char
@Cast("herr_t") public static int H5LTget_attribute_char(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer obj_name, @Cast("const char*") BytePointer attr_name, @Cast("char*") BytePointer data)
------------------------------------------------------------------------- \ingroup H5LT \brief Reads an attribute from disk.- Parameters:
loc_id- [in] Identifier of the object (dataset or group) to read the attribute fromobj_name- [in] The name of the object that the attribute is attached toattr_name- [in] The attribute namedata- [out] Buffer with data- Returns:
- \herr_t \details H5LTget_attribute_char() reads an attribute named \p attr_name that is attached to the object specified by the name \p obj_name. The datatype of the attribute is #H5T_NATIVE_CHAR.
-
H5LTget_attribute_char
@Cast("herr_t") public static int H5LTget_attribute_char(@Cast("hid_t") long loc_id, String obj_name, String attr_name, @Cast("char*") ByteBuffer data)
-
H5LTget_attribute_char
@Cast("herr_t") public static int H5LTget_attribute_char(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer obj_name, @Cast("const char*") BytePointer attr_name, @Cast("char*") byte[] data)
-
H5LTget_attribute_char
@Cast("herr_t") public static int H5LTget_attribute_char(@Cast("hid_t") long loc_id, String obj_name, String attr_name, @Cast("char*") BytePointer data)
-
H5LTget_attribute_char
@Cast("herr_t") public static int H5LTget_attribute_char(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer obj_name, @Cast("const char*") BytePointer attr_name, @Cast("char*") ByteBuffer data)
-
H5LTget_attribute_char
@Cast("herr_t") public static int H5LTget_attribute_char(@Cast("hid_t") long loc_id, String obj_name, String attr_name, @Cast("char*") byte[] data)
-
H5LTget_attribute_uchar
@Cast("herr_t") public static int H5LTget_attribute_uchar(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer obj_name, @Cast("const char*") BytePointer attr_name, @Cast("unsigned char*") BytePointer data)
------------------------------------------------------------------------- \ingroup H5LT \brief Reads an attribute from disk.- Parameters:
loc_id- [in] Identifier of the object (dataset or group) to read the attribute fromobj_name- [in] The name of the object that the attribute is attached toattr_name- [in] The attribute namedata- [out] Buffer with data- Returns:
- \herr_t \details H5LTget_attribute_uchar() reads an attribute named \p attr_name that is attached to the object specified by the name \p obj_name. The HDF5 datatype of the attribute is #H5T_NATIVE_UCHAR
-
H5LTget_attribute_uchar
@Cast("herr_t") public static int H5LTget_attribute_uchar(@Cast("hid_t") long loc_id, String obj_name, String attr_name, @Cast("unsigned char*") ByteBuffer data)
-
H5LTget_attribute_uchar
@Cast("herr_t") public static int H5LTget_attribute_uchar(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer obj_name, @Cast("const char*") BytePointer attr_name, @Cast("unsigned char*") byte[] data)
-
H5LTget_attribute_uchar
@Cast("herr_t") public static int H5LTget_attribute_uchar(@Cast("hid_t") long loc_id, String obj_name, String attr_name, @Cast("unsigned char*") BytePointer data)
-
H5LTget_attribute_uchar
@Cast("herr_t") public static int H5LTget_attribute_uchar(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer obj_name, @Cast("const char*") BytePointer attr_name, @Cast("unsigned char*") ByteBuffer data)
-
H5LTget_attribute_uchar
@Cast("herr_t") public static int H5LTget_attribute_uchar(@Cast("hid_t") long loc_id, String obj_name, String attr_name, @Cast("unsigned char*") byte[] data)
-
H5LTget_attribute_short
@Cast("herr_t") public static int H5LTget_attribute_short(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer obj_name, @Cast("const char*") BytePointer attr_name, ShortPointer data)
------------------------------------------------------------------------- \ingroup H5LT \brief Reads an attribute from disk.- Parameters:
loc_id- [in] Identifier of the object (dataset or group) to read the attribute fromobj_name- [in] The name of the object that the attribute is attached toattr_name- [in] The attribute namedata- [out] Buffer with data- Returns:
- \herr_t \details H5LTget_attribute_short() reads an attribute named \p attr_name that is attached to the object specified by the name \p obj_name. The HDF5 datatype of the attribute is #H5T_NATIVE_SHORT
-
H5LTget_attribute_short
@Cast("herr_t") public static int H5LTget_attribute_short(@Cast("hid_t") long loc_id, String obj_name, String attr_name, ShortBuffer data)
-
H5LTget_attribute_short
@Cast("herr_t") public static int H5LTget_attribute_short(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer obj_name, @Cast("const char*") BytePointer attr_name, short[] data)
-
H5LTget_attribute_short
@Cast("herr_t") public static int H5LTget_attribute_short(@Cast("hid_t") long loc_id, String obj_name, String attr_name, ShortPointer data)
-
H5LTget_attribute_short
@Cast("herr_t") public static int H5LTget_attribute_short(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer obj_name, @Cast("const char*") BytePointer attr_name, ShortBuffer data)
-
H5LTget_attribute_short
@Cast("herr_t") public static int H5LTget_attribute_short(@Cast("hid_t") long loc_id, String obj_name, String attr_name, short[] data)
-
H5LTget_attribute_ushort
@Cast("herr_t") public static int H5LTget_attribute_ushort(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer obj_name, @Cast("const char*") BytePointer attr_name, @Cast("unsigned short*") ShortPointer data)
------------------------------------------------------------------------- \ingroup H5LT \brief Reads an attribute from disk.- Parameters:
loc_id- [in] Identifier of the object (dataset or group) to read the attribute fromobj_name- [in] The name of the object that the attribute is attached toattr_name- [in] The attribute namedata- [out] Buffer with data- Returns:
- \herr_t \details H5LTget_attribute_ushort() reads an attribute named \p attr_name that is attached to the object specified by the name \p obj_name. The HDF5 datatype of the attribute is #H5T_NATIVE_USHORT.
-
H5LTget_attribute_ushort
@Cast("herr_t") public static int H5LTget_attribute_ushort(@Cast("hid_t") long loc_id, String obj_name, String attr_name, @Cast("unsigned short*") ShortBuffer data)
-
H5LTget_attribute_ushort
@Cast("herr_t") public static int H5LTget_attribute_ushort(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer obj_name, @Cast("const char*") BytePointer attr_name, @Cast("unsigned short*") short[] data)
-
H5LTget_attribute_ushort
@Cast("herr_t") public static int H5LTget_attribute_ushort(@Cast("hid_t") long loc_id, String obj_name, String attr_name, @Cast("unsigned short*") ShortPointer data)
-
H5LTget_attribute_ushort
@Cast("herr_t") public static int H5LTget_attribute_ushort(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer obj_name, @Cast("const char*") BytePointer attr_name, @Cast("unsigned short*") ShortBuffer data)
-
H5LTget_attribute_ushort
@Cast("herr_t") public static int H5LTget_attribute_ushort(@Cast("hid_t") long loc_id, String obj_name, String attr_name, @Cast("unsigned short*") short[] data)
-
H5LTget_attribute_int
@Cast("herr_t") public static int H5LTget_attribute_int(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer obj_name, @Cast("const char*") BytePointer attr_name, IntPointer data)
------------------------------------------------------------------------- \ingroup H5LT \brief Reads an attribute from disk.- Parameters:
loc_id- [in] Identifier of the object (dataset or group) to read the attribute fromobj_name- [in] The name of the object that the attribute is attached toattr_name- [in] The attribute namedata- [out] Buffer with data- Returns:
- \herr_t \details H5LTget_attribute_int() reads an attribute named \p attr_name that is attached to the object specified by the name \p obj_name. The HDF5 datatype of the attribute is #H5T_NATIVE_INT.
-
H5LTget_attribute_int
@Cast("herr_t") public static int H5LTget_attribute_int(@Cast("hid_t") long loc_id, String obj_name, String attr_name, IntBuffer data)
-
H5LTget_attribute_int
@Cast("herr_t") public static int H5LTget_attribute_int(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer obj_name, @Cast("const char*") BytePointer attr_name, int[] data)
-
H5LTget_attribute_int
@Cast("herr_t") public static int H5LTget_attribute_int(@Cast("hid_t") long loc_id, String obj_name, String attr_name, IntPointer data)
-
H5LTget_attribute_int
@Cast("herr_t") public static int H5LTget_attribute_int(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer obj_name, @Cast("const char*") BytePointer attr_name, IntBuffer data)
-
H5LTget_attribute_int
@Cast("herr_t") public static int H5LTget_attribute_int(@Cast("hid_t") long loc_id, String obj_name, String attr_name, int[] data)
-
H5LTget_attribute_uint
@Cast("herr_t") public static int H5LTget_attribute_uint(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer obj_name, @Cast("const char*") BytePointer attr_name, @Cast("unsigned int*") IntPointer data)
------------------------------------------------------------------------- \ingroup H5LT \brief Reads an attribute from disk.- Parameters:
loc_id- [in] Identifier of the object (dataset or group) to read the attribute fromobj_name- [in] The name of the object that the attribute is attached toattr_name- [in] The attribute namedata- [out] Buffer with data- Returns:
- \herr_t \details H5LTget_attribute_uint() reads an attribute named \p attr_name that is attached to the object specified by the name \p obj_name. The HDF5 datatype of the attribute is #H5T_NATIVE_INT.
-
H5LTget_attribute_uint
@Cast("herr_t") public static int H5LTget_attribute_uint(@Cast("hid_t") long loc_id, String obj_name, String attr_name, @Cast("unsigned int*") IntBuffer data)
-
H5LTget_attribute_uint
@Cast("herr_t") public static int H5LTget_attribute_uint(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer obj_name, @Cast("const char*") BytePointer attr_name, @Cast("unsigned int*") int[] data)
-
H5LTget_attribute_uint
@Cast("herr_t") public static int H5LTget_attribute_uint(@Cast("hid_t") long loc_id, String obj_name, String attr_name, @Cast("unsigned int*") IntPointer data)
-
H5LTget_attribute_uint
@Cast("herr_t") public static int H5LTget_attribute_uint(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer obj_name, @Cast("const char*") BytePointer attr_name, @Cast("unsigned int*") IntBuffer data)
-
H5LTget_attribute_uint
@Cast("herr_t") public static int H5LTget_attribute_uint(@Cast("hid_t") long loc_id, String obj_name, String attr_name, @Cast("unsigned int*") int[] data)
-
H5LTget_attribute_long
@Cast("herr_t") public static int H5LTget_attribute_long(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer obj_name, @Cast("const char*") BytePointer attr_name, CLongPointer data)
------------------------------------------------------------------------- \ingroup H5LT \brief Reads an attribute from disk.- Parameters:
loc_id- [in] Identifier of the object (dataset or group) to read the attribute fromobj_name- [in] The name of the object that the attribute is attached toattr_name- [in] The attribute namedata- [out] Buffer with data- Returns:
- \herr_t \details H5LTget_attribute_long() reads an attribute named \p attr_name that is attached to the object specified by the name \p obj_name. The HDF5 datatype of the attribute is #H5T_NATIVE_LONG.
-
H5LTget_attribute_long
@Cast("herr_t") public static int H5LTget_attribute_long(@Cast("hid_t") long loc_id, String obj_name, String attr_name, CLongPointer data)
-
H5LTget_attribute_long_long
@Cast("herr_t") public static int H5LTget_attribute_long_long(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer obj_name, @Cast("const char*") BytePointer attr_name, LongPointer data)
------------------------------------------------------------------------- \ingroup H5LT \brief Reads a \e long \e long attribute.- Parameters:
loc_id- [in] Location of the object to which the attribute is attachedobj_name- [in] That object's nameattr_name- [in] Attribute namedata- [out] Attribute value- Returns:
- \herr_t \details H5LTget_attribute_long_long() reads the attribute specified by \p loc_id and \p obj_name.
-
H5LTget_attribute_long_long
@Cast("herr_t") public static int H5LTget_attribute_long_long(@Cast("hid_t") long loc_id, String obj_name, String attr_name, LongBuffer data)
-
H5LTget_attribute_long_long
@Cast("herr_t") public static int H5LTget_attribute_long_long(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer obj_name, @Cast("const char*") BytePointer attr_name, long[] data)
-
H5LTget_attribute_long_long
@Cast("herr_t") public static int H5LTget_attribute_long_long(@Cast("hid_t") long loc_id, String obj_name, String attr_name, LongPointer data)
-
H5LTget_attribute_long_long
@Cast("herr_t") public static int H5LTget_attribute_long_long(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer obj_name, @Cast("const char*") BytePointer attr_name, LongBuffer data)
-
H5LTget_attribute_long_long
@Cast("herr_t") public static int H5LTget_attribute_long_long(@Cast("hid_t") long loc_id, String obj_name, String attr_name, long[] data)
-
H5LTget_attribute_ulong
@Cast("herr_t") public static int H5LTget_attribute_ulong(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer obj_name, @Cast("const char*") BytePointer attr_name, @Cast("unsigned long*") CLongPointer data)
------------------------------------------------------------------------- \ingroup H5LT \brief Reads an attribute from disk.- Parameters:
loc_id- [in] Identifier of the object (dataset or group) to read the attribute fromobj_name- [in] The name of the object that the attribute is attached toattr_name- [in] The attribute namedata- [out] Buffer with data- Returns:
- \herr_t \details H5LTget_attribute_ulong() reads an attribute named \p attr_name that is attached to the object specified by the name \p obj_name. The HDF5 datatype of the attribute is #H5T_NATIVE_ULONG.
-
H5LTget_attribute_ulong
@Cast("herr_t") public static int H5LTget_attribute_ulong(@Cast("hid_t") long loc_id, String obj_name, String attr_name, @Cast("unsigned long*") CLongPointer data)
-
H5LTget_attribute_ullong
@Cast("herr_t") public static int H5LTget_attribute_ullong(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer obj_name, @Cast("const char*") BytePointer attr_name, @Cast("unsigned long long*") LongPointer data)
------------------------------------------------------------------------- \ingroup H5LT \brief Reads an attribute from disk.- Parameters:
loc_id- [in] Identifier of the object (dataset or group) to read the attribute fromobj_name- [in] The name of the object that the attribute is attached toattr_name- [in] The attribute namedata- [out] Buffer with data- Returns:
- \herr_t \details H5LTget_attribute_ullong() reads an attribute named \p attr_name that is attached to the object specified by the name \p obj_name. The HDF5 datatype of the attribute is #H5T_NATIVE_ULLONG.
-
H5LTget_attribute_ullong
@Cast("herr_t") public static int H5LTget_attribute_ullong(@Cast("hid_t") long loc_id, String obj_name, String attr_name, @Cast("unsigned long long*") LongBuffer data)
-
H5LTget_attribute_ullong
@Cast("herr_t") public static int H5LTget_attribute_ullong(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer obj_name, @Cast("const char*") BytePointer attr_name, @Cast("unsigned long long*") long[] data)
-
H5LTget_attribute_ullong
@Cast("herr_t") public static int H5LTget_attribute_ullong(@Cast("hid_t") long loc_id, String obj_name, String attr_name, @Cast("unsigned long long*") LongPointer data)
-
H5LTget_attribute_ullong
@Cast("herr_t") public static int H5LTget_attribute_ullong(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer obj_name, @Cast("const char*") BytePointer attr_name, @Cast("unsigned long long*") LongBuffer data)
-
H5LTget_attribute_ullong
@Cast("herr_t") public static int H5LTget_attribute_ullong(@Cast("hid_t") long loc_id, String obj_name, String attr_name, @Cast("unsigned long long*") long[] data)
-
H5LTget_attribute_float
@Cast("herr_t") public static int H5LTget_attribute_float(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer obj_name, @Cast("const char*") BytePointer attr_name, FloatPointer data)
------------------------------------------------------------------------- \ingroup H5LT \brief Reads an attribute from disk.- Parameters:
loc_id- [in] Identifier of the object (dataset or group) to read the attribute fromobj_name- [in] The name of the object that the attribute is attached toattr_name- [in] The attribute namedata- [out] Buffer with data- Returns:
- \herr_t \details H5LTget_attribute_float() reads an attribute named \p attr_name that is attached to the object specified by the name \p obj_name. The HDF5 datatype of the attribute is #H5T_NATIVE_FLOAT.
-
H5LTget_attribute_float
@Cast("herr_t") public static int H5LTget_attribute_float(@Cast("hid_t") long loc_id, String obj_name, String attr_name, FloatBuffer data)
-
H5LTget_attribute_float
@Cast("herr_t") public static int H5LTget_attribute_float(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer obj_name, @Cast("const char*") BytePointer attr_name, float[] data)
-
H5LTget_attribute_float
@Cast("herr_t") public static int H5LTget_attribute_float(@Cast("hid_t") long loc_id, String obj_name, String attr_name, FloatPointer data)
-
H5LTget_attribute_float
@Cast("herr_t") public static int H5LTget_attribute_float(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer obj_name, @Cast("const char*") BytePointer attr_name, FloatBuffer data)
-
H5LTget_attribute_float
@Cast("herr_t") public static int H5LTget_attribute_float(@Cast("hid_t") long loc_id, String obj_name, String attr_name, float[] data)
-
H5LTget_attribute_double
@Cast("herr_t") public static int H5LTget_attribute_double(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer obj_name, @Cast("const char*") BytePointer attr_name, DoublePointer data)
------------------------------------------------------------------------- \ingroup H5LT \brief Reads an attribute from disk.- Parameters:
loc_id- [in] Identifier of the object (dataset or group) to read the attribute fromobj_name- [in] The name of the object that the attribute is attached toattr_name- [in] The attribute namedata- [out] Buffer with data- Returns:
- \herr_t \details H5LTget_attribute_double() reads an attribute named \p attr_name that is attached to the object specified by the name \p obj_name. The HDF5 datatype of the attribute is #H5T_NATIVE_DOUBLE.
-
H5LTget_attribute_double
@Cast("herr_t") public static int H5LTget_attribute_double(@Cast("hid_t") long loc_id, String obj_name, String attr_name, DoubleBuffer data)
-
H5LTget_attribute_double
@Cast("herr_t") public static int H5LTget_attribute_double(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer obj_name, @Cast("const char*") BytePointer attr_name, double[] data)
-
H5LTget_attribute_double
@Cast("herr_t") public static int H5LTget_attribute_double(@Cast("hid_t") long loc_id, String obj_name, String attr_name, DoublePointer data)
-
H5LTget_attribute_double
@Cast("herr_t") public static int H5LTget_attribute_double(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer obj_name, @Cast("const char*") BytePointer attr_name, DoubleBuffer data)
-
H5LTget_attribute_double
@Cast("herr_t") public static int H5LTget_attribute_double(@Cast("hid_t") long loc_id, String obj_name, String attr_name, double[] data)
-
H5LTget_attribute_ndims
@Cast("herr_t") public static int H5LTget_attribute_ndims(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer obj_name, @Cast("const char*") BytePointer attr_name, IntPointer rank)
------------------------------------------------------------------------- \ingroup H5LT \brief Gets the dimensionality of an attribute.- Parameters:
loc_id- [in] Identifier of the object (dataset or group) to read the attribute fromobj_name- [in] The name of the object that the attribute is attached toattr_name- [in] The attribute namerank- [out] The dimensionality of the attribute- Returns:
- \herr_t \details H5LTget_attribute_ndims() gets the dimensionality of an attribute named \p attr_name that is attached to the object specified by the name \p obj_name.
-
H5LTget_attribute_ndims
@Cast("herr_t") public static int H5LTget_attribute_ndims(@Cast("hid_t") long loc_id, String obj_name, String attr_name, IntBuffer rank)
-
H5LTget_attribute_ndims
@Cast("herr_t") public static int H5LTget_attribute_ndims(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer obj_name, @Cast("const char*") BytePointer attr_name, int[] rank)
-
H5LTget_attribute_ndims
@Cast("herr_t") public static int H5LTget_attribute_ndims(@Cast("hid_t") long loc_id, String obj_name, String attr_name, IntPointer rank)
-
H5LTget_attribute_ndims
@Cast("herr_t") public static int H5LTget_attribute_ndims(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer obj_name, @Cast("const char*") BytePointer attr_name, IntBuffer rank)
-
H5LTget_attribute_ndims
@Cast("herr_t") public static int H5LTget_attribute_ndims(@Cast("hid_t") long loc_id, String obj_name, String attr_name, int[] rank)
-
H5LTget_attribute_info
@Cast("herr_t") public static int H5LTget_attribute_info(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer obj_name, @Cast("const char*") BytePointer attr_name, @Cast("hsize_t*") LongPointer dims, @Cast("H5T_class_t*") IntPointer type_class, @Cast("size_t*") SizeTPointer type_size)
------------------------------------------------------------------------- \ingroup H5LT \brief Gets information about an attribute.- Parameters:
loc_id- [in] Identifier of the object (dataset or group) to read the attribute fromobj_name- [in] The name of the object that the attribute is attached toattr_name- [in] The attribute namedims- [out] The dimensions of the attributetype_class- [out] The class identifier. #H5T_class_t is defined in H5Tpublic.h. For a list of valid class types see: H5Tget_class().type_size- [out] The size of the datatype in bytes- Returns:
- \herr_t \details H5LTget_attribute_info() gets information about an attribute named \p attr_name attached to the object specified by the name \p obj_name. \par Example \snippet H5LT_examples.c get_attribute_info
-
H5LTget_attribute_info
@Cast("herr_t") public static int H5LTget_attribute_info(@Cast("hid_t") long loc_id, String obj_name, String attr_name, @Cast("hsize_t*") LongBuffer dims, @Cast("H5T_class_t*") IntBuffer type_class, @Cast("size_t*") SizeTPointer type_size)
-
H5LTget_attribute_info
@Cast("herr_t") public static int H5LTget_attribute_info(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer obj_name, @Cast("const char*") BytePointer attr_name, @Cast("hsize_t*") long[] dims, @Cast("H5T_class_t*") int[] type_class, @Cast("size_t*") SizeTPointer type_size)
-
H5LTget_attribute_info
@Cast("herr_t") public static int H5LTget_attribute_info(@Cast("hid_t") long loc_id, String obj_name, String attr_name, @Cast("hsize_t*") LongPointer dims, @Cast("H5T_class_t*") IntPointer type_class, @Cast("size_t*") SizeTPointer type_size)
-
H5LTget_attribute_info
@Cast("herr_t") public static int H5LTget_attribute_info(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer obj_name, @Cast("const char*") BytePointer attr_name, @Cast("hsize_t*") LongBuffer dims, @Cast("H5T_class_t*") IntBuffer type_class, @Cast("size_t*") SizeTPointer type_size)
-
H5LTget_attribute_info
@Cast("herr_t") public static int H5LTget_attribute_info(@Cast("hid_t") long loc_id, String obj_name, String attr_name, @Cast("hsize_t*") long[] dims, @Cast("H5T_class_t*") int[] type_class, @Cast("size_t*") SizeTPointer type_size)
-
H5LTtext_to_dtype
@Cast("hid_t") public static long H5LTtext_to_dtype(@Cast("const char*") BytePointer text, @Cast("H5LT_lang_t") int lang_type)
------------------------------------------------------------------------- \ingroup H5LT \brief Creates an HDF5 datatype given a text description.- Parameters:
text- [in] A character string containing a DDL definition of the datatype to be createdlang_type- [in] The language used to describe the datatype. The only currently supported language is #H5LT_DDL.- Returns:
- Returns the datatype identifier(non-negative) if successful; otherwise returns a negative value. \details Given a text description of a datatype, this function creates an HDF5 datatype and returns the datatype identifier. The text description of the datatype has to comply with the \p lang_type definition of HDF5 datatypes. Currently, only the DDL(#H5LT_DDL) is supported. The complete DDL definition of HDF5 datatypes can be found in the last chapter of the HDF5 User's Guide. \par Example An example of DDL definition of \c enum type is shown as follows. \snippet H5LT_examples.c enum
-
H5LTtext_to_dtype
@Cast("hid_t") public static long H5LTtext_to_dtype(String text, @Cast("H5LT_lang_t") int lang_type)
-
H5LTdtype_to_text
@Cast("herr_t") public static int H5LTdtype_to_text(@Cast("hid_t") long dtype, @Cast("char*") BytePointer str, @Cast("H5LT_lang_t") int lang_type, @Cast("size_t*") SizeTPointer len)
------------------------------------------------------------------------- \ingroup H5LT \brief Creates a text description of an HDF5 datatype.- Parameters:
dtype- [in] Identifier of the datatype to be convertedstr- [out] Buffer for the text description of the datatypelang_type- [in] The language used to describe the datatype. The currently supported language is #H5LT_DDL.len- [out] The size of buffer needed to store the text description- Returns:
- \herr_t \details Given an HDF5 datatype identifier, this function creates a description of this datatype in \p lang_type language format. A preliminary H5LTdtype_to_text() call can be made to determine the size of the buffer needed with a NULL passed in for \p str. This value is returned as \p len. That value can then be assigned to len for a second H5Ttype_to_text() call, which will retrieve the actual text description for the datatype. If \p len is not big enough for the description, the text description will be truncated to fit in the buffer. Currently only DDL (#H5LT_DDL) is supported for \p lang_type. The complete DDL definition of HDF5 data types can be found in the last chapter of the HDF5 User's Guide. \par Example An example of DDL definition of \c enum type is shown as follows. \snippet H5LT_examples.c enum
-
H5LTdtype_to_text
@Cast("herr_t") public static int H5LTdtype_to_text(@Cast("hid_t") long dtype, @Cast("char*") ByteBuffer str, @Cast("H5LT_lang_t") int lang_type, @Cast("size_t*") SizeTPointer len)
-
H5LTdtype_to_text
@Cast("herr_t") public static int H5LTdtype_to_text(@Cast("hid_t") long dtype, @Cast("char*") byte[] str, @Cast("H5LT_lang_t") int lang_type, @Cast("size_t*") SizeTPointer len)
-
H5LTfind_attribute
@Cast("herr_t") public static int H5LTfind_attribute(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer name)
------------------------------------------------------------------------- \ingroup H5LT \brief Determines whether an attribute exists.- Parameters:
loc_id- [in] Identifier of the object to which the attribute is expected to be attachedname- [in] Attribute name- Returns:
- \htri_t \details H5LTfind_attribute() determines whether an attribute named \p name exists attached to the object specified by \p loc_id. \p loc_id must be an object identifier and \p name must specify an attribute that is expected to be attached to that object.
-
H5LTfind_attribute
@Cast("herr_t") public static int H5LTfind_attribute(@Cast("hid_t") long loc_id, String name)
-
H5LTpath_valid
@Cast("htri_t") public static int H5LTpath_valid(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer path, @Cast("hbool_t") boolean check_object_valid)
------------------------------------------------------------------------- \ingroup H5LT \brief Determines whether an HDF5 path is valid and, optionally, whether the path resolves to an HDF5 object.- Parameters:
loc_id- [in] Identifier of an object in the filepath- [in] The path to the object to check; links in \p path may be of any type.check_object_valid- [in] If TRUE, determine whether the final component of \p path resolves to an object; if FALSE, do not check.- Returns:
- Upon success:
-
H5LTpath_valid
@Cast("htri_t") public static int H5LTpath_valid(@Cast("hid_t") long loc_id, String path, @Cast("hbool_t") boolean check_object_valid)
-
H5LTopen_file_image
@Cast("hid_t") public static long H5LTopen_file_image(Pointer buf_ptr, @Cast("size_t") long buf_size, @Cast("unsigned") int flags)
------------------------------------------------------------------------- \ingroup H5LT \brief Opens an HDF5 file image in memory.- Parameters:
buf_ptr- [in] A pointer to the supplied initial imagebuf_size- [in] Size of the supplied bufferflags- [in] Flags specifying whether to open the image read-only or read/write, whether HDF5 is to take control of the buffer, and instruction regarding releasing the buffer.- Returns:
- Returns a file identifier if successful; otherwise returns a negative value. \warning \Bold{Failure Modes:} \warning H5LTopen_file_image() will fail if either \p buf_ptr is NULL or \p buf_size equals 0 (zero). \details H5LTopen_file_image() opens the HDF5 file image that is located in system memory at the address indicated by \p buf_ptr of size \p buf_size. H5LTopen_file_image() opens a file image with the Core driver, #H5FD_CORE. A value of NULL for \p buf_ptr is invalid and will cause the function to fail. A value of 0 for \p buf_size is invalid and will cause the function to fail. The flags passed in \p flags specify whether to open the image read-only or read/write, whether HDF5 is to take control of the buffer, and instruction regarding releasing the buffer. Valid values are: - #H5LT_FILE_IMAGE_OPEN_RW - Specifies opening the file image in read/write mode. - Default without this flag: File image will be opened read-only. - #H5LT_FILE_IMAGE_DONT_COPY - Specifies to not copy the provided file image buffer; the buffer will be used directly. HDF5 will release the file image when finished. - Default without this flag: Copy the file image buffer and open the copied file image. - #H5LT_FILE_IMAGE_DONT_RELEASE - Specifies that HDF5 is not to release the buffer when the file opened with H5LTopen_file_image() is closed; releasing the buffer will be left to the application. - Default without this flag: HDF5 will automatically release the file image buffer after the file image is closed. This flag is valid only when used with #H5LT_FILE_IMAGE_DONT_COPY. \note **Motivation:** \note H5LTopen_file_image() and other elements of HDF5 are used to load an image of an HDF5 file into system memory and open that image as a regular HDF5 file. An application can then use the file without the overhead of disk I/O. \note **Recommended Reading:** \note This function is part of the file image operations feature set. It is highly recommended to study the guide HDF5 File Image Operations before using this feature set.\n See the âSee Alsoâ section below for links to other elements of HDF5 file image operations. \todo There is no "See Also" section???
- Since:
- 1.8.9
-
H5IMmake_image_8bit
@Cast("herr_t") public static int H5IMmake_image_8bit(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer dset_name, @Cast("hsize_t") long width, @Cast("hsize_t") long height, @Cast("const unsigned char*") BytePointer buffer)
-------------------------------------------------------------------------- \ingroup H5IM \brief Creates and writes an image. \fg_loc_id- Parameters:
dset_name- [in] The name of the dataset to createwidth- [in] The width of the imageheight- [in] The height of the imagebuffer- [in] Buffer with data to be written to the dataset- Returns:
- \herr_t \details H5IMmake_image_8bit() creates and writes a dataset named \p dset_name attached to the file or group specified by the identifier \p loc_id. Attributes conforming to the HDF5 Image and Palette specification for an indexed image are attached to the dataset, thus identifying it as an image. The image data is of the type #H5T_NATIVE_UCHAR. An indexed image is an image in which each each pixel information storage is an index to a table palette.
-
H5IMmake_image_8bit
@Cast("herr_t") public static int H5IMmake_image_8bit(@Cast("hid_t") long loc_id, String dset_name, @Cast("hsize_t") long width, @Cast("hsize_t") long height, @Cast("const unsigned char*") ByteBuffer buffer)
-
H5IMmake_image_8bit
@Cast("herr_t") public static int H5IMmake_image_8bit(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer dset_name, @Cast("hsize_t") long width, @Cast("hsize_t") long height, @Cast("const unsigned char*") byte[] buffer)
-
H5IMmake_image_8bit
@Cast("herr_t") public static int H5IMmake_image_8bit(@Cast("hid_t") long loc_id, String dset_name, @Cast("hsize_t") long width, @Cast("hsize_t") long height, @Cast("const unsigned char*") BytePointer buffer)
-
H5IMmake_image_8bit
@Cast("herr_t") public static int H5IMmake_image_8bit(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer dset_name, @Cast("hsize_t") long width, @Cast("hsize_t") long height, @Cast("const unsigned char*") ByteBuffer buffer)
-
H5IMmake_image_8bit
@Cast("herr_t") public static int H5IMmake_image_8bit(@Cast("hid_t") long loc_id, String dset_name, @Cast("hsize_t") long width, @Cast("hsize_t") long height, @Cast("const unsigned char*") byte[] buffer)
-
H5IMmake_image_24bit
@Cast("herr_t") public static int H5IMmake_image_24bit(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer dset_name, @Cast("hsize_t") long width, @Cast("hsize_t") long height, @Cast("const char*") BytePointer interlace, @Cast("const unsigned char*") BytePointer buffer)
-------------------------------------------------------------------------- \ingroup H5IM \brief Creates and writes a true color image. \fg_loc_id- Parameters:
dset_name- [in] The name of the dataset to createwidth- [in] The width of the imageheight- [in] The height of the imageinterlace- [in] String defining the interlace modebuffer- [in] Buffer with data to be written to the dataset- Returns:
- \herr_t \details H5IMmake_image_24bit() creates and writes a dataset named \p dset_name attached to the file or group specified by the identifier \p loc_id. This function defines a true color image conforming to the HDF5 Image and Palette specification. The function assumes that the image data is of the type #H5T_NATIVE_UCHAR. A true color image is an image where the pixel storage contains several color planes. In a 24 bit RGB color model, these planes are red, green and blue. In a true color image the stream of bytes can be stored in several different ways, thus defining the interlace (or interleaving) mode. The 2 most used types of interlace mode are interlace by pixel and interlace by plane. In the 24 bit RGB color model example, interlace by plane means all the red components for the entire dataset are stored first, followed by all the green components, and then by all the blue components. Interlace by pixel in this example means that for each pixel the sequence red, green, blue is defined. In this function, the interlace mode is defined in the parameter \p interlace, a string that can have the values INTERLACE_PIXEL or INTERLACE_PLANE.
-
H5IMmake_image_24bit
@Cast("herr_t") public static int H5IMmake_image_24bit(@Cast("hid_t") long loc_id, String dset_name, @Cast("hsize_t") long width, @Cast("hsize_t") long height, String interlace, @Cast("const unsigned char*") ByteBuffer buffer)
-
H5IMmake_image_24bit
@Cast("herr_t") public static int H5IMmake_image_24bit(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer dset_name, @Cast("hsize_t") long width, @Cast("hsize_t") long height, @Cast("const char*") BytePointer interlace, @Cast("const unsigned char*") byte[] buffer)
-
H5IMmake_image_24bit
@Cast("herr_t") public static int H5IMmake_image_24bit(@Cast("hid_t") long loc_id, String dset_name, @Cast("hsize_t") long width, @Cast("hsize_t") long height, String interlace, @Cast("const unsigned char*") BytePointer buffer)
-
H5IMmake_image_24bit
@Cast("herr_t") public static int H5IMmake_image_24bit(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer dset_name, @Cast("hsize_t") long width, @Cast("hsize_t") long height, @Cast("const char*") BytePointer interlace, @Cast("const unsigned char*") ByteBuffer buffer)
-
H5IMmake_image_24bit
@Cast("herr_t") public static int H5IMmake_image_24bit(@Cast("hid_t") long loc_id, String dset_name, @Cast("hsize_t") long width, @Cast("hsize_t") long height, String interlace, @Cast("const unsigned char*") byte[] buffer)
-
H5IMget_image_info
@Cast("herr_t") public static int H5IMget_image_info(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer dset_name, @Cast("hsize_t*") LongPointer width, @Cast("hsize_t*") LongPointer height, @Cast("hsize_t*") LongPointer planes, @Cast("char*") BytePointer interlace, @Cast("hssize_t*") LongPointer npals)
------------------------------------------------------------------------- \ingroup H5IM \brief Gets information about an image dataset (dimensions, interlace mode and number of associated palettes). \fg_loc_id- Parameters:
dset_name- [in] The name of the datasetwidth- [out] The width of the imageheight- [out] The height of the imageplanes- [out] The number of color planes of the imageinterlace- [out] The interlace mode of the imagenpals- [out] The number of palettes associated to the image- Returns:
- \herr_t \details H5IMget_image_info() gets information about an image named \p dset_name attached to the file or group specified by the identifier \p loc_id.
-
H5IMget_image_info
@Cast("herr_t") public static int H5IMget_image_info(@Cast("hid_t") long loc_id, String dset_name, @Cast("hsize_t*") LongBuffer width, @Cast("hsize_t*") LongBuffer height, @Cast("hsize_t*") LongBuffer planes, @Cast("char*") ByteBuffer interlace, @Cast("hssize_t*") LongBuffer npals)
-
H5IMget_image_info
@Cast("herr_t") public static int H5IMget_image_info(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer dset_name, @Cast("hsize_t*") long[] width, @Cast("hsize_t*") long[] height, @Cast("hsize_t*") long[] planes, @Cast("char*") byte[] interlace, @Cast("hssize_t*") long... npals)
-
H5IMget_image_info
@Cast("herr_t") public static int H5IMget_image_info(@Cast("hid_t") long loc_id, String dset_name, @Cast("hsize_t*") LongPointer width, @Cast("hsize_t*") LongPointer height, @Cast("hsize_t*") LongPointer planes, @Cast("char*") BytePointer interlace, @Cast("hssize_t*") LongPointer npals)
-
H5IMget_image_info
@Cast("herr_t") public static int H5IMget_image_info(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer dset_name, @Cast("hsize_t*") LongBuffer width, @Cast("hsize_t*") LongBuffer height, @Cast("hsize_t*") LongBuffer planes, @Cast("char*") ByteBuffer interlace, @Cast("hssize_t*") LongBuffer npals)
-
H5IMget_image_info
@Cast("herr_t") public static int H5IMget_image_info(@Cast("hid_t") long loc_id, String dset_name, @Cast("hsize_t*") long[] width, @Cast("hsize_t*") long[] height, @Cast("hsize_t*") long[] planes, @Cast("char*") byte[] interlace, @Cast("hssize_t*") long... npals)
-
H5IMread_image
@Cast("herr_t") public static int H5IMread_image(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer dset_name, @Cast("unsigned char*") BytePointer buffer)
-------------------------------------------------------------------------- \ingroup H5IM \brief Reads image data from disk. \fg_loc_id- Parameters:
dset_name- [in] The name of the dataset to createbuffer- [out] Buffer with data to store the image- Returns:
- \herr_t \details H5IMread_image() reads a dataset named \p dset_name attached to the file or group specified by the identifier \p loc_id.
-
H5IMread_image
@Cast("herr_t") public static int H5IMread_image(@Cast("hid_t") long loc_id, String dset_name, @Cast("unsigned char*") ByteBuffer buffer)
-
H5IMread_image
@Cast("herr_t") public static int H5IMread_image(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer dset_name, @Cast("unsigned char*") byte[] buffer)
-
H5IMread_image
@Cast("herr_t") public static int H5IMread_image(@Cast("hid_t") long loc_id, String dset_name, @Cast("unsigned char*") BytePointer buffer)
-
H5IMread_image
@Cast("herr_t") public static int H5IMread_image(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer dset_name, @Cast("unsigned char*") ByteBuffer buffer)
-
H5IMread_image
@Cast("herr_t") public static int H5IMread_image(@Cast("hid_t") long loc_id, String dset_name, @Cast("unsigned char*") byte[] buffer)
-
H5IMmake_palette
@Cast("herr_t") public static int H5IMmake_palette(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer pal_name, @Cast("const hsize_t*") LongPointer pal_dims, @Cast("const unsigned char*") BytePointer pal_data)
-------------------------------------------------------------------------- \ingroup H5IM \brief Creates and writes a palette. \fg_loc_id- Parameters:
pal_name- [in] The name of the palettepal_dims- [in] An array of the size of the palette dimensionspal_data- [in] Buffer with data to be written to the dataset- Returns:
- \herr_t \details H5IMmake_palette() creates and writes a dataset named \p pal_name. Attributes conforming to the HDF5 Image and Palette specification are attached to the dataset, thus identifying it as a palette. The palette data is of the type #H5T_NATIVE_UCHAR.
-
H5IMmake_palette
@Cast("herr_t") public static int H5IMmake_palette(@Cast("hid_t") long loc_id, String pal_name, @Cast("const hsize_t*") LongBuffer pal_dims, @Cast("const unsigned char*") ByteBuffer pal_data)
-
H5IMmake_palette
@Cast("herr_t") public static int H5IMmake_palette(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer pal_name, @Cast("const hsize_t*") long[] pal_dims, @Cast("const unsigned char*") byte[] pal_data)
-
H5IMmake_palette
@Cast("herr_t") public static int H5IMmake_palette(@Cast("hid_t") long loc_id, String pal_name, @Cast("const hsize_t*") LongPointer pal_dims, @Cast("const unsigned char*") BytePointer pal_data)
-
H5IMmake_palette
@Cast("herr_t") public static int H5IMmake_palette(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer pal_name, @Cast("const hsize_t*") LongBuffer pal_dims, @Cast("const unsigned char*") ByteBuffer pal_data)
-
H5IMmake_palette
@Cast("herr_t") public static int H5IMmake_palette(@Cast("hid_t") long loc_id, String pal_name, @Cast("const hsize_t*") long[] pal_dims, @Cast("const unsigned char*") byte[] pal_data)
-
H5IMlink_palette
@Cast("herr_t") public static int H5IMlink_palette(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer image_name, @Cast("const char*") BytePointer pal_name)
-------------------------------------------------------------------------- \ingroup H5IM \brief Attaches a palette to an image. \fg_loc_id- Parameters:
image_name- [in] The name of the dataset to attach the palette topal_name- [in] The name of the palette- Returns:
- \herr_t \details H5IMlink_palette() attaches a palette named \p pal_name to an image specified by \p image_name. The image dataset may or not already have an attached palette. If it has, the array of palette references is extended to hold the reference to the new palette.
-
H5IMlink_palette
@Cast("herr_t") public static int H5IMlink_palette(@Cast("hid_t") long loc_id, String image_name, String pal_name)
-
H5IMunlink_palette
@Cast("herr_t") public static int H5IMunlink_palette(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer image_name, @Cast("const char*") BytePointer pal_name)
-------------------------------------------------------------------------- \ingroup H5IM \brief Dettaches a palette from an image. \fg_loc_id- Parameters:
image_name- [in] The name of the image datasetpal_name- [in] The name of the palette- Returns:
- \herr_t \details H5IMunlink_palette() dettaches a palette from an image specified by \p image_name.
-
H5IMunlink_palette
@Cast("herr_t") public static int H5IMunlink_palette(@Cast("hid_t") long loc_id, String image_name, String pal_name)
-
H5IMget_npalettes
@Cast("herr_t") public static int H5IMget_npalettes(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer image_name, @Cast("hssize_t*") LongPointer npals)
-------------------------------------------------------------------------- \ingroup H5IM \brief Gets the number of palettes associated to an image. \fg_loc_id- Parameters:
image_name- [in] The name of the image datasetnpals- [out] The number of palettes- Returns:
- \herr_t \details H5IMget_npalettes() gets the number of palettes associated to an image specified by \p image_name.
-
H5IMget_npalettes
@Cast("herr_t") public static int H5IMget_npalettes(@Cast("hid_t") long loc_id, String image_name, @Cast("hssize_t*") LongBuffer npals)
-
H5IMget_npalettes
@Cast("herr_t") public static int H5IMget_npalettes(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer image_name, @Cast("hssize_t*") long... npals)
-
H5IMget_npalettes
@Cast("herr_t") public static int H5IMget_npalettes(@Cast("hid_t") long loc_id, String image_name, @Cast("hssize_t*") LongPointer npals)
-
H5IMget_npalettes
@Cast("herr_t") public static int H5IMget_npalettes(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer image_name, @Cast("hssize_t*") LongBuffer npals)
-
H5IMget_npalettes
@Cast("herr_t") public static int H5IMget_npalettes(@Cast("hid_t") long loc_id, String image_name, @Cast("hssize_t*") long... npals)
-
H5IMget_palette_info
@Cast("herr_t") public static int H5IMget_palette_info(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer image_name, int pal_number, @Cast("hsize_t*") LongPointer pal_dims)
-------------------------------------------------------------------------- \ingroup H5IM \brief Gets information about a palette dataset (dimensions). \fg_loc_id- Parameters:
image_name- [in] The name of the image datasetpal_number- [in] The zero based index that identifies the palettepal_dims- [out] The dimensions of the palette dataset- Returns:
- \herr_t \details H5IMget_palette_info() gets the dimensions of the palette dataset identified by \p pal_number (a zero based index) associated to an image specified by \p image_name.
-
H5IMget_palette_info
@Cast("herr_t") public static int H5IMget_palette_info(@Cast("hid_t") long loc_id, String image_name, int pal_number, @Cast("hsize_t*") LongBuffer pal_dims)
-
H5IMget_palette_info
@Cast("herr_t") public static int H5IMget_palette_info(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer image_name, int pal_number, @Cast("hsize_t*") long... pal_dims)
-
H5IMget_palette_info
@Cast("herr_t") public static int H5IMget_palette_info(@Cast("hid_t") long loc_id, String image_name, int pal_number, @Cast("hsize_t*") LongPointer pal_dims)
-
H5IMget_palette_info
@Cast("herr_t") public static int H5IMget_palette_info(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer image_name, int pal_number, @Cast("hsize_t*") LongBuffer pal_dims)
-
H5IMget_palette_info
@Cast("herr_t") public static int H5IMget_palette_info(@Cast("hid_t") long loc_id, String image_name, int pal_number, @Cast("hsize_t*") long... pal_dims)
-
H5IMget_palette
@Cast("herr_t") public static int H5IMget_palette(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer image_name, int pal_number, @Cast("unsigned char*") BytePointer pal_data)
-------------------------------------------------------------------------- \ingroup H5IM \brief Gets the palette dataset. \fg_loc_id- Parameters:
image_name- [in] The name of the image datasetpal_number- [in] The zero based index that identifies the palettepal_data- [out] The palette dataset- Returns:
- \herr_t \details H5IMget_palette() gets the palette dataset identified by \p pal_number (a zero based index) associated to an image specified by \p image_name.
-
H5IMget_palette
@Cast("herr_t") public static int H5IMget_palette(@Cast("hid_t") long loc_id, String image_name, int pal_number, @Cast("unsigned char*") ByteBuffer pal_data)
-
H5IMget_palette
@Cast("herr_t") public static int H5IMget_palette(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer image_name, int pal_number, @Cast("unsigned char*") byte[] pal_data)
-
H5IMget_palette
@Cast("herr_t") public static int H5IMget_palette(@Cast("hid_t") long loc_id, String image_name, int pal_number, @Cast("unsigned char*") BytePointer pal_data)
-
H5IMget_palette
@Cast("herr_t") public static int H5IMget_palette(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer image_name, int pal_number, @Cast("unsigned char*") ByteBuffer pal_data)
-
H5IMget_palette
@Cast("herr_t") public static int H5IMget_palette(@Cast("hid_t") long loc_id, String image_name, int pal_number, @Cast("unsigned char*") byte[] pal_data)
-
H5IMis_image
@Cast("herr_t") public static int H5IMis_image(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer dset_name)
-------------------------------------------------------------------------- \ingroup H5IM \brief Inquires if a dataset is an image. \fg_loc_id- Parameters:
dset_name- [in] The name of the dataset- Returns:
- \htri_t \details H5IMis_image() inquires if a dataset named \p dset_name, attached to the file or group specified by the identifier \p loc_id, is an image based on the HDF5 Image and Palette Specification.
-
H5IMis_image
@Cast("herr_t") public static int H5IMis_image(@Cast("hid_t") long loc_id, String dset_name)
-
H5IMis_palette
@Cast("herr_t") public static int H5IMis_palette(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer dset_name)
-------------------------------------------------------------------------- \ingroup H5IM \brief Inquires if a dataset is a palette \fg_loc_id- Parameters:
dset_name- [in] The name of the dataset- Returns:
- \htri_t \details H5IMis_palette() inquires if a dataset named \p dset_name, attached to the file or group specified by the identifier \p loc_id, is a palette based on the HDF5 Image and Palette Specification.
-
H5IMis_palette
@Cast("herr_t") public static int H5IMis_palette(@Cast("hid_t") long loc_id, String dset_name)
-
H5TBmake_table
@Cast("herr_t") public static int H5TBmake_table(@Cast("const char*") BytePointer table_title, @Cast("hid_t") long loc_id, @Cast("const char*") BytePointer dset_name, @Cast("hsize_t") long nfields, @Cast("hsize_t") long nrecords, @Cast("size_t") long type_size, @Cast("const char**") PointerPointer field_names, @Cast("const size_t*") SizeTPointer field_offset, @Cast("const hid_t*") LongPointer field_types, @Cast("hsize_t") long chunk_size, Pointer fill_data, int compress, @Const Pointer buf)
-------------------------------------------------------------------------- \ingroup H5TB \brief Creates and writes a table- Parameters:
table_title- [in] The title of the table \fg_loc_iddset_name- [in] The name of the dataset to createnfields- [in] The number of fieldsnrecords- [in] The number of recordstype_size- [in] The size in bytes of the structure associated with the table; This value is obtained with \c sizeof().field_names- [in] An array containing the names of the fieldsfield_offset- [in] An array containing the offsets of the fieldsfield_types- [in] An array containing the type of the fieldschunk_size- [in] The chunk sizefill_data- [in] Fill values datacompress- [in] Flag that turns compression on or offbuf- [in] Buffer with data to be written to the table- Returns:
- \herr_t \details H5TBmake_table() creates and writes a dataset named \p dset_name attached to the object specified by the identifier loc_id.
-
H5TBmake_table
@Cast("herr_t") public static int H5TBmake_table(@Cast("const char*") BytePointer table_title, @Cast("hid_t") long loc_id, @Cast("const char*") BytePointer dset_name, @Cast("hsize_t") long nfields, @Cast("hsize_t") long nrecords, @Cast("size_t") long type_size, @Cast("const char**") @ByPtrPtr BytePointer field_names, @Cast("const size_t*") SizeTPointer field_offset, @Cast("const hid_t*") LongPointer field_types, @Cast("hsize_t") long chunk_size, Pointer fill_data, int compress, @Const Pointer buf)
-
H5TBmake_table
@Cast("herr_t") public static int H5TBmake_table(String table_title, @Cast("hid_t") long loc_id, String dset_name, @Cast("hsize_t") long nfields, @Cast("hsize_t") long nrecords, @Cast("size_t") long type_size, @Cast("const char**") @ByPtrPtr ByteBuffer field_names, @Cast("const size_t*") SizeTPointer field_offset, @Cast("const hid_t*") LongBuffer field_types, @Cast("hsize_t") long chunk_size, Pointer fill_data, int compress, @Const Pointer buf)
-
H5TBmake_table
@Cast("herr_t") public static int H5TBmake_table(@Cast("const char*") BytePointer table_title, @Cast("hid_t") long loc_id, @Cast("const char*") BytePointer dset_name, @Cast("hsize_t") long nfields, @Cast("hsize_t") long nrecords, @Cast("size_t") long type_size, @Cast("const char**") @ByPtrPtr byte[] field_names, @Cast("const size_t*") SizeTPointer field_offset, @Cast("const hid_t*") long[] field_types, @Cast("hsize_t") long chunk_size, Pointer fill_data, int compress, @Const Pointer buf)
-
H5TBmake_table
@Cast("herr_t") public static int H5TBmake_table(String table_title, @Cast("hid_t") long loc_id, String dset_name, @Cast("hsize_t") long nfields, @Cast("hsize_t") long nrecords, @Cast("size_t") long type_size, @Cast("const char**") @ByPtrPtr BytePointer field_names, @Cast("const size_t*") SizeTPointer field_offset, @Cast("const hid_t*") LongPointer field_types, @Cast("hsize_t") long chunk_size, Pointer fill_data, int compress, @Const Pointer buf)
-
H5TBmake_table
@Cast("herr_t") public static int H5TBmake_table(@Cast("const char*") BytePointer table_title, @Cast("hid_t") long loc_id, @Cast("const char*") BytePointer dset_name, @Cast("hsize_t") long nfields, @Cast("hsize_t") long nrecords, @Cast("size_t") long type_size, @Cast("const char**") @ByPtrPtr ByteBuffer field_names, @Cast("const size_t*") SizeTPointer field_offset, @Cast("const hid_t*") LongBuffer field_types, @Cast("hsize_t") long chunk_size, Pointer fill_data, int compress, @Const Pointer buf)
-
H5TBmake_table
@Cast("herr_t") public static int H5TBmake_table(String table_title, @Cast("hid_t") long loc_id, String dset_name, @Cast("hsize_t") long nfields, @Cast("hsize_t") long nrecords, @Cast("size_t") long type_size, @Cast("const char**") @ByPtrPtr byte[] field_names, @Cast("const size_t*") SizeTPointer field_offset, @Cast("const hid_t*") long[] field_types, @Cast("hsize_t") long chunk_size, Pointer fill_data, int compress, @Const Pointer buf)
-
H5TBappend_records
@Cast("herr_t") public static int H5TBappend_records(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer dset_name, @Cast("hsize_t") long nrecords, @Cast("size_t") long type_size, @Cast("const size_t*") SizeTPointer field_offset, @Cast("const size_t*") SizeTPointer dst_sizes, @Const Pointer buf)
-------------------------------------------------------------------------- \ingroup H5TB \brief Adds records to the end of the table \fg_loc_id- Parameters:
dset_name- [in] The name of the dataset to overwritenrecords- [in] The number of records to appendtype_size- [in] The size of the structure type, as calculated by \c sizeof().field_offset- [in] An array containing the offsets of the fields. These offsets can be calculated with the #HOFFSET macrodst_sizes- [in] An array containing the sizes of the fieldsbuf- [in] Buffer with data- Returns:
- \herr_t \details H5TBappend_records() adds records to the end of the table named \p dset_name attached to the object specified by the identifier \p loc_id. The dataset is extended to hold the new records.
-
H5TBappend_records
@Cast("herr_t") public static int H5TBappend_records(@Cast("hid_t") long loc_id, String dset_name, @Cast("hsize_t") long nrecords, @Cast("size_t") long type_size, @Cast("const size_t*") SizeTPointer field_offset, @Cast("const size_t*") SizeTPointer dst_sizes, @Const Pointer buf)
-
H5TBwrite_records
@Cast("herr_t") public static int H5TBwrite_records(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer dset_name, @Cast("hsize_t") long start, @Cast("hsize_t") long nrecords, @Cast("size_t") long type_size, @Cast("const size_t*") SizeTPointer field_offset, @Cast("const size_t*") SizeTPointer dst_sizes, @Const Pointer buf)
-------------------------------------------------------------------------- \ingroup H5TB \brief Overwrites records \fg_loc_id- Parameters:
dset_name- [in] The name of the dataset to overwritestart- [in] The zero index record to start writingnrecords- [in] The number of records to writetype_size- [in] The size of the structure type, as calculated by \c sizeof().field_offset- [in] An array containing the offsets of the fields. These offsets can be calculated with the #HOFFSET macrodst_sizes- [in] An array containing the sizes of the fieldsbuf- [in] Buffer with data- Returns:
- \herr_t \details H5TBwrite_records() overwrites records starting at the zero index position start of the table named \p dset_name attached to the object specified by the identifier \p loc_id.
-
H5TBwrite_records
@Cast("herr_t") public static int H5TBwrite_records(@Cast("hid_t") long loc_id, String dset_name, @Cast("hsize_t") long start, @Cast("hsize_t") long nrecords, @Cast("size_t") long type_size, @Cast("const size_t*") SizeTPointer field_offset, @Cast("const size_t*") SizeTPointer dst_sizes, @Const Pointer buf)
-
H5TBwrite_fields_name
@Cast("herr_t") public static int H5TBwrite_fields_name(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer dset_name, @Cast("const char*") BytePointer field_names, @Cast("hsize_t") long start, @Cast("hsize_t") long nrecords, @Cast("size_t") long type_size, @Cast("const size_t*") SizeTPointer field_offset, @Cast("const size_t*") SizeTPointer dst_sizes, @Const Pointer buf)
-------------------------------------------------------------------------- \ingroup H5TB \brief Overwrites fields \fg_loc_id- Parameters:
dset_name- [in] The name of the dataset to overwritefield_names- [in] The names of the fields to writestart- [in] The zero index record to start writingnrecords- [in] The number of records to writetype_size- [in] The size of the structure type, as calculated by \c sizeof().field_offset- [in] An array containing the offsets of the fields. These offsets can be calculated with the #HOFFSET macrodst_sizes- [in] An array containing the sizes of the fieldsbuf- [in] Buffer with data- Returns:
- \herr_t \details H5TBwrite_fields_name() overwrites one or several fields specified by \p field_names with data in \p buf from a dataset named \p dset_name attached to the object specified by the identifier \p loc_id.
-
H5TBwrite_fields_name
@Cast("herr_t") public static int H5TBwrite_fields_name(@Cast("hid_t") long loc_id, String dset_name, String field_names, @Cast("hsize_t") long start, @Cast("hsize_t") long nrecords, @Cast("size_t") long type_size, @Cast("const size_t*") SizeTPointer field_offset, @Cast("const size_t*") SizeTPointer dst_sizes, @Const Pointer buf)
-
H5TBwrite_fields_index
@Cast("herr_t") public static int H5TBwrite_fields_index(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer dset_name, @Cast("hsize_t") long nfields, @Const IntPointer field_index, @Cast("hsize_t") long start, @Cast("hsize_t") long nrecords, @Cast("size_t") long type_size, @Cast("const size_t*") SizeTPointer field_offset, @Cast("const size_t*") SizeTPointer dst_sizes, @Const Pointer buf)
-------------------------------------------------------------------------- \ingroup H5TB \brief Overwrites fields \fg_loc_id- Parameters:
dset_name- [in] The name of the dataset to overwritenfields- [in] The number of fields to overwrite. This parameter is also the size of the \p field_index array.field_index- [in] The indexes of the fields to writestart- [in] The zero based index record to start writingnrecords- [in] The number of records to writetype_size- [in] The size of the structure type, as calculated by \c sizeof().field_offset- [in] An array containing the offsets of the fields. These offsets can be calculated with the #HOFFSET macrodst_sizes- [in] An array containing the sizes of the fieldsbuf- [in] Buffer with data- Returns:
- \herr_t \details H5TBwrite_fields_index() overwrites one or several fields specified by \p field_index with a buffer \p buf from a dataset named \p dset_name attached to the object specified by the identifier \p loc_id.
-
H5TBwrite_fields_index
@Cast("herr_t") public static int H5TBwrite_fields_index(@Cast("hid_t") long loc_id, String dset_name, @Cast("hsize_t") long nfields, @Const IntBuffer field_index, @Cast("hsize_t") long start, @Cast("hsize_t") long nrecords, @Cast("size_t") long type_size, @Cast("const size_t*") SizeTPointer field_offset, @Cast("const size_t*") SizeTPointer dst_sizes, @Const Pointer buf)
-
H5TBwrite_fields_index
@Cast("herr_t") public static int H5TBwrite_fields_index(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer dset_name, @Cast("hsize_t") long nfields, @Const int[] field_index, @Cast("hsize_t") long start, @Cast("hsize_t") long nrecords, @Cast("size_t") long type_size, @Cast("const size_t*") SizeTPointer field_offset, @Cast("const size_t*") SizeTPointer dst_sizes, @Const Pointer buf)
-
H5TBwrite_fields_index
@Cast("herr_t") public static int H5TBwrite_fields_index(@Cast("hid_t") long loc_id, String dset_name, @Cast("hsize_t") long nfields, @Const IntPointer field_index, @Cast("hsize_t") long start, @Cast("hsize_t") long nrecords, @Cast("size_t") long type_size, @Cast("const size_t*") SizeTPointer field_offset, @Cast("const size_t*") SizeTPointer dst_sizes, @Const Pointer buf)
-
H5TBwrite_fields_index
@Cast("herr_t") public static int H5TBwrite_fields_index(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer dset_name, @Cast("hsize_t") long nfields, @Const IntBuffer field_index, @Cast("hsize_t") long start, @Cast("hsize_t") long nrecords, @Cast("size_t") long type_size, @Cast("const size_t*") SizeTPointer field_offset, @Cast("const size_t*") SizeTPointer dst_sizes, @Const Pointer buf)
-
H5TBwrite_fields_index
@Cast("herr_t") public static int H5TBwrite_fields_index(@Cast("hid_t") long loc_id, String dset_name, @Cast("hsize_t") long nfields, @Const int[] field_index, @Cast("hsize_t") long start, @Cast("hsize_t") long nrecords, @Cast("size_t") long type_size, @Cast("const size_t*") SizeTPointer field_offset, @Cast("const size_t*") SizeTPointer dst_sizes, @Const Pointer buf)
-
H5TBread_table
@Cast("herr_t") public static int H5TBread_table(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer dset_name, @Cast("size_t") long dst_size, @Cast("const size_t*") SizeTPointer dst_offset, @Cast("const size_t*") SizeTPointer dst_sizes, Pointer dst_buf)
-------------------------------------------------------------------------- \ingroup H5TB \brief Reads a table \fg_loc_id- Parameters:
dset_name- [in] The name of the dataset to readdst_size- [in] The size of the structure type, as calculated by \c sizeof()dst_offset- [in] An array containing the offsets of the fields. These offsets can be calculated with the #HOFFSET macrodst_sizes- [in] An array containing the sizes of the fields. These sizes can be calculated with the sizeof() macro.dst_buf- [in] Buffer with data- Returns:
- \herr_t \details H5TBread_table() reads a table named \p dset_name attached to the object specified by the identifier \p loc_id.
-
H5TBread_table
@Cast("herr_t") public static int H5TBread_table(@Cast("hid_t") long loc_id, String dset_name, @Cast("size_t") long dst_size, @Cast("const size_t*") SizeTPointer dst_offset, @Cast("const size_t*") SizeTPointer dst_sizes, Pointer dst_buf)
-
H5TBread_fields_name
@Cast("herr_t") public static int H5TBread_fields_name(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer dset_name, @Cast("const char*") BytePointer field_names, @Cast("hsize_t") long start, @Cast("hsize_t") long nrecords, @Cast("size_t") long type_size, @Cast("const size_t*") SizeTPointer field_offset, @Cast("const size_t*") SizeTPointer dst_sizes, Pointer buf)
-------------------------------------------------------------------------- \ingroup H5TB \brief Reads one or several fields. The fields are identified by name. \fg_loc_id- Parameters:
dset_name- [in] The name of the dataset to readfield_names- [in] An array containing the names of the fields to readstart- [in] The start record to read fromnrecords- [in] The number of records to readtype_size- [in] The size in bytes of the structure associated with the table (This value is obtained with \c sizeof().)field_offset- [in] An array containing the offsets of the fieldsdst_sizes- [in] An array containing the size in bytes of the fieldsbuf- [out] Buffer with data- Returns:
- \herr_t \details H5TBread_fields_name() reads the fields identified by \p field_names from a dataset named \p dset_name attached to the object specified by the identifier \p loc_id.
-
H5TBread_fields_name
@Cast("herr_t") public static int H5TBread_fields_name(@Cast("hid_t") long loc_id, String dset_name, String field_names, @Cast("hsize_t") long start, @Cast("hsize_t") long nrecords, @Cast("size_t") long type_size, @Cast("const size_t*") SizeTPointer field_offset, @Cast("const size_t*") SizeTPointer dst_sizes, Pointer buf)
-
H5TBread_fields_index
@Cast("herr_t") public static int H5TBread_fields_index(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer dset_name, @Cast("hsize_t") long nfields, @Const IntPointer field_index, @Cast("hsize_t") long start, @Cast("hsize_t") long nrecords, @Cast("size_t") long type_size, @Cast("const size_t*") SizeTPointer field_offset, @Cast("const size_t*") SizeTPointer dst_sizes, Pointer buf)
-------------------------------------------------------------------------- \ingroup H5TB \brief Reads one or several fields. The fields are identified by index. \fg_loc_id- Parameters:
dset_name- [in] The name of the dataset to readnfields- [in] The number of fields to read (This parameter is also the size of the \p field_index array.) fields to readfield_index- [in] The indexes of the fields to readstart- [in] The start record to read fromnrecords- [in] The number of records to readtype_size- [in] The size in bytes of the structure associated with the table (This value is obtained with \c sizeof())field_offset- [in] An array containing the offsets of the fieldsdst_sizes- [in] An array containing the size in bytes of the fieldsbuf- [out] Buffer with data- Returns:
- \herr_t \details H5TBread_fields_index() reads the fields identified by \p field_index from a dataset named \p dset_name attached to the object specified by the identifier \p loc_id.
-
H5TBread_fields_index
@Cast("herr_t") public static int H5TBread_fields_index(@Cast("hid_t") long loc_id, String dset_name, @Cast("hsize_t") long nfields, @Const IntBuffer field_index, @Cast("hsize_t") long start, @Cast("hsize_t") long nrecords, @Cast("size_t") long type_size, @Cast("const size_t*") SizeTPointer field_offset, @Cast("const size_t*") SizeTPointer dst_sizes, Pointer buf)
-
H5TBread_fields_index
@Cast("herr_t") public static int H5TBread_fields_index(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer dset_name, @Cast("hsize_t") long nfields, @Const int[] field_index, @Cast("hsize_t") long start, @Cast("hsize_t") long nrecords, @Cast("size_t") long type_size, @Cast("const size_t*") SizeTPointer field_offset, @Cast("const size_t*") SizeTPointer dst_sizes, Pointer buf)
-
H5TBread_fields_index
@Cast("herr_t") public static int H5TBread_fields_index(@Cast("hid_t") long loc_id, String dset_name, @Cast("hsize_t") long nfields, @Const IntPointer field_index, @Cast("hsize_t") long start, @Cast("hsize_t") long nrecords, @Cast("size_t") long type_size, @Cast("const size_t*") SizeTPointer field_offset, @Cast("const size_t*") SizeTPointer dst_sizes, Pointer buf)
-
H5TBread_fields_index
@Cast("herr_t") public static int H5TBread_fields_index(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer dset_name, @Cast("hsize_t") long nfields, @Const IntBuffer field_index, @Cast("hsize_t") long start, @Cast("hsize_t") long nrecords, @Cast("size_t") long type_size, @Cast("const size_t*") SizeTPointer field_offset, @Cast("const size_t*") SizeTPointer dst_sizes, Pointer buf)
-
H5TBread_fields_index
@Cast("herr_t") public static int H5TBread_fields_index(@Cast("hid_t") long loc_id, String dset_name, @Cast("hsize_t") long nfields, @Const int[] field_index, @Cast("hsize_t") long start, @Cast("hsize_t") long nrecords, @Cast("size_t") long type_size, @Cast("const size_t*") SizeTPointer field_offset, @Cast("const size_t*") SizeTPointer dst_sizes, Pointer buf)
-
H5TBread_records
@Cast("herr_t") public static int H5TBread_records(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer dset_name, @Cast("hsize_t") long start, @Cast("hsize_t") long nrecords, @Cast("size_t") long type_size, @Cast("const size_t*") SizeTPointer dst_offset, @Cast("const size_t*") SizeTPointer dst_sizes, Pointer buf)
-------------------------------------------------------------------------- \ingroup H5TB \brief Reads records \fg_loc_id- Parameters:
dset_name- [in] The name of the dataset to readstart- [in] The start record to read fromnrecords- [in] The number of records to readtype_size- [in] The size of the structure type, as calculated by \c sizeof()dst_offset- [in] An array containing the offsets of the fields. These offsets can be calculated with the #HOFFSET macrodst_sizes- [in] An array containing the size in bytes of the fieldsbuf- [out] Buffer with data- Returns:
- \herr_t \details H5TBread_records() reads some records identified from a dataset named \p dset_name attached to the object specified by the identifier \p loc_id.
-
H5TBread_records
@Cast("herr_t") public static int H5TBread_records(@Cast("hid_t") long loc_id, String dset_name, @Cast("hsize_t") long start, @Cast("hsize_t") long nrecords, @Cast("size_t") long type_size, @Cast("const size_t*") SizeTPointer dst_offset, @Cast("const size_t*") SizeTPointer dst_sizes, Pointer buf)
-
H5TBget_table_info
@Cast("herr_t") public static int H5TBget_table_info(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer dset_name, @Cast("hsize_t*") LongPointer nfields, @Cast("hsize_t*") LongPointer nrecords)
-------------------------------------------------------------------------- \ingroup H5TB \brief Gets the table dimensions \fg_loc_id- Parameters:
dset_name- [in] The name of the dataset to readnfields- [out] The number of fieldsnrecords- [out] The number of records- Returns:
- \herr_t \details H5TBget_table_info() retrieves the table dimensions from a dataset named \p dset_name attached to the object specified by the identifier \p loc_id.
-
H5TBget_table_info
@Cast("herr_t") public static int H5TBget_table_info(@Cast("hid_t") long loc_id, String dset_name, @Cast("hsize_t*") LongBuffer nfields, @Cast("hsize_t*") LongBuffer nrecords)
-
H5TBget_table_info
@Cast("herr_t") public static int H5TBget_table_info(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer dset_name, @Cast("hsize_t*") long[] nfields, @Cast("hsize_t*") long... nrecords)
-
H5TBget_table_info
@Cast("herr_t") public static int H5TBget_table_info(@Cast("hid_t") long loc_id, String dset_name, @Cast("hsize_t*") LongPointer nfields, @Cast("hsize_t*") LongPointer nrecords)
-
H5TBget_table_info
@Cast("herr_t") public static int H5TBget_table_info(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer dset_name, @Cast("hsize_t*") LongBuffer nfields, @Cast("hsize_t*") LongBuffer nrecords)
-
H5TBget_table_info
@Cast("herr_t") public static int H5TBget_table_info(@Cast("hid_t") long loc_id, String dset_name, @Cast("hsize_t*") long[] nfields, @Cast("hsize_t*") long... nrecords)
-
H5TBget_field_info
@Cast("herr_t") public static int H5TBget_field_info(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer dset_name, @Cast("char**") PointerPointer field_names, @Cast("size_t*") SizeTPointer field_sizes, @Cast("size_t*") SizeTPointer field_offsets, @Cast("size_t*") SizeTPointer type_size)
-------------------------------------------------------------------------- \ingroup H5TB \brief Gets information about a table \fg_loc_id- Parameters:
dset_name- [in] The name of the dataset to readfield_names- [out] An array containing the names of the fieldsfield_sizes- [out] An array containing the size of the fieldsfield_offsets- [out] An array containing the offsets of the fieldstype_size- [out] The size of the HDF5 datatype associated with the table. (More specifically, the size in bytes of the HDF5 compound datatype used to define a row, or record, in the table)- Returns:
- \herr_t \details H5TBget_field_info() gets information about a dataset named \p dset_name attached to the object specified by the identifier \p loc_id.
-
H5TBget_field_info
@Cast("herr_t") public static int H5TBget_field_info(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer dset_name, @Cast("char**") @ByPtrPtr BytePointer field_names, @Cast("size_t*") SizeTPointer field_sizes, @Cast("size_t*") SizeTPointer field_offsets, @Cast("size_t*") SizeTPointer type_size)
-
H5TBget_field_info
@Cast("herr_t") public static int H5TBget_field_info(@Cast("hid_t") long loc_id, String dset_name, @Cast("char**") @ByPtrPtr ByteBuffer field_names, @Cast("size_t*") SizeTPointer field_sizes, @Cast("size_t*") SizeTPointer field_offsets, @Cast("size_t*") SizeTPointer type_size)
-
H5TBget_field_info
@Cast("herr_t") public static int H5TBget_field_info(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer dset_name, @Cast("char**") @ByPtrPtr byte[] field_names, @Cast("size_t*") SizeTPointer field_sizes, @Cast("size_t*") SizeTPointer field_offsets, @Cast("size_t*") SizeTPointer type_size)
-
H5TBget_field_info
@Cast("herr_t") public static int H5TBget_field_info(@Cast("hid_t") long loc_id, String dset_name, @Cast("char**") @ByPtrPtr BytePointer field_names, @Cast("size_t*") SizeTPointer field_sizes, @Cast("size_t*") SizeTPointer field_offsets, @Cast("size_t*") SizeTPointer type_size)
-
H5TBget_field_info
@Cast("herr_t") public static int H5TBget_field_info(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer dset_name, @Cast("char**") @ByPtrPtr ByteBuffer field_names, @Cast("size_t*") SizeTPointer field_sizes, @Cast("size_t*") SizeTPointer field_offsets, @Cast("size_t*") SizeTPointer type_size)
-
H5TBget_field_info
@Cast("herr_t") public static int H5TBget_field_info(@Cast("hid_t") long loc_id, String dset_name, @Cast("char**") @ByPtrPtr byte[] field_names, @Cast("size_t*") SizeTPointer field_sizes, @Cast("size_t*") SizeTPointer field_offsets, @Cast("size_t*") SizeTPointer type_size)
-
H5TBdelete_record
@Cast("herr_t") public static int H5TBdelete_record(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer dset_name, @Cast("hsize_t") long start, @Cast("hsize_t") long nrecords)
-------------------------------------------------------------------------- \ingroup H5TB \brief Delete records \fg_loc_id- Parameters:
dset_name- [in] The name of the datasetstart- [in] The start record to delete fromnrecords- [in] The number of records to delete- Returns:
- \herr_t \details H5TBdelete_record() deletes nrecords number of records starting from \p start from the middle of the table \p dset_name ("pulling up" all the records after it).
-
H5TBdelete_record
@Cast("herr_t") public static int H5TBdelete_record(@Cast("hid_t") long loc_id, String dset_name, @Cast("hsize_t") long start, @Cast("hsize_t") long nrecords)
-
H5TBinsert_record
@Cast("herr_t") public static int H5TBinsert_record(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer dset_name, @Cast("hsize_t") long start, @Cast("hsize_t") long nrecords, @Cast("size_t") long dst_size, @Cast("const size_t*") SizeTPointer dst_offset, @Cast("const size_t*") SizeTPointer dst_sizes, Pointer buf)
-------------------------------------------------------------------------- \ingroup H5TB \brief Insert records \fg_loc_id- Parameters:
dset_name- [in] The name of the datasetstart- [in] The position to insertnrecords- [in] The number of records to insertdst_size- [in] The size in bytes of the structure associated with the tabledst_offset- [in] An array containing the offsets of the fieldsdst_sizes- [in] An array containing the size in bytes of the fieldsbuf- [in] Buffer with data- Returns:
- \herr_t \details H5TBinsert_record() inserts records into the middle of the table ("pushing down" all the records after it)
-
H5TBinsert_record
@Cast("herr_t") public static int H5TBinsert_record(@Cast("hid_t") long loc_id, String dset_name, @Cast("hsize_t") long start, @Cast("hsize_t") long nrecords, @Cast("size_t") long dst_size, @Cast("const size_t*") SizeTPointer dst_offset, @Cast("const size_t*") SizeTPointer dst_sizes, Pointer buf)
-
H5TBadd_records_from
@Cast("herr_t") public static int H5TBadd_records_from(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer dset_name1, @Cast("hsize_t") long start1, @Cast("hsize_t") long nrecords, @Cast("const char*") BytePointer dset_name2, @Cast("hsize_t") long start2)
-------------------------------------------------------------------------- \ingroup H5TB \brief Add records from first table to second table \fg_loc_id- Parameters:
dset_name- [in] 1 The name of the dataset to read the recordsstart- [in] 1 The position to read the records from the first tablenrecords- [in] The number of records to read from the first tabledset_name- [in] 2 The name of the dataset to write the recordsstart- [in] 2 The position to write the records on the second table- Returns:
- \herr_t \details H5TBadd_records_from() adds records from a dataset named \p dset_name1 to a dataset named \p dset_name2. Both tables are attached to the object specified by the identifier loc_id.
-
H5TBadd_records_from
@Cast("herr_t") public static int H5TBadd_records_from(@Cast("hid_t") long loc_id, String dset_name1, @Cast("hsize_t") long start1, @Cast("hsize_t") long nrecords, String dset_name2, @Cast("hsize_t") long start2)
-
H5TBcombine_tables
@Cast("herr_t") public static int H5TBcombine_tables(@Cast("hid_t") long loc_id1, @Cast("const char*") BytePointer dset_name1, @Cast("hid_t") long loc_id2, @Cast("const char*") BytePointer dset_name2, @Cast("const char*") BytePointer dset_name3)
-------------------------------------------------------------------------- \ingroup H5TB \brief Combines records from two tables into a third- Parameters:
loc_id- [in] 1 Identifier of the file or group in which the first table is locateddset_name- [in] 1 The name of the first table to combineloc_id- [in] 2 Identifier of the file or group in which the second table is locateddset_name- [in] 2 The name of the second table to combinedset_name- [in] 3 The name of the new table- Returns:
- \herr_t \details H5TBcombine_tables() combines records from two datasets named \p dset_name1 and \p dset_name2, to a new table named \p dset_name3. These tables can be located on different files, identified by \p loc_id1 and \p loc_id2 (identifiers obtained with H5Fcreate()). They can also be located on the same file. In this case one uses the same identifier for both parameters \p loc_id1 and \p loc_id2. If two files are used, the third table is written in the first file.
-
H5TBcombine_tables
@Cast("herr_t") public static int H5TBcombine_tables(@Cast("hid_t") long loc_id1, String dset_name1, @Cast("hid_t") long loc_id2, String dset_name2, String dset_name3)
-
H5TBinsert_field
@Cast("herr_t") public static int H5TBinsert_field(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer dset_name, @Cast("const char*") BytePointer field_name, @Cast("hid_t") long field_type, @Cast("hsize_t") long _position, @Const Pointer fill_data, @Const Pointer buf)
-------------------------------------------------------------------------- \ingroup H5TB \brief Insert a new field into a table \fg_loc_id- Parameters:
dset_name- [in] The name of the tablefield_name- [in] The name of the field to insertfield_type- [in] The data type of the fieldposition- [in] The zero based index position where to insert the fieldfill_data- [in] Fill value data for the field. This parameter can be NULLbuf- [in] Buffer with data- Returns:
- \herr_t \details H5TBinsert_field() inserts a new field named \p field_name into the table \p dset_name. Note: this function requires the table to be re-created and rewritten in its entirety, and this can result in some unused space in the file, and can also take a great deal of time if the table is large.
-
H5TBinsert_field
@Cast("herr_t") public static int H5TBinsert_field(@Cast("hid_t") long loc_id, String dset_name, String field_name, @Cast("hid_t") long field_type, @Cast("hsize_t") long _position, @Const Pointer fill_data, @Const Pointer buf)
-
H5TBdelete_field
@Cast("herr_t") public static int H5TBdelete_field(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer dset_name, @Cast("const char*") BytePointer field_name)
-------------------------------------------------------------------------- \ingroup H5TB \brief Deletes a field from a table \fg_loc_id- Parameters:
dset_name- [in] The name of the tablefield_name- [in] The name of the field to delete- Returns:
- \herr_t \details H5TBdelete_field() deletes a field named \p field_name from the table \p dset_name. Note: this function requires the table to be re-created and rewritten in its entirety, and this can result in some unused space in the file, and can also take a great deal of time if the table is large.
-
H5TBdelete_field
@Cast("herr_t") public static int H5TBdelete_field(@Cast("hid_t") long loc_id, String dset_name, String field_name)
-
H5TBAget_title
@Cast("herr_t") public static int H5TBAget_title(@Cast("hid_t") long loc_id, @Cast("char*") BytePointer table_title)
-------------------------------------------------------------------------- \ingroup H5TB \brief Reads a table's title \fg_loc_id- Parameters:
table_title- [out] Buffer for title name- Returns:
- \herr_t \details H5TBget_title() returns the title of the table identified by \p loc_id in a buffer \p table_title.
-
H5TBAget_title
@Cast("herr_t") public static int H5TBAget_title(@Cast("hid_t") long loc_id, @Cast("char*") ByteBuffer table_title)
-
H5TBAget_title
@Cast("herr_t") public static int H5TBAget_title(@Cast("hid_t") long loc_id, @Cast("char*") byte[] table_title)
-
H5TBAget_fill
@Cast("htri_t") public static int H5TBAget_fill(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer dset_name, @Cast("hid_t") long dset_id, @Cast("unsigned char*") BytePointer dst_buf)
-------------------------------------------------------------------------- \ingroup H5TB \brief Reads the table attribute fill values \fg_loc_id- Parameters:
dset_name- [in] Name of tabledset_id- [in] Table identifierdst_buf- [out] Buffer of fill values for table fields- Returns:
-
H5TBAget_fill
@Cast("htri_t") public static int H5TBAget_fill(@Cast("hid_t") long loc_id, String dset_name, @Cast("hid_t") long dset_id, @Cast("unsigned char*") ByteBuffer dst_buf)
-
H5TBAget_fill
@Cast("htri_t") public static int H5TBAget_fill(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer dset_name, @Cast("hid_t") long dset_id, @Cast("unsigned char*") byte[] dst_buf)
-
H5TBAget_fill
@Cast("htri_t") public static int H5TBAget_fill(@Cast("hid_t") long loc_id, String dset_name, @Cast("hid_t") long dset_id, @Cast("unsigned char*") BytePointer dst_buf)
-
H5TBAget_fill
@Cast("htri_t") public static int H5TBAget_fill(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer dset_name, @Cast("hid_t") long dset_id, @Cast("unsigned char*") ByteBuffer dst_buf)
-
H5TBAget_fill
@Cast("htri_t") public static int H5TBAget_fill(@Cast("hid_t") long loc_id, String dset_name, @Cast("hid_t") long dset_id, @Cast("unsigned char*") byte[] dst_buf)
-
H5PTcreate
@Cast("hid_t") public static long H5PTcreate(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer dset_name, @Cast("hid_t") long dtype_id, @Cast("hsize_t") long chunk_size, @Cast("hid_t") long plist_id)
-------------------------------------------------------------------------- \ingroup H5PT \brief Creates a packet table to store fixed-length or variable-length packets. \fg_loc_id- Parameters:
dset_name- [in] The name of the packet table to createdtype_id- [in] The datatype of the packetchunk_size- [in] The size in number of table entries per chunkplist_id- [in] Identifier of the property list. Can be used to specify the compression of the packet table.- Returns:
- Returns an identifier for the new packet table or #H5I_INVALID_HID on error. \details The H5PTcreate() creates and opens a packet table named \p dset_name attached to the object specified by the identifier \p loc_id. The created packet table should be closed with H5PTclose(), eventually. The datatype, \p dtype_id, may specify any datatype, including variable-length data. If \p dtype_id specifies a compound datatype, one or more fields in that compound type may be variable-length. \p chunk_size is the size in number of table entries per chunk. Packet table datasets use HDF5 chunked storage to allow them to grow. This value allows the user to set the size of a chunk. The chunk size affects performance.
- Since:
- 1.10.0 and 1.8.17
-
H5PTcreate
@Cast("hid_t") public static long H5PTcreate(@Cast("hid_t") long loc_id, String dset_name, @Cast("hid_t") long dtype_id, @Cast("hsize_t") long chunk_size, @Cast("hid_t") long plist_id)
-
H5PTopen
@Cast("hid_t") public static long H5PTopen(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer dset_name)
-------------------------------------------------------------------------- \ingroup H5PT \brief Opens an existing packet table. \fg_loc_id- Parameters:
dset_name- [in] The name of the packet table to open- Returns:
- Returns an identifier for the packet table or #H5I_INVALID_HID on error. \details H5PTopen() opens an existing packet table in the file or group specified by \p loc_id. \p dset_name is the name of the packet table and is used to identify it in the file. This function is used to open both fixed-length packet tables and variable-length packet tables. The packet table should later be closed with H5PTclose().
-
H5PTclose
@Cast("herr_t") public static int H5PTclose(@Cast("hid_t") long table_id)
-------------------------------------------------------------------------- \ingroup H5PT \brief Closes an open packet table.- Parameters:
table_id- [in] Identifier of packet table to be closed- Returns:
- \herr_t \details The H5PTclose() ends access to a packet table specified by \p table_id.
-
H5PTcreate_fl
@Cast("hid_t") public static long H5PTcreate_fl(@Cast("hid_t") long loc_id, @Cast("const char*") BytePointer dset_name, @Cast("hid_t") long dtype_id, @Cast("hsize_t") long chunk_size, int compression)
Deprecated.This function was deprecated in favor of the function H5PTcreate(). \details The H5PTcreate_fl() creates and opens a packet table named \p dset_name attached to the object specified by the identifier \p loc_id. It should be closed with H5PTclose(). The datatype, \p dtype_id, may specify any datatype, including variable-length data. If \p dtype_id specifies a compound datatype, one or more fields in that compound type may be variable-length. \p chunk_size is the size in number of table entries per chunk. Packet table datasets use HDF5 chunked storage to allow them to grow. This value allows the user to set the size of a chunk. The chunk size affects performance. \p compression is the compression level, a value of 0 through 9. Level 0 is faster but offers the least compression; level 9 is slower but offers maximum compression. A setting of -1 indicates that no compression is desired.-------------------------------------------------------------------------- \ingroup H5PT \brief Creates a packet table to store fixed-length packets \fg_loc_id- Parameters:
dset_name- [in] The name of the dataset to createdtype_id- [in] The datatype of a packet.chunk_size- [in] The size in number of table entries per chunk.compression- [in] The compression level; a value of 0 through 9.- Returns:
- Returns an identifier for the packet table or #H5I_INVALID_HID on error.
-
H5PTcreate_fl
@Cast("hid_t") public static long H5PTcreate_fl(@Cast("hid_t") long loc_id, String dset_name, @Cast("hid_t") long dtype_id, @Cast("hsize_t") long chunk_size, int compression)
-
H5PTappend
@Cast("herr_t") public static int H5PTappend(@Cast("hid_t") long table_id, @Cast("size_t") long nrecords, @Const Pointer data)
-------------------------------------------------------------------------- \ingroup H5PT \brief Appends packets to the end of a packet table.- Parameters:
table_id- [in] Identifier of packet table to which packets should be appendednrecords- [in] Number of packets to be appendeddata- [in] Buffer holding data to write- Returns:
- \herr_t \details The H5PTappend() writes \p nrecords packets to the end of a packet table specified by \p table_id. \p data is a buffer containing the data to be written. For a packet table holding fixed-length packets, this data should be in the packet table's datatype. For a variable-length packet table, the data should be in the form of #hvl_t structs.
-
H5PTget_next
@Cast("herr_t") public static int H5PTget_next(@Cast("hid_t") long table_id, @Cast("size_t") long nrecords, Pointer data)
-------------------------------------------------------------------------- \ingroup H5PT \brief Reads packets from a packet table starting at the current index.- Parameters:
table_id- [in] Identifier of packet table to read fromnrecords- [in] Number of packets to be readdata- [out] Buffer into which to read data- Returns:
- \herr_t \details The H5PTget_next() reads \p nrecords packets starting with the "current index" from a packet table specified by \p table_id. The packet table's index is set and reset with H5PTset_index() and H5PTcreate_index(). \p data is a buffer into which the data should be read. For a packet table holding variable-length records, the data returned in the buffer will be in form of a #hvl_t struct containing the length of the data and a pointer to it in memory. The memory used by this data must be freed using H5PTfree_vlen_buff().
-
H5PTread_packets
@Cast("herr_t") public static int H5PTread_packets(@Cast("hid_t") long table_id, @Cast("hsize_t") long start, @Cast("size_t") long nrecords, Pointer data)
-------------------------------------------------------------------------- \ingroup H5PT \brief Reads a number of packets from a packet table.- Parameters:
table_id- [in] Identifier of packet table to read fromstart- [in] Packet to start reading fromnrecords- [in] Number of packets to be readdata- [out] Buffer into which to read data.- Returns:
- \herr_t \details The H5PTread_packets() reads \p nrecords packets starting at packet number \p start from a packet table specified by \p table_id. \p data is a buffer into which the data should be read. For a packet table holding variable-length records, the data returned in the buffer will be in form of #hvl_t structs, each containing the length of the data and a pointer to it in memory. The memory used by this data must be freed using H5PTfree_vlen_buff().
-
H5PTget_num_packets
@Cast("herr_t") public static int H5PTget_num_packets(@Cast("hid_t") long table_id, @Cast("hsize_t*") LongPointer nrecords)
-------------------------------------------------------------------------- \ingroup H5PT \brief Returns the number of packets in a packet table.- Parameters:
table_id- [in] Identifier of packet table to querynrecords- [out] Number of packets in packet table- Returns:
- \herr_t \details The H5PTget_num_packets() returns by reference the number of packets in a packet table specified by \p table_id.
-
H5PTget_num_packets
@Cast("herr_t") public static int H5PTget_num_packets(@Cast("hid_t") long table_id, @Cast("hsize_t*") LongBuffer nrecords)
-
H5PTget_num_packets
@Cast("herr_t") public static int H5PTget_num_packets(@Cast("hid_t") long table_id, @Cast("hsize_t*") long... nrecords)
-
H5PTis_valid
@Cast("herr_t") public static int H5PTis_valid(@Cast("hid_t") long table_id)
-------------------------------------------------------------------------- \ingroup H5PT \brief Determines whether an identifier points to a packet table.- Parameters:
table_id- [in] Identifier to query- Returns:
- Returns a non-negative value if \p table_id is a valid packet table, otherwise returns a negative value. \details The H5PTis_valid() returns a non-negative value if \p table_id corresponds to an open packet table, and returns a negative value otherwise.
-
H5PTis_varlen
@Cast("herr_t") public static int H5PTis_varlen(@Cast("hid_t") long table_id)
-------------------------------------------------------------------------- \ingroup H5PT \brief Determines whether a packet table contains variable-length or fixed-length packets.- Parameters:
table_id- [in] Packet table to query- Returns:
- Returns 1 for a variable-length packet table, 0 for fixed-length, or a negative value on error. \details The H5PTis_varlen() returns 1 (TRUE) if \p table_id is a packet table containing variable-length records. It returns 0 (FALSE) if \p table_id is a packet table containing fixed-length records. If \p table_id is not a packet table, a negative value is returned.
-
H5PTget_dataset
@Cast("hid_t") public static long H5PTget_dataset(@Cast("hid_t") long table_id)
-------------------------------------------------------------------------- \ingroup H5PT \brief Returns the backend dataset of this packet table.- Parameters:
table_id- [in] Identifier of the packet table- Returns:
- Returns a dataset identifier or H5I_INVALID_HID on error. \details The H5PTget_dataset() returns the identifier of the dataset storing the packet table \p table_id. This dataset identifier will be closed by H5PTclose().
- Since:
- 1.10.0 and 1.8.17
-
H5PTget_type
@Cast("hid_t") public static long H5PTget_type(@Cast("hid_t") long table_id)
-------------------------------------------------------------------------- \ingroup H5PT \brief Returns the backend datatype of this packet table.- Parameters:
table_id- [in] Identifier of the packet table- Returns:
- Returns a datatype identifier or H5I_INVALID_HID on error. \details The H5PTget_type() returns the identifier of the datatype used by the packet table \p table_id. This datatype identifier will be closed by H5PTclose().
- Since:
- 1.10.0 and 1.8.17
-
H5PTcreate_index
@Cast("herr_t") public static int H5PTcreate_index(@Cast("hid_t") long table_id)
-------------------------------------------------------------------------- \ingroup H5PT \brief Resets a packet table's index to the first packet.- Parameters:
table_id- [in] Identifier of packet table whose index should be initialized.- Returns:
- \herr_t \details Each packet table keeps an index of the "current" packet so that \c get_next can iterate through the packets in order. H5PTcreate_index() initializes a packet table's index, and should be called before using \c get_next. The index must be initialized every time a packet table is created or opened; this information is lost when the packet table is closed.
-
H5PTset_index
@Cast("herr_t") public static int H5PTset_index(@Cast("hid_t") long table_id, @Cast("hsize_t") long pt_index)
-------------------------------------------------------------------------- \ingroup H5PT \brief Sets a packet table's index.- Parameters:
table_id- [in] Identifier of packet table whose index is to be setpt_index- [in] The packet to which the index should point- Returns:
- \herr_t \details Each packet table keeps an index of the "current" packet so that \c get_next can iterate through the packets in order. H5PTset_index() sets this index to point to a user-specified packet (the packets are zero-indexed).
-
H5PTget_index
@Cast("herr_t") public static int H5PTget_index(@Cast("hid_t") long table_id, @Cast("hsize_t*") LongPointer pt_index)
-------------------------------------------------------------------------- \ingroup H5PT \brief Gets the current record index for a packet table.- Parameters:
table_id- [in] Table identifierpt_index- [out] Current record index- Returns:
- \herr_t \details The H5PTget_index() returns the current record index \p pt_index for the table identified by \p table_id.
- Since:
- 1.8.0
-
H5PTget_index
@Cast("herr_t") public static int H5PTget_index(@Cast("hid_t") long table_id, @Cast("hsize_t*") LongBuffer pt_index)
-
H5PTget_index
@Cast("herr_t") public static int H5PTget_index(@Cast("hid_t") long table_id, @Cast("hsize_t*") long... pt_index)
-
H5PTfree_vlen_buff
@Cast("herr_t") public static int H5PTfree_vlen_buff(@Cast("hid_t") long table_id, @Cast("size_t") long bufflen, Pointer buff)
-------------------------------------------------------------------------- \ingroup H5PT \brief Releases memory allocated in the process of reading variable-length packets.- Parameters:
table_id- [in] Packet table whose memory should be freed.bufflen- [in] Size of \p buffbuff- [in] Buffer that was used to read in variable-length packets- Returns:
- \herr_t \details When variable-length packets are read, memory is automatically allocated to hold them, and must be freed. H5PTfree_vlen_buff() frees this memory, and should be called whenever packets are read from a variable-length packet table.
-
H5LDget_dset_dims
@Cast("herr_t") public static int H5LDget_dset_dims(@Cast("hid_t") long did, @Cast("hsize_t*") LongPointer cur_dims)
------------------------------------------------------------------------- \ingroup H5LT \brief Retrieves the current dimension sizes of a dataset.- Parameters:
did- [in] The dataset identifiercur_dims- [out] The current dimension sizes of the dataset- Returns:
- \herr_t \details H5LDget_dset_dims() retrieves the current dimension sizes for the dataset \p did through the parameter \p cur_dims. It will return failure if \p cur_dims is NULL. \note See Also: \note Dataset Watch functions (used with h5watch): - H5LDget_dset_dims() - H5LDget_dset_elmts() - H5LDget_dset_type_size() \par Example: See the example code in H5LDget_dset_elmts() for usage of this routine.
- Since:
- 1.10.0
-
H5LDget_dset_dims
@Cast("herr_t") public static int H5LDget_dset_dims(@Cast("hid_t") long did, @Cast("hsize_t*") LongBuffer cur_dims)
-
H5LDget_dset_dims
@Cast("herr_t") public static int H5LDget_dset_dims(@Cast("hid_t") long did, @Cast("hsize_t*") long... cur_dims)
-
H5LDget_dset_type_size
@Cast("size_t") public static long H5LDget_dset_type_size(@Cast("hid_t") long did, @Cast("const char*") BytePointer fields)
------------------------------------------------------------------------- \ingroup H5LT \brief Returns the size in bytes of the datasetâs datatype- Parameters:
did- [in] The dataset identifierfields- [in] The pointer to a comma-separated list of fields for a compound datatype- Returns:
- If successful, returns the size in bytes of the datasetâs datatype. Otherwise, returns 0. \details H5LDget_dset_type_size() allows the user to find out the datatype size for the dataset associated with \p did. If the parameter \p fields is NULL, this routine just returns the size of the datasetâs datatype. If the dataset has a compound datatype and \p fields is non-NULL, this routine returns the size of the datatype(s) for the selected fields specified in \p fields. Note that â,â is the separator for the fields of a compound datatype while â.â (dot) is the separator for a nested field. Use a backslash ( \ ) to escape characters in field names that conflict with these two separators. \note See Also: \note Dataset Watch functions (used with h5watch): - H5LDget_dset_dims() - H5LDget_dset_elmts() - H5LDget_dset_type_size() \par Example: See the example code in H5LDget_dset_elmts() for usage of this routine.
- Since:
- 1.10.0
-
H5LDget_dset_type_size
@Cast("size_t") public static long H5LDget_dset_type_size(@Cast("hid_t") long did, String fields)
-
H5LDget_dset_elmts
@Cast("herr_t") public static int H5LDget_dset_elmts(@Cast("hid_t") long did, @Cast("const hsize_t*") LongPointer prev_dims, @Cast("const hsize_t*") LongPointer cur_dims, @Cast("const char*") BytePointer fields, Pointer buf)
------------------------------------------------------------------------- \ingroup H5LT \brief Retrieves selected data from the dataset- Parameters:
did- [in] The dataset identifierprev_dims- [in] The previous dimension size of the datasetcur_dims- [in] The current dimension sizes of the datasetfields- [in] A string containing a comma-separated list of fields for a compound datatypebuf- [out] Buffer for storing data retrieved from the dataset- Returns:
- \herr_t \details H5LDget_dset_dims() retrieves selected data of the dataset \p did and stores the data in the parameter \p buf. The difference between the parameters \p prev_dims and \p cur_dims indicates the dimension sizes of the data to be selected from the dataset. Note that \p cur_dims must have at least one dimension whose size is greater than the corresponding dimension in \p prev_dims. Users can determine the size of buf by multiplying the datatype size of the dataset by the number of selected elements. If the parameter \p fields is NULL, this routine returns data for the selected elements of the dataset. If \p fields is not NULL and the dataset has a compound datatype, \p fields is a string containing a comma-separated list of fields. Each name in \p fields specifies a field in the compound datatype, and this routine returns data of the selected fields for the dataset's selected elements. Note that â,â is the separator for the fields of a compound datatype while â.â is the separator for a nested field. Use backslash to escape characters in field names that conflict with these two separators. \note See Also: \note Dataset Watch functions (used with h5watch): - H5LDget_dset_dims() - H5LDget_dset_elmts() - H5LDget_dset_type_size() \par Examples: For the first example, \c DSET1 is a two-dimensional chunked dataset with atomic type defined below: \snippet H5LDget_dset_elmts.c first_declare The following coding sample illustrates the reading of data elements appended to the dataset \c DSET1: \snippet H5LDget_dset_elmts.c first_reading The output buffer will contain data elements selected from \c DSET1 as follows: \snippet H5LDget_dset_elmts.c first_output For the second example, DSET2 is a one-dimensional chunked dataset with compound type defined below: \snippet H5LDget_dset_elmts.c second_declare The following coding sample illustrates the reading of data elements appended to the dataset \c DSET2 with compound datatype. This example selects only 2 fields: the fourth field \c d and a subfield of the sixth field \c s2.c: \snippet H5LDget_dset_elmts.c second_reading The output buffer will contain data for \c d and \c s2.c selected from \c DSET2 as follows: \snippet H5LDget_dset_elmts.c second_output
- Since:
- 1.10.0
-
H5LDget_dset_elmts
@Cast("herr_t") public static int H5LDget_dset_elmts(@Cast("hid_t") long did, @Cast("const hsize_t*") LongBuffer prev_dims, @Cast("const hsize_t*") LongBuffer cur_dims, String fields, Pointer buf)
-
H5LDget_dset_elmts
@Cast("herr_t") public static int H5LDget_dset_elmts(@Cast("hid_t") long did, @Cast("const hsize_t*") long[] prev_dims, @Cast("const hsize_t*") long[] cur_dims, @Cast("const char*") BytePointer fields, Pointer buf)
-
H5LDget_dset_elmts
@Cast("herr_t") public static int H5LDget_dset_elmts(@Cast("hid_t") long did, @Cast("const hsize_t*") LongPointer prev_dims, @Cast("const hsize_t*") LongPointer cur_dims, String fields, Pointer buf)
-
H5LDget_dset_elmts
@Cast("herr_t") public static int H5LDget_dset_elmts(@Cast("hid_t") long did, @Cast("const hsize_t*") LongBuffer prev_dims, @Cast("const hsize_t*") LongBuffer cur_dims, @Cast("const char*") BytePointer fields, Pointer buf)
-
H5LDget_dset_elmts
@Cast("herr_t") public static int H5LDget_dset_elmts(@Cast("hid_t") long did, @Cast("const hsize_t*") long[] prev_dims, @Cast("const hsize_t*") long[] cur_dims, String fields, Pointer buf)
-
H5ESinsert_request
@Cast("herr_t") public static int H5ESinsert_request(@Cast("hid_t") long es_id, @Cast("hid_t") long connector_id, Pointer request)
-
H5ESget_requests
@Cast("herr_t") public static int H5ESget_requests(@Cast("hid_t") long es_id, @Cast("H5_iter_order_t") int order, @Cast("hid_t*") LongPointer connector_ids, @Cast("void**") PointerPointer requests, @Cast("size_t") long array_len, @Cast("size_t*") SizeTPointer count)
-
H5ESget_requests
@Cast("herr_t") public static int H5ESget_requests(@Cast("hid_t") long es_id, @Cast("H5_iter_order_t") int order, @Cast("hid_t*") LongPointer connector_ids, @Cast("void**") @ByPtrPtr Pointer requests, @Cast("size_t") long array_len, @Cast("size_t*") SizeTPointer count)
-
H5ESget_requests
@Cast("herr_t") public static int H5ESget_requests(@Cast("hid_t") long es_id, @Cast("H5_iter_order_t") int order, @Cast("hid_t*") LongBuffer connector_ids, @Cast("void**") @ByPtrPtr Pointer requests, @Cast("size_t") long array_len, @Cast("size_t*") SizeTPointer count)
-
H5ESget_requests
@Cast("herr_t") public static int H5ESget_requests(@Cast("hid_t") long es_id, @Cast("H5_iter_order_t") int order, @Cast("hid_t*") long[] connector_ids, @Cast("void**") @ByPtrPtr Pointer requests, @Cast("size_t") long array_len, @Cast("size_t*") SizeTPointer count)
-
H5FDperform_init
@Cast("hid_t") public static long H5FDperform_init(H5FD_init_t op)
-
H5FDregister
@Cast("hid_t") public static long H5FDregister(@Const H5FD_class_t cls)
-
H5FDis_driver_registered_by_name
@Cast("htri_t") public static int H5FDis_driver_registered_by_name(@Cast("const char*") BytePointer driver_name)
-
H5FDis_driver_registered_by_name
@Cast("htri_t") public static int H5FDis_driver_registered_by_name(String driver_name)
-
H5FDis_driver_registered_by_value
@Cast("htri_t") public static int H5FDis_driver_registered_by_value(@Cast("H5FD_class_value_t") int driver_value)
-
H5FDopen
public static H5FD_t H5FDopen(@Cast("const char*") BytePointer name, @Cast("unsigned") int flags, @Cast("hid_t") long fapl_id, @Cast("haddr_t") long maxaddr)
-
H5FDopen
public static H5FD_t H5FDopen(String name, @Cast("unsigned") int flags, @Cast("hid_t") long fapl_id, @Cast("haddr_t") long maxaddr)
-
H5FDquery
public static int H5FDquery(@Const H5FD_t f, @Cast("unsigned long*") CLongPointer flags)
-
H5FDalloc
@Cast("haddr_t") public static long H5FDalloc(H5FD_t file, @Cast("H5FD_mem_t") int type, @Cast("hid_t") long dxpl_id, @Cast("hsize_t") long size)
-
H5FDfree
@Cast("herr_t") public static int H5FDfree(H5FD_t file, @Cast("H5FD_mem_t") int type, @Cast("hid_t") long dxpl_id, @Cast("haddr_t") long addr, @Cast("hsize_t") long size)
-
H5FDget_eoa
@Cast("haddr_t") public static long H5FDget_eoa(H5FD_t file, @Cast("H5FD_mem_t") int type)
-
H5FDset_eoa
@Cast("herr_t") public static int H5FDset_eoa(H5FD_t file, @Cast("H5FD_mem_t") int type, @Cast("haddr_t") long eoa)
-
H5FDget_eof
@Cast("haddr_t") public static long H5FDget_eof(H5FD_t file, @Cast("H5FD_mem_t") int type)
-
H5FDget_vfd_handle
@Cast("herr_t") public static int H5FDget_vfd_handle(H5FD_t file, @Cast("hid_t") long fapl, @Cast("void**") PointerPointer file_handle)
-
H5FDget_vfd_handle
@Cast("herr_t") public static int H5FDget_vfd_handle(H5FD_t file, @Cast("hid_t") long fapl, @Cast("void**") @ByPtrPtr Pointer file_handle)
-
H5FDread
@Cast("herr_t") public static int H5FDread(H5FD_t file, @Cast("H5FD_mem_t") int type, @Cast("hid_t") long dxpl_id, @Cast("haddr_t") long addr, @Cast("size_t") long size, Pointer buf)
-
H5FDwrite
@Cast("herr_t") public static int H5FDwrite(H5FD_t file, @Cast("H5FD_mem_t") int type, @Cast("hid_t") long dxpl_id, @Cast("haddr_t") long addr, @Cast("size_t") long size, @Const Pointer buf)
-
H5FDread_vector
@Cast("herr_t") public static int H5FDread_vector(H5FD_t file, @Cast("hid_t") long dxpl_id, @Cast("uint32_t") int count, @Cast("H5FD_mem_t*") IntPointer types, @Cast("haddr_t*") LongPointer addrs, @Cast("size_t*") SizeTPointer sizes, @Cast("void**") PointerPointer bufs)
-
H5FDread_vector
@Cast("herr_t") public static int H5FDread_vector(H5FD_t file, @Cast("hid_t") long dxpl_id, @Cast("uint32_t") int count, @Cast("H5FD_mem_t*") IntPointer types, @Cast("haddr_t*") LongPointer addrs, @Cast("size_t*") SizeTPointer sizes, @Cast("void**") @ByPtrPtr Pointer bufs)
-
H5FDread_vector
@Cast("herr_t") public static int H5FDread_vector(H5FD_t file, @Cast("hid_t") long dxpl_id, @Cast("uint32_t") int count, @Cast("H5FD_mem_t*") IntBuffer types, @Cast("haddr_t*") LongBuffer addrs, @Cast("size_t*") SizeTPointer sizes, @Cast("void**") @ByPtrPtr Pointer bufs)
-
H5FDread_vector
@Cast("herr_t") public static int H5FDread_vector(H5FD_t file, @Cast("hid_t") long dxpl_id, @Cast("uint32_t") int count, @Cast("H5FD_mem_t*") int[] types, @Cast("haddr_t*") long[] addrs, @Cast("size_t*") SizeTPointer sizes, @Cast("void**") @ByPtrPtr Pointer bufs)
-
H5FDwrite_vector
@Cast("herr_t") public static int H5FDwrite_vector(H5FD_t file, @Cast("hid_t") long dxpl_id, @Cast("uint32_t") int count, @Cast("H5FD_mem_t*") IntPointer types, @Cast("haddr_t*") LongPointer addrs, @Cast("size_t*") SizeTPointer sizes, @Cast("const void**") PointerPointer bufs)
-
H5FDwrite_vector
@Cast("herr_t") public static int H5FDwrite_vector(H5FD_t file, @Cast("hid_t") long dxpl_id, @Cast("uint32_t") int count, @Cast("H5FD_mem_t*") IntPointer types, @Cast("haddr_t*") LongPointer addrs, @Cast("size_t*") SizeTPointer sizes, @Cast("const void**") @ByPtrPtr Pointer bufs)
-
H5FDwrite_vector
@Cast("herr_t") public static int H5FDwrite_vector(H5FD_t file, @Cast("hid_t") long dxpl_id, @Cast("uint32_t") int count, @Cast("H5FD_mem_t*") IntBuffer types, @Cast("haddr_t*") LongBuffer addrs, @Cast("size_t*") SizeTPointer sizes, @Cast("const void**") @ByPtrPtr Pointer bufs)
-
H5FDwrite_vector
@Cast("herr_t") public static int H5FDwrite_vector(H5FD_t file, @Cast("hid_t") long dxpl_id, @Cast("uint32_t") int count, @Cast("H5FD_mem_t*") int[] types, @Cast("haddr_t*") long[] addrs, @Cast("size_t*") SizeTPointer sizes, @Cast("const void**") @ByPtrPtr Pointer bufs)
-
H5FDread_selection
@Cast("herr_t") public static int H5FDread_selection(H5FD_t file, @Cast("H5FD_mem_t") int type, @Cast("hid_t") long dxpl_id, @Cast("uint32_t") int count, @Cast("hid_t*") LongPointer mem_spaces, @Cast("hid_t*") LongPointer file_spaces, @Cast("haddr_t*") LongPointer offsets, @Cast("size_t*") SizeTPointer element_sizes, @Cast("void**") PointerPointer bufs)
-
H5FDread_selection
@Cast("herr_t") public static int H5FDread_selection(H5FD_t file, @Cast("H5FD_mem_t") int type, @Cast("hid_t") long dxpl_id, @Cast("uint32_t") int count, @Cast("hid_t*") LongPointer mem_spaces, @Cast("hid_t*") LongPointer file_spaces, @Cast("haddr_t*") LongPointer offsets, @Cast("size_t*") SizeTPointer element_sizes, @Cast("void**") @ByPtrPtr Pointer bufs)
-
H5FDread_selection
@Cast("herr_t") public static int H5FDread_selection(H5FD_t file, @Cast("H5FD_mem_t") int type, @Cast("hid_t") long dxpl_id, @Cast("uint32_t") int count, @Cast("hid_t*") LongBuffer mem_spaces, @Cast("hid_t*") LongBuffer file_spaces, @Cast("haddr_t*") LongBuffer offsets, @Cast("size_t*") SizeTPointer element_sizes, @Cast("void**") @ByPtrPtr Pointer bufs)
-
H5FDread_selection
@Cast("herr_t") public static int H5FDread_selection(H5FD_t file, @Cast("H5FD_mem_t") int type, @Cast("hid_t") long dxpl_id, @Cast("uint32_t") int count, @Cast("hid_t*") long[] mem_spaces, @Cast("hid_t*") long[] file_spaces, @Cast("haddr_t*") long[] offsets, @Cast("size_t*") SizeTPointer element_sizes, @Cast("void**") @ByPtrPtr Pointer bufs)
-
H5FDwrite_selection
@Cast("herr_t") public static int H5FDwrite_selection(H5FD_t file, @Cast("H5FD_mem_t") int type, @Cast("hid_t") long dxpl_id, @Cast("uint32_t") int count, @Cast("hid_t*") LongPointer mem_spaces, @Cast("hid_t*") LongPointer file_spaces, @Cast("haddr_t*") LongPointer offsets, @Cast("size_t*") SizeTPointer element_sizes, @Cast("const void**") PointerPointer bufs)
-
H5FDwrite_selection
@Cast("herr_t") public static int H5FDwrite_selection(H5FD_t file, @Cast("H5FD_mem_t") int type, @Cast("hid_t") long dxpl_id, @Cast("uint32_t") int count, @Cast("hid_t*") LongPointer mem_spaces, @Cast("hid_t*") LongPointer file_spaces, @Cast("haddr_t*") LongPointer offsets, @Cast("size_t*") SizeTPointer element_sizes, @Cast("const void**") @ByPtrPtr Pointer bufs)
-
H5FDwrite_selection
@Cast("herr_t") public static int H5FDwrite_selection(H5FD_t file, @Cast("H5FD_mem_t") int type, @Cast("hid_t") long dxpl_id, @Cast("uint32_t") int count, @Cast("hid_t*") LongBuffer mem_spaces, @Cast("hid_t*") LongBuffer file_spaces, @Cast("haddr_t*") LongBuffer offsets, @Cast("size_t*") SizeTPointer element_sizes, @Cast("const void**") @ByPtrPtr Pointer bufs)
-
H5FDwrite_selection
@Cast("herr_t") public static int H5FDwrite_selection(H5FD_t file, @Cast("H5FD_mem_t") int type, @Cast("hid_t") long dxpl_id, @Cast("uint32_t") int count, @Cast("hid_t*") long[] mem_spaces, @Cast("hid_t*") long[] file_spaces, @Cast("haddr_t*") long[] offsets, @Cast("size_t*") SizeTPointer element_sizes, @Cast("const void**") @ByPtrPtr Pointer bufs)
-
H5FDflush
@Cast("herr_t") public static int H5FDflush(H5FD_t file, @Cast("hid_t") long dxpl_id, @Cast("hbool_t") boolean closing)
-
H5FDtruncate
@Cast("herr_t") public static int H5FDtruncate(H5FD_t file, @Cast("hid_t") long dxpl_id, @Cast("hbool_t") boolean closing)
-
H5FDdelete
@Cast("herr_t") public static int H5FDdelete(@Cast("const char*") BytePointer name, @Cast("hid_t") long fapl_id)
-
H5FDctl
@Cast("herr_t") public static int H5FDctl(H5FD_t file, @Cast("uint64_t") long op_code, @Cast("uint64_t") long flags, @Const Pointer input, @Cast("void**") PointerPointer output)
-
H5FDctl
@Cast("herr_t") public static int H5FDctl(H5FD_t file, @Cast("uint64_t") long op_code, @Cast("uint64_t") long flags, @Const Pointer input, @Cast("void**") @ByPtrPtr Pointer output)
-
H5Iregister_future
@Cast("hid_t") public static long H5Iregister_future(@Cast("H5I_type_t") int type, @Const Pointer object, H5I_future_realize_func_t realize_cb, H5I_future_discard_func_t discard_cb)
\ingroup H5I \brief Registers a "future" object under a type and returns an ID for it- Parameters:
type- [in] The identifier of the type of the new IDobject- [in] Pointer to "future" object for which a new ID is createdrealize_cb- [in] Function pointer to realize a future objectdiscard_cb- [in] Function pointer to destroy a future object- Returns:
- \hid_t{object} \details H5Iregister_future() creates and returns a new ID for a "future" object. Future objects are a special kind of object and represent a placeholder for an object that has not yet been created or opened. The \p realize_cb will be invoked by the HDF5 library to 'realize' the future object as an actual object. A call to H5Iobject_verify() will invoke the \p realize_cb callback and if it successfully returns, will return the actual object, not the future object. \details The \p type parameter is the identifier for the ID type to which this new future ID will belong. This identifier may have been created by a call to H5Iregister_type() or may be one of the HDF5 pre-defined ID classes (e.g. H5I_FILE, H5I_GROUP, H5I_DATASPACE, etc). \details The \p object parameter is a pointer to the memory which the new ID will be a reference to. This pointer will be stored by the library, but will not be returned to a call to H5Iobject_verify() until the \p realize_cb callback has returned the actual pointer for the object. A NULL value for \p object is allowed. \details The \p realize_cb parameter is a function pointer that will be invoked by the HDF5 library to convert a future object into an actual object. The \p realize_cb function may be invoked by H5Iobject_verify() to return the actual object for a user-defined ID class (i.e. an ID class registered with H5Iregister_type()) or internally by the HDF5 library in order to use or get information from an HDF5 pre-defined ID type. For example, the \p realize_cb for a future dataspace object will be called during the process of returning information from H5Sget_simple_extent_dims(). Note that although the \p realize_cb routine returns an ID (as a parameter) for the actual object, the HDF5 library will swap the actual object in that ID for the future object in the future ID. This ensures that the ID value for the object doesn't change for the user when the object is realized. Note that the \p realize_cb callback could receive a NULL value for a future object pointer, if one was used when H5Iregister_future() was initially called. This is permitted as a means of allowing the \p realize_cb to act as a generator of new objects, without requiring creation of unnecessary future objects. It is an error to pass NULL for \p realize_cb. \details The \p discard_cb parameter is a function pointer that will be invoked by the HDF5 library to destroy a future object. This callback will always be invoked for _every_ future object, whether the \p realize_cb is invoked on it or not. It's possible that the \p discard_cb is invoked on a future object without the \p realize_cb being invoked, e.g. when a future ID is closed without requiring the future object to be realized into an actual one. Note that the \p discard_cb callback could receive a NULL value for a future object pointer, if one was used when H5Iregister_future() was initially called. It is an error to pass NULL for \p discard_cb. \note The H5Iregister_future() function is primarily targeted at VOL connector authors and is _not_ designed for general-purpose application use.
-
H5Lregister
@Cast("herr_t") public static int H5Lregister(@Const H5L_class_t cls)
\ingroup H5LA \brief Registers a user-defined link class or changes behavior of an existing class- Parameters:
cls- [in] Pointer to a buffer containing the struct describing the user-defined link class- Returns:
- \herr_t
\details H5Lregister() registers a class of user-defined links, or changes
the behavior of an existing class.
\p cls is a pointer to a buffer containing a copy of the
H5L_class_t struct. This struct is defined in H5Lpublic.h as
follows:
\snippet this H5L_class_t_snip
The class definition passed with \p cls must include at least the
following:
\li An H5L_class_t version (which should be #H5L_LINK_CLASS_T_VERS)
\li A link class identifier, \c class_id
\li A traversal function, \c trav_func
Remaining \c struct members are optional and may be passed as NULL.
The link class passed in \c class_id must be in the user-definable
range between #H5L_TYPE_UD_MIN and #H5L_TYPE_UD_MAX
(see the table below) and will override
any existing link class with that identifier.
As distributed, valid values of \c class_id used in HDF5 include
the following (defined in H5Lpublic.h):
\link_types
The hard and soft link class identifiers cannot be modified or
reassigned, but the external link class is implemented as an
example in the user-definable link class identifier range.
H5Lregister() is used to register additional link classes. It could
also be used to modify the behavior of the external link class,
though that is not recommended.
The following table summarizes existing link types and values and
the reserved and user-definable link class identifier value ranges.
Note that HDF5 internally registers user-defined link classes only by the numeric value of the link class identifier. An application, on the other hand, will generally use a name for a user-defined class, if for no other purpose than as a variable name. Assume, for example, that a complex link type is registered with the link class identifier 73 and that the code includes the following assignment:Link class identifier or Value range Description Link class or label 0 to 63 Reserved range 64 to 255 User-definable range 64 Minimum user-defined value #H5L_TYPE_UD_MIN 64 External link #H5L_TYPE_EXTERNAL 255 Maximum user-defined value #H5L_TYPE_UD_MAX 255 Maximum value #H5L_TYPE_MAX -1 Error #H5L_TYPE_ERROR
The application can refer to the link class with a term, \c H5L_TYPE_COMPLEX_A, that conveys meaning to a human reviewing the code, while HDF5 recognizes it by the more cryptic numeric identifier, 73. \attention Important details and considerations include the following: \li If you plan to distribute files or software with a user-defined link class, please contact the Help Desk at The HDF Group to help prevent collisions between \c class_id values. See below. \li As distributed with HDF5, the external link class is implemented as an example of a user-defined link class with #H5L_TYPE_EXTERNAL equal to #H5L_TYPE_UD_MIN. \c class_id in the H5L_class_t \c struct must not equal #H5L_TYPE_UD_MIN unless you intend to overwrite or modify the behavior of external links. \li H5Lregister() can be used only with link class identifiers in the user-definable range (see table above). \li The hard and soft links defined by the HDF5 library, #H5L_TYPE_HARD and #H5L_TYPE_SOFT, reside in the reserved range below #H5L_TYPE_UD_MIN and cannot be redefined or modified. \li H5Lis_registered() can be used to determine whether a desired link class identifier is available. \Emph{Note that this function will tell you only whether the link class identifier has been registered with the installed copy of HDF5; it cannot tell you whether the link class has been registered with The HDF Group.} \li #H5L_TYPE_MAX is the maximum allowed value for a link type identifier. \li #H5L_TYPE_UD_MIN equals #H5L_TYPE_EXTERNAL. \li #H5L_TYPE_UD_MAX equals #H5L_TYPE_MAX. \li #H5L_TYPE_ERROR indicates that an error has occurred. \note \Bold{Registration with The HDF Group:}\n There are sometimes reasons to take a broader approach to registering a user-defined link class than just invoking H5Lregister(). For example: \li A user-defined link class is intended for use across an organization, among collaborators, or across a community of users. \li An application or library overlying HDF5 invokes a user-defined link class that must be shipped with the software. \li Files are distributed that make use of a user-defined link class. \li Or simply, a specific user-defined link class is thought to be widely useful. In such cases, you are encouraged to register that link class with The HDF Group's Helpdesk. The HDF Group maintains a registry of known user-defined link classes and tracks the selected link class identifiers. This registry is intended to reduce the risk of collisions between \c class_id values and to help coordinate the use of specialized link classes.H5L_TYPE_COMPLEX_A = 73 - Since:
- 1.8.0
-
H5Lunregister
@Cast("herr_t") public static int H5Lunregister(@Cast("H5L_type_t") int id)
\ingroup H5LA \brief Unregisters a class of user-defined links- Parameters:
id- [in] User-defined link class identifier- Returns:
- \herr_t \details H5Lunregister() unregisters a class of user-defined links, preventing them from being traversed, queried, moved, etc. \note A link class can be re-registered using H5Lregister().
- Since:
- 1.8.0
-
H5Tregister
@Cast("herr_t") public static int H5Tregister(@Cast("H5T_pers_t") int pers, @Cast("const char*") BytePointer name, @Cast("hid_t") long src_id, @Cast("hid_t") long dst_id, H5T_conv_t func)
\ingroup CONV \brief Registers a datatype conversion function- Parameters:
pers- [in] Conversion function typename- [in] Name displayed in diagnostic output \type_id{src_id} of source datatype \type_id{dst_id} of destination datatypefunc- [in] Function to convert between source and destination datatypes- Returns:
- \herr_t \details H5Tregister() registers a hard or soft conversion function for a datatype conversion path. The parameter \p pers indicates whether a conversion function is hard (#H5T_PERS_HARD) or soft (#H5T_PERS_SOFT). User-defined functions employing compiler casting are designated as \Emph{hard}; other user-defined conversion functions registered with the HDF5 library (with H5Tregister() ) are designated as \Emph{soft}. The HDF5 library also has its own hard and soft conversion functions. A conversion path can have only one hard function. When type is #H5T_PERS_HARD, \p func replaces any previous hard function. When type is #H5T_PERS_SOFT, H5Tregister() adds the function to the end of the master soft list and replaces the soft function in all applicable existing conversion paths. Soft functions are used when determining which conversion function is appropriate for this path. The \p name is used only for debugging and should be a short identifier for the function. The path is specified by the source and destination datatypes \p src_id and \p dst_id. For soft conversion functions, only the class of these types is important. The type of the conversion function pointer is declared as: \snippet this H5T_conv_t_snip The \ref H5T_cdata_t \c struct is declared as: \snippet this H5T_cdata_t_snip
- Since:
- 1.6.3 The following change occurred in the \ref H5T_conv_t function: the \c nelmts parameter type changed to size_t.
-
H5Tregister
@Cast("herr_t") public static int H5Tregister(@Cast("H5T_pers_t") int pers, String name, @Cast("hid_t") long src_id, @Cast("hid_t") long dst_id, H5T_conv_t func)
-
H5Tunregister
@Cast("herr_t") public static int H5Tunregister(@Cast("H5T_pers_t") int pers, @Cast("const char*") BytePointer name, @Cast("hid_t") long src_id, @Cast("hid_t") long dst_id, H5T_conv_t func)
\ingroup CONV \brief Removes a conversion function- Parameters:
pers- [in] Conversion function typename- [in] Name displayed in diagnostic output \type_id{src_id} of source datatype \type_id{dst_id} of destination datatypefunc- [in] Function to convert between source and destination datatypes- Returns:
- \herr_t \details H5Tunregister() removes a conversion function matching criteria such as soft or hard conversion, source and destination types, and the conversion function. If a user is trying to remove a conversion function he registered, all parameters can be used. If he is trying to remove a libraryâs default conversion function, there is no guarantee the \p name and \p func parameters will match the userâs chosen values. Passing in some values may cause this function to fail. A good practice is to pass in NULL as their values. All parameters are optional. The missing parameters will be used to generalize the search criteria. The conversion function pointer type declaration is described in H5Tregister().
-
H5Tunregister
@Cast("herr_t") public static int H5Tunregister(@Cast("H5T_pers_t") int pers, String name, @Cast("hid_t") long src_id, @Cast("hid_t") long dst_id, H5T_conv_t func)
-
H5Tfind
public static H5T_conv_t H5Tfind(@Cast("hid_t") long src_id, @Cast("hid_t") long dst_id, @Cast("H5T_cdata_t**") PointerPointer pcdata)
\ingroup CONV \brief Finds a conversion function \type_id{src_id} of source datatype \type_id{dst_id} of destination datatype- Parameters:
pcdata- [out] Pointer to type conversion data- Returns:
- Returns a pointer to a suitable conversion function if successful. Otherwise returns NULL. \details H5Tfind() finds a conversion function that can handle a conversion from type \p src_id to type \p dst_id. The \p pcdata argument is a pointer to a pointer to type conversion data which was created and initialized by the soft type conversion function of this path when the conversion function was installed on the path.
-
H5Tfind
public static H5T_conv_t H5Tfind(@Cast("hid_t") long src_id, @Cast("hid_t") long dst_id, @ByPtrPtr H5T_cdata_t pcdata)
-
H5Tcompiler_conv
@Cast("htri_t") public static int H5Tcompiler_conv(@Cast("hid_t") long src_id, @Cast("hid_t") long dst_id)
\ingroup CONV \brief Check whether the libraryâs default conversion is hard conversion \type_id{src_id} of source datatype \type_id{dst_id} of destination datatype- Returns:
- \htri_t \details H5Tcompiler_conv() determines whether the libraryâs conversion function from type \p src_id to type \p dst_id is a compiler (hard) conversion or not. A compiler conversion uses compilerâs casting; a library (soft) conversion uses the libraryâs own conversion function.
- Since:
- 1.8.0
-
H5Zregister
@Cast("herr_t") public static int H5Zregister(@Const Pointer cls)
\ingroup H5Z \brief Registers a new filter with the HDF5 library- Parameters:
cls- [in] A pointer to a buffer for the struct containing the filter-definition- Returns:
- \herr_t \details H5Zregister() registers a new filter with the HDF5 library. \details Making a new filter available to an application is a two-step process. The first step is to write the three filter callback functions described below: \c can_apply, \c set_local, and \c filter. This call to H5Zregister(), registering the filter with the library, is the second step. The can_apply and set_local fields can be set to NULL if they are not required for the filter being registered. H5Zregister() accepts a single parameter, a pointer to a buffer for the \p cls data structure. That data structure must conform to one of the following definitions: \snippet this H5Z_class1_t_snip or \snippet this H5Z_class2_t_snip \c version is a library-defined value reporting the version number of the #H5Z_class_t struct. This currently must be set to #H5Z_CLASS_T_VERS. \c id is the identifier for the new filter. This is a user-defined value between #H5Z_FILTER_RESERVED and #H5Z_FILTER_MAX. These values are defined in the HDF5 source file H5Zpublic.h, but the symbols #H5Z_FILTER_RESERVED and #H5Z_FILTER_MAX should always be used instead of the literal values. \c encoder_present is a library-defined value indicating whether the filterâs encoding capability is available to the application. \c decoder_present is a library-defined value indicating whether the filterâs encoding capability is available to the application. \c name is a descriptive comment used for debugging, may contain a descriptive name for the filter, and may be the null pointer. \c can_apply, described in detail below, is a user-defined callback function which determines whether the combination of the dataset creation property list values, the datatype, and the dataspace represent a valid combination to apply this filter to. \c set_local, described in detail below, is a user-defined callback function which sets any parameters that are specific to this dataset, based on the combination of the dataset creation property list values, the datatype, and the dataspace. \c filter, described in detail below, is a user-defined callback function which performs the action of the filter. The statistics associated with a filter are not reset by this function; they accumulate over the life of the library. #H5Z_class_t is a macro which maps to either H5Z_class1_t or H5Z_class2_t, depending on the needs of the application. To affect only this macro, H5Z_class_t_vers may be defined to either 1 or 2. Otherwise, it will behave in the same manner as other API compatibility macros. See API Compatibility Macros in HDF5 for more information. H5Z_class1_t matches the #H5Z_class_t structure that is used in the 1.6.x versions of the HDF5 library. H5Zregister() will automatically detect which structure type has been passed in, regardless of the mapping of the #H5Z_class_t macro. However, the application must make sure that the fields are filled in according to the correct structure definition if the macro is used to declare the structure. \Bold{The callback functions:}\n Before H5Zregister() can link a filter into an application, three callback functions must be defined as described in the HDF5 library header file H5Zpublic.h. When a filter is applied to the fractal heap for a group (e.g., when compressing group metadata) and if the can apply and set local callback functions have been defined for that filter, HDF5 passes the value -1 for all parameters for those callback functions. This is done to ensure that the filter will not be applied to groups if it relies on these parameters, as they are not applicable to group fractal heaps; to operate on group fractal heaps, a filter must be capable of operating on an opaque block of binary data. The \Emph{can apply} callback function must return a positive value for a valid combination, zero for an invalid combination, and a negative value for an error. \snippet this H5Z_can_apply_func_t_snip Before a dataset is created, the \Emph{can apply} callbacks for any filters used in the dataset creation property list are called with the dataset's dataset creation property list, \c dcpl_id, the dataset's datatype, \p type_id, and a dataspace describing a chunk, \p space_id, (for chunked dataset storage). This callback must determine whether the combination of the dataset creation property list settings, the datatype, and the dataspace represent a valid combination to which to apply this filter. For example, an invalid combination may involve the filter not operating correctly on certain datatypes, on certain datatype sizes, or on certain sizes of the chunk dataspace. If this filter is enabled through H5Pset_filter() as optional and the can apply function returns 0, the library will skip the filter in the filter pipeline. This callback can be the NULL pointer, in which case the library will assume that the filter can be applied to a dataset with any combination of dataset creation property list values, datatypes, and dataspaces. The \Emph{set local} callback function is defined as follows: \snippet this H5Z_set_local_func_t_snip After the can apply callbacks are checked for a new dataset, the \Emph{set local} callback functions for any filters used in the dataset creation property list are called. These callbacks receive \c dcpl_id, the dataset's private copy of the dataset creation property list passed in to H5Dcreate() (i.e. not the actual property list passed in to H5Dcreate()); \c type_id, the datatype identifier passed in to H5Dcreate(), which is not copied and should not be modified; and \c space_id, a dataspace describing the chunk (for chunked dataset storage), which should also not be modified. The set local callback must set any filter parameters that are specific to this dataset, based on the combination of the dataset creation property list values, the datatype, and the dataspace. For example, some filters perform different actions based on different datatypes, datatype sizes, numbers of dimensions, or dataspace sizes. The \Emph{set local} callback may be the NULL pointer, in which case, the library will assume that there are no dataset-specific settings for this filter. The \Emph{set local} callback function must return a non-negative value on success and a negative value for an error. The \Emph{filter operation} callback function, defining the filter's operation on the data, is defined as follows: \snippet this H5Z_func_t_snip The parameters \c flags, \c cd_nelmts, and \c cd_values are the same as for the function H5Pset_filter(). The one exception is that an additional flag, #H5Z_FLAG_REVERSE, is set when the filter is called as part of the input pipeline. The parameter \c buf points to the input buffer which has a size of \c buf_size bytes, \c nbytes of which are valid data. The filter should perform the transformation in place if possible. If the transformation cannot be done in place, then the filter should allocate a new buffer and assign it to \c buf, assigning the allocated size of that buffer to \c buf_size. The old buffer should be freed by the filter. Some care must be taken with the functions that allocate and free memory. Standard C library functions like malloc(3) and free(3) will work in many cases, but if there is a mismatch between the memory allocators used in the library and any filter that reallocates a buffer, there could be problems. This is most often the case with Windows and/or when debug memory allocators are being used. In both cases, the "state" of the memory allocator lies in different libraries and will get corrupted if you allocate in one library and free in another. Windows adds the C standard library via dlls that can vary with Visual Studio version and debug vs release builds. Static links to the MSVC CRT can also introduce new memory allocator state. The library does provide H5allocate_memory() and H5free_memory() functions that will use the library's allocation and free functions, however using these functions will require linking your filter to a particular version of the library, which may be inconvenient. If successful, the \Emph{filter operation} callback function returns the number of valid bytes of data contained in \c buf. In the case of failure, the return value is 0 (zero) and all pointer arguments are left unchanged.
-
H5Zunregister
@Cast("herr_t") public static int H5Zunregister(@Cast("H5Z_filter_t") int id)
\ingroup H5Z \brief Unregisters a filter.- Parameters:
id- [in] Identifier of the filter to be unregistered.- Returns:
- \herr_t \details H5Zunregister() unregisters the filter specified in \p id. \details This function first iterates through all opened datasets and groups. If an open object that uses this filter is found, the function will fail with a message indicating that an object using the filter is still open. All open files are then flushed to make sure that all cached data that may use this filter are written out. If the application is a parallel program, all processes that participate in collective data write should call this function to ensure that all data is flushed. After a call to H5Zunregister(), the filter specified in filter will no longer be available to the application.
- Since:
- 1.6.0
-
-