radarlib 1.4.6
OdimH5v20::HOWDatasetMetadata Class Referenceabstract

Interface fot HOW dataset attributes methods. More...

#include <radarlib/odimh5v20_metadata.hpp>

Inheritance diagram for OdimH5v20::HOWDatasetMetadata:
OdimH5v20::HOWRootMetadata OdimH5v20::HOWPolarMetadata OdimH5v20::HOWVerticalProfileMetadata 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 double getBeamWidth ()=0
 Get the 'beamwidth' attribute value.
 
virtual double getBeamWidth (double defaultValue)=0
 Get the 'beamwidth' attribute value.
 
virtual void setBeamWidth (double val)=0
 Set the 'beamwidth' attribute value.
 
virtual double getWaveLength ()=0
 Get the 'wavelength' attribute value.
 
virtual double getWaveLength (double defaultValue)=0
 Get the 'wavelength' attribute value.
 
virtual void setWaveLength (double val)=0
 Get the 'wavelength' attribute value.
 
virtual double getRPM ()=0
 Get the 'prm' attribute value.
 
virtual double getRPM (double defaultValue)=0
 Get the 'rpm' attribute value.
 
virtual void setRPM (double val)=0
 Get the 'rpm' attribute value.
 
virtual double getPulseWidth ()=0
 Get the 'pulsewidth' attribute value.
 
virtual double getPulseWidth (double defaultValue)=0
 Get the 'pulsewidth' attribute value.
 
virtual void setPulseWidth (double val)=0
 Get the 'pulsewidth' attribute value.
 
virtual int getLowPRF ()=0
 Get the 'lowprf' attribute value.
 
virtual int getLowPRF (int defaultValue)=0
 Get the 'lowprf' attribute value.
 
virtual void setLowPRF (int val)=0
 Get the 'lowprf' attribute value.
 
virtual int getHighPRF ()=0
 Get the 'highprf' attribute value.
 
virtual int getHighPRF (int defaultValue)=0
 Get the 'highprf' attribute value.
 
virtual void setHighPRF (int val)=0
 Get the 'highprf' attribute value.
 
virtual std::string getTaskOrProdGen ()=0
 Get the 'task' attribute value.
 
virtual void setTaskOrProdGen (const std::string &val)=0
 Set the 'task' attribute value.
 
virtual time_t getStartEpochs ()=0
 Get the 'startepochs' attribute value.
 
virtual void setStartEpochs (time_t val)=0
 Set the 'startepochs' attribute value.
 
virtual time_t getEndEpochs ()=0
 Get the 'endepochs' attribute value.
 
virtual void setEndEpochs (time_t val)=0
 Set the 'endepochs' attribute value.
 
virtual std::string getSystem ()=0
 Get the 'system' attribute value.
 
virtual void setSystem (const std::string &val)=0
 Set the 'system' attribute value.
 
virtual std::string getSoftware ()=0
 Get the 'software' attribute value.
 
virtual void setSoftware (const std::string &val)=0
 Set the 'software' attribute value.
 
virtual std::string getSoftwareVer ()=0
 Get the 'sw_version' attribute value.
 
virtual void setSoftwareVer (const std::string &val)=0
 Set the 'sw_version' attribute value.
 
virtual double getZR_A ()=0
 Get the 'zr_a' attribute value.
 
virtual void setZR_A (double val)=0
 Set the 'zr_a' attribute value.
 
virtual double getZR_B ()=0
 Get the 'zr_b' attribute value.
 
virtual void setZR_B (double val)=0
 Set the 'zr_b' attribute value.
 
virtual double getKR_A ()=0
 Get the 'kr_a' attribute value.
 
virtual void setKR_A (double val)=0
 Set the 'kr_a' attribute value.
 
virtual double getKR_B ()=0
 Get the 'kr_b' attribute value.
 
virtual void setKR_B (double val)=0
 Set the 'kr_b' attribute value.
 
virtual bool getSimulated ()=0
 Get the 'simulated' attribute value.
 
virtual void setSimulated (bool val)=0
 Set the 'simulated' attribute value.
 

Detailed Description

Interface fot HOW dataset attributes methods.

