radarlib 1.4.6
OdimH5v20::HOWPolarMetadata Class Referenceabstract

Interface for HOW dataset attributes methods for polar data. More...

#include <radarlib/odimh5v20_metadata.hpp>

Inheritance diagram for OdimH5v20::HOWPolarMetadata:
OdimH5v20::HOWDatasetMetadata OdimH5v20::HOWRootMetadata 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 std::string getAzimuthMethod ()=0
 Get the 'azmethod' attribute value.
 
virtual void setAzimuthMethod (const std::string &val)=0
 Set the 'azmethod' attribute value.
 
virtual std::string getBinMethod ()=0
 Get the 'binmethod' attribute value.
 
virtual void setBinMethod (const std::string &val)=0
 Set the 'binmethod' attribute value.
 
virtual std::vector< AZAnglesgetAzimuthAngles ()=0
 Get the 'azangles' attribute values.
 
virtual void setAzimuthAngles (const std::vector< AZAngles > &val, int precision=0)=0
 Set the 'azangles' attribute values.
 
virtual std::vector< double > getElevationAngles ()=0
 Get the 'elangles' attribute values.
 
virtual void setElevationAngles (const std::vector< double > &val, int precision=0)=0
 Set the 'elangles' attribute values.
 
virtual std::vector< AZTimesgetAzimuthTimes ()=0
 Get the 'aztimes' attribute values.
 
virtual void setAzimuthTimes (const std::vector< AZTimes > &val)=0
 Set the 'aztimes' attribute values.
 
virtual double getPointAccEl ()=0
 Get the 'pointaccEL' attribute values.
 
virtual void setPointAccEl (double val)=0
 Set the 'pointaccEL' attribute values.
 
virtual double getPointAccAZ ()=0
 Get the 'pointaccAZ' attribute values.
 
virtual void setPointAccAZ (double val)=0
 Set the 'pointaccAZ' attribute values.
 
virtual bool getMalfunc ()=0
 Get the 'malfunc' attribute value.
 
virtual void setMalfunc (bool val)=0
 Set the 'malfunc' attribute value.
 
virtual std::string getRadarMsg ()=0
 Get the 'radarmsg' attribute value.
 
virtual void setRadarMsg (const std::string &val)=0
 Set the 'radarmsg' attribute value.
 
virtual double getRadarHorizon ()=0
 Get the 'radhoriz' attribute value.
 
virtual void setRadarHorizon (double val)=0
 Set the 'radhoriz' attribute value.
 
virtual double getMDS ()=0
 Get the 'MDS' attribute value.
 
virtual void setMDS (double val)=0
 Set the 'MDS' attribute value.
 
virtual double getOUR ()=0
 Get the 'OUR' attribute value.
 
virtual void setOUR (double val)=0
 Set the 'OUR' attribute value.
 
virtual std::vector< std::string > getDClutter ()=0
 Get the 'Dclutter' attribute value.
 
virtual void setDClutter (const std::vector< std::string > &val)=0
 Set the 'Dclutter' attribute value.
 
virtual std::string getComment ()=0
 Get the 'comment' attribute value.
 
virtual void setComment (const std::string &val)=0
 Set the 'comment' attribute value.
 
virtual double getSQI ()=0
 Get the 'SQI' attribute value.
 
virtual void setSQI (double val)=0
 Set the 'SQI' attribute value.
 
virtual double getCSR ()=0
 Get the 'CSR' attribute value.
 
virtual void setCSR (double val)=0
 Set the 'CSR' attribute value.
 
virtual double getLOG ()=0
 Get the 'LOG' attribute value.
 
virtual void setLOG (double val)=0
 Set the 'LOG' attribute value.
 
virtual bool getVPRCorr ()=0
 Get the 'VPRCoor' attribute value.
 
virtual void setVPRCorr (bool val)=0
 Set the 'VPRCoor' attribute value.
 
virtual double getFreeze ()=0
 Get the 'freeze' attribute value.
 
virtual void setFreeze (double val)=0
 Set the 'freeze' attribute value.
 
