radarlib  1.4.4
OdimH5v20::OdimDataset Class Reference

Generic OdimH5 v2.0 dataset group. More...

#include <radarlib/odimh5v20_classes.hpp>

Inheritance diagram for OdimH5v20::OdimDataset:
OdimH5v20::PolarScan OdimH5v20::Product_2D OdimH5v20::Horizontal_Product_2D OdimH5v20::Vertical_Product_2D OdimH5v20::Product_CAPPI OdimH5v20::Product_COMP OdimH5v20::Product_ETOP OdimH5v20::Product_LBM OdimH5v20::Product_MAX OdimH5v20::Product_PCAPPI OdimH5v20::Product_PPI OdimH5v20::Product_RR OdimH5v20::Product_VIL OdimH5v20::Product_Panel OdimH5v20::Product_RHI OdimH5v20::Product_XSEC

Public Member Functions

virtual H5::Group * getH5Object ()
 Get the HDF5 group associated to this object. More...
 
virtual bool existWhat ()
 Test is the WHAT attributes group exist. More...
 
virtual bool existWhere ()
 Test is the WHERE attributes group exist. More...
 
virtual bool existHow ()
 Test is the HOW attributes group exist. More...
 
virtual MetadataGroupgetWhat ()
 Get the WHAT attributes group. More...
 
virtual MetadataGroupgetWhere ()
 Get the WHERE attributes group. More...
 
virtual MetadataGroupgetHow ()
 Get the HOW attributes group. More...
 
virtual int getDataCount ()
 Get the number of 'data' groups inside this dataset group. More...
 
virtual OdimDatacreateData ()
 Create a new group 'data' inside this dataset. More...
 
virtual OdimDatagetData (int index)
 Get an existing dataset using the given index. More...
 
virtual void removeData (int index)
 Remove a 'data' group from this dataset. More...
 

Detailed Description

Generic OdimH5 v2.0 dataset group.

All OdimH5 objects split informations into a variable number of datasets.
This class represents a generic OdimH5 dataset.
Generic datasets allow only to create/remove sub data and attributes.
Users are responsible for manipulating informations following OdimH5 specifications.

See Also
OdimObject, OdimData
Examples:
create_delete.cpp, and create_odim_object.cpp.

Member Function Documentation

H5::Group * OdimH5v20::OdimDataset::getH5Object ( )
virtual

Get the HDF5 group associated to this object.

Get the HDF5 group associated to this object

Remarks
user must not delete this object
Exceptions
OdimH5Exceptionif an unexpected error occurs
bool OdimH5v20::OdimDataset::existWhat ( )
virtual

Test is the WHAT attributes group exist.

Check if the WHAT attributes group of this object exist.

Exceptions
OdimH5Exceptionif an unexpected error occurs
Examples:
image-visitor.cpp.
bool OdimH5v20::OdimDataset::existWhere ( )
virtual

Test is the WHERE attributes group exist.

Check if the WHERE attributes group of this object exist.

Exceptions
OdimH5Exceptionif an unexpected error occurs
Examples:
image-visitor.cpp.
bool OdimH5v20::OdimDataset::existHow ( )
virtual

Test is the HOW attributes group exist.

Check if the HOW attributes group of this object exist.

Exceptions
OdimH5Exceptionif an unexpected error occurs
Examples:
image-visitor.cpp.
MetadataGroup * OdimH5v20::OdimDataset::getWhat ( )
virtual

Get the WHAT attributes group.

Get the WHAT attributes group of this object. If it does not exist it will be created

Remarks
user must not delete this object
Exceptions
OdimH5Exceptionif an unexpected error occurs
Examples:
create_delete.cpp, create_odim_object.cpp, create_polar_volume.cpp, and image-visitor.cpp.
MetadataGroup * OdimH5v20::OdimDataset::getWhere ( )
virtual

Get the WHERE attributes group.

Get the WHERE attributes group of this object. If it does not exist it will be created

Remarks
user must not delete this object
Exceptions
OdimH5Exceptionif an unexpected error occurs
Examples:
image-visitor.cpp.
MetadataGroup * OdimH5v20::OdimDataset::getHow ( )
virtual

Get the HOW attributes group.

Get the HOW attributes group of this object. If it does not exist it will be created

Remarks
user must not delete this object
Exceptions
OdimH5Exceptionif an unexpected error occurs
Examples:
image-visitor.cpp.
int OdimH5v20::OdimDataset::getDataCount ( )
virtual

Get the number of 'data' groups inside this dataset group.

Returns
the number of 'data' groups
Exceptions
OdimH5Exceptionif an unexpected error occurs
OdimData * OdimH5v20::OdimDataset::createData ( )
virtual

Create a new group 'data' inside this dataset.

Returns
the object associated to the new 'data' group
Exceptions
OdimH5Exceptionif an unexpected error occurs
Remarks
User is responsible for deleting the returned object
Examples:
create_delete.cpp, and create_odim_object.cpp.
OdimData * OdimH5v20::OdimDataset::getData ( int  index)
virtual

Get an existing dataset using the given index.

Get an existing dataset using the given index

Parameters
indexthe dataset index from 0 to n-1
Returns
the OdimData object associated to the HDF5 group or NULL if the group does not exist
Exceptions
OdimH5Exceptionif an unexpected error occurs
Remarks
User is responsible for deleting the returned object
void OdimH5v20::OdimDataset::removeData ( int  index)
virtual

Remove a 'data' group from this dataset.

Remove a 'data' group from this dataset

Parameters
indexthe dataset index from 0 to n-1
Exceptions
OdimH5Exceptionif an unexpected error occurs
Examples:
create_delete.cpp.

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