_static/doxygen/hdf5__helpers_8h_source.html

#ifndef HDF5_HELPERS_H

#define HDF5_HELPERS_H


#include <hdf5.h>

#include "../ascot5.h"


void hdf5_init(void);

hid_t hdf5_create(const char* filename);

hid_t hdf5_open(const char* filename);

hid_t hdf5_open_ro(const char* filename);

herr_t hdf5_close(hid_t file_id);

hid_t hdf5_create_group(hid_t loc, const char* path);

herr_t hdf5_find_group(hid_t loc, const char* path);

char* hdf5_generate_qid_path(const char* original, char* qid, char* path);

char* hdf5_gen_path(const char* original, char* qid, char* path);

int hdf5_read_double(const char* var, real* ptr, hid_t file, char* qid,

                     const char* errfile, int errline);

int hdf5_read_int(const char* var, int* ptr, hid_t file, char* qid,

                  const char* errfile, int errline);

int hdf5_read_long(const char* var, long* ptr, hid_t file, char* qid,

                   const char* errfile, int errline);

herr_t  hdf5_write_string_attribute(hid_t loc, const char* path,

                                    const char* attrname,  const char* string);

herr_t hdf5_write_extendible_dataset_double(hid_t group,

                                            const char* datasetname,

                                            int length, double* data);

herr_t hdf5_write_extendible_dataset_long(hid_t group,

                                          const char* datasetname,

                                          int length, long* data);

herr_t hdf5_write_extendible_dataset_int(hid_t group,

                                         const char* datasetname,

                                         int length, int* data);


#endif

ascot5.h
Main header file for ASCOT5.

real
double real
Definition ascot5.h:85

hdf5_create_group
hid_t hdf5_create_group(hid_t loc, const char *path)
Create a group (with parent groups if necessary). Returns a handle to the group. Negative on failure.
Definition hdf5_helpers.c:66

hdf5_write_string_attribute
herr_t hdf5_write_string_attribute(hid_t loc, const char *path, const char *attrname, const char *string)
Write string attribute with null-padding.
Definition hdf5_helpers.c:254

hdf5_find_group
herr_t hdf5_find_group(hid_t loc, const char *path)
Checks if given group exists within given hdf5 file. Negative value is returned if the group doesn't ...
Definition hdf5_helpers.c:100

hdf5_write_extendible_dataset_long
herr_t hdf5_write_extendible_dataset_long(hid_t group, const char *datasetname, int length, long *data)
Create and write to an extendible dataset for long data.
Definition hdf5_helpers.c:329

hdf5_write_extendible_dataset_int
herr_t hdf5_write_extendible_dataset_int(hid_t group, const char *datasetname, int length, int *data)
Create and write to an extendible dataset int data.
Definition hdf5_helpers.c:362

hdf5_read_double
int hdf5_read_double(const char *var, real *ptr, hid_t file, char *qid, const char *errfile, int errline)
Read double-valued data from ASCOT5 HDF5 file.
Definition hdf5_helpers.c:166

hdf5_read_long
int hdf5_read_long(const char *var, long *ptr, hid_t file, char *qid, const char *errfile, int errline)
Read long-valued data from ASCOT5 HDF5 file.
Definition hdf5_helpers.c:236

hdf5_create
hid_t hdf5_create(const char *filename)
Create an hdf5 file, fail if file exists. A negative value is returned on failure.
Definition hdf5_helpers.c:26

hdf5_close
herr_t hdf5_close(hid_t file_id)
Close access to given hdf5 file identifier. A negative value is returned on failure.
Definition hdf5_helpers.c:56

hdf5_gen_path
char * hdf5_gen_path(const char *original, char *qid, char *path)
Generate a valid path from a given template and qid.
Definition hdf5_helpers.c:131

hdf5_init
void hdf5_init(void)
Initialize hdf5, right now just disables automatic error messages.
Definition hdf5_helpers.c:18

hdf5_open_ro
hid_t hdf5_open_ro(const char *filename)
Open a hdf5 file for read only. A negative value is returned on failure.
Definition hdf5_helpers.c:46

hdf5_write_extendible_dataset_double
herr_t hdf5_write_extendible_dataset_double(hid_t group, const char *datasetname, int length, double *data)
Create and write to an extendible dataset for double data.
Definition hdf5_helpers.c:295

hdf5_open
hid_t hdf5_open(const char *filename)
Open a hdf5 file for reading and writing. A negative value is returned on failure.
Definition hdf5_helpers.c:36

hdf5_read_int
int hdf5_read_int(const char *var, int *ptr, hid_t file, char *qid, const char *errfile, int errline)
Read int-valued data from ASCOT5 HDF5 file.
Definition hdf5_helpers.c:201

hdf5_generate_qid_path
char * hdf5_generate_qid_path(const char *original, char *qid, char *path)
Generate a valid path from a given template and qid.
Definition hdf5_helpers.c:112