radarlib 1.4.6
OdimH5v20::PolarVolume Class Reference

OdimH5 v2.0 Polar Volume. More...

#include <radarlib/odimh5v20_classes.hpp>

Inheritance diagram for OdimH5v20::PolarVolume:
OdimH5v20::OdimObject OdimH5v20::WHERERootMetadata OdimH5v20::HOWRootMetadata OdimH5v20::WHATRootMetadata

Public Member Functions

virtual void setLongitude (double val)
 Set the value of 'longitude' attribute.
 
virtual double getLatitude ()
 Get the value of 'longitude' attribute.
 
virtual void setLatitude (double val)
 Set the value of 'latitude' attribute.
 
virtual double getAltitude ()
 Get the value of 'altitude' attribute.
 
virtual void setAltitude (double val)
 Set the value of 'altitude' attribute.
 
virtual std::string getTaskOrProdGen ()
 Get the 'task' attribute value.
 
virtual void setTaskOrProdGen (const std::string &val)
 Set the 'task' attribute value.
 
virtual time_t getStartEpochs ()
 Get the 'startepochs' attribute value.
 
virtual void setStartEpochs (time_t val)
 Set the 'startepochs' attribute value.
 
virtual time_t getEndEpochs ()
 Get the 'endepochs' attribute value.
 
virtual void setEndEpochs (time_t val)
 Set the 'endepochs' attribute value.
 
virtual std::string getSystem ()
 Get the 'system' attribute value.
 
virtual void setSystem (const std::string &val)
 Set the 'system' attribute value.
 
virtual std::string getSoftware ()
 Get the 'software' attribute value.
 
virtual void setSoftware (const std::string &val)
 Set the 'software' attribute value.
 
virtual std::string getSoftwareVer ()
 Get the 'sw_version' attribute value.
 
virtual void setSoftwareVer (const std::string &val)
 Set the 'sw_version' attribute value.
 
virtual double getZR_A ()
 Get the 'zr_a' attribute value.
 
virtual void setZR_A (double val)
 Set the 'zr_a' attribute value.
 
virtual double getZR_B ()
 Get the 'zr_b' attribute value.
 
virtual void setZR_B (double val)
 Set the 'zr_b' attribute value.
 
virtual double getKR_A ()
 Get the 'kr_a' attribute value.
 
virtual void setKR_A (double val)
 Set the 'kr_a' attribute value.
 
virtual double getKR_B ()
 Get the 'kr_b' attribute value.
 
virtual void setKR_B (double val)
 Set the 'kr_b' attribute value.
 
virtual bool getSimulated ()
 Get the 'simulated' attribute value.
 
virtual void setSimulated (bool val)
 Set the 'simulated' attribute value.
 
virtual int getScanCount ()
 Get the number of scans store in this volume.
 
virtual PolarScancreateScan ()
 Create a new scan in this volume.
 
virtual PolarScangetScan (int index)
 Get a pointer to a scan of the volume.
 
virtual void removeScan (int index)
 Remove a scan from the volume.
 
virtual std::vector< PolarScan * > getScans ()
 Get the pointers to all the scans in the volume.
 
virtual std::vector< PolarScan * > getScans (double elevation, double gap=0)
 Get the pointers to all the scans at the elevation angle indicated +/- a given gap

 
virtual std::vector< PolarScan * > getScansBetween (double minElevation, double maxElevation)
 Get the pointers to all the scans with an elevation angle between the given limits.
 
virtual std::vector< PolarScan * > getScans (const char *quantity)
 Get the pointers to all the scans that contains indicated quantity

 
virtual std::vector< double > getScanAngles ()
 Get the elevation angle for each scan in the volume.
 
virtual std::vector< double > getElevationAngles ()
 Get the elevation angles for all the scans in the volumes without duplicates.
 
virtual std::set< std::string > getStoredQuantities ()
 Get the set of radar quantities stored in the scans.
 
virtual std::string getConventions ()
 Get OdimH5 conventions attribute value.
 
virtual void setConventions ()
 Set OdimH5 conventions attribute value to the value required by OdimH5 specification.
 
virtual H5::H5File * getFile ()
 Get the associated HDF5 file object.
 
virtual H5::Group * getH5Object ()
 Get the HDF5 group associated to this object.
 
virtual bool existWhat ()
 Test is the WHAT attributes group exist.
 
virtual bool existWhere ()
 Test is the WHERE attributes group exist.
 
virtual bool existHow ()
 Test is the HOW attributes group exist.
 
