#include <H5File.hpp>

Inheritance diagram for HighFive::File:

Collaboration diagram for HighFive::File:

Public Types
enum	: unsigned { ReadOnly = 0x00u, ReadWrite = 0x01u, Truncate = 0x02u, Excl = 0x04u, Debug = 0x08u, Create = 0x10u, Overwrite = Truncate, OpenOrCreate = ReadWrite \| Create }

Public Member Functions
	File (const std::string &filename, unsigned openFlags=ReadOnly, const FileAccessProps &fileAccessProps=FileDriver())
	File. More...

const std::string &	getName () const noexcept
	Return the name of the file. More...

void	flush ()
	flush More...

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< File >
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< File >
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...

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

Additional Inherited Members
Protected Member Functions inherited from HighFive::Object
	Object ()

	Object (const Object &other)

	Object (Object &&other) noexcept

	Object (hid_t)

Object &	operator= (const Object &other)

Protected Attributes inherited from HighFive::Object
hid_t	_hid

Detailed Description

File class.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum : unsigned

Enumerator
ReadOnly	Open flag: Read only access.
ReadWrite	Open flag: Read Write access.
Truncate	Open flag: Truncate a file if already existing.
Excl	Open flag: Open will fail if file already exist.
Debug	Open flag: Open in debug mode.
Create	Open flag: Create non existing file.
Overwrite	Derived open flag: common write mode (=ReadWrite\|Create\|Truncate)
OpenOrCreate	Derived open flag: Opens RW or exclusively creates.

Constructor & Destructor Documentation

◆ File()

HighFive::File::File	(	const std::string &	filename,
		unsigned	openFlags = `ReadOnly`,
		const FileAccessProps &	fileAccessProps = `FileDriver()`
	)

inlineexplicit

File.

Parameters

filename	filepath of the HDF5 file
openFlags	Open mode / flags ( ReadOnly, ReadWrite)
fileAccessProps	the file access properties

Open or create a new HDF5 file

Member Function Documentation

◆ flush()

void HighFive::File::flush ( )

inline

flush

Flushes all buffers associated with a file to disk

◆ getName()

const std::string & HighFive::File::getName ( ) const

inlinenoexcept

Return the name of the file.

Member Data Documentation

◆ type

const static ObjectType HighFive::File::type = ObjectType::File

static

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

Public Types

Public Member Functions

Static Public Attributes

Additional Inherited Members