Member Function Documentation

◆ getBeamWidth() [1/2]

virtual double OdimH5v20::HOWDatasetMetadata::getBeamWidth ( )
pure virtual

Get the 'beamwidth' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implemented in OdimH5v20::PolarScan, and OdimH5v20::Product_2D.

◆ getBeamWidth() [2/2]

virtual double OdimH5v20::HOWDatasetMetadata::getBeamWidth ( double defaultValue)
pure virtual

Get the 'beamwidth' attribute value.

Parameters
defaultValuethe value to return if the attribute does not exists
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implemented in OdimH5v20::PolarScan, and OdimH5v20::Product_2D.

◆ setBeamWidth()

virtual void OdimH5v20::HOWDatasetMetadata::setBeamWidth ( double val)
pure virtual

Set the 'beamwidth' attribute value.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implemented in OdimH5v20::PolarScan, and OdimH5v20::Product_2D.

◆ getWaveLength() [1/2]

virtual double OdimH5v20::HOWDatasetMetadata::getWaveLength ( )
pure virtual

Get the 'wavelength' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implemented in OdimH5v20::PolarScan, and OdimH5v20::Product_2D.

◆ getWaveLength() [2/2]

virtual double OdimH5v20::HOWDatasetMetadata::getWaveLength ( double defaultValue)
pure virtual

Get the 'wavelength' attribute value.

Parameters
defaultValuethe value to return if the attribute does not exists
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implemented in OdimH5v20::PolarScan, and OdimH5v20::Product_2D.

◆ setWaveLength()

virtual void OdimH5v20::HOWDatasetMetadata::setWaveLength ( double val)
pure virtual

Get the 'wavelength' attribute value.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implemented in OdimH5v20::PolarScan, and OdimH5v20::Product_2D.

◆ getRPM() [1/2]

virtual double OdimH5v20::HOWDatasetMetadata::getRPM ( )
pure virtual

Get the 'prm' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implemented in OdimH5v20::PolarScan, and OdimH5v20::Product_2D.

◆ getRPM() [2/2]

virtual double OdimH5v20::HOWDatasetMetadata::getRPM ( double defaultValue)
pure virtual

Get the 'rpm' attribute value.

Parameters
defaultValuethe value to return if the attribute does not exists
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implemented in OdimH5v20::PolarScan, and OdimH5v20::Product_2D.

◆ setRPM()

virtual void OdimH5v20::HOWDatasetMetadata::setRPM ( double val)
pure virtual

Get the 'rpm' attribute value.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implemented in OdimH5v20::PolarScan, and OdimH5v20::Product_2D.

◆ getPulseWidth() [1/2]

virtual double OdimH5v20::HOWDatasetMetadata::getPulseWidth ( )
pure virtual

Get the 'pulsewidth' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implemented in OdimH5v20::PolarScan, and OdimH5v20::Product_2D.

◆ getPulseWidth() [2/2]

virtual double OdimH5v20::HOWDatasetMetadata::getPulseWidth ( double defaultValue)
pure virtual

Get the 'pulsewidth' attribute value.

Parameters
defaultValuethe value to return if the attribute does not exists
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implemented in OdimH5v20::PolarScan, and OdimH5v20::Product_2D.

◆ setPulseWidth()

virtual void OdimH5v20::HOWDatasetMetadata::setPulseWidth ( double val)
pure virtual

Get the 'pulsewidth' attribute value.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implemented in OdimH5v20::PolarScan, and OdimH5v20::Product_2D.

◆ getLowPRF() [1/2]

virtual int OdimH5v20::HOWDatasetMetadata::getLowPRF ( )
pure virtual

Get the 'lowprf' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implemented in OdimH5v20::PolarScan, and OdimH5v20::Product_2D.

◆ getLowPRF() [2/2]

virtual int OdimH5v20::HOWDatasetMetadata::getLowPRF ( int defaultValue)
pure virtual

Get the 'lowprf' attribute value.

Parameters
defaultValuethe value to return if the attribute does not exists
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implemented in OdimH5v20::PolarScan, and OdimH5v20::Product_2D.

◆ setLowPRF()