virtual MetadataGroupgetWhat ()
 Get the WHAT attributes group.
 
virtual MetadataGroupgetWhere ()
 Get the WHERE attributes group.
 
virtual MetadataGroupgetHow ()
 Get the HOW attributes group.
 
virtual std::string getObject ()
 Get the value of 'object' attribute.
 
virtual void setObject (const std::string &val)
 Set the value of 'object' attribute.
 
virtual std::string getVersion ()
 Get the value of 'version' attribute.
 
virtual void setVersion (const std::string &val)
 Set the value of 'version' attribute.
 
virtual time_t getDateTime ()
 Get the joined value of 'date' and 'time' attributes.
 
virtual void setDateTime (const time_t val)
 Set the value of 'date' and 'time' attributes.
 
virtual SourceInfo getSource ()
 Get the value of 'source' attribute.
 
virtual void setSource (const SourceInfo &val)
 Set the value of 'source' attribute.
 
virtual int getDatasetCount ()
 Get the number of datasets in the file.
 
virtual OdimDatasetcreateDataset ()
 Create a new dataset.
 
virtual OdimDatasetgetDataset (int index)
 Get a dataset

 
virtual void removeDataset (int index)
 Delete a odim dataset group from the odim object.
 

Detailed Description

OdimH5 v2.0 Polar Volume.


This class represents an OdimH5 PVOL composed of SCAN objects.

Polar volume specific attributes can be manipulated using specific methods.

Generic data manipulations can be done using methods provided by the OdimObject interface.

See also
PolarScan
Examples
copy_polar_volume_attributes.cpp, create_polar_volume.cpp, odimh5scanner.cpp, pvolsplitter.cpp, read_polar_volume.cpp, read_polar_volume2.cpp, read_polar_volume_scans.cpp, visitor.cpp, and write_attributes.cpp.

Member Function Documentation

◆ setLongitude()

void OdimH5v20::PolarVolume::setLongitude ( double val)
virtual

Set the value of 'longitude' attribute.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::WHERERootMetadata.

Examples
create_polar_volume.cpp, and write_attributes.cpp.

◆ getLatitude()

double OdimH5v20::PolarVolume::getLatitude ( )
virtual

Get the value of 'longitude' attribute.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::WHERERootMetadata.

Examples
odimh5scanner.cpp, read_polar_volume.cpp, read_polar_volume2.cpp, and read_polar_volume_scans.cpp.

◆ setLatitude()

void OdimH5v20::PolarVolume::setLatitude ( double val)
virtual

Set the value of 'latitude' attribute.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::WHERERootMetadata.

Examples
create_polar_volume.cpp.

◆ getAltitude()

double OdimH5v20::PolarVolume::getAltitude ( )
virtual

Get the value of 'altitude' attribute.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::WHERERootMetadata.

Examples
odimh5scanner.cpp, read_polar_volume.cpp, read_polar_volume2.cpp, and read_polar_volume_scans.cpp.

◆ setAltitude()

void OdimH5v20::PolarVolume::setAltitude ( double val)
virtual

Set the value of 'altitude' attribute.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::WHERERootMetadata.

Examples
create_polar_volume.cpp.

◆ getTaskOrProdGen()

std::string OdimH5v20::PolarVolume::getTaskOrProdGen ( )
virtual

Get the 'task' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::HOWRootMetadata.

Examples
odimh5scanner.cpp, read_polar_volume.cpp, read_polar_volume2.cpp, and read_polar_volume_scans.cpp.

◆ setTaskOrProdGen()

void OdimH5v20::PolarVolume::setTaskOrProdGen ( const std::string & val)
virtual

Set the 'task' attribute value.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::HOWRootMetadata.

Examples
create_polar_volume.cpp.

◆ getStartEpochs()

time_t OdimH5v20::PolarVolume::getStartEpochs ( )
virtual

Get the 'startepochs' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::HOWRootMetadata.

Examples
read_polar_volume.cpp, read_polar_volume2.cpp, and read_polar_volume_scans.cpp.

◆ setStartEpochs()

void OdimH5v20::PolarVolume::setStartEpochs ( time_t val)
virtual

Set the 'startepochs' attribute value.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::HOWRootMetadata.

Examples
create_polar_volume.cpp.

◆ getEndEpochs()

time_t OdimH5v20::PolarVolume::getEndEpochs ( )
virtual

Get the 'endepochs' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::HOWRootMetadata.

Examples
read_polar_volume.cpp, read_polar_volume2.cpp, and read_polar_volume_scans.cpp.

◆ setEndEpochs()

