radarlib 1.4.6
OdimH5v21::HDF5Group Class Reference

HDF5Group class. More...

#include <radarlib/odimh5v21_hdf5.hpp>

Static Public Member Functions

static int getChildCount (H5::Group *parent, const char *prefix)
 Get the number of children group of a given HDF5 group. More...
 
static H5::Group * getChild (H5::Group *parent, const char *name)
 Get the a child group of a given HDF5 group. More...
 
static void ensureChild (H5::Group *parent, const char *name)
 Check or create a child group. More...
 
static H5::Group * ensureGetChild (H5::Group *parent, const char *name)
 Get (and automatically create) a child group. More...
 
static void removeChild (H5::Group *parent, const char *name)
 Delete a child group. More...
 
static bool exists (H5::Group *parent, const char *name)
 Check for child group existance. More...
 
static H5::DataSet * getDataset (H5::Group *parent, const char *name)
 Get a HDF5 dataset child of a given HDF5 group. More...
 
static void copyAttributes (H5::Group *src, H5::Group *dst)
 Copy all attributes from a HDF5 group to another. More...
 
static void copyAttributes (H5::Group *src, H5::Group *dst, const std::set< std::string > &names)
 Copy all specified attributes from a HDF5 group to another. More...
 

Detailed Description

HDF5Group class.

This is an internal class with methods to perform operations on HDF5 groups

Member Function Documentation

◆ getChildCount()

int OdimH5v21::HDF5Group::getChildCount ( H5::Group *  parent,
const char *  prefix 
)
static

Get the number of children group of a given HDF5 group.

Get the number of children group of a given HDF5 group searching for elements with the same name prefix

Parameters
parentthe parent HDF5 object
prefixthe name prefix used to select children
Exceptions
OdimH5Exceptionif an unexpected error occurs

◆ getChild()

H5::Group * OdimH5v21::HDF5Group::getChild ( H5::Group *  parent,
const char *  name 
)
static

Get the a child group of a given HDF5 group.

Get the child group of a given HDF5 group using a given name

Parameters
parentthe parent HDF5 object
namethe name of the child
Returns
The child group or NULL if it does not exists
Exceptions
OdimH5Exceptionif an unexpected error occurs

◆ ensureChild()

void OdimH5v21::HDF5Group::ensureChild ( H5::Group *  parent,
const char *  name 
)
static

Check or create a child group.

Check or create a child group of a given group

Parameters
parentthe parent HDF5 object
namethe name of the child
Exceptions
OdimH5Exceptionif an unexpected error occurs

◆ ensureGetChild()

H5::Group * OdimH5v21::HDF5Group::ensureGetChild ( H5::Group *  parent,
const char *  name 
)
static

Get (and automatically create) a child group.

Get (and automatically create) a child group of a given group with the given name

Parameters
parentthe parent HDF5 object
namethe name of the child
Returns
the child group
Exceptions
OdimH5Exceptionif an unexpected error occurs

◆ removeChild()

void OdimH5v21::HDF5Group::removeChild ( H5::Group *  parent,
const char *  name 
)
static

Delete a child group.

Delete a child group

Parameters
parentthe parent HDF5 object
namethe name of the child
Exceptions
OdimH5Exceptionif an unexpected error occurs

◆ exists()

bool OdimH5v21::HDF5Group::exists ( H5::Group *  parent,
const char *  name 
)
static

Check for child group existance.

Check for child group existance

Parameters
parentthe parent HDF5 object
namethe name of the child
Exceptions
OdimH5Exceptionif an unexpected error occurs

◆ getDataset()

H5::DataSet * OdimH5v21::HDF5Group::getDataset ( H5::Group *  parent,
const char *  name 
)
static

Get a HDF5 dataset child of a given HDF5 group.

Get a HDF5 dataset child of a given HDF5 group

Parameters
parentthe parent HDF5 object
namethe name of the child
Exceptions
OdimH5Exceptionif an unexpected error occurs or the group is not found

◆ copyAttributes() [1/2]

void OdimH5v21::HDF5Group::copyAttributes ( H5::Group *  src,
H5::Group *  dst 
)
static

Copy all attributes from a HDF5 group to another.

Copy all attributes from a HDF5 group to another

Parameters
srcthe HDF5 group to copy from
dstthe HDF5 group to copy to
Exceptions
OdimH5Exceptionif an unexpected error occurs

◆ copyAttributes() [2/2]

void OdimH5v21::HDF5Group::copyAttributes ( H5::Group *  src,
H5::Group *  dst,
const std::set< std::string > &  names 
)
static

Copy all specified attributes from a HDF5 group to another.

Copy all attributes from a HDF5 group to another

Parameters
srcthe HDF5 group to copy from
dstthe HDF5 group to copy to
namesthe attributes to copy
Exceptions
OdimH5Exceptionif an unexpected error occurs

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