virtual void OdimH5v20::HOWDatasetMetadata::setLowPRF ( int val)
pure virtual

Get the 'lowprf' attribute value.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implemented in OdimH5v20::PolarScan, and OdimH5v20::Product_2D.

◆ getHighPRF() [1/2]

virtual int OdimH5v20::HOWDatasetMetadata::getHighPRF ( )
pure virtual

Get the 'highprf' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implemented in OdimH5v20::PolarScan, and OdimH5v20::Product_2D.

◆ getHighPRF() [2/2]

virtual int OdimH5v20::HOWDatasetMetadata::getHighPRF ( int defaultValue)
pure virtual

Get the 'highprf' attribute value.

Parameters
defaultValuethe value to return if the attribute does not exists
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implemented in OdimH5v20::PolarScan, and OdimH5v20::Product_2D.

◆ setHighPRF()

virtual void OdimH5v20::HOWDatasetMetadata::setHighPRF ( int val)
pure virtual

Get the 'highprf' attribute value.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implemented in OdimH5v20::PolarScan, and OdimH5v20::Product_2D.

◆ getTaskOrProdGen()

virtual std::string OdimH5v20::HOWRootMetadata::getTaskOrProdGen ( )
pure virtualinherited

Get the 'task' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implemented in OdimH5v20::Object_2D, OdimH5v20::PolarScan, OdimH5v20::PolarVolume, and OdimH5v20::Product_2D.

◆ setTaskOrProdGen()

virtual void OdimH5v20::HOWRootMetadata::setTaskOrProdGen ( const std::string & val)
pure virtualinherited

Set the 'task' attribute value.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implemented in OdimH5v20::Object_2D, OdimH5v20::PolarScan, OdimH5v20::PolarVolume, and OdimH5v20::Product_2D.

◆ getStartEpochs()

virtual time_t OdimH5v20::HOWRootMetadata::getStartEpochs ( )
pure virtualinherited

Get the 'startepochs' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implemented in OdimH5v20::Object_2D, OdimH5v20::PolarScan, OdimH5v20::PolarVolume, and OdimH5v20::Product_2D.

◆ setStartEpochs()

virtual void OdimH5v20::HOWRootMetadata::setStartEpochs ( time_t val)
pure virtualinherited

Set the 'startepochs' attribute value.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implemented in OdimH5v20::Object_2D, OdimH5v20::PolarScan, OdimH5v20::PolarVolume, and OdimH5v20::Product_2D.

◆ getEndEpochs()

virtual time_t OdimH5v20::HOWRootMetadata::getEndEpochs ( )
pure virtualinherited

Get the 'endepochs' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implemented in OdimH5v20::Object_2D, OdimH5v20::PolarScan, OdimH5v20::PolarVolume, and OdimH5v20::Product_2D.

◆ setEndEpochs()

virtual void OdimH5v20::HOWRootMetadata::setEndEpochs ( time_t val)
pure virtualinherited

Set the 'endepochs' attribute value.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implemented in OdimH5v20::Object_2D, OdimH5v20::PolarScan, OdimH5v20::PolarVolume, and OdimH5v20::Product_2D.

◆ getSystem()

virtual std::string OdimH5v20::HOWRootMetadata::getSystem ( )
pure virtualinherited

Get the 'system' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implemented in OdimH5v20::Object_2D, OdimH5v20::PolarScan, OdimH5v20::PolarVolume, and OdimH5v20::Product_2D.

◆ setSystem()

virtual void OdimH5v20::HOWRootMetadata::setSystem ( const std::string & val)
pure virtualinherited

Set the 'system' attribute value.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implemented in OdimH5v20::Object_2D, OdimH5v20::PolarScan, OdimH5v20::PolarVolume, and OdimH5v20::Product_2D.

◆ getSoftware()

virtual std::string OdimH5v20::HOWRootMetadata::getSoftware ( )
pure virtualinherited

Get the 'software' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implemented in OdimH5v20::Object_2D, OdimH5v20::PolarScan, OdimH5v20::PolarVolume, and OdimH5v20::Product_2D.

◆ setSoftware()

virtual void OdimH5v20::HOWRootMetadata::setSoftware ( const std::string & val)
pure virtualinherited

