Functions

Setting up the Data Model
[H5hut C API]

Functions

h5_err_t H5SetStepNameFormat (h5_file_t *const f, const char *name, const h5_int64_t width)
h5_err_t H5GetStepNameFormat (h5_file_t *const f, char *name, const h5_size_t l_name, int *width)
h5_err_t H5SetStep (h5_file_t *const f, const h5_id_t step)
h5_id_t H5GetStep (h5_file_t *const f)
h5_ssize_t H5GetNumSteps (h5_file_t *const f)
h5_err_t H5StartTraverseSteps (h5_file_t *const f)
h5_err_t H5TraverseSteps (h5_file_t *const f)

Function Documentation

h5_err_t H5SetStepNameFormat ( h5_file_t *const   f,
const char *  name,
const h5_int64_t  width 
)

Define format of the step names.

Example: ==H5SetStepNameFormat( f, "Step", 6 )== defines step names like ==Step#000042==.

Returns:
H5_SUCCESS or error code
Parameters:
fHandle to file
namePrefix
widthWidth of the number
h5_err_t H5GetStepNameFormat ( h5_file_t *const   f,
char *  name,
const h5_size_t  l_name,
int *  width 
)

Get format of the step names.

Returns:
value >=0 on success
-1 on error
Parameters:
fHandle to file
nameOUT: Prefix
l_namelength of buffer name
widthOUT: Width of the number
h5_err_t H5SetStep ( h5_file_t *const   f,
const h5_id_t  step 
)

Set the current step.

Returns:
H5_SUCCESS or error code
Parameters:
[in]fHandle to open file
[in]stepStep to set.
h5_id_t H5GetStep ( h5_file_t *const   f )

Get current step.

Returns:
H5_SUCCESS or error code
Parameters:
fHandle to open file
h5_ssize_t H5GetNumSteps ( h5_file_t *const   f )

Get the number of time-steps that are currently stored in the file f.

It works for both reading and writing of files, but is probably only typically used when you are reading.

Parameters:
[in]fFile handle.
Returns:
number of time-steps or error code
h5_err_t H5StartTraverseSteps ( h5_file_t *const   f )

Start traversing steps.

Returns:
H5_SUCCESS or error code
Parameters:
fHandle to open file
h5_err_t H5TraverseSteps ( h5_file_t *const   f )

Traverse steps.

Returns:
H5_SUCCESS or error code
Parameters:
fHandle to open file