virtual double getMin ()=0
 Get the 'min' attribute value.
 
virtual void setMin (double val)=0
 Set the 'min' attribute value.
 
virtual double getMax ()=0
 Get the 'max' attribute value.
 
virtual void setMax (double val)=0
 Set the 'max' attribute value.
 
virtual double getStep ()=0
 Get the 'step' attribute value.
 
virtual void setStep (double val)=0
 Set the 'step' attribute value.
 
virtual int getLevels ()=0
 Get the 'levels' attribute value.
 
virtual void setLevels (int val)=0
 Set the 'levels' attribute value.
 
virtual double getPeakPwr ()=0
 Get the 'peakpwr' attribute value.
 
virtual void setPeakPwr (double val)=0
 Set the 'peakpwr' attribute value.
 
virtual double getAvgPwr ()=0
 Get the 'avgpwr' attribute value.
 
virtual void setAvgPwr (double val)=0
 Set the 'awgpwr' attribute value.
 
virtual double getDynRange ()=0
 Get the 'dynrange' attribute value.
 
virtual void setDynRange (double val)=0
 Set the 'dynrange' attribute value.
 
virtual double getRAC ()=0
 Get the 'RAC' attribute value.
 
virtual void setRAC (double val)=0
 Set the 'RAC' attribute value.
 
virtual bool getBBC ()=0
 Get the 'BBC' attribute value.
 
virtual void setBBC (bool val)=0
 Set the 'BBC' attribute value.
 
virtual double getPAC ()=0
 Get the 'PAC' attribute value.
 
virtual void setPAC (double val)=0
 Set the 'PAC' attribute value.
 
virtual double getS2N ()=0
 Get the 'S2N' attribute value.
 
virtual void setS2N (double val)=0
 Set the 'S2N' attribute value.
 
virtual std::string getPolarization ()=0
 Get the 'polarization' attribute value.
 
virtual void setPolarization (const std::string &val)=0
 Set the 'polarization' attribute value.
 
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 for HOW dataset attributes methods for polar data.

Member Function Documentation

◆ getAzimuthMethod()

virtual std::string OdimH5v20::HOWPolarMetadata::getAzimuthMethod ( )
pure virtual

Get the 'azmethod' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

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

◆ setAzimuthMethod()

virtual void OdimH5v20::HOWPolarMetadata::setAzimuthMethod ( const std::string &  val)
pure virtual

Set the 'azmethod' attribute value.

Parameters
valthe value tro write
Exceptions
OdimH5Exceptionif an unexpected error occurs

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

◆ getBinMethod()

virtual std::string OdimH5v20::HOWPolarMetadata::getBinMethod ( )
pure virtual

Get the 'binmethod' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

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

◆ setBinMethod()

virtual void OdimH5v20::HOWPolarMetadata::setBinMethod ( const std::string &  val)
pure virtual

Set the 'binmethod' attribute value.

Parameters
valthe value tro write
Exceptions
OdimH5Exceptionif an unexpected error occurs

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

◆ getAzimuthAngles()

virtual std::vector< AZAngles > OdimH5v20::HOWPolarMetadata::getAzimuthAngles ( )
pure virtual

Get the 'azangles' attribute values.

Exceptions
OdimH5Exceptionif an unexpected error occurs

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

◆ setAzimuthAngles()

virtual void OdimH5v20::HOWPolarMetadata::setAzimuthAngles ( const std::vector< AZAngles > &  val,
int  precision = 0 
)
pure virtual

Set the 'azangles' attribute values.

Parameters
valthe values to write
precisionprecision to use when converting angle pairs to string pairs
Exceptions
OdimH5Exceptionif an unexpected error occurs

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

◆ getElevationAngles()

virtual std::vector< double > OdimH5v20::HOWPolarMetadata::getElevationAngles ( )
pure virtual

Get the 'elangles' attribute values.

Exceptions
OdimH5Exceptionif an unexpected error occurs

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

◆ setElevationAngles()

virtual void OdimH5v20::HOWPolarMetadata::setElevationAngles ( const std::vector< double > &  val,
int  precision = 0 
)
pure virtual

