Generic OdimH5 v2.0 object.
More...
#include <radarlib/odimh5v20_classes.hpp>
Generic OdimH5 v2.0 object.
All OdimH5 objects have the same general structure.
This class allows users to manipulate OdimH5 objects in the most generic way.
This means that users can manipulate only Odim datasets and common mandatory attributes.
Only mandatory informations common to every OdimH5 objects are automatic written or checked by the internal implementatino.
Users are responsible for manipulating informations following OdimH5 specifications.
- See also
- OdimDataset
- Examples
- dump_object.cpp, image-visitor.cpp, odimh5scanner.cpp, and visitor.cpp.
◆ getConventions()
std::string OdimH5v20::OdimObject::getConventions |
( |
| ) |
|
|
virtual |
Get OdimH5 conventions attribute value.
- Exceptions
-
◆ setConventions()
void OdimH5v20::OdimObject::setConventions |
( |
| ) |
|
|
virtual |
Set OdimH5 conventions attribute value to the value required by OdimH5 specification.
- Exceptions
-
◆ getFile()
H5::H5File * OdimH5v20::OdimObject::getFile |
( |
| ) |
|
|
virtual |
Get the associated HDF5 file object.
Get the associated HDF5 file object
- Exceptions
-
◆ getH5Object()
H5::Group * OdimH5v20::OdimObject::getH5Object |
( |
| ) |
|
|
virtual |
Get the HDF5 group associated to this object.
Get the HDF5 group associated to this object
- Exceptions
-
◆ existWhat()
bool OdimH5v20::OdimObject::existWhat |
( |
| ) |
|
|
virtual |
Test is the WHAT attributes group exist.
Check if the WHAT attributes group of this object exist.
- Exceptions
-
- Examples
- image-visitor.cpp.
◆ existWhere()
bool OdimH5v20::OdimObject::existWhere |
( |
| ) |
|
|
virtual |
Test is the WHERE attributes group exist.
Check if the WHERE attributes group of this object exist.
- Exceptions
-
- Examples
- image-visitor.cpp.
◆ existHow()
bool OdimH5v20::OdimObject::existHow |
( |
| ) |
|
|
virtual |
Test is the HOW attributes group exist.
Check if the HOW attributes group of this object exist.
- Exceptions
-
- Examples
- image-visitor.cpp.
◆ getWhat()
Get the WHAT attributes group.
Get the WHAT attributes group of this object. If it does not exist it will be created
- Exceptions
-
- Examples
- image-visitor.cpp.
◆ getWhere()
Get the WHERE attributes group.
Get the WHERE attributes group of this object. If it does not exist it will be created
- Exceptions
-
- Examples
- image-visitor.cpp.
◆ getHow()
Get the HOW attributes group.
Get the HOW attributes group of this object. If it does not exist it will be created
- Exceptions
-
- Examples
- image-visitor.cpp.
◆ getObject()
std::string OdimH5v20::OdimObject::getObject |
( |
| ) |
|
|
virtual |
◆ setObject()
void OdimH5v20::OdimObject::setObject |
( |
const std::string & |
val | ) |
|
|
virtual |
◆ getVersion()
std::string OdimH5v20::OdimObject::getVersion |
( |
| ) |
|
|
virtual |
◆ setVersion()
void OdimH5v20::OdimObject::setVersion |
( |
const std::string & |
val | ) |
|
|
virtual |
◆ getDateTime()
time_t OdimH5v20::OdimObject::getDateTime |
( |
| ) |
|
|
virtual |
◆ setDateTime()
void OdimH5v20::OdimObject::setDateTime |
( |
const time_t |
val | ) |
|
|
virtual |
Set the value of 'date' and 'time' attributes.
Set the value of 'date' and 'time' attributes using the given time_t value
- Parameters
-
- Exceptions
-
Implements OdimH5v20::WHATRootMetadata.
◆ getSource()
◆ setSource()
void OdimH5v20::OdimObject::setSource |
( |
const SourceInfo & |
val | ) |
|
|
virtual |
Set the value of 'source' attribute.
Set the value of 'source' attribute according to OdimH5 format, using the values stored in a SourceInfo object
- Parameters
-
- Exceptions
-
Implements OdimH5v20::WHATRootMetadata.
◆ getDatasetCount()
int OdimH5v20::OdimObject::getDatasetCount |
( |
| ) |
|
|
virtual |
Get the number of datasets in the file.
Get the number of datasets in the odim object
- Exceptions
-
◆ createDataset()
Create a new dataset.
Create a new dataset in the odim object
- Returns
- the new OdimDataset object associated to the new HDF5 group
- Exceptions
-
◆ getDataset()
OdimDataset * OdimH5v20::OdimObject::getDataset |
( |
int |
index | ) |
|
|
virtual |
Get a dataset
Get the existing dataset with the given index
- Parameters
-
index | the dataset index from 0 to n-1 |
- Returns
- the OdimDataset object associated to the new HDF5 group or NULL if the dataset does not exist
- Exceptions
-
◆ removeDataset()
void OdimH5v20::OdimObject::removeDataset |
( |
int |
index | ) |
|
|
virtual |
Delete a odim dataset group from the odim object.
Delete the odim dataset with the given index. Nothing is done if the dataset does not exist
- Parameters
-
index | the dataset index from 0 to n-1 |
- Exceptions
-
The documentation for this class was generated from the following files: