Abstract base class to provide an interface for reading data out of Generic_wrapper objects. More...

#include <generic_wrapper.h>

Inheritance diagram for utilities::Generic_wrapper_read:

Public Member Functions
virtual	~Generic_wrapper_read ()
	Destructor. More...

Wrapper state
Change and query the top level wrapper state
virtual void	open_wrapper ()=0
	Initializes the wrapper. More...

virtual void	close_wrapper ()=0
	closes and cleans up the wrapper More...

virtual bool	is_open () const =0
	Returns if the wrapper is open or not. More...

Group state
Change and query the wrapper current group state
virtual void	open_group (const std::string &name="none")=0
	Opens a group in the wrapper, ie a group in hdf or a cell in matlab. More...

virtual void	close_group ()=0
	closes the current group More...

Data
get data
virtual void	get_dset (std::vector< int > &data, std::vector< unsigned int > &dims, const std::string &dset_name) const =0
	Gets data from the wrapper. More...

virtual void	get_dset (std::vector< unsigned int > &data, std::vector< unsigned int > &dims, const std::string &dset_name) const =0
	Gets data from the wrapper. More...

virtual void	get_dset (std::vector< float > &data, std::vector< unsigned int > &dims, const std::string &dset_name) const =0
	Gets data from the wrapper. More...

virtual void	get_dset_info (std::vector< int > &dims, V_TYPE &vt, const std::string &dset_name) const =0
	Get dset size. More...

Group Level Metadata
getter functions for metadata for the currently open group.
virtual float	get_meta_data (const std::string &key, float &val)=0
	Gets a float meta-data. More...

virtual Tuple< float, 3 >	get_meta_data (const std::string &key, Tuple< float, 3 > &val)=0
	Gets a Triple meta-data. More...

virtual Tuple< float, 2 >	get_meta_data (const std::string &key, Tuple< float, 2 > &val)=0
	Gets a Pair meta-data. More...

virtual std::string	get_meta_data (const std::string &key, std::string &val)=0
	Gets a string meta-data. More...

virtual int	get_meta_data (const std::string &key, int &val)=0
	Gets an integer meta-data. More...

virtual unsigned int	get_meta_data (const std::string &key, unsigned int &val)=0
	Gets an unsigned integer meta-data. More...

virtual Md_store &	get_meta_data (Md_store &md_store)=0
	Gets all the meta data in a Md_store at the group level. More...

Dataset Level Metadata
getter functions for metadata for the named dataset.
virtual float	get_meta_data (const std::string &key, float &val, const std::string &dset_name)=0
	Gets a float meta-data for a data set. More...

virtual Tuple< float, 3 >	get_meta_data (const std::string &key, Tuple< float, 3 > &val, const std::string &dset_name)=0
	Gets a Triple meta-data for a data set. More...

virtual Tuple< float, 2 >	get_meta_data (const std::string &key, Tuple< float, 2 > &val, const std::string &dset_name)=0
	Gets a Pair meta-data for a data set. More...

virtual std::string	get_meta_data (const std::string &key, std::string &val, const std::string &dset_name)=0
	Gets a string meta-data for a data set. More...

virtual int	get_meta_data (const std::string &key, int &val, const std::string &dset_name)=0
	Gets an integer meta-data for a data set. More...

virtual Md_store &	get_meta_data (Md_store &md_store, const std::string &dset_name)=0
	Gets all the meta data in a Md_store at the dset level. More...

Detailed Description

Abstract base class to provide an interface for reading data out of Generic_wrapper objects.

ABC/Interface.

Constructor & Destructor Documentation

virtual utilities::Generic_wrapper_read::~Generic_wrapper_read ( )

inlinevirtual

Destructor.

Member Function Documentation

virtual void utilities::Generic_wrapper_read::close_group ( )

pure virtual

closes the current group

Implemented in utilities::Generic_wrapper_hdf.

