Common functions for working with an HDF5 file through the HL-HDF API. More...

#include <hdf5.h>
#include "hlhdf_types.h"
#include "hlhdf_node.h"
#include "hlhdf_nodelist.h"
#include "hlhdf_read.h"
#include "hlhdf_write.h"
#include "hlhdf_compound.h"

Macros
#define	FALSE 0
	Define for FALSE unless it already has been defined.

#define	TRUE 1
	Define for TRUE unless it already has been defined.

Functions
void	HL_disableErrorReporting (void)
	Disables error reporting.

void	HL_enableErrorReporting (void)
	Enables error reporting.

int	HL_isErrorReportingEnabled (void)
	Returns if error reporting is enabled or not.

void	HL_init (void)
	Initializes the HLHDF handler functions.

void	HL_setDebugMode (int flag)
	Toggles the debug mode for HLHDF.

int	HL_isHDF5File (const char *filename)
	Verifies if the provided filename is a valid HDF5 file or not.

HL_FileCreationProperty *	HLFileCreationProperty_new (void)
	Creates a file property instance that can be passed on to createHlHdfFile when creating a HDF5 file.

void	HLFileCreationProperty_free (HL_FileCreationProperty *prop)
	Deallocates the HL_FileCreationProperty instance.

int	HL_sizeOfFormat (const char *format)
	Calculates the size in bytes of the provided format specifiers.

int	HL_isFormatSupported (const char *format)
	Verifies if the format name is supported by HLHDF.

HL_FormatSpecifier	HL_getFormatSpecifier (const char *format)
	Returns the format specifier for the provided format string.

const char *	HL_getFormatSpecifierString (HL_FormatSpecifier specifier)
	Returns the string representation of the provided specifier.

const char *	HL_getHDF5Version (void)
	Returns the version that was used for building this binary.

HL_Compression *	HLCompression_new (HL_CompressionType type)
	Creates an allocated and initialized instance of HL_Compression.

HL_Compression *	HLCompression_clone (HL_Compression *inv)
	Creates a copy of the provided HL_Compression instance.

void	HLCompression_init (HL_Compression *inv, HL_CompressionType type)
	Initializes a HL_Compressiosn instance.

void	HLCompression_free (HL_Compression *inv)
	Deallocates the HL_Compression instance.

Detailed Description

Common functions for working with an HDF5 file through the HL-HDF API.

Author: Anders Henja (Swedish Meteorological and Hydrological Institute, SMHI)

Date: 2009-06-10

Macro Definition Documentation

◆ FALSE

#define FALSE 0

Define for FALSE unless it already has been defined.

◆ TRUE

#define TRUE 1

Define for TRUE unless it already has been defined.

Function Documentation

◆ HL_getFormatSpecifier()

HL_FormatSpecifier HL_getFormatSpecifier ( const char * format )

Returns the format specifier for the provided format string.

Parameters

[in] format the format name

Returns: the format specifier. HLHDF_UNDEFINED is also returned on error

◆ HL_getFormatSpecifierString()

const char * HL_getFormatSpecifierString ( HL_FormatSpecifier specifier )

Returns the string representation of the provided specifier.

Parameters

[in] specifier - the specifier

Returns: NULL if not a valid specifier, otherwise the format.

◆ HL_getHDF5Version()

const char * HL_getHDF5Version ( void )

Returns the version that was used for building this binary.

Returns: the version string.

Macros

Functions