h5dds.h File Reference

Data structure and retrieval processing header for the default option. More...

#include <H5Gpublic.h>
#include <H5Fpublic.h>
#include <H5Ipublic.h>
#include <H5Tpublic.h>
#include <H5Spublic.h>
#include <H5Apublic.h>
#include <H5public.h>
#include <libdap/DDS.h>

Include dependency graph for h5dds.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions
bool	depth_first (hid_t, const char *, libdap::DDS &, const char *)
void	read_objects (libdap::DDS &dds, const std::string &varname, const std::string &filename)

Detailed Description

Data structure and retrieval processing header for the default option.

This file is part of h5_dap_handler, A C++ implementation of the DAP handler for HDF5 data.

It defines functions that describe and retrieve group/dataset from HDF5 files.

Author

Hyo-Kyung Lee hyokl.nosp@m.ee@h.nosp@m.dfgro.nosp@m.up.o.nosp@m.rg

Kent Yang myang.nosp@m.6@hd.nosp@m.fgrou.nosp@m.p.or.nosp@m.g

Definition in file h5dds.h.

Function Documentation

depth_first()

bool depth_first	(	hid_t	pid,
		const char *	gname,
		DDS &	dds,
		const char *	fname )

will fill DDS table.

This function will walk through hdf5 gname group using the depth-first approach to obtain data information (data type and data pattern) of all hdf5 datasets and then put them into ithe dds table.

Parameters

pid	group id
gname	group name (the absolute path from the root group)
dds	reference of DDS object
fname	the HDF5 file name

Returns

0, if failed.

1, if succeeded.

Remarks

hard link is treated as a dataset.

will return error message to the DAP interface.

See also

depth_first(hid_t pid, char *gname, DAS & das, const char *fname) in h5das.cc

Definition at line 86 of file h5dds.cc.

read_objects()

void read_objects	(	DDS &	dds_table,
		const string &	varname,
		const string &	filename )

fills in information of a dataset (name, data type, data space) into one DDS table.

Parameters

dds_table	Destination for the HDF5 objects.
varname	Absolute name of an HDF5 dataset.
filename	The HDF5 file name that maps to the DDS dataset name.

Exceptions

error

a string of error message to the dods interface.

Definition at line 369 of file h5dds.cc.