ewoksxrpd.tasks.utils.data_utils.hdf5_link_object#
- ewoksxrpd.tasks.utils.data_utils.hdf5_link_object(parent_filename, parent_name, link_name, target_filename, target_name, relative=True)[source]#
- Parameters:
parent_filename (
str
) – HDF5 filename in which the link will be createdparent_name (
str
) – absolute HDF5 group path inparent_filename
link_name (
str
) – relative HDF5 path of the link source with respect toparent_name
target_filename (
str
) – HDF5 filename in which the link target is locatedtarget_name (
str
) – absolute HDF5 path intarget_filename
of the link targetrelative (
bool
) – determines whether the external or internal link is absolute or relative. Internal links that refer upwards are not supported and will always be absolute.
- Return type:
Union
[None
,ExternalLink
,SoftLink
]- Returns:
Internal or external link object to be used to create the HDF5 link. Returns
None
when the link refers to itself.