void OdimH5v20::PolarVolume::setEndEpochs ( time_t val)
virtual

Set the 'endepochs' attribute value.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::HOWRootMetadata.

Examples
create_polar_volume.cpp.

◆ getSystem()

std::string OdimH5v20::PolarVolume::getSystem ( )
virtual

Get the 'system' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::HOWRootMetadata.

Examples
read_polar_volume.cpp, read_polar_volume2.cpp, and read_polar_volume_scans.cpp.

◆ setSystem()

void OdimH5v20::PolarVolume::setSystem ( const std::string & val)
virtual

Set the 'system' attribute value.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::HOWRootMetadata.

Examples
create_polar_volume.cpp.

◆ getSoftware()

std::string OdimH5v20::PolarVolume::getSoftware ( )
virtual

Get the 'software' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::HOWRootMetadata.

Examples
read_polar_volume.cpp, read_polar_volume2.cpp, and read_polar_volume_scans.cpp.

◆ setSoftware()

void OdimH5v20::PolarVolume::setSoftware ( const std::string & val)
virtual

Set the 'software' attribute value.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::HOWRootMetadata.

Examples
create_polar_volume.cpp.

◆ getSoftwareVer()

std::string OdimH5v20::PolarVolume::getSoftwareVer ( )
virtual

Get the 'sw_version' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::HOWRootMetadata.

Examples
read_polar_volume.cpp, read_polar_volume2.cpp, and read_polar_volume_scans.cpp.

◆ setSoftwareVer()

void OdimH5v20::PolarVolume::setSoftwareVer ( const std::string & val)
virtual

Set the 'sw_version' attribute value.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::HOWRootMetadata.

Examples
create_polar_volume.cpp.

◆ getZR_A()

double OdimH5v20::PolarVolume::getZR_A ( )
virtual

Get the 'zr_a' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::HOWRootMetadata.

Examples
read_polar_volume.cpp, read_polar_volume2.cpp, and read_polar_volume_scans.cpp.

◆ setZR_A()

void OdimH5v20::PolarVolume::setZR_A ( double val)
virtual

Set the 'zr_a' attribute value.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::HOWRootMetadata.

Examples
create_polar_volume.cpp.

◆ getZR_B()

double OdimH5v20::PolarVolume::getZR_B ( )
virtual

Get the 'zr_b' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::HOWRootMetadata.

Examples
read_polar_volume.cpp, read_polar_volume2.cpp, and read_polar_volume_scans.cpp.

◆ setZR_B()

void OdimH5v20::PolarVolume::setZR_B ( double val)
virtual

Set the 'zr_b' attribute value.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::HOWRootMetadata.

Examples
create_polar_volume.cpp.

◆ getKR_A()

double OdimH5v20::PolarVolume::getKR_A ( )
virtual

Get the 'kr_a' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::HOWRootMetadata.

Examples
read_polar_volume.cpp, read_polar_volume2.cpp, and read_polar_volume_scans.cpp.

◆ setKR_A()

void OdimH5v20::PolarVolume::setKR_A ( double val)
virtual

Set the 'kr_a' attribute value.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::HOWRootMetadata.

Examples
create_polar_volume.cpp.

◆ getKR_B()

double OdimH5v20::PolarVolume::getKR_B ( )
virtual

Get the 'kr_b' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::HOWRootMetadata.

Examples
read_polar_volume.cpp, read_polar_volume2.cpp, and read_polar_volume_scans.cpp.

◆ setKR_B()

void OdimH5v20::PolarVolume::setKR_B ( double val)
virtual

Set the 'kr_b' attribute value.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::HOWRootMetadata.

Examples
create_polar_volume.cpp.

◆ getSimulated()

bool OdimH5v20::PolarVolume::getSimulated ( )
virtual

Get the 'simulated' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::HOWRootMetadata.

Examples
read_polar_volume.cpp, read_polar_volume2.cpp, and read_polar_volume_scans.cpp.

◆ setSimulated()

void OdimH5v20::PolarVolume::setSimulated ( bool val)
virtual

Set the 'simulated' attribute value.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::HOWRootMetadata.

Examples
create_polar_volume.cpp.

◆ getScanCount()

int OdimH5v20::PolarVolume::getScanCount ( )
virtual

Get the number of scans store in this volume.

Exceptions
OdimH5ExceptionThrowed if an error occurs
Examples
read_polar_volume.cpp.

◆ createScan()

PolarScan * OdimH5v20::PolarVolume::createScan ( )
virtual

