Describe a group element. More...

#include <NDFileHDF5Layout.h>

Inheritance diagram for hdf5::Group:

Public Types
typedef std::map< std::string, Group * >	MapGroups_t
	Return a string representation of the object. More...

typedef std::map< std::string, Dataset * >	MapDatasets_t

typedef std::map< std::string, HardLink * >	MapHardLinks_t

typedef std::map< std::string, DataSource * >	MapNDAttrSrc_t
	return a map of datasets [string name, Dataset dset] which contains all datasets, marked as [source] data. More...

Public Types inherited from hdf5::Element
typedef std::map< std::string, Attribute >	MapAttributes_t

Public Member Functions
	Group ()

	Group (const std::string &name)

	Group (const char *name)

	Group (const Group &src)

virtual	~Group ()

Group &	operator= (const Group &src)

Dataset *	new_dset (const std::string &name)

Dataset *	new_dset (const char *name)

Group *	new_group (const std::string &name)
	Create a new group, insert it into the group list, set the full path name, and finally return a pointer to the newly created object. More...

Group *	new_group (const char *name)

HardLink *	new_hardlink (const std::string &name)
	Create a new HardLink, insert it into the group list, set the full path name, and finally return a pointer to the newly created object. More...

HardLink *	new_hardlink (const char *name)

int	find_dset_ndattr (const std::string &ndattr_name, Dataset **dset)

int	find_dset_ndattr (const char ndattr_name, Dataset *dset)
	<< Find and return a reference to the dataset for a given NDAttribute More...

int	find_dset (std::string &dsetname, Dataset **dest)

int	find_dset (const char dsetname, Dataset *dest)

void	set_default_ndattr_group ()

Group *	find_ndattr_default_group ()

int	find_detector_default_dset (Dataset **dset)
	<< search through subgroups to return a pointer to the NDAttribute default container group More...

int	num_groups ()

int	num_datasets ()

std::string	_str_ ()

MapGroups_t &	get_groups ()

MapDatasets_t &	get_datasets ()

MapHardLinks_t &	get_hardlinks ()

void	find_dsets (DataSrc_t source, MapDatasets_t &dsets)

virtual void	merge_ndattributes (MapNDAttrSrc_t::const_iterator it_begin, MapNDAttrSrc_t::const_iterator it_end, std::set< std::string > &used_ndattribute_srcs)

Public Member Functions inherited from hdf5::Element
	Element ()

	Element (const Element &src)

	Element (const std::string &name)

	~Element ()

Element &	operator= (const Element &src)

const std::string &	get_name ()

virtual std::string	get_full_name ()

virtual std::string	get_path (bool trailing_slash=false)

int	add_attribute (Attribute &attr)

bool	has_attribute (const std::string &attr_name)

int	tree_level ()

Element *	get_parent ()

MapAttributes_t &	get_attributes ()

Friends
std::ostream &	operator<< (std::ostream &out, Group &grp)
	Stream operator: use to prints a string representation of this class. More...

Additional Inherited Members
Protected Member Functions inherited from hdf5::Element
void	_copy (const Element &src)

Protected Attributes inherited from hdf5::Element
MapAttributes_t	attributes

std::string	name

Detailed Description

Describe a group element.

A group is like a directory in a file system. It can contain other groups and datasets (like files).

Member Typedef Documentation

◆ MapDatasets_t

typedef std::map<std::string, Dataset*> hdf5::Group::MapDatasets_t

◆ MapGroups_t

typedef std::map<std::string, Group*> hdf5::Group::MapGroups_t

Return a string representation of the object.

◆ MapHardLinks_t

typedef std::map<std::string, HardLink*> hdf5::Group::MapHardLinks_t

◆ MapNDAttrSrc_t

typedef std::map<std::string, DataSource*> hdf5::Group::MapNDAttrSrc_t

return a map of datasets [string name, Dataset dset] which contains all datasets, marked as [source] data.

Constructor & Destructor Documentation

