#include <H5Node_traits.hpp>

Public Member Functions
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...

template<typename Type >
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...

template<typename T >
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...

Group	createGroup (const std::string &group_name)
	create a new group with the name group_name More...

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

DataSet	getDataSet (const std::string &dataset_name, const DataSetAccessProps &accessProps=DataSetAccessProps()) const
	get an existing dataset in the current file 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::vector< std::string >	listObjectNames () const
	list all leaf objects name of the node / group More...

Private Types
typedef Derivate	derivate_type

Detailed Description

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

Definition at line 23 of file H5Node_traits.hpp.

Member Typedef Documentation

◆ derivate_type

template<typename Derivate>

typedef Derivate HighFive::NodeTraits< Derivate >::derivate_type

private

Definition at line 118 of file H5Node_traits.hpp.

Member Function Documentation

◆ createDataSet() [1/3]

template<typename Derivate >

DataSet HighFive::NodeTraits< Derivate >::createDataSet	(	const std::string &	dataset_name,
		const DataSpace &	space,
		const DataType &	type,
		const DataSetCreateProps &	createProps = `DataSetCreateProps()`,
		const DataSetAccessProps &	accessProps = `DataSetAccessProps()`
	)

inline

createDataSet Create a new dataset in the current file of datatype type and of size space

Parameters

dataset_name	identifier of the dataset
space	Associated DataSpace, see DataSpace for more informations
type	Type of Data
createProps	A property list with data set creation properties
createProps	A property list with data set access properties

Returns: DataSet Object

Definition at line 36 of file H5Node_traits_misc.hpp.

◆ createDataSet() [2/3]

template<typename Derivate >

template<typename Type >

DataSet HighFive::NodeTraits< Derivate >::createDataSet	(	const std::string &	dataset_name,
		const DataSpace &	space,
		const DataSetCreateProps &	createProps = `DataSetCreateProps()`,
		const DataSetAccessProps &	accessProps = `DataSetAccessProps()`
	)

inline

createDataSet create a new dataset in the current file with a size specified by space

Parameters

dataset_name	identifier of the dataset
space	Associated DataSpace, see DataSpace for more information
createProps	A property list with data set creation properties

Returns: DataSet Object

Definition at line 57 of file H5Node_traits_misc.hpp.

◆ createDataSet() [3/3]

template<typename Derivate >

template<typename T >

DataSet HighFive::NodeTraits< Derivate >::createDataSet	(	const std::string &	dataset_name,
		const T &	data,
		const DataSetCreateProps &	createProps = `DataSetCreateProps()`,
		const DataSetAccessProps &	accessProps = `DataSetAccessProps()`
	)

inline

createDataSet create a new dataset in the current file and write to it, inferring the DataSpace from the data.

Parameters

dataset_name	identifier of the dataset
data	Associated data, must support DataSpace::From, see DataSpace for more information
createProps	A property list with data set creation properties

Returns: DataSet Object

Definition at line 69 of file H5Node_traits_misc.hpp.

◆ createGroup()

template<typename Derivate >

Group HighFive::NodeTraits< Derivate >::createGroup ( const std::string & group_name )

inline

create a new group with the name group_name

Parameters

group_name

Returns: the group object

Definition at line 97 of file H5Node_traits_misc.hpp.

◆ exist()

template<typename Derivate >

bool HighFive::NodeTraits< Derivate >::exist ( const std::string & node_name ) const

inline

check a dataset or group exists in the current node / group

Parameters

dataset/group name to check

Returns: true if a dataset/group with the asssociated name exist, or false

Definition at line 172 of file H5Node_traits_misc.hpp.

◆ getDataSet()

template<typename Derivate >

DataSet HighFive::NodeTraits< Derivate >::getDataSet	(	const std::string &	dataset_name,
		const DataSetAccessProps &	accessProps = `DataSetAccessProps()`
	)		const

inline

get an existing dataset in the current file

Parameters

dataset_name
accessProps	property list to configure dataset chunk cache

Returns: return the named dataset, or throw exception if not found

Definition at line 84 of file H5Node_traits_misc.hpp.

◆ getGroup()

template<typename Derivate >

Group HighFive::NodeTraits< Derivate >::getGroup ( const std::string & group_name ) const

inline

open an existing group with the name group_name

Parameters

group_name

Returns: the group object

Definition at line 110 of file H5Node_traits_misc.hpp.

◆ getNumberObjects()

template<typename Derivate >

size_t HighFive::NodeTraits< Derivate >::getNumberObjects ( ) const

inline

return the number of leaf objects of the node / group

Returns: number of leaf objects

Definition at line 121 of file H5Node_traits_misc.hpp.

◆ getObjectName()

template<typename Derivate >

std::string HighFive::NodeTraits< Derivate >::getObjectName ( size_t index ) const

inline

return the name of the object with the given index

Returns: the name of the object

Definition at line 132 of file H5Node_traits_misc.hpp.

◆ listObjectNames()

template<typename Derivate >

std::vector< std::string > HighFive::NodeTraits< Derivate >::listObjectNames ( ) const

inline

list all leaf objects name of the node / group

Returns: number of leaf objects

Definition at line 152 of file H5Node_traits_misc.hpp.

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

Public Member Functions

Private Types

Detailed Description

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

Member Typedef Documentation

◆ derivate_type

Member Function Documentation

◆ createDataSet() [1/3]

◆ createDataSet() [2/3]

◆ createDataSet() [3/3]

◆ createGroup()

◆ exist()

◆ getDataSet()

◆ getGroup()

◆ getNumberObjects()

◆ getObjectName()

◆ listObjectNames()

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