HL-HDF
hlhdf_types.h File Reference

Type definitions that are used in HLHDF. More...

#include <hdf5.h>

Go to the source code of this file.

Classes

struct  HL_PropertyVersion
 See hdf5 documentation for H5Pget_version for purpose. More...
 
struct  HL_PropertySize
 See hdf5 documentation for H5Pset_sizes and H5Pget_sizes for purpose. More...
 
struct  HL_PropertySymK
 See hdf5 documentation for H5Pset_sym_k and H5Pget_sym_k for purpose. More...
 
struct  HL_FileCreationProperty
 Properties that can be finely tuned when creating a HDF5 file. More...
 
struct  HL_Compression
 Compression properties. More...
 
struct  HL_CompoundTypeAttribute
 This type is designed to describe an individual node with a complicated structure, ie. More...
 
struct  HL_CompoundTypeDescription
 This type is a list of HL_CompoundTypeAttributes. More...
 

Typedefs

typedef enum HL_FormatSpecifier HL_FormatSpecifier
 These are all valid format specifiers that are used within HLHDF.
 
typedef enum HL_CompressionType HL_CompressionType
 Defines what type of compression that should be used.
 
typedef enum HL_Type HL_Type
 This is an enumeration variable designed to identify the type of a given node.
 
typedef enum HL_DataType HL_DataType
 This is an enumeration variable designed to identify the type of data in a given node.
 
typedef enum HL_NodeMark HL_NodeMark
 This is an enumeration variable designed to keep track of the status of a given node.
 
typedef struct _HL_Node HL_Node
 Each entry and type in a HDF5 file is represented by a HL_Node.
 
typedef struct _HL_NodeList HL_NodeList
 Represents a HDF5 file.
 

Enumerations

enum  HL_FormatSpecifier {
  HLHDF_UNDEFINED = 0 , HLHDF_CHAR , HLHDF_SCHAR , HLHDF_UCHAR ,
  HLHDF_SHORT , HLHDF_USHORT , HLHDF_INT , HLHDF_UINT ,
  HLHDF_LONG , HLHDF_ULONG , HLHDF_LLONG , HLHDF_ULLONG ,
  HLHDF_FLOAT , HLHDF_DOUBLE , HLHDF_LDOUBLE , HLHDF_HSIZE ,
  HLHDF_HSSIZE , HLHDF_HERR , HLHDF_HBOOL , HLHDF_STRING ,
  HLHDF_COMPOUND , HLHDF_ARRAY , HLHDF_END_OF_SPECIFIERS
}
 These are all valid format specifiers that are used within HLHDF. More...
 
enum  HL_CompressionType { CT_NONE =0 , CT_ZLIB , CT_SZLIB }
 Defines what type of compression that should be used. More...
 
enum  HL_Type {
  UNDEFINED_ID =-1 , ATTRIBUTE_ID =0 , GROUP_ID , DATASET_ID ,
  TYPE_ID , REFERENCE_ID
}
 This is an enumeration variable designed to identify the type of a given node. More...
 
enum  HL_DataType { DTYPE_UNDEFINED_ID =-1 , HL_SIMPLE =0 , HL_ARRAY }
 This is an enumeration variable designed to identify the type of data in a given node. More...
 
enum  HL_NodeMark {
  NMARK_UNDEFINED =-1 , NMARK_ORIGINAL =0 , NMARK_CREATED , NMARK_CHANGED ,
  NMARK_SELECT , NMARK_SELECTMETA
}
 This is an enumeration variable designed to keep track of the status of a given node. More...
 

Detailed Description

Type definitions that are used in HLHDF.

Author
Anders Henja (Swedish Meteorological and Hydrological Institute, SMHI)
Date
2009-06-10

Typedef Documentation

◆ HL_FormatSpecifier

These are all valid format specifiers that are used within HLHDF.

HLHDF_ARRAY is not possible to use for writing and is only used when reading HDF5 files with array content.

Enumeration Type Documentation

◆ HL_FormatSpecifier

These are all valid format specifiers that are used within HLHDF.

HLHDF_ARRAY is not possible to use for writing and is only used when reading HDF5 files with array content.

Enumerator
HLHDF_UNDEFINED 

'UNDEFINED' If no format has been specified, this string will be returned

HLHDF_CHAR 

'char'

HLHDF_SCHAR 

'schar'

HLHDF_UCHAR 

'uchar'

HLHDF_SHORT 

'short'

HLHDF_USHORT 

'ushort'

HLHDF_INT 

'int'

HLHDF_UINT 

'uint'

HLHDF_LONG 

'long'

HLHDF_ULONG 

'ulong'

HLHDF_LLONG 

'llong'

HLHDF_ULLONG 

'ullong'

HLHDF_FLOAT 

'float'

HLHDF_DOUBLE 

'double'

HLHDF_LDOUBLE 

'ldouble'

HLHDF_HSIZE 

'hsize'

HLHDF_HSSIZE 

'hssize'

HLHDF_HERR 

'herr'

HLHDF_HBOOL 

'hbool'

HLHDF_STRING 

'string'

HLHDF_COMPOUND 

'compound'

HLHDF_ARRAY 

'array' This is only something that will be read but is not possible to write