Set the 'elangles' attribute values.

Parameters
valthe values to write
precisionprecision to use when converting angle pairs to string pairs
Exceptions
OdimH5Exceptionif an unexpected error occurs

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

◆ getAzimuthTimes()

virtual std::vector< AZTimes > OdimH5v20::HOWPolarMetadata::getAzimuthTimes ( )
pure virtual

Get the 'aztimes' attribute values.

Exceptions
OdimH5Exceptionif an unexpected error occurs

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

◆ setAzimuthTimes()

virtual void OdimH5v20::HOWPolarMetadata::setAzimuthTimes ( const std::vector< AZTimes > &  val)
pure virtual

Set the 'aztimes' attribute values.

Parameters
valthe values to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

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

◆ getPointAccEl()

virtual double OdimH5v20::HOWPolarMetadata::getPointAccEl ( )
pure virtual

Get the 'pointaccEL' attribute values.

Exceptions
OdimH5Exceptionif an unexpected error occurs

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

◆ setPointAccEl()

virtual void OdimH5v20::HOWPolarMetadata::setPointAccEl ( double  val)
pure virtual

Set the 'pointaccEL' attribute values.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

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

◆ getPointAccAZ()

virtual double OdimH5v20::HOWPolarMetadata::getPointAccAZ ( )
pure virtual

Get the 'pointaccAZ' attribute values.

Exceptions
OdimH5Exceptionif an unexpected error occurs

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

◆ setPointAccAZ()

virtual void OdimH5v20::HOWPolarMetadata::setPointAccAZ ( double  val)
pure virtual

Set the 'pointaccAZ' attribute values.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

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

◆ getMalfunc()

virtual bool OdimH5v20::HOWPolarMetadata::getMalfunc ( )
pure virtual

Get the 'malfunc' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

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

◆ setMalfunc()

virtual void OdimH5v20::HOWPolarMetadata::setMalfunc ( bool  val)
pure virtual

Set the 'malfunc' attribute value.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

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

◆ getRadarMsg()

virtual std::string OdimH5v20::HOWPolarMetadata::getRadarMsg ( )
pure virtual

Get the 'radarmsg' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

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

◆ setRadarMsg()

virtual void OdimH5v20::HOWPolarMetadata::setRadarMsg ( const std::string &  val)
pure virtual

Set the 'radarmsg' attribute value.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

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

◆ getRadarHorizon()

virtual double OdimH5v20::HOWPolarMetadata::getRadarHorizon ( )
pure virtual

Get the 'radhoriz' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

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

◆ setRadarHorizon()

virtual void OdimH5v20::HOWPolarMetadata::setRadarHorizon ( double  val)
pure virtual

Set the 'radhoriz' attribute value.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

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

◆ getMDS()

virtual double OdimH5v20::HOWPolarMetadata::getMDS ( )
pure virtual

Get the 'MDS' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

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

◆ setMDS()

virtual void OdimH5v20::HOWPolarMetadata::setMDS ( double  val)
pure virtual

Set the 'MDS' attribute value.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

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

◆ getOUR()

virtual double OdimH5v20::HOWPolarMetadata::getOUR ( )
pure virtual

Get the 'OUR' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

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

◆ setOUR()

virtual void OdimH5v20::HOWPolarMetadata::setOUR ( double  val)
pure virtual

Set the 'OUR' attribute value.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

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

◆ getDClutter()

virtual std::vector< std::string > OdimH5v20::HOWPolarMetadata::getDClutter ( )
pure virtual

Get the 'Dclutter' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

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

◆ setDClutter()

virtual void OdimH5v20::HOWPolarMetadata::setDClutter ( const std::vector< std::string > &  val)
pure virtual

Set the 'Dclutter' attribute value.

Parameters
valthe values to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

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

◆ getComment()

virtual std::string OdimH5v20::HOWPolarMetadata::getComment ( )
pure virtual

Get the 'comment' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

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

◆ setComment()

virtual void OdimH5v20::HOWPolarMetadata::setComment ( const std::string &  val)
pure virtual