Set the 'software' attribute value.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implemented in OdimH5v20::Object_2D, OdimH5v20::PolarScan, OdimH5v20::PolarVolume, and OdimH5v20::Product_2D.

◆ getSoftwareVer()

virtual std::string OdimH5v20::HOWRootMetadata::getSoftwareVer ( )
pure virtualinherited

Get the 'sw_version' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implemented in OdimH5v20::Object_2D, OdimH5v20::PolarScan, OdimH5v20::PolarVolume, and OdimH5v20::Product_2D.

◆ setSoftwareVer()

virtual void OdimH5v20::HOWRootMetadata::setSoftwareVer ( const std::string & val)
pure virtualinherited

Set the 'sw_version' attribute value.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implemented in OdimH5v20::Object_2D, OdimH5v20::PolarScan, OdimH5v20::PolarVolume, and OdimH5v20::Product_2D.

◆ getZR_A()

virtual double OdimH5v20::HOWRootMetadata::getZR_A ( )
pure virtualinherited

Get the 'zr_a' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implemented in OdimH5v20::Object_2D, OdimH5v20::PolarScan, OdimH5v20::PolarVolume, and OdimH5v20::Product_2D.

◆ setZR_A()

virtual void OdimH5v20::HOWRootMetadata::setZR_A ( double val)
pure virtualinherited

Set the 'zr_a' attribute value.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implemented in OdimH5v20::Object_2D, OdimH5v20::PolarScan, OdimH5v20::PolarVolume, and OdimH5v20::Product_2D.

◆ getZR_B()

virtual double OdimH5v20::HOWRootMetadata::getZR_B ( )
pure virtualinherited

Get the 'zr_b' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implemented in OdimH5v20::Object_2D, OdimH5v20::PolarScan, OdimH5v20::PolarVolume, and OdimH5v20::Product_2D.

◆ setZR_B()

virtual void OdimH5v20::HOWRootMetadata::setZR_B ( double val)
pure virtualinherited

Set the 'zr_b' attribute value.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implemented in OdimH5v20::Object_2D, OdimH5v20::PolarScan, OdimH5v20::PolarVolume, and OdimH5v20::Product_2D.

◆ getKR_A()

virtual double OdimH5v20::HOWRootMetadata::getKR_A ( )
pure virtualinherited

Get the 'kr_a' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implemented in OdimH5v20::Object_2D, OdimH5v20::PolarScan, OdimH5v20::PolarVolume, and OdimH5v20::Product_2D.

◆ setKR_A()

virtual void OdimH5v20::HOWRootMetadata::setKR_A ( double val)
pure virtualinherited

Set the 'kr_a' attribute value.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implemented in OdimH5v20::Object_2D, OdimH5v20::PolarScan, OdimH5v20::PolarVolume, and OdimH5v20::Product_2D.

◆ getKR_B()

virtual double OdimH5v20::HOWRootMetadata::getKR_B ( )
pure virtualinherited

Get the 'kr_b' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implemented in OdimH5v20::Object_2D, OdimH5v20::PolarScan, OdimH5v20::PolarVolume, and OdimH5v20::Product_2D.

◆ setKR_B()

virtual void OdimH5v20::HOWRootMetadata::setKR_B ( double val)
pure virtualinherited

Set the 'kr_b' attribute value.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implemented in OdimH5v20::Object_2D, OdimH5v20::PolarScan, OdimH5v20::PolarVolume, and OdimH5v20::Product_2D.

◆ getSimulated()

virtual bool OdimH5v20::HOWRootMetadata::getSimulated ( )
pure virtualinherited

Get the 'simulated' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implemented in OdimH5v20::Object_2D, OdimH5v20::PolarScan, OdimH5v20::PolarVolume, and OdimH5v20::Product_2D.

◆ setSimulated()

virtual void OdimH5v20::HOWRootMetadata::setSimulated ( bool val)
pure virtualinherited

Set the 'simulated' attribute value.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implemented in OdimH5v20::Object_2D, OdimH5v20::PolarScan, OdimH5v20::PolarVolume, and OdimH5v20::Product_2D.


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