hlhdf_read.c File Reference

Functions for working with HL_Node's and HL_NodeList's. More...

#include "hlhdf.h"
#include "hlhdf_alloc.h"
#include "hlhdf_private.h"
#include "hlhdf_debug.h"
#include "hlhdf_defines_private.h"
#include "hlhdf_node_private.h"
#include <string.h>
#include <stdlib.h>

Classes
struct	ReferenceLookup
	Struct used internally for beeing able to do a reverse name lookup when reading a file with references. More...
struct	VisitorStruct
	Used when traversing over the different nodes during reading. More...

Typedefs
typedef struct ReferenceLookup	ReferenceLookup
	Struct used internally for beeing able to do a reverse name lookup when reading a file with references.
typedef struct VisitorStruct	VisitorStruct
	Used when traversing over the different nodes during reading.

Functions
HL_NodeList *	HLNodeList_readFrom (const char *filename, const char *fromPath)
	Reads an HDF5 file with name filename from the group fromPath and downwards.
HL_NodeList *	HLNodeList_read (const char *filename)
	Reads an HDF5 file with name filename from the root group ("/") and downwards.
int	HLNodeList_selectNode (HL_NodeList *nodelist, const char *name)
	Selects the node named 'name' from which to fetch data.
int	HLNodeList_selectAllNodes (HL_NodeList *nodelist)
	Marks all nodes in the nodelist for retrival.
int	HLNodeList_selectMetadataNodes (HL_NodeList *nodelist)
	Selects all metadata nodes in the nodelist to be fetched, ie.
int	HLNodeList_selectAllMetadataNodes (HL_NodeList *nodelist)
	Selects all metadata including metadata about datasets but will exclude data for datasets.
int	HLNodeList_selectOnlyDatasetNodes (HL_NodeList *nodelist)
	Only select data set nodes for fetching.
int	HLNodeList_deselectNode (HL_NodeList *nodelist, const char *name)
	De-selects the node named 'name' to be retrived when fetching data from the nodelist file.
int	HLNodeList_fetchMarkedNodes (HL_NodeList *nodelist)
	Fills all nodes (marked as select) with data.
HL_Node *	HLNodeList_fetchNode (HL_NodeList *nodelist, const char *name)
	Behaves as a combination of HLNodeList_selectNode()/fetch()/getNode().

Detailed Description

Functions for working with HL_Node's and HL_NodeList's.

Author

Anders Henja (Swedish Meteorological and Hydrological Institute, SMHI)

Date

2009-06-12

Typedef Documentation

ReferenceLookup

typedef struct ReferenceLookup ReferenceLookup

Struct used internally for beeing able to do a reverse name lookup when reading a file with references.

We dont want to have the data in the object referenced to, but instead we want to have the name, thats why this has to be used.

VisitorStruct

typedef struct VisitorStruct VisitorStruct

Used when traversing over the different nodes during reading.