Group Class Reference

#include <group.hh>

Public Member Functions
	Group ()=default
	Group (hid_t id)
hid_t	id () const noexcept
bool	valid () const noexcept
Group	create_group (const std::string &name)
Group	open_group (const std::string &name)
bool	has_group (const std::string &name) const
bool	has_dataset (const std::string &name) const
Dataset	create_dataset (const std::string &name, const Datatype &type, const Dataspace &space)
Dataset	create_chunked_dataset (const std::string &name, const Datatype &type, const Dataspace &space, const Dims &chunk)
Dataset	open_dataset (const std::string &name)
void	create_soft_link (const std::string &name, const std::string &target_path)
template<class T > requires (!std::is_same_v<std::decay_t<T>, std::string>)
void	write_attribute (const std::string &name, const T &value)
void	write_attribute (const std::string &name, const std::string &value)
void	write_attribute (const std::string &name, const char *value)
bool	has_attribute (const std::string &name) const
void	delete_attribute (const std::string &name)
template<class T >
void	overwrite_attribute (const std::string &name, const T &value)
template<class T > requires (!std::is_same_v<std::decay_t<T>, std::string>)
T	read_attribute (const std::string &name) const
template<class T > requires (std::is_same_v<std::decay_t<T>, std::string>)
std::string	read_attribute (const std::string &name) const
std::vector< std::string >	child_names () const
	Names of all immediate children, in link-name order.
bool	child_is_group (const std::string &name) const
bool	child_is_dataset (const std::string &name) const

Static Public Member Functions
static Group	take (hid_t id)

Constructor & Destructor Documentation

Group() [1/2]

Group ( )

default

Group() [2/2]

Group ( hid_t id )

inlineexplicit

Member Function Documentation

child_is_dataset()

bool child_is_dataset ( const std::string & name ) const

inline

child_is_group()

bool child_is_group ( const std::string & name ) const

inline

child_names()

std::vector< std::string > child_names ( ) const

inline

Names of all immediate children, in link-name order.

create_chunked_dataset()

Dataset create_chunked_dataset ( const std::string & name, const Datatype & type, const Dataspace & space, const Dims & chunk )

inline

Create a chunked dataset. Pass an unlimited Dataspace for an appendable dataset.

create_dataset()

Dataset create_dataset ( const std::string & name, const Datatype & type, const Dataspace & space )

inline

create_group()

Group create_group ( const std::string & name )

inline

create_soft_link()

void create_soft_link ( const std::string & name, const std::string & target_path )

inline

delete_attribute()

void delete_attribute ( const std::string & name )

inline

has_attribute()

bool has_attribute ( const std::string & name ) const

inline

has_dataset()

bool has_dataset ( const std::string & name ) const

inline

has_group()

bool has_group ( const std::string & name ) const

inline

id()

hid_t id ( ) const

inlinenoexcept

open_dataset()

Dataset open_dataset ( const std::string & name )

inline

open_group()

Group open_group ( const std::string & name )

inline

overwrite_attribute()

template<class T >

void overwrite_attribute ( const std::string & name, const T & value )

inline

Write an attribute, replacing any existing one of that name.

Deliberately separate from write_attribute, which fails on a name that is already taken – for most attributes a second write is a bug, and that throw is the only thing that catches it. Use this only where a value is meant to change over the file's life.

read_attribute() [1/2]

template<class T >
requires (!std::is_same_v<std::decay_t<T>, std::string>)

T read_attribute ( const std::string & name ) const

inline

read_attribute() [2/2]

template<class T >
requires (std::is_same_v<std::decay_t<T>, std::string>)

std::string read_attribute ( const std::string & name ) const

inline

take()

static Group take ( hid_t id )

inlinestatic

valid()

bool valid ( ) const

inlinenoexcept

write_attribute() [1/3]

void write_attribute ( const std::string & name, const char * value )

inline

write_attribute() [2/3]

void write_attribute ( const std::string & name, const std::string & value )

inline

write_attribute() [3/3]

template<class T >
requires (!std::is_same_v<std::decay_t<T>, std::string>)

void write_attribute ( const std::string & name, const T & value )

inline

---

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

• /home/runner/work/DiFfRG/DiFfRG/DiFfRG/include/hdf5lib/group.hh