virtual void utilities::Generic_wrapper_read::close_wrapper ( )

pure virtual

closes and cleans up the wrapper

Implemented in utilities::Generic_wrapper_hdf.

virtual void utilities::Generic_wrapper_read::get_dset	(	std::vector< int > &	data,
		std::vector< unsigned int > &	dims,
		const std::string &	dset_name
	)		const

pure virtual

Gets data from the wrapper.

Implemented in utilities::Generic_wrapper_hdf.

virtual void utilities::Generic_wrapper_read::get_dset	(	std::vector< unsigned int > &	data,
		std::vector< unsigned int > &	dims,
		const std::string &	dset_name
	)		const

pure virtual

Gets data from the wrapper.

Implemented in utilities::Generic_wrapper_hdf.

virtual void utilities::Generic_wrapper_read::get_dset	(	std::vector< float > &	data,
		std::vector< unsigned int > &	dims,
		const std::string &	dset_name
	)		const

pure virtual

Gets data from the wrapper.

Implemented in utilities::Generic_wrapper_hdf.

virtual void utilities::Generic_wrapper_read::get_dset_info	(	std::vector< int > &	dims,
		V_TYPE &	vt,
		const std::string &	dset_name
	)		const

pure virtual

Get dset size.

Parameters

[out]	dims	a vector that gets filled with the dimensions
[out]	dims	the type of the data set
[in]	dset_name	the name of the data set

Implemented in utilities::Generic_wrapper_hdf.

virtual float utilities::Generic_wrapper_read::get_meta_data	(	const std::string &	key,
		float &	val
	)

pure virtual

Gets a float meta-data.

Implemented in utilities::Generic_wrapper_hdf.

virtual Tuple<float,3> utilities::Generic_wrapper_read::get_meta_data	(	const std::string &	key,
		Tuple< float, 3 > &	val
	)

pure virtual

Gets a Triple meta-data.

Implemented in utilities::Generic_wrapper_hdf.

virtual Tuple<float,2> utilities::Generic_wrapper_read::get_meta_data	(	const std::string &	key,
		Tuple< float, 2 > &	val
	)

pure virtual

Gets a Pair meta-data.

Implemented in utilities::Generic_wrapper_hdf.

virtual std::string utilities::Generic_wrapper_read::get_meta_data	(	const std::string &	key,
		std::string &	val
	)

pure virtual

Gets a string meta-data.

Implemented in utilities::Generic_wrapper_hdf.

virtual int utilities::Generic_wrapper_read::get_meta_data	(	const std::string &	key,
		int &	val
	)

pure virtual

Gets an integer meta-data.

Implemented in utilities::Generic_wrapper_hdf.

virtual unsigned int utilities::Generic_wrapper_read::get_meta_data	(	const std::string &	key,
		unsigned int &	val
	)

pure virtual

Gets an unsigned integer meta-data.

Implemented in utilities::Generic_wrapper_hdf.

virtual Md_store& utilities::Generic_wrapper_read::get_meta_data ( Md_store & md_store)

pure virtual

Gets all the meta data in a Md_store at the group level.

Implemented in utilities::Generic_wrapper_hdf.

virtual float utilities::Generic_wrapper_read::get_meta_data	(	const std::string &	key,
		float &	val,
		const std::string &	dset_name
	)

pure virtual

Gets a float meta-data for a data set.

Implemented in utilities::Generic_wrapper_hdf.

virtual Tuple<float,3> utilities::Generic_wrapper_read::get_meta_data	(	const std::string &	key,
		Tuple< float, 3 > &	val,
		const std::string &	dset_name
	)

pure virtual

Gets a Triple meta-data for a data set.

Implemented in utilities::Generic_wrapper_hdf.

virtual Tuple<float,2> utilities::Generic_wrapper_read::get_meta_data	(	const std::string &	key,
		Tuple< float, 2 > &	val,
		const std::string &	dset_name
	)