Represents an hdf5 group. More...

#include <H5Group.hpp>

Inheritance diagram for HighFive::Group:

[legend]

Collaboration diagram for HighFive::Group:

[legend]

Public Member Functions
	Group ()=default

std::pair< unsigned int, unsigned int >	getEstimatedLinkInfo () const

GroupCreateProps	getCreatePropertyList () const
	Get the list of properties for creation of this group.

	Group (Object &&o) noexcept

Public Member Functions inherited from HighFive::Object
	Object (Object &&other) noexcept

bool	isValid () const noexcept
	isValid

hid_t	getId () const noexcept
	getId

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

haddr_t	getAddress () const
	Address of an HDF5 object in the file.

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

bool	operator== (const Object &other) const noexcept

Public Member Functions inherited from HighFive::NodeTraits< Group >
DataSet	createDataSet (const std::string &dataset_name, const DataSpace &space, const DataType &type, const DataSetCreateProps &createProps=DataSetCreateProps::Default(), const DataSetAccessProps &accessProps=DataSetAccessProps::Default(), bool parents=true)
	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 DataSetCreateProps &createProps=DataSetCreateProps::Default(), const DataSetAccessProps &accessProps=DataSetAccessProps::Default(), bool parents=true)
	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 DataSetCreateProps &createProps=DataSetCreateProps::Default(), const DataSetAccessProps &accessProps=DataSetAccessProps::Default(), bool parents=true)
	createDataSet create a new dataset in the current file and write to it, inferring the DataSpace from the data.

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

Group	createGroup (const std::string &group_name, bool parents=true)
	create a new group, and eventually intermediate groups

Group	createGroup (const std::string &group_name, const GroupCreateProps &createProps, bool parents=true)
	create a new group, and eventually intermediate groups

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

DataType	getDataType (const std::string &type_name, const DataTypeAccessProps &accessProps=DataTypeAccessProps::Default()) const
	open a commited datatype with the name type_name

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

std::string	getObjectName (size_t index) const
	return the name of the object with the given index

bool	rename (const std::string &src_path, const std::string &dst_path, bool parents=true) const
	moves an object and its content within an HDF5 file.

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

bool	exist (const std::string &node_path) const
	check a dataset or group exists in the current node / group

void	unlink (const std::string &node_path) const
	unlink the given dataset or group

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

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

void	createSoftLink (const std::string &linkName, const T &obj)
	A shorthand to create softlink to any object which provides `getPath` The link will be created with default properties along with required parent groups.

void	createSoftLink (const std::string &link_name, const std::string &obj_path, LinkCreateProps linkCreateProps=LinkCreateProps(), const LinkAccessProps &linkAccessProps=LinkAccessProps(), bool parents=true)
	Creates softlinks.

void	createExternalLink (const std::string &link_name, const std::string &h5_file, const std::string &obj_path, LinkCreateProps linkCreateProps=LinkCreateProps(), const LinkAccessProps &linkAccessProps=LinkAccessProps(), bool parents=true)

void	createHardLink (const std::string &link_name, const T &target_obj, LinkCreateProps linkCreateProps=LinkCreateProps(), const LinkAccessProps &linkAccessProps=LinkAccessProps(), bool parents=true)
	Creates hardlinks.

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

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

Attribute	createAttribute (const std::string &attribute_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 &attribute_name)
	deleteAttribute let you delete an attribute by its name.

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

size_t	getNumberAttributes () const
	return the number of attributes of the node / group

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

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

Public Member Functions inherited from HighFive::PathTraits< Group >
	PathTraits ()

std::string	getPath () const
	return the path to the current object

File &	getFile () const
	Return a reference to the File object this object belongs.

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

Protected Member Functions
	Object (Object &&other) noexcept

	Object ()

	Object (const Object &other)

	Object (hid_t) noexcept

Protected Member Functions inherited from HighFive::Object
	Object ()

	Object (const Object &other)

	Object (hid_t) noexcept

	~Object ()

Object &	operator= (const Object &other)

Object &	operator= (Object &&other)

Friends
class	File

class	Reference

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

Detailed Description

Represents an hdf5 group.

Constructor & Destructor Documentation

◆ Group() [1/2]

HighFive::Group::Group ( )

default

◆ Group() [2/2]

HighFive::Group::Group ( Object && o )

inlineexplicitnoexcept

Member Function Documentation

◆ getCreatePropertyList()

GroupCreateProps HighFive::Group::getCreatePropertyList ( ) const

inline

Get the list of properties for creation of this group.

◆ getEstimatedLinkInfo()

std::pair< unsigned int, unsigned int > HighFive::Group::getEstimatedLinkInfo ( ) const

inline

◆ Object() [1/4]

HighFive::Object::Object ( )

inlineprotected

◆ Object() [2/4]

HighFive::Object::Object ( const Object & other )

inlineprotected

◆ Object() [3/4]

HighFive::Object::Object ( hid_t hid )

inlineexplicitprotectednoexcept

◆ Object() [4/4]

HighFive::Object::Object ( Object && other )

inlineprotectednoexcept

Friends And Related Symbol Documentation

◆ File

friend class File

friend

◆ Reference

friend class Reference

friend

Member Data Documentation

◆ type

const ObjectType HighFive::Group::type = ObjectType::Group

static

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

highfive/H5Group.hpp

Public Member Functions

Static Public Attributes

Protected Member Functions

Friends

Additional Inherited Members