Set the 'comment' attribute value.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

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

◆ getSQI()

virtual double OdimH5v20::HOWPolarMetadata::getSQI ( )
pure virtual

Get the 'SQI' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

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

◆ setSQI()

virtual void OdimH5v20::HOWPolarMetadata::setSQI ( double  val)
pure virtual

Set the 'SQI' attribute value.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

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

◆ getCSR()

virtual double OdimH5v20::HOWPolarMetadata::getCSR ( )
pure virtual

Get the 'CSR' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

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

◆ setCSR()

virtual void OdimH5v20::HOWPolarMetadata::setCSR ( double  val)
pure virtual

Set the 'CSR' attribute value.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

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

◆ getLOG()

virtual double OdimH5v20::HOWPolarMetadata::getLOG ( )
pure virtual

Get the 'LOG' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

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

◆ setLOG()

virtual void OdimH5v20::HOWPolarMetadata::setLOG ( double  val)
pure virtual

Set the 'LOG' attribute value.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

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

◆ getVPRCorr()

virtual bool OdimH5v20::HOWPolarMetadata::getVPRCorr ( )
pure virtual

Get the 'VPRCoor' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

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

◆ setVPRCorr()

virtual void OdimH5v20::HOWPolarMetadata::setVPRCorr ( bool  val)
pure virtual

Set the 'VPRCoor' attribute value.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

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

◆ getFreeze()

virtual double OdimH5v20::HOWPolarMetadata::getFreeze ( )
pure virtual

Get the 'freeze' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

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

◆ setFreeze()

virtual void OdimH5v20::HOWPolarMetadata::setFreeze ( double  val)
pure virtual

Set the 'freeze' attribute value.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

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

◆ getMin()

virtual double OdimH5v20::HOWPolarMetadata::getMin ( )
pure virtual

Get the 'min' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

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

◆ setMin()

virtual void OdimH5v20::HOWPolarMetadata::setMin ( double  val)
pure virtual

Set the 'min' attribute value.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

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

◆ getMax()

virtual double OdimH5v20::HOWPolarMetadata::getMax ( )
pure virtual

Get the 'max' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

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

◆ setMax()

virtual void OdimH5v20::HOWPolarMetadata::setMax ( double  val)
pure virtual

Set the 'max' attribute value.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

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

◆ getStep()

virtual double OdimH5v20::HOWPolarMetadata::getStep ( )
pure virtual

Get the 'step' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

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

◆ setStep()

virtual void OdimH5v20::HOWPolarMetadata::setStep ( double  val)
pure virtual

Set the 'step' attribute value.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

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

◆ getLevels()

virtual int OdimH5v20::HOWPolarMetadata::getLevels ( )
pure virtual

Get the 'levels' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

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

◆ setLevels()

virtual void OdimH5v20::HOWPolarMetadata::setLevels ( int  val)
pure virtual

Set the 'levels' attribute value.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

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

◆ getPeakPwr()

virtual double OdimH5v20::HOWPolarMetadata::getPeakPwr ( )
pure virtual

Get the 'peakpwr' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

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

◆ setPeakPwr()

virtual void OdimH5v20::HOWPolarMetadata::setPeakPwr ( double  val)
pure virtual

Set the 'peakpwr' attribute value.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

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

◆ getAvgPwr()

virtual double OdimH5v20::HOWPolarMetadata::getAvgPwr ( )
pure virtual

Get the 'avgpwr' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

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

◆ setAvgPwr()

virtual void OdimH5v20::HOWPolarMetadata::setAvgPwr ( double  val)
pure virtual

Set the 'awgpwr' attribute value.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

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

◆ getDynRange()

virtual double OdimH5v20::HOWPolarMetadata::getDynRange ( )
pure virtual

Get the 'dynrange' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

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

◆ setDynRange()

virtual void OdimH5v20::HOWPolarMetadata::setDynRange ( double  val)
pure virtual

Set the 'dynrange' attribute value.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

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

◆ getRAC()

virtual double OdimH5v20::HOWPolarMetadata::getRAC ( )
pure virtual

Get the 'RAC' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

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