Create a new scan in this volume.

Exceptions
OdimH5ExceptionThrowed if an error occurs
Remarks
User is responsible for deleting the returned object
Examples
create_polar_volume.cpp.

◆ getScan()

PolarScan * OdimH5v20::PolarVolume::getScan ( int index)
virtual

Get a pointer to a scan of the volume.

Parameters
indexThe scan number (from 0 to n-1)
Exceptions
OdimH5ExceptionThrowed if an error occurs
Remarks
User is responsible for deleting the returned object
Examples
read_polar_volume.cpp.

◆ removeScan()

void OdimH5v20::PolarVolume::removeScan ( int index)
virtual

Remove a scan from the volume.

Parameters
indexThe scan number (from 0 to n-1)
Exceptions
OdimH5ExceptionThrowed if an error occurs
Remarks
User is responsible for deleting the returned object

◆ getScans() [1/3]

std::vector< PolarScan * > OdimH5v20::PolarVolume::getScans ( )
virtual

Get the pointers to all the scans in the volume.

Exceptions
OdimH5ExceptionThrowed if an error occurs
Remarks
User is responsible for deleting the returned objects

◆ getScans() [2/3]

std::vector< PolarScan * > OdimH5v20::PolarVolume::getScans ( double elevation,
double gap = 0 )
virtual

Get the pointers to all the scans at the elevation angle indicated +/- a given gap

Parameters
elevationThe base elevation angle
gapThe allowed gap between the scan angle and the base angle
Exceptions
OdimH5ExceptionThrowed if an error occurs
Remarks
User is responsible for deleting the returned objects

◆ getScansBetween()

std::vector< PolarScan * > OdimH5v20::PolarVolume::getScansBetween ( double minElevation,
double maxElevation )
virtual

Get the pointers to all the scans with an elevation angle between the given limits.

Parameters
minElevationThe lowest allowed angle
maxElevationThe highest allowed angle
Exceptions
OdimH5ExceptionThrowed if an error occurs
Remarks
User is responsible for deleting the returned objects
Examples
read_polar_volume2.cpp, and read_polar_volume_scans.cpp.

◆ getScans() [3/3]

std::vector< PolarScan * > OdimH5v20::PolarVolume::getScans ( const char * quantity)
virtual

Get the pointers to all the scans that contains indicated quantity

Parameters
quantityThe quanty name
Exceptions
OdimH5ExceptionThrowed if an error occurs
Remarks
User is responsible for deleting the returned object

◆ getScanAngles()

std::vector< double > OdimH5v20::PolarVolume::getScanAngles ( )
virtual

Get the elevation angle for each scan in the volume.

Returns
A vector with the elevation angles
Exceptions
OdimH5ExceptionThrowed if an error occurs
Remarks
User is responsible for deleting the returned objects
Examples
read_polar_volume.cpp.

◆ getElevationAngles()

std::vector< double > OdimH5v20::PolarVolume::getElevationAngles ( )
virtual

Get the elevation angles for all the scans in the volumes without duplicates.

Returns
A vector with the elevation angles
Exceptions
OdimH5ExceptionThrowed if an error occurs
Examples
odimh5scanner.cpp, and read_polar_volume.cpp.

◆ getStoredQuantities()

std::set< std::string > OdimH5v20::PolarVolume::getStoredQuantities ( )
virtual

Get the set of radar quantities stored in the scans.

Returns
A STL set containing quantity names
Exceptions
OdimH5ExceptionThrowed if an error occurs
Examples
odimh5scanner.cpp.

◆ getConventions()

std::string OdimH5v20::OdimObject::getConventions ( )
virtualinherited

Get OdimH5 conventions attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs
Examples
read_polar_volume.cpp, read_polar_volume2.cpp, and read_polar_volume_scans.cpp.

◆ setConventions()

void OdimH5v20::OdimObject::setConventions ( )
virtualinherited

Set OdimH5 conventions attribute value to the value required by OdimH5 specification.

Exceptions
OdimH5Exceptionif an unexpected error occurs

◆ getFile()

H5::H5File * OdimH5v20::OdimObject::getFile ( )
virtualinherited

Get the associated HDF5 file object.

Get the associated HDF5 file object

Remarks
user must not delete this object
Exceptions
OdimH5Exceptionif an unexpected error occurs

◆ getH5Object()

H5::Group * OdimH5v20::OdimObject::getH5Object ( )
virtualinherited

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

◆ existWhat()

bool OdimH5v20::OdimObject::existWhat ( )
virtualinherited

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.

