HL-HDF
hlhdf.h
Go to the documentation of this file.
1/* --------------------------------------------------------------------
2Copyright (C) 2009 Swedish Meteorological and Hydrological Institute, SMHI,
3
4This file is part of HLHDF.
5
6HLHDF is free software: you can redistribute it and/or modify
7it under the terms of the GNU Lesser General Public License as published by
8the Free Software Foundation, either version 3 of the License, or
9(at your option) any later version.
10
11HLHDF is distributed in the hope that it will be useful,
12but WITHOUT ANY WARRANTY; without even the implied warranty of
13MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14GNU Lesser General Public License for more details.
15
16You should have received a copy of the GNU Lesser General Public License
17along with HLHDF. If not, see <http://www.gnu.org/licenses/>.
18------------------------------------------------------------------------*/
19
26#ifndef HLHDF_H
27#define HLHDF_H
28#include <hdf5.h>
29#include "hlhdf_types.h"
30#include "hlhdf_node.h"
31#include "hlhdf_nodelist.h"
32#include "hlhdf_read.h"
33#include "hlhdf_write.h"
34#include "hlhdf_compound.h"
35
39#ifndef FALSE
40#define FALSE 0
41#endif
42
46#ifndef TRUE
47#define TRUE 1
48#endif
49
63
69
70
76
82void HL_init(void);
83
94void HL_setDebugMode(int flag);
95
102int HL_isHDF5File(const char* filename);
103
111
118
126int HL_sizeOfFormat(const char* format);
127
136int HL_isFormatSupported(const char* format);
137
143HL_FormatSpecifier HL_getFormatSpecifier(const char* format);
144
151
156const char* HL_getHDF5Version(void);
157
165
173
181
188
189#endif
int HL_sizeOfFormat(const char *format)
Calculates the size in bytes of the provided format specifiers.
Definition hlhdf.c:270
void HL_enableErrorReporting(void)
Enables error reporting.
Definition hlhdf.c:112
void HLCompression_free(HL_Compression *inv)
Deallocates the HL_Compression instance.
Definition hlhdf.c:392
void HLCompression_init(HL_Compression *inv, HL_CompressionType type)
Initializes a HL_Compressiosn instance.
Definition hlhdf.c:376
HL_Compression * HLCompression_clone(HL_Compression *inv)
Creates a copy of the provided HL_Compression instance.
Definition hlhdf.c:352
int HL_isFormatSupported(const char *format)
Verifies if the format name is supported by HLHDF.
Definition hlhdf.c:288
void HL_setDebugMode(int flag)
Toggles the debug mode for HLHDF.
Definition hlhdf.c:156
int HL_isErrorReportingEnabled(void)
Returns if error reporting is enabled or not.
Definition hlhdf.c:120
int HL_isHDF5File(const char *filename)
Verifies if the provided filename is a valid HDF5 file or not.
Definition hlhdf.c:179
void HLFileCreationProperty_free(HL_FileCreationProperty *prop)
Deallocates the HL_FileCreationProperty instance.
Definition hlhdf.c:258
void HL_disableErrorReporting(void)
Disables error reporting.
Definition hlhdf.c:99
HL_Compression * HLCompression_new(HL_CompressionType type)
Creates an allocated and initialized instance of HL_Compression.
Definition hlhdf.c:337
void HL_init(void)
Initializes the HLHDF handler functions.
Definition hlhdf.c:136
HL_FileCreationProperty * HLFileCreationProperty_new(void)
Creates a file property instance that can be passed on to createHlHdfFile when creating a HDF5 file.
Definition hlhdf.c:191
HL_CompressionType
Defines what type of compression that should be used.
Definition hlhdf_types.h:102
const char * HL_getFormatSpecifierString(HL_FormatSpecifier specifier)
Returns the string representation of the provided specifier.
Definition hlhdf.c:317
HL_FormatSpecifier HL_getFormatSpecifier(const char *format)
Returns the format specifier for the provided format string.
Definition hlhdf.c:300
const char * HL_getHDF5Version(void)
Returns the version that was used for building this binary.
Definition hlhdf.c:325
Functions for working with compound types.
Functions for working with HL_Node's.
Functions for working with HL_NodeList's.
Functions that should be used when reading a HDF5 file.
Type definitions that are used in HLHDF.
HL_FormatSpecifier
These are all valid format specifiers that are used within HLHDF.
Definition hlhdf_types.h:70
Functions for writing and updating HDF5 files.
Compression properties.
Definition hlhdf_types.h:181
Properties that can be finely tuned when creating a HDF5 file.
Definition hlhdf_types.h:141