◆ setRAC()

virtual void OdimH5v20::HOWPolarMetadata::setRAC ( double  val)
pure virtual

Set the 'RAC' attribute value.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

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

◆ getBBC()

virtual bool OdimH5v20::HOWPolarMetadata::getBBC ( )
pure virtual

Get the 'BBC' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

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

◆ setBBC()

virtual void OdimH5v20::HOWPolarMetadata::setBBC ( bool  val)
pure virtual

Set the 'BBC' attribute value.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

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

◆ getPAC()

virtual double OdimH5v20::HOWPolarMetadata::getPAC ( )
pure virtual

Get the 'PAC' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

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

◆ setPAC()

virtual void OdimH5v20::HOWPolarMetadata::setPAC ( double  val)
pure virtual

Set the 'PAC' attribute value.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

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

◆ getS2N()

virtual double OdimH5v20::HOWPolarMetadata::getS2N ( )
pure virtual

Get the 'S2N' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

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

◆ setS2N()

virtual void OdimH5v20::HOWPolarMetadata::setS2N ( double  val)
pure virtual

Set the 'S2N' attribute value.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

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

◆ getPolarization()

virtual std::string OdimH5v20::HOWPolarMetadata::getPolarization ( )
pure virtual

Get the 'polarization' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

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

◆ setPolarization()

virtual void OdimH5v20::HOWPolarMetadata::setPolarization ( const std::string &  val)
pure virtual

Set the 'polarization' attribute value.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

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

◆ getBeamWidth() [1/2]

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

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 virtualinherited

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 virtualinherited

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 virtualinherited

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 virtualinherited

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 virtualinherited

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 virtualinherited

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 virtualinherited

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 virtualinherited

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 virtualinherited

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 virtualinherited

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 virtualinherited

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 virtualinherited

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 virtualinherited

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 virtualinherited

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 virtualinherited

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 virtualinherited

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 virtualinherited

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::PolarVolume, OdimH5v20::PolarScan, OdimH5v20::Object_2D, 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::PolarVolume, OdimH5v20::PolarScan, OdimH5v20::Object_2D, 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::PolarVolume, OdimH5v20::PolarScan, OdimH5v20::Object_2D, 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::PolarVolume, OdimH5v20::PolarScan, OdimH5v20::Object_2D, 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::PolarVolume, OdimH5v20::PolarScan, OdimH5v20::Object_2D, 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::PolarVolume, OdimH5v20::PolarScan, OdimH5v20::Object_2D, 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::PolarVolume, OdimH5v20::PolarScan, OdimH5v20::Object_2D, 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::PolarVolume, OdimH5v20::PolarScan, OdimH5v20::Object_2D, 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::PolarVolume, OdimH5v20::PolarScan, OdimH5v20::Object_2D, 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::PolarVolume, OdimH5v20::PolarScan, OdimH5v20::Object_2D, 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::PolarVolume, OdimH5v20::PolarScan, OdimH5v20::Object_2D, 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::PolarVolume, OdimH5v20::PolarScan, OdimH5v20::Object_2D, 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::PolarVolume, OdimH5v20::PolarScan, OdimH5v20::Object_2D, 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::PolarVolume, OdimH5v20::PolarScan, OdimH5v20::Object_2D, 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::PolarVolume, OdimH5v20::PolarScan, OdimH5v20::Object_2D, 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::PolarVolume, OdimH5v20::PolarScan, OdimH5v20::Object_2D, 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::PolarVolume, OdimH5v20::PolarScan, OdimH5v20::Object_2D, 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::PolarVolume, OdimH5v20::PolarScan, OdimH5v20::Object_2D, 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::PolarVolume, OdimH5v20::PolarScan, OdimH5v20::Object_2D, 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::PolarVolume, OdimH5v20::PolarScan, OdimH5v20::Object_2D, 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::PolarVolume, OdimH5v20::PolarScan, OdimH5v20::Object_2D, 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::PolarVolume, OdimH5v20::PolarScan, OdimH5v20::Object_2D, and OdimH5v20::Product_2D.


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