isce3::io::IH5File Class Reference

Inheritance diagram for isce3::io::IH5File:

Public Member Functions
	IH5File (const H5std_string &name, const char mode= 'r')
void	openFile (const H5std_string &name)
IDataSet	openDataSet (const H5std_string &name)
	Open a given dataset. More...
IGroup	openGroup (const H5std_string &name)
	Open a given group. More...
std::vector< std::string >	find (const std::string name, const std::string start="/", const std::string type="BOTH", const std::string path="FULL")
	Searching for given name in file. More...
std::string	filename () const
	Get filename of HDF5 file. More...
IGroup	createGroup (const H5std_string &name)
	Create a group. More...

Constructor & Destructor Documentation

isce3::io::IH5File::IH5File	(	const H5std_string &	name,
		const char	mode = 'r'
	)

Parameters

[in]	name	Name of the Hdf5 file to open.
[in]	mode	File opening mode The different mode available are: r: read only, file must exist (default) w: read/write, file must exist x: create file, overwrite if exist a: create file, fails if exist

Member Function Documentation

isce3::io::IGroup isce3::io::IH5File::createGroup

(

const H5std_string &

name

)

Create a group.

Parameters

[in]

name

Name of the group to create.

name must contain the full path from root location and name of the group to create.

std::string isce3::io::IH5File::filename ( ) const

inline

Get filename of HDF5 file.

std::vector< std::string > isce3::io::IH5File::find	(	const std::string	name,
		const std::string	start = "/",
		const std::string	type = "BOTH",
		const std::string	path = "FULL"
	)

Searching for given name in file.

Parameters

[in]	name	Regular Expression to search for.
[in]	start	Relative path from root to start the search from. Default:file root
[in]	type	Type of object to search for. Default: BOTH
[in]	path	Absolute or Relative path of found object. Default: FULL

The function returns paths of all objects in the file whose names satisfy the

param name: can be a regular expression. param type: three types of objects to search for are available: GROUP: only returns groups whose names satisfy the inpout name. DATASET: only return datasets whose names satisfy the input name. BOTH: return groups and datsets whose names satisfy the input name. param path: the returned path of the found objects can be expressed from the root (path = FULL - this is default) or relative to the start (path = RELATIVE).

isce3::io::IDataSet isce3::io::IH5File::openDataSet

(

const H5std_string &

name

)

Open a given dataset.

Parameters

[in]

name

Name of the dataset to open.

name must contain the full path from root location and name of the dataset to open.

isce3::io::IGroup isce3::io::IH5File::openGroup

(

const H5std_string &

name

)

Open a given group.

Parameters

[in]

name

Name of the group to open.

name must contain the full path from root location and name of the group to open.

---

The documentation for this class was generated from the following files:

• isce/cxx/isce3/io/IH5.h
• isce/cxx/isce3/io/IH5.cpp