◆ Group() [1/4]

hdf5::Group::Group ( )

◆ Group() [2/4]

hdf5::Group::Group ( const std::string & name )

◆ Group() [3/4]

hdf5::Group::Group ( const char * name )

◆ Group() [4/4]

hdf5::Group::Group ( const Group & src )

◆ ~Group()

hdf5::Group::~Group ( )

virtual

Member Function Documentation

◆ _str_()

std::string hdf5::Group::_str_ ( )

◆ find_detector_default_dset()

int hdf5::Group::find_detector_default_dset ( Dataset ** dset )

<< search through subgroups to return a pointer to the NDAttribute default container group

◆ find_dset() [1/2]

int hdf5::Group::find_dset	(	const char *	dsetname,
		Dataset **	dest
	)

◆ find_dset() [2/2]

int hdf5::Group::find_dset	(	std::string &	dsetname,
		Dataset **	dest
	)

◆ find_dset_ndattr() [1/2]

int hdf5::Group::find_dset_ndattr	(	const char *	ndattr_name,
		Dataset **	dset
	)

<< Find and return a reference to the dataset for a given NDAttribute

◆ find_dset_ndattr() [2/2]

int hdf5::Group::find_dset_ndattr	(	const std::string &	ndattr_name,
		Dataset **	dset
	)

◆ find_dsets()

void hdf5::Group::find_dsets	(	DataSrc_t	source,
		MapDatasets_t &	dsets
	)

◆ find_ndattr_default_group()

Group * hdf5::Group::find_ndattr_default_group ( )

◆ get_datasets()

Group::MapDatasets_t & hdf5::Group::get_datasets ( )

◆ get_groups()

Group::MapGroups_t & hdf5::Group::get_groups ( )

◆ get_hardlinks()

Group::MapHardLinks_t & hdf5::Group::get_hardlinks ( )

◆ merge_ndattributes()

void hdf5::Group::merge_ndattributes	(	MapNDAttrSrc_t::const_iterator	it_begin,
		MapNDAttrSrc_t::const_iterator	it_end,
		std::set< std::string > &	used_ndattribute_srcs
	)

virtual

Reimplemented in hdf5::Root.

◆ new_dset() [1/2]

Dataset * hdf5::Group::new_dset ( const char * name )

◆ new_dset() [2/2]

Dataset * hdf5::Group::new_dset ( const std::string & name )

◆ new_group() [1/2]

Group * hdf5::Group::new_group ( const char * name )

◆ new_group() [2/2]

Group * hdf5::Group::new_group ( const std::string & name )

Create a new group, insert it into the group list, set the full path name, and finally return a pointer to the newly created object.

Return NULL on error (group or dataset already exists or list insertion fails)

◆ new_hardlink() [1/2]

HardLink * hdf5::Group::new_hardlink ( const char * name )

◆ new_hardlink() [2/2]

HardLink * hdf5::Group::new_hardlink ( const std::string & name )

Create a new HardLink, insert it into the group list, set the full path name, and finally return a pointer to the newly created object.

Return NULL on error (hardlink already exists or list insertion fails)

◆ num_datasets()

int hdf5::Group::num_datasets ( )

◆ num_groups()

int hdf5::Group::num_groups ( )

◆ operator=()

Group & hdf5::Group::operator= ( const Group & src )

◆ set_default_ndattr_group()

void hdf5::Group::set_default_ndattr_group ( )

Friends And Related Function Documentation

◆ operator<<

std::ostream& operator<<	(	std::ostream &	out,
		Group &	grp
	)

friend

Stream operator: use to prints a string representation of this class.

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

/home/runner/work/areaDetector/areaDetector/ADCore/ADApp/pluginSrc/NDFileHDF5Layout.h
/home/runner/work/areaDetector/areaDetector/ADCore/ADApp/pluginSrc/NDFileHDF5Layout.cpp

Public Types

Public Member Functions

Friends

Additional Inherited Members