Safe Haskell | Safe-Inferred |
---|---|
Language | Haskell2010 |
Bindings.HDF5.Raw.H5O
Synopsis
- h5o_COPY_SHALLOW_HIERARCHY_FLAG :: Num a => a
- h5o_COPY_EXPAND_SOFT_LINK_FLAG :: Num a => a
- h5o_COPY_EXPAND_EXT_LINK_FLAG :: Num a => a
- h5o_COPY_EXPAND_REFERENCE_FLAG :: Num a => a
- h5o_COPY_WITHOUT_ATTR_FLAG :: Num a => a
- h5o_COPY_PRESERVE_NULL_FLAG :: Num a => a
- h5o_COPY_MERGE_COMMITTED_DTYPE_FLAG :: Num a => a
- h5o_COPY_ALL :: Num a => a
- h5o_SHMESG_NONE_FLAG :: Num a => a
- h5o_SHMESG_SDSPACE_FLAG :: Num a => a
- h5o_SHMESG_DTYPE_FLAG :: Num a => a
- h5o_SHMESG_FILL_FLAG :: Num a => a
- h5o_SHMESG_PLINE_FLAG :: Num a => a
- h5o_SHMESG_ATTR_FLAG :: Num a => a
- h5o_SHMESG_ALL_FLAG :: Num a => a
- h5o_HDR_CHUNK0_SIZE :: Num a => a
- h5o_HDR_ATTR_CRT_ORDER_TRACKED :: Num a => a
- h5o_HDR_ATTR_CRT_ORDER_INDEXED :: Num a => a
- h5o_HDR_ATTR_STORE_PHASE_CHANGE :: Num a => a
- h5o_HDR_STORE_TIMES :: Num a => a
- h5o_HDR_ALL_FLAGS :: Num a => a
- h5o_SHMESG_MAX_NINDEXES :: Num a => a
- h5o_SHMESG_MAX_LIST_SIZE :: Num a => a
- newtype H5O_type_t = H5O_type_t Int32
- h5o_TYPE_UNKNOWN :: H5O_type_t
- h5o_TYPE_GROUP :: H5O_type_t
- h5o_TYPE_DATASET :: H5O_type_t
- h5o_TYPE_NAMED_DATATYPE :: H5O_type_t
- h5o_TYPE_NTYPES :: Num a => a
- data H5O_hdr_info_t = H5O_hdr_info_t {
- h5o_hdr_info_t'version :: CUInt
- h5o_hdr_info_t'nmesgs :: CUInt
- h5o_hdr_info_t'nchunks :: CUInt
- h5o_hdr_info_t'flags :: CUInt
- h5o_hdr_info_t'space'total :: HSize_t
- h5o_hdr_info_t'space'meta :: HSize_t
- h5o_hdr_info_t'space'mesg :: HSize_t
- h5o_hdr_info_t'space'free :: HSize_t
- h5o_hdr_info_t'mesg'present :: Word64
- h5o_hdr_info_t'mesg'shared :: Word64
- p'H5O_hdr_info_t'version :: Ptr H5O_hdr_info_t -> Ptr CUInt
- p'H5O_hdr_info_t'nmesgs :: Ptr H5O_hdr_info_t -> Ptr CUInt
- p'H5O_hdr_info_t'nchunks :: Ptr H5O_hdr_info_t -> Ptr CUInt
- p'H5O_hdr_info_t'flags :: Ptr H5O_hdr_info_t -> Ptr CUInt
- p'H5O_hdr_info_t'space'total :: Ptr H5O_hdr_info_t -> Ptr HSize_t
- p'H5O_hdr_info_t'space'meta :: Ptr H5O_hdr_info_t -> Ptr HSize_t
- p'H5O_hdr_info_t'space'mesg :: Ptr H5O_hdr_info_t -> Ptr HSize_t
- p'H5O_hdr_info_t'space'free :: Ptr H5O_hdr_info_t -> Ptr HSize_t
- p'H5O_hdr_info_t'mesg'present :: Ptr H5O_hdr_info_t -> Ptr Word64
- p'H5O_hdr_info_t'mesg'shared :: Ptr H5O_hdr_info_t -> Ptr Word64
- data H5O_info_t = H5O_info_t {
- h5o_info_t'fileno :: CULong
- h5o_info_t'addr :: HAddr_t
- h5o_info_t'type :: H5O_type_t
- h5o_info_t'rc :: CUInt
- h5o_info_t'atime :: CTime
- h5o_info_t'mtime :: CTime
- h5o_info_t'ctime :: CTime
- h5o_info_t'btime :: CTime
- h5o_info_t'num_attrs :: HSize_t
- h5o_info_t'hdr :: H5O_hdr_info_t
- h5o_info_t'meta_size'obj :: H5_ih_info_t
- h5o_info_t'meta_size'attr :: H5_ih_info_t
- newtype H5O_msg_crt_idx_t = H5O_msg_crt_idx_t Word32
- type H5O_iterate_t a = FunPtr (HId_t -> CString -> In H5O_info_t -> InOut a -> IO HErr_t)
- newtype H5O_mcdt_search_ret_t = H5O_mcdt_search_ret_t Int32
- h5o_MCDT_SEARCH_ERROR :: H5O_mcdt_search_ret_t
- h5o_MCDT_SEARCH_CONT :: H5O_mcdt_search_ret_t
- p'H5O_info_t'fileno :: Ptr H5O_info_t -> Ptr CULong
- p'H5O_info_t'addr :: Ptr H5O_info_t -> Ptr HAddr_t
- h5o_MCDT_SEARCH_STOP :: H5O_mcdt_search_ret_t
- p'H5O_info_t'type :: Ptr H5O_info_t -> Ptr H5O_type_t
- p'H5O_info_t'rc :: Ptr H5O_info_t -> Ptr CUInt
- p'H5O_info_t'atime :: Ptr H5O_info_t -> Ptr CTime
- type H5O_mcdt_search_cb_t a = FunPtr (InOut a -> IO H5O_mcdt_search_ret_t)
- p'H5O_info_t'mtime :: Ptr H5O_info_t -> Ptr CTime
- p'H5O_info_t'ctime :: Ptr H5O_info_t -> Ptr CTime
- p'H5O_info_t'btime :: Ptr H5O_info_t -> Ptr CTime
- p'H5O_info_t'num_attrs :: Ptr H5O_info_t -> Ptr HSize_t
- p'H5O_info_t'hdr :: Ptr H5O_info_t -> Ptr H5O_hdr_info_t
- p'H5O_info_t'meta_size'obj :: Ptr H5O_info_t -> Ptr H5_ih_info_t
- p'H5O_info_t'meta_size'attr :: Ptr H5O_info_t -> Ptr H5_ih_info_t
- h5o_open :: HId_t -> CString -> HId_t -> IO HId_t
- p_H5Oopen :: FunPtr (HId_t -> CString -> HId_t -> IO HId_t)
- h5o_open_by_addr :: HId_t -> HAddr_t -> IO HId_t
- p_H5Oopen_by_addr :: FunPtr (HId_t -> HAddr_t -> IO HId_t)
- h5o_open_by_idx :: HId_t -> CString -> H5_index_t -> H5_iter_order_t -> HSize_t -> HId_t -> IO HId_t
- p_H5Oopen_by_idx :: FunPtr (HId_t -> CString -> H5_index_t -> H5_iter_order_t -> HSize_t -> HId_t -> IO HId_t)
- h5o_exists_by_name :: HId_t -> CString -> HId_t -> IO HTri_t
- p_H5Oexists_by_name :: FunPtr (HId_t -> CString -> HId_t -> IO HTri_t)
- h5o_get_info :: HId_t -> Out H5O_info_t -> IO HErr_t
- p_H5Oget_info :: FunPtr (HId_t -> Out H5O_info_t -> IO HErr_t)
- h5o_get_info_by_name :: HId_t -> CString -> Out H5O_info_t -> HId_t -> IO HErr_t
- p_H5Oget_info_by_name :: FunPtr (HId_t -> CString -> Out H5O_info_t -> HId_t -> IO HErr_t)
- h5o_get_info_by_idx :: HId_t -> CString -> H5_index_t -> H5_iter_order_t -> HSize_t -> Out H5O_info_t -> HId_t -> IO HErr_t
- p_H5Oget_info_by_idx :: FunPtr (HId_t -> CString -> H5_index_t -> H5_iter_order_t -> HSize_t -> Out H5O_info_t -> HId_t -> IO HErr_t)
- h5o_link :: HId_t -> HId_t -> CString -> HId_t -> HId_t -> IO HErr_t
- p_H5Olink :: FunPtr (HId_t -> HId_t -> CString -> HId_t -> HId_t -> IO HErr_t)
- h5o_incr_refcount :: HId_t -> IO HErr_t
- p_H5Oincr_refcount :: FunPtr (HId_t -> IO HErr_t)
- h5o_decr_refcount :: HId_t -> IO HErr_t
- p_H5Odecr_refcount :: FunPtr (HId_t -> IO HErr_t)
- h5o_copy :: HId_t -> CString -> HId_t -> CString -> HId_t -> HId_t -> IO HErr_t
- p_H5Ocopy :: FunPtr (HId_t -> CString -> HId_t -> CString -> HId_t -> HId_t -> IO HErr_t)
- h5o_set_comment :: HId_t -> CString -> IO HErr_t
- p_H5Oset_comment :: FunPtr (HId_t -> CString -> IO HErr_t)
- h5o_set_comment_by_name :: HId_t -> CString -> CString -> HId_t -> IO HErr_t
- p_H5Oset_comment_by_name :: FunPtr (HId_t -> CString -> CString -> HId_t -> IO HErr_t)
- h5o_get_comment :: HId_t -> OutArray CChar -> CSize -> IO CSSize
- p_H5Oget_comment :: FunPtr (HId_t -> OutArray CChar -> CSize -> IO CSSize)
- h5o_get_comment_by_name :: HId_t -> CString -> OutArray CChar -> CSize -> HId_t -> IO CSSize
- p_H5Oget_comment_by_name :: FunPtr (HId_t -> CString -> OutArray CChar -> CSize -> HId_t -> IO CSSize)
- h5o_visit :: HId_t -> H5_index_t -> H5_iter_order_t -> H5O_iterate_t a -> InOut a -> IO HErr_t
- p_H5Ovisit :: FunPtr (HId_t -> H5_index_t -> H5_iter_order_t -> H5O_iterate_t a -> InOut a -> IO HErr_t)
- h5o_visit_by_name :: HId_t -> CString -> H5_index_t -> H5_iter_order_t -> H5O_iterate_t a -> InOut a -> HId_t -> IO HErr_t
- p_H5Ovisit_by_name :: FunPtr (HId_t -> CString -> H5_index_t -> H5_iter_order_t -> H5O_iterate_t a -> InOut a -> HId_t -> IO HErr_t)
- h5o_close :: HId_t -> IO HErr_t
- p_H5Oclose :: FunPtr (HId_t -> IO HErr_t)
- h5o_flush :: HId_t -> IO HErr_t
- p_H5Oflush :: FunPtr (HId_t -> IO HErr_t)
- h5o_refresh :: HId_t -> IO HErr_t
- p_H5Orefresh :: FunPtr (HId_t -> IO HErr_t)
- h5o_disable_mdc_flushes :: HId_t -> IO HErr_t
- p_H5Odisable_mdc_flushes :: FunPtr (HId_t -> IO HErr_t)
- h5o_enable_mdc_flushes :: HId_t -> IO HErr_t
- p_H5Oenable_mdc_flushes :: FunPtr (HId_t -> IO HErr_t)
- h5o_are_mdc_flushes_disabled :: HId_t -> Out hbool_t -> IO HErr_t
- p_H5Oare_mdc_flushes_disabled :: FunPtr (HId_t -> Out hbool_t -> IO HErr_t)
- data H5O_stat_t = H5O_stat_t {}
- p'H5O_stat_t'size :: Ptr H5O_stat_t -> Ptr HSize_t
- p'H5O_stat_t'free :: Ptr H5O_stat_t -> Ptr HSize_t
- p'H5O_stat_t'nmesgs :: Ptr H5O_stat_t -> Ptr CUInt
- p'H5O_stat_t'nchunks :: Ptr H5O_stat_t -> Ptr CUInt
Constants
Flags for object copy (h5o_copy
)
h5o_COPY_SHALLOW_HIERARCHY_FLAG :: Num a => a Source #
Copy only immediate members
h5o_COPY_EXPAND_SOFT_LINK_FLAG :: Num a => a Source #
Expand soft links into new objects
h5o_COPY_EXPAND_EXT_LINK_FLAG :: Num a => a Source #
Expand external links into new objects
h5o_COPY_EXPAND_REFERENCE_FLAG :: Num a => a Source #
Copy objects that are pointed by references
h5o_COPY_WITHOUT_ATTR_FLAG :: Num a => a Source #
Copy object without copying attributes
h5o_COPY_PRESERVE_NULL_FLAG :: Num a => a Source #
Copy NULL messages (empty space)
h5o_COPY_MERGE_COMMITTED_DTYPE_FLAG :: Num a => a Source #
Merge committed datatypes in dest file
h5o_COPY_ALL :: Num a => a Source #
All object copying flags (for internal checking)
Flags for shared message indexes
h5o_SHMESG_NONE_FLAG :: Num a => a Source #
No shared messages
h5o_SHMESG_SDSPACE_FLAG :: Num a => a Source #
Simple Dataspace Message
h5o_SHMESG_DTYPE_FLAG :: Num a => a Source #
Datatype Message
h5o_SHMESG_FILL_FLAG :: Num a => a Source #
Fill Value Message
h5o_SHMESG_PLINE_FLAG :: Num a => a Source #
Filter pipeline message
h5o_SHMESG_ATTR_FLAG :: Num a => a Source #
Attribute Message
h5o_SHMESG_ALL_FLAG :: Num a => a Source #
Object header status flag definitions
h5o_HDR_CHUNK0_SIZE :: Num a => a Source #
2-bit field indicating # of bytes to store the size of chunk 0's data
h5o_HDR_ATTR_CRT_ORDER_TRACKED :: Num a => a Source #
Attribute creation order is tracked
h5o_HDR_ATTR_CRT_ORDER_INDEXED :: Num a => a Source #
Attribute creation order has index
h5o_HDR_ATTR_STORE_PHASE_CHANGE :: Num a => a Source #
Non-default attribute storage phase change values stored
h5o_HDR_STORE_TIMES :: Num a => a Source #
Store access, modification, change & birth times for object
h5o_HDR_ALL_FLAGS :: Num a => a Source #
Maximum shared message values
h5o_SHMESG_MAX_NINDEXES :: Num a => a Source #
h5o_SHMESG_MAX_LIST_SIZE :: Num a => a Source #
Types
newtype H5O_type_t Source #
Types of objects in file
Constructors
H5O_type_t Int32 |
Instances
Storable H5O_type_t Source # | |
Defined in Bindings.HDF5.Raw.H5O Methods sizeOf :: H5O_type_t -> Int Source # alignment :: H5O_type_t -> Int Source # peekElemOff :: Ptr H5O_type_t -> Int -> IO H5O_type_t Source # pokeElemOff :: Ptr H5O_type_t -> Int -> H5O_type_t -> IO () Source # peekByteOff :: Ptr b -> Int -> IO H5O_type_t Source # pokeByteOff :: Ptr b -> Int -> H5O_type_t -> IO () Source # peek :: Ptr H5O_type_t -> IO H5O_type_t Source # poke :: Ptr H5O_type_t -> H5O_type_t -> IO () Source # | |
Show H5O_type_t Source # | |
Defined in Bindings.HDF5.Raw.H5O | |
Eq H5O_type_t Source # | |
Defined in Bindings.HDF5.Raw.H5O Methods (==) :: H5O_type_t -> H5O_type_t -> Bool Source # (/=) :: H5O_type_t -> H5O_type_t -> Bool Source # |
h5o_TYPE_UNKNOWN :: H5O_type_t Source #
Unknown object type
h5o_TYPE_GROUP :: H5O_type_t Source #
Object is a group
h5o_TYPE_DATASET :: H5O_type_t Source #
Object is a dataset
h5o_TYPE_NAMED_DATATYPE :: H5O_type_t Source #
Object is a named data type
h5o_TYPE_NTYPES :: Num a => a Source #
Number of different object types
data H5O_hdr_info_t Source #
Information struct for object header metadata
(for h5o_get_info
h5o_get_info_by_name
h5o_get_info_by_idx
)
Version number of header format in file
Number of object header messages
Number of object header chunks
Object header status flags
Total space for storing object header in file
Space within header for object header metadata information
Space within header for actual message information
Free space within object header
Flags to indicate presence of message type in header
Flags to indicate message type is shared in header
Constructors
Instances
Storable H5O_hdr_info_t Source # | # of attributes attached to object |
Defined in Bindings.HDF5.Raw.H5O Methods sizeOf :: H5O_hdr_info_t -> Int Source # alignment :: H5O_hdr_info_t -> Int Source # peekElemOff :: Ptr H5O_hdr_info_t -> Int -> IO H5O_hdr_info_t Source # pokeElemOff :: Ptr H5O_hdr_info_t -> Int -> H5O_hdr_info_t -> IO () Source # peekByteOff :: Ptr b -> Int -> IO H5O_hdr_info_t Source # pokeByteOff :: Ptr b -> Int -> H5O_hdr_info_t -> IO () Source # peek :: Ptr H5O_hdr_info_t -> IO H5O_hdr_info_t Source # poke :: Ptr H5O_hdr_info_t -> H5O_hdr_info_t -> IO () Source # | |
Show H5O_hdr_info_t Source # | |
Defined in Bindings.HDF5.Raw.H5O | |
Eq H5O_hdr_info_t Source # | |
Defined in Bindings.HDF5.Raw.H5O Methods (==) :: H5O_hdr_info_t -> H5O_hdr_info_t -> Bool Source # (/=) :: H5O_hdr_info_t -> H5O_hdr_info_t -> Bool Source # |
p'H5O_hdr_info_t'version :: Ptr H5O_hdr_info_t -> Ptr CUInt Source #
Information struct for object
(for h5o_get_info
h5o_get_info_by_name
h5o_get_info_by_idx
)
File number that object is located in
Object address in file
p'H5O_hdr_info_t'nmesgs :: Ptr H5O_hdr_info_t -> Ptr CUInt Source #
Basic object type (group, dataset, etc.)
p'H5O_hdr_info_t'nchunks :: Ptr H5O_hdr_info_t -> Ptr CUInt Source #
Reference count of object
p'H5O_hdr_info_t'space'total :: Ptr H5O_hdr_info_t -> Ptr HSize_t Source #
Access time
p'H5O_hdr_info_t'space'meta :: Ptr H5O_hdr_info_t -> Ptr HSize_t Source #
Modification time
p'H5O_hdr_info_t'space'free :: Ptr H5O_hdr_info_t -> Ptr HSize_t Source #
Change time
p'H5O_hdr_info_t'mesg'present :: Ptr H5O_hdr_info_t -> Ptr Word64 Source #
Birth time
data H5O_info_t Source #
Object header information
v1v2 B-tree & localfractal heap for groups, B-tree for chunked datasets
v2 B-tree & heap for attributes
Constructors
Instances
Storable H5O_info_t Source # | |
Defined in Bindings.HDF5.Raw.H5O Methods sizeOf :: H5O_info_t -> Int Source # alignment :: H5O_info_t -> Int Source # peekElemOff :: Ptr H5O_info_t -> Int -> IO H5O_info_t Source # pokeElemOff :: Ptr H5O_info_t -> Int -> H5O_info_t -> IO () Source # peekByteOff :: Ptr b -> Int -> IO H5O_info_t Source # pokeByteOff :: Ptr b -> Int -> H5O_info_t -> IO () Source # peek :: Ptr H5O_info_t -> IO H5O_info_t Source # poke :: Ptr H5O_info_t -> H5O_info_t -> IO () Source # | |
Show H5O_info_t Source # | |
Defined in Bindings.HDF5.Raw.H5O | |
Eq H5O_info_t Source # | |
Defined in Bindings.HDF5.Raw.H5O Methods (==) :: H5O_info_t -> H5O_info_t -> Bool Source # (/=) :: H5O_info_t -> H5O_info_t -> Bool Source # |
newtype H5O_msg_crt_idx_t Source #
Typedef for message creation indexes
Constructors
H5O_msg_crt_idx_t Word32 |
Instances
type H5O_iterate_t a = FunPtr (HId_t -> CString -> In H5O_info_t -> InOut a -> IO HErr_t) Source #
Prototype for h5o_visit
/ h5o_visit_by_name
operator
newtype H5O_mcdt_search_ret_t Source #
Constructors
H5O_mcdt_search_ret_t Int32 |
Instances
Storable H5O_mcdt_search_ret_t Source # | |
Defined in Bindings.HDF5.Raw.H5O Methods sizeOf :: H5O_mcdt_search_ret_t -> Int Source # alignment :: H5O_mcdt_search_ret_t -> Int Source # peekElemOff :: Ptr H5O_mcdt_search_ret_t -> Int -> IO H5O_mcdt_search_ret_t Source # pokeElemOff :: Ptr H5O_mcdt_search_ret_t -> Int -> H5O_mcdt_search_ret_t -> IO () Source # peekByteOff :: Ptr b -> Int -> IO H5O_mcdt_search_ret_t Source # pokeByteOff :: Ptr b -> Int -> H5O_mcdt_search_ret_t -> IO () Source # peek :: Ptr H5O_mcdt_search_ret_t -> IO H5O_mcdt_search_ret_t Source # poke :: Ptr H5O_mcdt_search_ret_t -> H5O_mcdt_search_ret_t -> IO () Source # | |
Show H5O_mcdt_search_ret_t Source # | |
Defined in Bindings.HDF5.Raw.H5O |
h5o_MCDT_SEARCH_ERROR :: H5O_mcdt_search_ret_t Source #
Abort H5Ocopy
h5o_MCDT_SEARCH_CONT :: H5O_mcdt_search_ret_t Source #
Continue the global search of all committed datatypes in the destination file
p'H5O_info_t'fileno :: Ptr H5O_info_t -> Ptr CULong Source #
p'H5O_info_t'addr :: Ptr H5O_info_t -> Ptr HAddr_t Source #
p'H5O_info_t'type :: Ptr H5O_info_t -> Ptr H5O_type_t Source #
Stop the search, but continue copying. The committed datatype will be copied but not merged.
p'H5O_info_t'rc :: Ptr H5O_info_t -> Ptr CUInt Source #
Callback to invoke when completing the search for a matching committed datatype from the committed dtype list
typedef H5O_mcdt_search_ret_t (*H5O_mcdt_search_cb_t)(void *op_data);
p'H5O_info_t'atime :: Ptr H5O_info_t -> Ptr CTime Source #
type H5O_mcdt_search_cb_t a = FunPtr (InOut a -> IO H5O_mcdt_search_ret_t) Source #
Functions
p'H5O_info_t'mtime :: Ptr H5O_info_t -> Ptr CTime Source #
p'H5O_info_t'ctime :: Ptr H5O_info_t -> Ptr CTime Source #
p'H5O_info_t'btime :: Ptr H5O_info_t -> Ptr CTime Source #
Opens an object within an HDF5 file.
This function opens an object in the same way that h5g_open2
,
h5t_open2
, and h5d_open2
do. However, h5o_open
doesn't require
the type of object to be known beforehand. This can be
useful in user-defined links, for instance, when only a
path is known.
The opened object should be closed again with h5o_close
or h5g_close
, h5t_close
, or h5d_close
.
On success, returns an open object identifier On failure, returns a negative value.
hid_t H5Oopen(hid_t loc_id, const char *name, hid_t lapl_id);
h5o_open_by_addr :: HId_t -> HAddr_t -> IO HId_t Source #
Warning! This function is EXTREMELY DANGEROUS!
Improper use can lead to FILE CORRUPTION, INACCESSIBLE DATA, and other VERY BAD THINGS!
This function opens an object using its address within the
HDF5 file, similar to an HDF5 hard link. The open object
is identical to an object opened with h5o_open
and should
be closed with h5o_close
or a type-specific closing
function (such as h5g_close
).
This function is very dangerous if called on an invalid
address. For this reason, h5o_incr_refcount
should be
used to prevent HDF5 from deleting any object that is
referenced by address (e.g. by a user-defined link).
h5o_decr_refcount
should be used when the object is
no longer being referenced by address (e.g. when the UD link
is deleted).
The address of the HDF5 file on disk has no effect on
h5o_open_by_addr
, nor does the use of any unusual file
drivers. The "address" is really the offset within the
HDF5 file, and HDF5's file drivers will transparently
map this to an address on disk for the filesystem.
On success, returns an open object identifier On failure, returns a negative value.
hid_t H5Oopen_by_addr(hid_t loc_id, haddr_t addr);
h5o_open_by_idx :: HId_t -> CString -> H5_index_t -> H5_iter_order_t -> HSize_t -> HId_t -> IO HId_t Source #
Opens an object within an HDF5 file, according to the offset within an index.
This function opens an object in the same way that h5g_open
,
h5t_open
, and h5d_open
do. However, h5o_open
doesn't require
the type of object to be known beforehand. This can be
useful in user-defined links, for instance, when only a
path is known.
The opened object should be closed again with h5o_close
or h5g_close
, h5t_close
, or h5d_close
.
On success, returns an open object identifier On failure, returns a negative value.
hid_t H5Oopen_by_idx(hid_t loc_id, const char *group_name, H5_index_t idx_type, H5_iter_order_t order, hsize_t n, hid_t lapl_id);
p_H5Oopen_by_idx :: FunPtr (HId_t -> CString -> H5_index_t -> H5_iter_order_t -> HSize_t -> HId_t -> IO HId_t) Source #
h5o_exists_by_name :: HId_t -> CString -> HId_t -> IO HTri_t Source #
Determine if a linked-to object exists
htri_t H5Oexists_by_name(hid_t loc_id, const char *name, hid_t lapl_id);
h5o_get_info :: HId_t -> Out H5O_info_t -> IO HErr_t Source #
Retrieve information about an object.
Returns non-negative on success, negative on failure.
herr_t H5Oget_info(hid_t loc_id, H5O_info_t *oinfo);
p_H5Oget_info :: FunPtr (HId_t -> Out H5O_info_t -> IO HErr_t) Source #
h5o_get_info_by_name :: HId_t -> CString -> Out H5O_info_t -> HId_t -> IO HErr_t Source #
Retrieve information about an object.
Returns non-negative on success, negative on failure.
herr_t H5Oget_info_by_name(hid_t loc_id, const char *name, H5O_info_t *oinfo, hid_t lapl_id);
h5o_get_info_by_idx :: HId_t -> CString -> H5_index_t -> H5_iter_order_t -> HSize_t -> Out H5O_info_t -> HId_t -> IO HErr_t Source #
Retrieve information about an object, according to the order of an index.
Returns non-negative on success, negative on failure.
herr_t H5Oget_info_by_idx(hid_t loc_id, const char *group_name, H5_index_t idx_type, H5_iter_order_t order, hsize_t n, H5O_info_t *oinfo, hid_t lapl_id);
p_H5Oget_info_by_idx :: FunPtr (HId_t -> CString -> H5_index_t -> H5_iter_order_t -> HSize_t -> Out H5O_info_t -> HId_t -> IO HErr_t) Source #
h5o_link :: HId_t -> HId_t -> CString -> HId_t -> HId_t -> IO HErr_t Source #
Creates a hard link from new_name
to the object specified
by obj_id
using properties defined in the Link Creation
Property List lcpl
.
This function should be used to link objects that have just been created.
new_name
is interpreted relative to new_loc_id
, which
is either a file ID or a group ID.
Returns non-negative on success, negative on failure.
herr_t H5Olink(hid_t obj_id, hid_t new_loc_id, const char *new_name, hid_t lcpl_id, hid_t lapl_id);
h5o_incr_refcount :: HId_t -> IO HErr_t Source #
Warning! This function is EXTREMELY DANGEROUS! Improper use can lead to FILE CORRUPTION, INACCESSIBLE DATA, and other VERY BAD THINGS!
This function increments the "hard link" reference count
for an object. It should be used when a user-defined link
that references an object by address is created. When the
link is deleted, h5o_decr_refcount
should be used.
Returns non-negative on success, negative on failure.
herr_t H5Oincr_refcount(hid_t object_id);
h5o_decr_refcount :: HId_t -> IO HErr_t Source #
Warning! This function is EXTREMELY DANGEROUS! Improper use can lead to FILE CORRUPTION, INACCESSIBLE DATA, and other VERY BAD THINGS!
This function decrements the "hard link" reference count
for an object. It should be used when user-defined links
that reference an object by address are deleted, and only
after h5o_incr_refcount
has already been used.
Returns non-negative on success, negative on failure.
herr_t H5Odecr_refcount(hid_t object_id);
h5o_copy :: HId_t -> CString -> HId_t -> CString -> HId_t -> HId_t -> IO HErr_t Source #
Copy an object (group or dataset) to destination location
within a file or cross files. plist_id
is a property list
which is used to pass user options and properties to the
copy. The name, dst_name
, must not already be taken by some
other object in the destination group.
h5o_copy
will fail if the name of the destination object
exists in the destination group. For example,
H5Ocopy(fid_src, "dset", fid_dst, "dset", ...)
will fail if "/dset" exists in the destination file
OPTIONS THAT HAVE BEEN IMPLEMENTED:
h5o_COPY_SHALLOW_HIERARCHY_FLAG
- If this flag is specified, only immediate members of the group are copied. Otherwise (default), it will recursively copy all objects below the group
h5o_COPY_EXPAND_SOFT_LINK_FLAG
- If this flag is specified, it will copy the objects pointed by the soft links. Otherwise (default), it will copy the soft link as they are
h5o_COPY_WITHOUT_ATTR_FLAG
- If this flag is specified, it will copy object without copying attributes. Otherwise (default), it will copy object along with all its attributes
h5o_COPY_EXPAND_REFERENCE_FLAG
- 1. Copy object between two different files:
When this flag is specified, it will copy objects that
are pointed by the references and update the values of
references in the destination file. Otherwise (default)
the values of references in the destination will set to
zero
The current implementation does not handle references
inside of other datatype structure. For example, if
a member of compound datatype is reference, H5Ocopy()
will copy that field as it is. It will not set the
value to zero as default is used nor copy the object
pointed by that field the flag is set
2. Copy object within the same file:
This flag does not have any effect to the
h5o_copy
. Datasets or attributes of references are copied as they are, i.e. values of references of the destination object are the same as the values of the source object
OPTIONS THAT MAY APPLY TO COPY IN THE FUTURE:
h5o_COPY_EXPAND_EXT_LINK_FLAG
- If this flag is specified, it will expand the external links into new objects, Otherwise (default), it will keep external links as they are (default)
PROPERTIES THAT MAY APPLY TO COPY IN FUTURE:
- Change data layout such as chunk size
- Add filter such as data compression.
- Add an attribute to the copied object(s) that say the date/time for the copy or other information about the source file.
The intermediate group creation property should be passed in using the lcpl instead of the ocpypl.
Parameters:
src_loc_id :: HId_t
- Source file or group identifier.
src_name :: CString
- Name of the source object to be copied
dst_loc_id :: HId_t
- Destination file or group identifier
dst_name :: CString
- Name of the destination object
ocpypl_id :: HId_t
- Properties which apply to the copy
lcpl_id :: HId_t
- Properties which apply to the new hard link
Returns non-negative on success, negative on failure.
herr_t H5Ocopy(hid_t src_loc_id, const char *src_name, hid_t dst_loc_id, const char *dst_name, hid_t ocpypl_id, hid_t lcpl_id);
h5o_set_comment :: HId_t -> CString -> IO HErr_t Source #
Gives the specified object a comment. The comment
string
should be a null terminated string. An object can have only
one comment at a time. Passing NULL for the comment
argument
will remove the comment property from the object.
Returns non-negative on success, negative on failure.
herr_t H5Oset_comment(hid_t obj_id, const char *comment);
h5o_set_comment_by_name :: HId_t -> CString -> CString -> HId_t -> IO HErr_t Source #
Gives the specified object a comment. The comment
string
should be a null terminated string. An object can have only
one comment at a time. Passing NULL for the comment
argument
will remove the comment property from the object.
Note: Deprecated in favor of using attributes on objects.
Returns non-negative on success, negative on failure.
herr_t H5Oset_comment_by_name(hid_t loc_id, const char *name, const char *comment, hid_t lapl_id);
h5o_get_comment :: HId_t -> OutArray CChar -> CSize -> IO CSSize Source #
Retrieve comment for an object.
On success, returns the number of bytes in the comment including the null terminator, or zero if the object has no comment. On failure returns a negative value.
ssize_t H5Oget_comment(hid_t obj_id, char *comment, size_t bufsize);
h5o_get_comment_by_name :: HId_t -> CString -> OutArray CChar -> CSize -> HId_t -> IO CSSize Source #
Retrieve comment for an object.
On success, returns the number of bytes in the comment including the null terminator, or zero if the object has no comment. On failure returns a negative value.
ssize_t H5Oget_comment_by_name(hid_t loc_id, const char *name, char *comment, size_t bufsize, hid_t lapl_id);
p_H5Oget_comment_by_name :: FunPtr (HId_t -> CString -> OutArray CChar -> CSize -> HId_t -> IO CSSize) Source #
h5o_visit :: HId_t -> H5_index_t -> H5_iter_order_t -> H5O_iterate_t a -> InOut a -> IO HErr_t Source #
Recursively visit an object and all the objects reachable from it. If the starting object is a group, all the objects linked to from that group will be visited. Links within each group are visited according to the order within the specified index (unless the specified index does not exist for a particular group, then the "name" index is used).
NOTE: Soft links and user-defined links are ignored during this operation.
NOTE: Each _object_ reachable from the initial group will only be visited once. If multiple hard links point to the same object, the first link to the object's path (according to the iteration index and iteration order given) will be used to in the callback about the object.
On success, returns the return value of the first operator that returns non-zero, or zero if all members were processed with no operator returning non-zero.
Returns negative if something goes wrong within the library, or the negative value returned by one of the operators.
herr_t H5Ovisit(hid_t obj_id, H5_index_t idx_type, H5_iter_order_t order, H5O_iterate_t op, void *op_data);
p_H5Ovisit :: FunPtr (HId_t -> H5_index_t -> H5_iter_order_t -> H5O_iterate_t a -> InOut a -> IO HErr_t) Source #
h5o_visit_by_name :: HId_t -> CString -> H5_index_t -> H5_iter_order_t -> H5O_iterate_t a -> InOut a -> HId_t -> IO HErr_t Source #
Recursively visit an object and all the objects reachable from it. If the starting object is a group, all the objects linked to from that group will be visited. Links within each group are visited according to the order within the specified index (unless the specified index does not exist for a particular group, then the "name" index is used).
NOTE: Soft links and user-defined links are ignored during this operation.
NOTE: Each _object_ reachable from the initial group will only be visited once. If multiple hard links point to the same object, the first link to the object's path (according to the iteration index and iteration order given) will be used to in the callback about the object.
On success, returns the return value of the first operator that returns non-zero, or zero if all members were processed with no operator returning non-zero.
Returns negative if something goes wrong within the library, or the negative value returned by one of the operators.
herr_t H5Ovisit_by_name(hid_t loc_id, const char *obj_name, H5_index_t idx_type, H5_iter_order_t order, H5O_iterate_t op, void *op_data, hid_t lapl_id);
p_H5Ovisit_by_name :: FunPtr (HId_t -> CString -> H5_index_t -> H5_iter_order_t -> H5O_iterate_t a -> InOut a -> HId_t -> IO HErr_t) Source #
h5o_close :: HId_t -> IO HErr_t Source #
Close an open file object.
This is the companion to h5o_open
. It is used to close any
open object in an HDF5 file (but not IDs are that not file
objects, such as property lists and dataspaces). It has
the same effect as calling h5g_close
, h5d_close
, or h5t_close
.
Returns non-negative on success, negative on failure.
herr_t H5Oclose(hid_t object_id);
Deprecated types
data H5O_stat_t Source #
A struct that's part of the h5g_stat_t
routine (deprecated)
Total size of object header in file
Free space within object header
Number of object header messages
Number of object header chunks
Constructors
H5O_stat_t | |
Fields |
Instances
Storable H5O_stat_t Source # | |
Defined in Bindings.HDF5.Raw.H5O Methods sizeOf :: H5O_stat_t -> Int Source # alignment :: H5O_stat_t -> Int Source # peekElemOff :: Ptr H5O_stat_t -> Int -> IO H5O_stat_t Source # pokeElemOff :: Ptr H5O_stat_t -> Int -> H5O_stat_t -> IO () Source # peekByteOff :: Ptr b -> Int -> IO H5O_stat_t Source # pokeByteOff :: Ptr b -> Int -> H5O_stat_t -> IO () Source # peek :: Ptr H5O_stat_t -> IO H5O_stat_t Source # poke :: Ptr H5O_stat_t -> H5O_stat_t -> IO () Source # | |
Show H5O_stat_t Source # | |
Defined in Bindings.HDF5.Raw.H5O | |
Eq H5O_stat_t Source # | |
Defined in Bindings.HDF5.Raw.H5O Methods (==) :: H5O_stat_t -> H5O_stat_t -> Bool Source # (/=) :: H5O_stat_t -> H5O_stat_t -> Bool Source # |
p'H5O_stat_t'size :: Ptr H5O_stat_t -> Ptr HSize_t Source #
p'H5O_stat_t'free :: Ptr H5O_stat_t -> Ptr HSize_t Source #
p'H5O_stat_t'nmesgs :: Ptr H5O_stat_t -> Ptr CUInt Source #
p'H5O_stat_t'nchunks :: Ptr H5O_stat_t -> Ptr CUInt Source #