HighFive::Group Class Reference

Represents an hdf5 group. More...

#include <H5Group.hpp>

Inheritance diagram for HighFive::Group:

Collaboration diagram for HighFive::Group:

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

Protected Member Functions
	Group (Object &&o) noexcept
	Object ()
	Object (const Object &other)
	Object (Object &&other) noexcept
	Object (hid_t)
Protected Member Functions inherited from HighFive::Object
	Object ()
	Object (const Object &other)
	Object (Object &&other) noexcept
	Object (hid_t)
Object &	operator= (const Object &other)

Friends
class	File
class	Reference
template<typename Derivate >
class	::HighFive::NodeTraits

Additional Inherited Members
Public Member Functions inherited from HighFive::Object
	~Object ()
bool	isValid () const noexcept
	isValid More...
hid_t	getId () const noexcept
	getId More...
ObjectInfo	getInfo () const
	Retrieve several infos about the current object (address, dates, etc) More...
ObjectType	getType () const
	Gets the fundamental type of the object (dataset, group, etc) More...
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(), const DataSetAccessProps &accessProps=DataSetAccessProps())
	createDataSet Create a new dataset in the current file of datatype type and of size space More...
DataSet	createDataSet (const std::string &dataset_name, const DataSpace &space, const DataSetCreateProps &createProps=DataSetCreateProps(), const DataSetAccessProps &accessProps=DataSetAccessProps())
	createDataSet create a new dataset in the current file with a size specified by space More...
DataSet	createDataSet (const std::string &dataset_name, const T &data, const DataSetCreateProps &createProps=DataSetCreateProps(), const DataSetAccessProps &accessProps=DataSetAccessProps())
	createDataSet create a new dataset in the current file and write to it, inferring the DataSpace from the data. More...
DataSet	createDataSet (const std::string &dataset_name, const FixedLenStringArray< N > &data, const DataSetCreateProps &createProps=DataSetCreateProps(), const DataSetAccessProps &accessProps=DataSetAccessProps())
DataSet	getDataSet (const std::string &dataset_name, const DataSetAccessProps &accessProps=DataSetAccessProps()) const
	get an existing dataset in the current file More...
Group	createGroup (const std::string &group_name, bool parents=true)
	create a new group, and eventually intermediate groups More...
Group	getGroup (const std::string &group_name) const
	open an existing group with the name group_name More...
size_t	getNumberObjects () const
	return the number of leaf objects of the node / group More...
std::string	getObjectName (size_t index) const
	return the name of the object with the given index More...
std::string	getPath () const
	return the path to the current object More...
bool	rename (const std::string &src_path, const std::string &dest_path, bool parents=true) const
	moves an object and its content within an HDF5 file. More...
std::vector< std::string >	listObjectNames () const
	list all leaf objects name of the node / group More...
bool	exist (const std::string &node_name) const
	check a dataset or group exists in the current node / group More...
void	unlink (const std::string &node_name) const
	unlink the given dataset or group More...
LinkType	getLinkType (const std::string &node_name) const
	Returns the kind of link of the given name (soft, hard...) More...
ObjectType	getObjectType (const std::string &node_name) const
	A shorthand to get the kind of object pointed to (group, dataset, type...) More...
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 More...
Attribute	createAttribute (const std::string &attribute_name, const DataSpace &space)
	createAttribute create a new attribute on the current dataset with size specified by space More...
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. More...
void	deleteAttribute (const std::string &attribute_name)
	deleteAttribute let you delete an attribute by its name. More...
Attribute	getAttribute (const std::string &attribute_name) const
	open an existing attribute with the name attribute_name More...
size_t	getNumberAttributes () const
	return the number of attributes of the node / group More...
std::vector< std::string >	listAttributeNames () const
	list all attribute name of the node / group More...
bool	hasAttribute (const std::string &attr_name) const
	checks an attribute exists More...
Protected Attributes inherited from HighFive::Object
hid_t	_hid

Detailed Description

Represents an hdf5 group.

Constructor & Destructor Documentation

Group()

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

inlineprotectednoexcept

Member Function Documentation

Object() [1/4]

HighFive::Object::Object

inlineprotected

Object() [2/4]

HighFive::Object::Object

inlineprotected

Object() [3/4]

HighFive::Object::Object

inlineexplicitprotected

Object() [4/4]

HighFive::Object::Object

inlineprotectednoexcept

Friends And Related Function Documentation

::HighFive::NodeTraits

template<typename Derivate >

friend class ::HighFive::NodeTraits

friend

File

friend class File

friend

Reference

friend class Reference

friend

Member Data Documentation

type

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

static

---

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

• H5Group.hpp