◆ existWhere()

bool OdimH5v20::OdimObject::existWhere ( )
virtualinherited

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.

◆ existHow()

bool OdimH5v20::OdimObject::existHow ( )
virtualinherited

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.

◆ getWhat()

MetadataGroup * OdimH5v20::OdimObject::getWhat ( )
virtualinherited

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
copy_polar_volume_attributes.cpp, image-visitor.cpp, read_attributes.cpp, and write_attributes.cpp.

◆ getWhere()

MetadataGroup * OdimH5v20::OdimObject::getWhere ( )
virtualinherited

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
copy_polar_volume_attributes.cpp, and image-visitor.cpp.

◆ getHow()

MetadataGroup * OdimH5v20::OdimObject::getHow ( )
virtualinherited

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
copy_polar_volume_attributes.cpp, create_polar_volume.cpp, and image-visitor.cpp.

◆ getObject()

std::string OdimH5v20::OdimObject::getObject ( )
virtualinherited

Get the value of 'object' attribute.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::WHATRootMetadata.

Examples
image-visitor.cpp, odimh5scanner.cpp, read_attributes.cpp, read_polar_volume.cpp, read_polar_volume2.cpp, read_polar_volume_scans.cpp, and visitor.cpp.

◆ setObject()

void OdimH5v20::OdimObject::setObject ( const std::string & val)
virtualinherited

Set the value of 'object' attribute.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::WHATRootMetadata.

Examples
create_delete.cpp, create_odim_object.cpp, and write_attributes.cpp.

◆ getVersion()

std::string OdimH5v20::OdimObject::getVersion ( )
virtualinherited

Get the value of 'version' attribute.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::WHATRootMetadata.

Examples
read_polar_volume.cpp, read_polar_volume2.cpp, and read_polar_volume_scans.cpp.

◆ setVersion()

void OdimH5v20::OdimObject::setVersion ( const std::string & val)
virtualinherited

Set the value of 'version' attribute.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::WHATRootMetadata.

◆ getDateTime()

time_t OdimH5v20::OdimObject::getDateTime ( )
virtualinherited

Get the joined value of 'date' and 'time' attributes.

Get the joined value of 'date' and 'time' attributes in a single time_t value

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::WHATRootMetadata.

Examples
image-visitor.cpp, odimh5scanner.cpp, read_attributes.cpp, read_polar_volume.cpp, read_polar_volume2.cpp, and read_polar_volume_scans.cpp.

◆ setDateTime()

void OdimH5v20::OdimObject::setDateTime ( const time_t val)
virtualinherited

Set the value of 'date' and 'time' attributes.

Set the value of 'date' and 'time' attributes using the given time_t value

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::WHATRootMetadata.

Examples
create_polar_volume.cpp, and write_attributes.cpp.

◆ getSource()

SourceInfo OdimH5v20::OdimObject::getSource ( )
virtualinherited

Get the value of 'source' attribute.

Returns
A SourceInfo object ottained parsing the 'source' attribute
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::WHATRootMetadata.

Examples
odimh5scanner.cpp, read_polar_volume.cpp, read_polar_volume2.cpp, and read_polar_volume_scans.cpp.

◆ setSource()

void OdimH5v20::OdimObject::setSource ( const SourceInfo & val)
virtualinherited

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
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v20::WHATRootMetadata.

Examples
create_polar_volume.cpp.

◆ getDatasetCount()

int OdimH5v20::OdimObject::getDatasetCount ( )
virtualinherited

Get the number of datasets in the file.

Get the number of datasets in the odim object

Exceptions
OdimH5Exceptionif an unexpected error occurs

◆ createDataset()

OdimDataset * OdimH5v20::OdimObject::createDataset ( )
virtualinherited

Create a new dataset.

Create a new dataset in the odim object

Returns
the new OdimDataset object associated to the new HDF5 group
Exceptions
OdimH5Exceptionif an unexpected error occurs
Remarks
User is responsible for deleting the returned object

◆ getDataset()

OdimDataset * OdimH5v20::OdimObject::getDataset ( int index)
virtualinherited

Get a dataset

Get the existing dataset with the given index

Parameters
indexthe 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
OdimH5Exceptionif an unexpected error occurs
Remarks
User is responsible for deleting the returned object

◆ removeDataset()

void OdimH5v20::OdimObject::removeDataset ( int index)
virtualinherited

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
indexthe dataset index from 0 to n-1
Exceptions
OdimH5Exceptionif an unexpected error occurs
Remarks
User is responsible for deleting the returned object

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