Represents an hdf5 group. More...

#include <H5Group.hpp>

Inheritance diagram for h5gt::Group:

Public Member Functions
LinkInfo	getLinkInfo () const

std::string	unpackSoftLink () const
	unpackSoftLink retrieve the path where Soft link points to

void	unlink () const

bool	rename (const std::string &dest_path, const LinkCreateProps &linkCreateProps=LinkCreateProps(), const LinkAccessProps &linkAccessProps=LinkAccessProps()) const
	rename move link within container

Group	getParent (const GroupAccessProps &groupAccessProps=GroupAccessProps()) const

bool	operator== (const Group &other) const
	operator == Check if objects reside in the same file and equal to each other

bool	operator!= (const Group &other) const

ObjectType	getObjectType () const
	Gets the fundamental type of the object (dataset, group, etc)

Public Member Functions inherited from h5gt::Object
void	flush (bool globalScope=true)
	flush

bool	isValid () const noexcept
	isValid

hid_t	getId (const bool &increaseRefCount=false) const noexcept
	getId

std::string	getFileName () const

std::string	getPath () const
	return the path to the current group, dataset, datatype or attribute's holder

int	getIdRefCount () const noexcept

ObjectInfo	getObjectInfo () const
	Retrieve several infos about the current object (address, dates, etc)

ObjectType	getObjectType () const
	Gets the fundamental type of the object (dataset, group, etc)

Public Member Functions inherited from h5gt::NodeTraits< Group >
DataSet	createDataSet (const std::string &dataset_name, const DataSpace &space, const DataType &type, const LinkCreateProps &linkCreateProps=LinkCreateProps(), const DataSetCreateProps &dsetCreateProps=DataSetCreateProps(), const DataSetAccessProps &dsetAccessProps=DataSetAccessProps())
	createDataSet Create a new dataset in the current file of datatype type and of size space

DataSet	createDataSet (const std::string &dataset_name, const DataSpace &space, const LinkCreateProps &linkCreateProps=LinkCreateProps(), const DataSetCreateProps &dsetCreateProps=DataSetCreateProps(), const DataSetAccessProps &dsetAccessProps=DataSetAccessProps())
	createDataSet create a new dataset in the current file with a size specified by space

DataSet	createDataSet (const std::string &dataset_name, const T &data, const LinkCreateProps &linkCreateProps=LinkCreateProps(), const DataSetCreateProps &dsetCreateProps=DataSetCreateProps(), const DataSetAccessProps &dsetAccessProps=DataSetAccessProps())
	createDataSet create a new dataset in the current file and write to it, inferring the DataSpace from the data.

DataSet	createDataSet (const std::string &dataset_name, const FixedLenStringArray< N > &data, const LinkCreateProps &linkCreateProps=LinkCreateProps(), const DataSetCreateProps &dsetCreateProps=DataSetCreateProps(), const DataSetAccessProps &dsetAccessProps=DataSetAccessProps())

DataType	getDataType (const std::string &dtype_name, const DataTypeAccessProps &dtypeAccessProps=DataTypeAccessProps()) const

DataSet	getDataSet (const std::string &dataset_name, const DataSetAccessProps &accessProps=DataSetAccessProps()) const
	get an existing dataset in the current file

Group	createGroup (const std::string &group_name, const LinkCreateProps &linkCreateProps=LinkCreateProps(), const GroupCreateProps &groupCreateProps=GroupCreateProps(), const GroupAccessProps &groupAccessProps=GroupAccessProps())
	create a new group, and eventually intermediate groups

Group	getGroup (const std::string &group_name, const GroupAccessProps &groupAccessProps=GroupAccessProps()) const
	open an existing group with the name group_name

File	getFile () const

size_t	getNumberObjects () const
	return the number of leaf objects of the node / group

std::string	getObjectName (size_t index, const LinkAccessProps &linkAccessProps=LinkAccessProps()) const
	return the name of the object with the given index

LinkInfo	getLinkInfo (const std::string &objName) const

std::string	unpackSoftLink (const std::string &objName)
	unpackSoftLink retrieve target path object path

std::string	unpackExternalLink (const std::string &objName, std::string &fileName_out)
	unpackExternalLink retrieve target path object path and file path

bool	rename (const std::string &src_path, const std::string &dest_path, const LinkCreateProps &linkCreateProps=LinkCreateProps(), const LinkAccessProps &linkAccessProps=LinkAccessProps()) const
	moves an object and its content within an HDF5 file.

std::vector< std::string >	listObjectNames () const
	list all leaf objects name of the node / group

bool	exist (const std::string &obj_name, const LinkAccessProps &linkAccessProps=LinkAccessProps(), bool raise_errors=false) const
	check a dataset or group exists in the current node / group

bool	resolved (const std::string &obj_name, const LinkAccessProps &linkAccessProps=LinkAccessProps(), bool raise_errors=false) const
	resolved Hard links always resolved but Soft/External links may point to unexistant objects

bool	existAndResolved (const std::string &obj_name, const LinkAccessProps &linkAccessProps=LinkAccessProps(), bool raise_errors=false) const
	existAndResolved invokes `exist()` and then `reoslved()`

bool	hasObject (const std::string &objName, const ObjectType &objType, const LinkAccessProps &linkAccessProps=LinkAccessProps(), bool raise_errors=false) const

void	unlink (const std::string &obj_name, const LinkAccessProps &linkAccessProps=LinkAccessProps()) const
	unlink the given dataset or group

LinkType	getLinkType (const std::string &obj_name, const LinkAccessProps &linkAccessProps=LinkAccessProps()) const
	Returns the kind of link of the given name (soft, hard...)

ObjectType	getObjectType (const std::string &obj_name, const LinkAccessProps &accessProps=LinkAccessProps()) const
	A shorthand to get the kind of object pointed to (group, dataset, type...)

Group	copy (const Group &obj, const std::string &objNewName, const ObjectCopyProps &copyProps=ObjectCopyProps(), const LinkCreateProps &linkCreateProps=LinkCreateProps(), const GroupAccessProps &groupAccessProps=GroupAccessProps())
	Copies specified object to the new destination (this File/Group) under new name. The destination must not already have the object with the same name (objNewName).

DataSet	copy (const DataSet &obj, const std::string &objNewName, const ObjectCopyProps &copyProps=ObjectCopyProps(), const LinkCreateProps &linkCreateProps=LinkCreateProps(), const DataSetAccessProps &dsetAccessProps=DataSetAccessProps())

DataType	copy (const DataType &obj, const std::string &objNewName, const ObjectCopyProps &copyProps=ObjectCopyProps(), const LinkCreateProps &linkCreateProps=LinkCreateProps(), const DataTypeAccessProps &dtypeAccessProps=DataTypeAccessProps())
	Copies commited datatype.

Group	createLink (const Node &target, const std::string &linkName, const LinkType &linkType, const std::string &targetPath="", const LinkCreateProps &linkCreateProps=LinkCreateProps(), const LinkAccessProps &linkAccessProps=LinkAccessProps(), const GroupAccessProps &groupAccessProps=GroupAccessProps())

DataSet	createLink (const DataSet &target, const std::string &linkName, const LinkType &linkType, const std::string &targetPath="", const LinkCreateProps &linkCreateProps=LinkCreateProps(), const LinkAccessProps &linkAccessProps=LinkAccessProps(), const DataSetAccessProps &dsetAccessProps=DataSetAccessProps())

DataType	createLink (const DataType &target, const std::string &linkName, const LinkType &linkType, const std::string &targetPath="", const LinkCreateProps &linkCreateProps=LinkCreateProps(), const LinkAccessProps &linkAccessProps=LinkAccessProps(), const DataTypeAccessProps &dtypeAccessProps=DataTypeAccessProps())

Public Member Functions inherited from h5gt::AnnotateTraits< Group >
Attribute	createAttribute (const std::string &attr_name, const DataSpace &space, const DataType &type)
	create a new attribute with the name attr_name

Attribute	createAttribute (const std::string &attr_name, const DataSpace &space)
	createAttribute create a new attribute on the current dataset with size specified by space

Attribute	createAttribute (const std::string &attr_name, const T &data)
	createAttribute create a new attribute on the current dataset and write to it, inferring the DataSpace from data.

void	deleteAttribute (const std::string &attr_name)
	deleteAttribute let you delete an attribute by its name.

Attribute	getAttribute (const std::string &attr_name) const
	open an existing attribute with the name attr_name

size_t	getNumberAttributes () const
	return the number of attributes of the object

std::vector< std::string >	listAttributeNames () const
	list all attribute name of the object

bool	hasAttribute (const std::string &attr_name) const
	checks an attribute exists

Static Public Member Functions
static Group	FromId (const hid_t &id, const bool &increaseRefCount=false)

Static Public Attributes
static const ObjectType	type = ObjectType::Group

Protected Member Functions
	Group (const Object &obj)

	Group (Object &&o) noexcept

	Object ()

	Object (const Object &other)

	Object (Object &&other) noexcept

	Object (const hid_t &)

	Object (const hid_t &, const ObjectType &, const bool &)

Protected Member Functions inherited from h5gt::Object
	Object (const Object &other)

	Object (Object &&other) noexcept

	Object (const hid_t &)

	Object (const hid_t &, const ObjectType &, const bool &)

LinkInfo	_getLinkInfo (const std::string &objPath) const
	getLinkInfo retrieve link info from an object with 'objPath'. This object must reside in the same container as current one.

std::string	_unpackSoftLink (const std::string &objName) const

std::string	_unpackExternalLink (const std::string &objName, std::string &fileName_out) const

void	_unlink (const std::string &obj_name) const

Object &	operator= (const Object &other)

bool	operator== (const Object &other) const
	When coparing objects h5gt::File must be open.

Friends
class	File

class	Reference

template<typename Derivate >
class	::h5gt::NodeTraits

Additional Inherited Members
Protected Attributes inherited from h5gt::Object
hid_t	_hid

Detailed Description

Represents an hdf5 group.

Member Function Documentation

◆ getObjectType()

ObjectType h5gt::Object::getObjectType ( ) const

inline

Gets the fundamental type of the object (dataset, group, etc)

Exceptions

ObjectException when the _hid is negative or the type is custom and not registered yet

◆ operator==()

bool h5gt::Group::operator== ( const Group & other ) const

inline

operator == Check if objects reside in the same file and equal to each other

Parameters

other

Returns

◆ rename()

bool h5gt::Group::rename	(	const std::string &	dest_path,
		const LinkCreateProps &	linkCreateProps = LinkCreateProps(),
		const LinkAccessProps &	linkAccessProps = LinkAccessProps() ) const

inline

rename move link within container

Parameters

dest_path
linkCreateProps	important as they create intermediate groups
linkAccessProps

Returns

◆ unpackSoftLink()

std::string h5gt::Group::unpackSoftLink ( ) const

inline

unpackSoftLink retrieve the path where Soft link points to

Parameters

objName
accessProp

Returns: path to the object

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

/github/workspace/include/h5gt/H5Group.hpp

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ getObjectType()

◆ operator==()

◆ rename()

◆ unpackSoftLink()