radarlib 1.4.6
OdimH5v21::PolarScan Class Reference

OdimH5 v2.1 Polar Volume SCAN. More...

#include <radarlib/odimh5v21_classes.hpp>

Inheritance diagram for OdimH5v21::PolarScan:
OdimH5v21::OdimDataset OdimH5v21::WHATDatasetMetadata OdimH5v21::WHEREScanMetadata OdimH5v21::HOWPolarMetadata OdimH5v21::WHATRootMetadata OdimH5v21::WHERERootMetadata OdimH5v21::HOWDatasetMetadata OdimH5v21::HOWRootMetadata

Public Member Functions

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 std::string getProduct ()
 Get the value of 'product' attribute.
 
virtual void setProduct (const std::string &val)
 Set the value of 'product' attribute.
 
virtual double getProdPar ()
 Get the value of 'prodpar' attribute as double value.
 
virtual VILHeights getProdParVIL ()
 Get the value of 'prodpar' attribute as VILHeights pair.
 
virtual void setProdPar (double val)
 Set the value of 'prodpar' attribute.
 
virtual void setProdPar (const VILHeights &val)
 Set the value of 'prodpar' attribute using the given VILHeights values.
 
virtual std::string getQuantity ()
 Set the value of 'quantity' attribute.
 
virtual void setQuantity (const std::string &val)
 Get the value of 'quantity' attribute.
 
virtual time_t getStartDateTime ()
 Get the value of 'startdate' and 'starttime' attributes.
 
virtual void setStartDateTime (time_t val)
 Set the value of 'startdate' and 'starttime' attributes.
 
virtual time_t getEndDateTime ()
 Get the value of 'enddate' and 'endtime' attributes.
 
virtual void setEndDateTime (time_t val)
 Set the value of 'enddate' and 'endtime' attributes.
 
virtual double getGain ()
 Get the value of 'gain' attribute.
 
virtual void setGain (double val)
 Set the value of 'gain' attribute.
 
virtual double getOffset ()
 Get the value of 'offset' attribute.
 
virtual void setOffset (double val)
 Set the value of 'offset' attribute.
 
virtual double getNodata ()
 Get the value of 'nodata' attribute.
 
virtual void setNodata (double val)
 Set the value of 'nodata' attribute.
 
virtual double getUndetect ()
 Get the value of 'undetect' attribute.
 
virtual void setUndetect (double val)
 Set the value of 'undetect' attribute.
 
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 double getEAngle ()
 Get the 'elangle' attribute value.
 
virtual void setEAngle (double val)
 Set the 'elangle' attribute value.
 
virtual int getNumBins ()
 Get the 'numbins' attribute value.
 
virtual void setNumBins (int val)
 Set the 'numbins' attribute value.
 
virtual double getRangeStart ()
 Get the 'rstart' attribute value.
 
virtual void setRangeStart (double val)
 Set the 'rstart' attribute value.
 
virtual double getRangeScale ()
 Get the 'rscale' attribute value.
 
virtual void setRangeScale (double val)
 Set the 'rscale' attribute value.
 
virtual int getNumRays ()
 Get the 'numrays' attribute value.
 
virtual void setNumRays (int val)
 Set the 'numrays' attribute value.
 
virtual int getA1Gate ()
 Get the 'a1gate' attribute value.
 
virtual void setA1Gate (int val)
 Set the 'a1gate' attribute value.
 
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 double getBeamWidth ()
 Get the 'beamwidth' attribute value.
 
virtual double getBeamWidth (double defaultValue)
 Get the 'beamwidth' attribute value.
 
virtual void setBeamWidth (double val)
 Set the 'beamwidth' attribute value.
 
virtual double getWaveLength ()
 Get the 'wavelength' attribute value.
 
virtual double getWaveLength (double defaultValue)
 Get the 'wavelength' attribute value.
 
virtual void setWaveLength (double val)
 Set the 'wavelength' attribute value.
 
virtual double getRPM ()
 Get the 'prm' attribute value.
 
virtual double getRPM (double defaultValue)
 Get the 'rpm' attribute value.
 
virtual void setRPM (double val)
 Set the 'rpm' attribute value.
 
virtual double getPulseWidth ()
 Get the 'pulsewidth' attribute value.
 
virtual double getPulseWidth (double defaultValue)
 Get the 'pulsewidth' attribute value.
 
virtual void setPulseWidth (double val)
 Set the 'pulsewidth' attribute value.
 
virtual double getRXBandWidth ()
 Get the 'RXbandwidth' attribute value.
 
virtual double getRXBandWidth (double defaultValue)
 Get the 'RXbandwidth' attribute value.
 
virtual void setRXBandWidth (double val)
 Set the 'RXbandwidth' attribute value.
 
virtual int getLowPRF ()
 Get the 'lowprf' attribute value.
 
virtual int getLowPRF (int defaultValue)
 Get the 'lowprf' attribute value.
 
virtual void setLowPRF (int val)
 Set the 'lowprf' attribute value.
 
virtual int getHighPRF ()
 Get the 'highprf' attribute value.
 
virtual int getHighPRF (int defaultValue)
 Get the 'highprf' attribute value.
 
virtual void setHighPRF (int val)
 Set the 'highprf' attribute value.
 
virtual double getTXLoss ()
 Get the 'TXloss' attribute value.
 
virtual double getTXLoss (double defaultValue)
 Get the 'TXloss' attribute value.
 
virtual void setTXLoss (double val)
 Set the 'TXLoss' attribute value.
 
virtual double getRXLoss ()
 Get the 'RXloss' attribute value.
 
virtual double getRXLoss (double defaultValue)
 Get the 'RXloss' attribute value.
 
virtual void setRXLoss (double val)
 Set the 'RXloss' attribute value.
 
virtual double getRadomeLoss ()
 Get the 'radomeloss' attribute value.
 
virtual double getRadomeLoss (double defaultValue)
 Get the 'radomeloss' attribute value.
 
virtual void setRadomeLoss (double val)
 Set the 'radomeloss' attribute value.
 
virtual double getAntGain ()
 Get the 'antgain' attribute value.
 
virtual double getAntGain (double defaultValue)
 Get the 'antgain' attribute value.
 
virtual void setAntGain (double val)
 Set the 'antgain' attribute value.
 
virtual double getBeamWH ()
 Get the 'beamwH' attribute value.
 
virtual double getBeamWH (double defaultValue)
 Get the 'beamwH' attribute value.
 
virtual void setBeamWH (double val)
 Set the 'beamwH' attribute value.
 
virtual double getBeamWV ()
 Get the 'beamwV' attribute value.
 
virtual double getBeamWV (double defaultValue)
 Get the 'beamwV' attribute value.
 
virtual void setBeamWV (double val)
 Set the 'beamwV' attribute value.
 
virtual double getGasAttn ()
 Get the 'gasattn' attribute value.
 
virtual double getGasAttn (double defaultValue)
 Get the 'gasattn' attribute value.
 
virtual void setGasAttn (double val)
 Set the 'gasattn' attribute value.
 
virtual double getRadConstH ()
 Get the 'radconstH' attribute value.
 
virtual double getRadConstH (double defaultValue)
 Get the 'radconstH' attribute value.
 
virtual void setRadConstH (double val)
 Set the 'radconstH' attribute value.
 
virtual double getRadConstV ()
 Get the 'radconstV' attribute value.
 
virtual double getRadConstV (double defaultValue)
 Get the 'radconstV' attribute value.
 
virtual void setRadConstV (double val)
 Set the 'radconstV' attribute value.
 
virtual double getNomTXPower ()
 Get the 'nomTXpower' attribute value.
 
virtual double getNomTXPower (double defaultValue)
 Get the 'nomTXpower' attribute value.
 
virtual void setNomTXPower (double val)
 Set the 'nomTXpower' attribute value.
 
virtual std::vector< double > getTXPower ()
 Get the 'TXpower' attribute value.
 
virtual std::vector< double > getTXPower (double defaultValue)
 Get the 'TXpower' attribute value.
 
virtual void setTXPower (double val)
 Set the 'TXpower' attribute value.
 
virtual double getNI ()
 Get the 'NI' attribute value.
 
virtual double getNI (double defaultValue)
 Get the 'NI' attribute value.
 
virtual void setNI (double val)
 Set the 'NI' attribute value.
 
virtual double getVSamples ()
 Get the 'Vsamples' attribute value.
 
virtual double getVSamples (double defaultValue)
 Get the 'Vsamples' attribute value.
 
virtual void setVSamples (double val)
 Set the 'Vsamples' attribute value.
 
virtual std::string getAzimuthMethod ()
 Get the 'azmethod' attribute value.
 
virtual void setAzimuthMethod (const std::string &val)
 Set the 'azmethod' attribute value.
 
virtual std::string getBinMethod ()
 Get the 'binmethod' attribute value.
 
virtual void setBinMethod (const std::string &val)
 Set the 'binmethod' attribute value.
 
virtual std::vector< AZAnglesgetAzimuthAngles ()
 Get the 'startazA' and 'stopazA' attributes values (formerly azangles attribute in odimh5v2.0) - available only in a Polar Data.
 
virtual void setAzimuthAngles (const std::vector< AZAngles > &val, int precision=0)
 Set the 'startazA' and 'stopazA' attributes values (formerly azangles attribute in odimh5v2.0) - available only in a Polar Data.
 
virtual std::vector< double > getElevationAngles ()
 Get the 'elangles' attribute values.
 
virtual void setElevationAngles (const std::vector< double > &val)
 Set the 'elangles' attribute values.
 
virtual std::vector< double > getStartAzimuthAngles ()
 Get the 'startazA' attribute values.
 
virtual void setStartAzimuthAngles (const std::vector< double > &val)
 Set the 'startazA' attribute values.
 
virtual std::vector< double > getStopAzimuthAngles ()
 Get the 'stopazA' attribute values.
 
virtual void setStopAzimuthAngles (const std::vector< double > &val)
 Set the 'stopazA' attribute values.
 
virtual std::vector< double > getStartAzimuthTimes ()
 Get the 'startazT' attribute values.
 
virtual void setStartAzimuthTimes (const std::vector< double > &val)
 Set the 'startazT' attribute values.
 
virtual std::vector< double > getStopAzimuthTimes ()
 Get the 'stopazT' attribute values.
 
virtual void setStopAzimuthTimes (const std::vector< double > &val)
 Set the 'stopazT' attribute values.
 
virtual double getPointAccEl ()
 Get the 'pointaccEL' attribute values.
 
virtual void setPointAccEl (double val)
 Set the 'pointaccEL' attribute values.
 
virtual double getPointAccAZ ()
 Get the 'pointaccAZ' attribute values.
 
virtual void setPointAccAZ (double val)
 Set the 'pointaccAZ' attribute values.
 
virtual bool getMalfunc ()
 Get the 'malfunc' attribute value.
 
virtual void setMalfunc (bool val)
 Set the 'malfunc' attribute value.
 
virtual std::string getRadarMsg ()
 Get the 'radarmsg' attribute value.
 
virtual void setRadarMsg (const std::string &val)
 Set the 'radarmsg' attribute value.
 
virtual double getRadarHorizon ()
 Get the 'radhoriz' attribute value.
 
virtual void setRadarHorizon (double val)
 Set the 'radhoriz' attribute value.
 
virtual double getNEZ ()
 Get the 'NEZ' attribute value.
 
virtual void setNEZ (double val)
 Set the 'NEZ' attribute value.
 
virtual double getOUR ()
 Get the 'OUR' attribute value.
 
virtual void setOUR (double val)
 Set the 'OUR' attribute value.
 
virtual std::vector< std::string > getDClutter ()
 Get the 'Dclutter' attribute value.
 
virtual void setDClutter (const std::vector< std::string > &value)
 Set the 'Dclutter' attribute value.
 
virtual std::string getComment ()
 Get the 'comment' attribute value.
 
virtual void setComment (const std::string &val)
 Set the 'comment' attribute value.
 
virtual double getSQI ()
 Get the 'SQI' attribute value.
 
virtual void setSQI (double val)
 Set the 'SQI' attribute value.
 
virtual double getCSR ()
 Get the 'CSR' attribute value.
 
virtual void setCSR (double val)
 Set the 'CSR' attribute value.
 
virtual double getLOG ()
 Get the 'LOG' attribute value.
 
virtual void setLOG (double val)
 Set the 'LOG' attribute value.
 
virtual bool getVPRCorr ()
 Get the 'VPRCoor' attribute value.
 
virtual void setVPRCorr (bool val)
 Set the 'VPRCoor' attribute value.
 
virtual double getFreeze ()
 Get the 'freeze' attribute value.
 
virtual void setFreeze (double val)
 Set the 'freeze' attribute value.
 
virtual double getMin ()
 Get the 'min' attribute value.
 
virtual void setMin (double val)
 Set the 'min' attribute value.
 
virtual double getMax ()
 Get the 'max' attribute value.
 
virtual void setMax (double val)
 Set the 'max' attribute value.
 
virtual double getStep ()
 Get the 'step' attribute value.
 
virtual void setStep (double val)
 Set the 'step' attribute value.
 
virtual int getLevels ()
 Get the 'levels' attribute value.
 
virtual void setLevels (int val)
 Set the 'levels' attribute value.
 
virtual double getPeakPwr ()
 Get the 'peakpwr' attribute value.
 
virtual void setPeakPwr (double val)
 Set the 'peakpwr' attribute value.
 
virtual double getAvgPwr ()
 Get the 'avgpwr' attribute value.
 
virtual void setAvgPwr (double val)
 Set the 'awgpwr' attribute value.
 
virtual double getDynRange ()
 Get the 'dynrange' attribute value.
 
virtual void setDynRange (double val)
 Set the 'dynrange' attribute value.
 
virtual double getRAC ()
 Get the 'RAC' attribute value.
 
virtual void setRAC (double val)
 Set the 'RAC' attribute value.
 
virtual bool getBBC ()
 Get the 'BBC' attribute value.
 
virtual void setBBC (bool val)
 Set the 'BBC' attribute value.
 
virtual double getPAC ()
 Get the 'PAC' attribute value.
 
virtual void setPAC (double val)
 Set the 'PAC' attribute value.
 
virtual double getS2N ()
 Get the 'S2N' attribute value.
 
virtual void setS2N (double val)
 Set the 'S2N' attribute value.
 
virtual std::string getPolarization ()
 Get the 'polarization' attribute value.
 
virtual void setPolarization (const std::string &val)
 Set the 'polarization' attribute value.
 
virtual int getQuantityDataCount ()
 Get number of quantities stored in the scan.
 
virtual PolarScanDatacreateQuantityData (const char *name)
 Create a new group for a quantity in the scan.
 
virtual PolarScanDatagetQuantityData (int index)
 Get the data associated to a quantity.
 
virtual PolarScanDatagetQuantityData (const char *name)
 Get the data associated to a quantity.
 
virtual void removeQuantityData (const char *name)
 Delete the data associated to a quantity.
 
virtual bool hasQuantityData (const char *name)
 Check if the scan contains the data associated to a quantity.
 
virtual int getQuantityDataIndex (const char *name)
 Return the index of the 'data' group containing the given quantity.
 
virtual int getDirection ()
 Get the direction of the scan

 
std::set< std::string > getStoredQuantities ()
 Get the name of all quantities present in this scan.
 
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 int getDataCount ()
 Get the number of 'data' groups inside this dataset group.
 
virtual OdimDatacreateData ()
 Create a new group 'data' inside this dataset.
 
virtual OdimDatagetData (int index)
 Get an existing dataset using the given index.
 
virtual void removeData (int index)
 Remove a 'data' group from this dataset.
 
virtual int getQualityCount ()
 Get the number of 'quality' groups inside this dataset group.
 
virtual OdimQualitycreateQuality ()
 Create a new group 'Quality' inside this dataset.
 
virtual OdimQualitygetQuality (int index)
 Get an existing Quality group using the given index.
 
virtual void removeQuality (int index)
 Remove a 'quality' group from this dataset.
 

Static Public Member Functions

static int originaRayIndex (int index, int originalDirection, int numrays, int a1gate)
 Calculate the original ray index of a scan.
 

Detailed Description

OdimH5 v2.1 Polar Volume SCAN.

This class represents an SCAN a OdimH5 PVOL object.
Polar SCAN specific attributes can be manipulated using specific methods.
Generic data manipulations can be done using methods provided by the OdimObject interface.

See also
PolarScanData

Member Function Documentation

◆ getObject()

std::string OdimH5v21::PolarScan::getObject ( )
virtual

Get the value of 'object' attribute.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::WHATRootMetadata.

◆ setObject()

void OdimH5v21::PolarScan::setObject ( const std::string & val)
virtual

Set the value of 'object' attribute.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::WHATRootMetadata.

◆ getVersion()

std::string OdimH5v21::PolarScan::getVersion ( )
virtual

Get the value of 'version' attribute.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::WHATRootMetadata.

◆ setVersion()

void OdimH5v21::PolarScan::setVersion ( const std::string & val)
virtual

Set the value of 'version' attribute.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::WHATRootMetadata.

◆ getDateTime()

time_t OdimH5v21::PolarScan::getDateTime ( )
virtual

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 OdimH5v21::WHATRootMetadata.

◆ setDateTime()

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

Implements OdimH5v21::WHATRootMetadata.

◆ getSource()

SourceInfo OdimH5v21::PolarScan::getSource ( )
virtual

Get the value of 'source' attribute.

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

Implements OdimH5v21::WHATRootMetadata.

◆ setSource()

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

Implements OdimH5v21::WHATRootMetadata.

◆ getProduct()

std::string OdimH5v21::PolarScan::getProduct ( )
virtual

Get the value of 'product' attribute.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::WHATDatasetMetadata.

◆ setProduct()

void OdimH5v21::PolarScan::setProduct ( const std::string & val)
virtual

Set the value of 'product' attribute.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::WHATDatasetMetadata.

◆ getProdPar()

double OdimH5v21::PolarScan::getProdPar ( )
virtual

Get the value of 'prodpar' attribute as double value.

This method is used only for some kind of products

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::WHATDatasetMetadata.

◆ getProdParVIL()

VILHeights OdimH5v21::PolarScan::getProdParVIL ( )
virtual

Get the value of 'prodpar' attribute as VILHeights pair.

This method is used only for some kind of products

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::WHATDatasetMetadata.

◆ setProdPar() [1/2]

void OdimH5v21::PolarScan::setProdPar ( double val)
virtual

Set the value of 'prodpar' attribute.

This method is used only for some kind of products

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::WHATDatasetMetadata.

◆ setProdPar() [2/2]

void OdimH5v21::PolarScan::setProdPar ( const VILHeights & val)
virtual

Set the value of 'prodpar' attribute using the given VILHeights values.

Set the value of 'prodpar' attribute using the given VILHeights values This method is used only for some kind of products

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::WHATDatasetMetadata.

◆ getQuantity()

std::string OdimH5v21::PolarScan::getQuantity ( )
virtual

Set the value of 'quantity' attribute.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::WHATDatasetMetadata.

◆ setQuantity()

void OdimH5v21::PolarScan::setQuantity ( const std::string & val)
virtual

Get the value of 'quantity' attribute.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::WHATDatasetMetadata.

◆ getStartDateTime()

time_t OdimH5v21::PolarScan::getStartDateTime ( )
virtual

Get the value of 'startdate' and 'starttime' attributes.

Get the value of 'startdate' and 'starttime' attributes joined into a time_t value

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::WHATDatasetMetadata.

◆ setStartDateTime()

void OdimH5v21::PolarScan::setStartDateTime ( time_t val)
virtual

Set the value of 'startdate' and 'starttime' attributes.

Set the value of 'startdate' and 'starttime' attributes using the given absolute time_t value

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::WHATDatasetMetadata.

◆ getEndDateTime()

time_t OdimH5v21::PolarScan::getEndDateTime ( )
virtual

Get the value of 'enddate' and 'endtime' attributes.

Get the value of 'enddate' and 'endtime' attributes joined into a time_t value

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::WHATDatasetMetadata.

◆ setEndDateTime()

void OdimH5v21::PolarScan::setEndDateTime ( time_t val)
virtual

Set the value of 'enddate' and 'endtime' attributes.

Set the value of 'enddate' and 'endtime' attributes using the given absolute time_t value

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::WHATDatasetMetadata.

◆ getGain()

double OdimH5v21::PolarScan::getGain ( )
virtual

Get the value of 'gain' attribute.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::WHATDatasetMetadata.

◆ setGain()

void OdimH5v21::PolarScan::setGain ( double val)
virtual

Set the value of 'gain' attribute.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::WHATDatasetMetadata.

◆ getOffset()

double OdimH5v21::PolarScan::getOffset ( )
virtual

Get the value of 'offset' attribute.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::WHATDatasetMetadata.

◆ setOffset()

void OdimH5v21::PolarScan::setOffset ( double val)
virtual

Set the value of 'offset' attribute.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::WHATDatasetMetadata.

◆ getNodata()

double OdimH5v21::PolarScan::getNodata ( )
virtual

Get the value of 'nodata' attribute.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::WHATDatasetMetadata.

◆ setNodata()

void OdimH5v21::PolarScan::setNodata ( double val)
virtual

Set the value of 'nodata' attribute.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::WHATDatasetMetadata.

◆ getUndetect()

double OdimH5v21::PolarScan::getUndetect ( )
virtual

Get the value of 'undetect' attribute.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::WHATDatasetMetadata.

◆ setUndetect()

void OdimH5v21::PolarScan::setUndetect ( double val)
virtual

Set the value of 'undetect' attribute.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::WHATDatasetMetadata.

◆ setLongitude()

void OdimH5v21::PolarScan::setLongitude ( double val)
virtual

Set the value of 'longitude' attribute.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::WHERERootMetadata.

◆ getLatitude()

double OdimH5v21::PolarScan::getLatitude ( )
virtual

Get the value of 'longitude' attribute.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::WHERERootMetadata.

◆ setLatitude()

void OdimH5v21::PolarScan::setLatitude ( double val)
virtual

Set the value of 'latitude' attribute.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::WHERERootMetadata.

◆ getAltitude()

double OdimH5v21::PolarScan::getAltitude ( )
virtual

Get the value of 'altitude' attribute.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::WHERERootMetadata.

◆ setAltitude()

void OdimH5v21::PolarScan::setAltitude ( double val)
virtual

Set the value of 'altitude' attribute.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::WHERERootMetadata.

◆ getEAngle()

double OdimH5v21::PolarScan::getEAngle ( )
virtual

Get the 'elangle' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::WHEREScanMetadata.

◆ setEAngle()

void OdimH5v21::PolarScan::setEAngle ( double val)
virtual

Set the 'elangle' attribute value.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::WHEREScanMetadata.

◆ getNumBins()

int OdimH5v21::PolarScan::getNumBins ( )
virtual

Get the 'numbins' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::WHEREScanMetadata.

◆ setNumBins()

void OdimH5v21::PolarScan::setNumBins ( int val)
virtual

Set the 'numbins' attribute value.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::WHEREScanMetadata.

◆ getRangeStart()

double OdimH5v21::PolarScan::getRangeStart ( )
virtual

Get the 'rstart' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::WHEREScanMetadata.

◆ setRangeStart()

void OdimH5v21::PolarScan::setRangeStart ( double val)
virtual

Set the 'rstart' attribute value.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::WHEREScanMetadata.

◆ getRangeScale()

double OdimH5v21::PolarScan::getRangeScale ( )
virtual

Get the 'rscale' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::WHEREScanMetadata.

◆ setRangeScale()

void OdimH5v21::PolarScan::setRangeScale ( double val)
virtual

Set the 'rscale' attribute value.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::WHEREScanMetadata.

◆ getNumRays()

int OdimH5v21::PolarScan::getNumRays ( )
virtual

Get the 'numrays' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::WHEREScanMetadata.

◆ setNumRays()

void OdimH5v21::PolarScan::setNumRays ( int val)
virtual

Set the 'numrays' attribute value.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::WHEREScanMetadata.

◆ getA1Gate()

int OdimH5v21::PolarScan::getA1Gate ( )
virtual

Get the 'a1gate' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::WHEREScanMetadata.

◆ setA1Gate()

void OdimH5v21::PolarScan::setA1Gate ( int val)
virtual

Set the 'a1gate' attribute value.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::WHEREScanMetadata.

◆ getTaskOrProdGen()

std::string OdimH5v21::PolarScan::getTaskOrProdGen ( )
virtual

Get the 'task' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::HOWRootMetadata.

◆ setTaskOrProdGen()

void OdimH5v21::PolarScan::setTaskOrProdGen ( const std::string & val)
virtual

Set the 'task' attribute value.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::HOWRootMetadata.

◆ getStartEpochs()

time_t OdimH5v21::PolarScan::getStartEpochs ( )
virtual

Get the 'startepochs' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::HOWRootMetadata.

◆ setStartEpochs()

void OdimH5v21::PolarScan::setStartEpochs ( time_t val)
virtual

Set the 'startepochs' attribute value.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::HOWRootMetadata.

◆ getEndEpochs()

time_t OdimH5v21::PolarScan::getEndEpochs ( )
virtual

Get the 'endepochs' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::HOWRootMetadata.

◆ setEndEpochs()

void OdimH5v21::PolarScan::setEndEpochs ( time_t val)
virtual

Set the 'endepochs' attribute value.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::HOWRootMetadata.

◆ getSystem()

std::string OdimH5v21::PolarScan::getSystem ( )
virtual

Get the 'system' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::HOWRootMetadata.

◆ setSystem()

void OdimH5v21::PolarScan::setSystem ( const std::string & val)
virtual

Set the 'system' attribute value.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::HOWRootMetadata.

◆ getSoftware()

std::string OdimH5v21::PolarScan::getSoftware ( )
virtual

Get the 'software' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::HOWRootMetadata.

◆ setSoftware()

void OdimH5v21::PolarScan::setSoftware ( const std::string & val)
virtual

Set the 'software' attribute value.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::HOWRootMetadata.

◆ getSoftwareVer()

std::string OdimH5v21::PolarScan::getSoftwareVer ( )
virtual

Get the 'sw_version' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::HOWRootMetadata.

◆ setSoftwareVer()

void OdimH5v21::PolarScan::setSoftwareVer ( const std::string & val)
virtual

Set the 'sw_version' attribute value.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::HOWRootMetadata.

◆ getZR_A()

double OdimH5v21::PolarScan::getZR_A ( )
virtual

Get the 'zr_a' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::HOWRootMetadata.

◆ setZR_A()

void OdimH5v21::PolarScan::setZR_A ( double val)
virtual

Set the 'zr_a' attribute value.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::HOWRootMetadata.

◆ getZR_B()

double OdimH5v21::PolarScan::getZR_B ( )
virtual

Get the 'zr_b' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::HOWRootMetadata.

◆ setZR_B()

void OdimH5v21::PolarScan::setZR_B ( double val)
virtual

Set the 'zr_b' attribute value.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::HOWRootMetadata.

◆ getKR_A()

double OdimH5v21::PolarScan::getKR_A ( )
virtual

Get the 'kr_a' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::HOWRootMetadata.

◆ setKR_A()

void OdimH5v21::PolarScan::setKR_A ( double val)
virtual

Set the 'kr_a' attribute value.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::HOWRootMetadata.

◆ getKR_B()

double OdimH5v21::PolarScan::getKR_B ( )
virtual

Get the 'kr_b' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::HOWRootMetadata.

◆ setKR_B()

void OdimH5v21::PolarScan::setKR_B ( double val)
virtual

Set the 'kr_b' attribute value.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::HOWRootMetadata.

◆ getSimulated()

bool OdimH5v21::PolarScan::getSimulated ( )
virtual

Get the 'simulated' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::HOWRootMetadata.

◆ setSimulated()

void OdimH5v21::PolarScan::setSimulated ( bool val)
virtual

Set the 'simulated' attribute value.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::HOWRootMetadata.

◆ getBeamWidth() [1/2]

double OdimH5v21::PolarScan::getBeamWidth ( )
virtual

Get the 'beamwidth' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::HOWDatasetMetadata.

◆ getBeamWidth() [2/2]

double OdimH5v21::PolarScan::getBeamWidth ( double defaultValue)
virtual

Get the 'beamwidth' attribute value.

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

Implements OdimH5v21::HOWDatasetMetadata.

◆ setBeamWidth()

void OdimH5v21::PolarScan::setBeamWidth ( double val)
virtual

Set the 'beamwidth' attribute value.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::HOWDatasetMetadata.

◆ getWaveLength() [1/2]

double OdimH5v21::PolarScan::getWaveLength ( )
virtual

Get the 'wavelength' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::HOWDatasetMetadata.

◆ getWaveLength() [2/2]

double OdimH5v21::PolarScan::getWaveLength ( double defaultValue)
virtual

Get the 'wavelength' attribute value.

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

Implements OdimH5v21::HOWDatasetMetadata.

◆ setWaveLength()

void OdimH5v21::PolarScan::setWaveLength ( double val)
virtual

Set the 'wavelength' attribute value.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::HOWDatasetMetadata.

◆ getRPM() [1/2]

double OdimH5v21::PolarScan::getRPM ( )
virtual

Get the 'prm' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::HOWDatasetMetadata.

◆ getRPM() [2/2]

double OdimH5v21::PolarScan::getRPM ( double defaultValue)
virtual

Get the 'rpm' attribute value.

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

Implements OdimH5v21::HOWDatasetMetadata.

◆ setRPM()

void OdimH5v21::PolarScan::setRPM ( double val)
virtual

Set the 'rpm' attribute value.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::HOWDatasetMetadata.

◆ getPulseWidth() [1/2]

double OdimH5v21::PolarScan::getPulseWidth ( )
virtual

Get the 'pulsewidth' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::HOWDatasetMetadata.

◆ getPulseWidth() [2/2]

double OdimH5v21::PolarScan::getPulseWidth ( double defaultValue)
virtual

Get the 'pulsewidth' attribute value.

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

Implements OdimH5v21::HOWDatasetMetadata.

◆ setPulseWidth()

void OdimH5v21::PolarScan::setPulseWidth ( double val)
virtual

Set the 'pulsewidth' attribute value.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::HOWDatasetMetadata.

◆ getRXBandWidth() [1/2]

double OdimH5v21::PolarScan::getRXBandWidth ( )
virtual

Get the 'RXbandwidth' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::HOWDatasetMetadata.

◆ getRXBandWidth() [2/2]

double OdimH5v21::PolarScan::getRXBandWidth ( double defaultValue)
virtual

Get the 'RXbandwidth' attribute value.

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

Implements OdimH5v21::HOWDatasetMetadata.

◆ setRXBandWidth()

void OdimH5v21::PolarScan::setRXBandWidth ( double val)
virtual

Set the 'RXbandwidth' attribute value.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::HOWDatasetMetadata.

◆ getLowPRF() [1/2]

int OdimH5v21::PolarScan::getLowPRF ( )
virtual

Get the 'lowprf' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::HOWDatasetMetadata.

◆ getLowPRF() [2/2]

int OdimH5v21::PolarScan::getLowPRF ( int defaultValue)
virtual

Get the 'lowprf' attribute value.

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

Implements OdimH5v21::HOWDatasetMetadata.

◆ setLowPRF()

void OdimH5v21::PolarScan::setLowPRF ( int val)
virtual

Set the 'lowprf' attribute value.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::HOWDatasetMetadata.

◆ getHighPRF() [1/2]

int OdimH5v21::PolarScan::getHighPRF ( )
virtual

Get the 'highprf' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::HOWDatasetMetadata.

◆ getHighPRF() [2/2]

int OdimH5v21::PolarScan::getHighPRF ( int defaultValue)
virtual

Get the 'highprf' attribute value.

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

Implements OdimH5v21::HOWDatasetMetadata.

◆ setHighPRF()

void OdimH5v21::PolarScan::setHighPRF ( int val)
virtual

Set the 'highprf' attribute value.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::HOWDatasetMetadata.

◆ getTXLoss() [1/2]

double OdimH5v21::PolarScan::getTXLoss ( )
virtual

Get the 'TXloss' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::HOWDatasetMetadata.

◆ getTXLoss() [2/2]

double OdimH5v21::PolarScan::getTXLoss ( double defaultValue)
virtual

Get the 'TXloss' attribute value.

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

Implements OdimH5v21::HOWDatasetMetadata.

◆ setTXLoss()

void OdimH5v21::PolarScan::setTXLoss ( double val)
virtual

Set the 'TXLoss' attribute value.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::HOWDatasetMetadata.

◆ getRXLoss() [1/2]

double OdimH5v21::PolarScan::getRXLoss ( )
virtual

Get the 'RXloss' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::HOWDatasetMetadata.

◆ getRXLoss() [2/2]

double OdimH5v21::PolarScan::getRXLoss ( double defaultValue)
virtual

Get the 'RXloss' attribute value.

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

Implements OdimH5v21::HOWDatasetMetadata.

◆ setRXLoss()

void OdimH5v21::PolarScan::setRXLoss ( double val)
virtual

Set the 'RXloss' attribute value.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::HOWDatasetMetadata.

◆ getRadomeLoss() [1/2]

double OdimH5v21::PolarScan::getRadomeLoss ( )
virtual

Get the 'radomeloss' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::HOWDatasetMetadata.

◆ getRadomeLoss() [2/2]

double OdimH5v21::PolarScan::getRadomeLoss ( double defaultValue)
virtual

Get the 'radomeloss' attribute value.

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

Implements OdimH5v21::HOWDatasetMetadata.

◆ setRadomeLoss()

void OdimH5v21::PolarScan::setRadomeLoss ( double val)
virtual

Set the 'radomeloss' attribute value.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::HOWDatasetMetadata.

◆ getAntGain() [1/2]

double OdimH5v21::PolarScan::getAntGain ( )
virtual

Get the 'antgain' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::HOWDatasetMetadata.

◆ getAntGain() [2/2]

double OdimH5v21::PolarScan::getAntGain ( double defaultValue)
virtual

Get the 'antgain' attribute value.

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

Implements OdimH5v21::HOWDatasetMetadata.

◆ setAntGain()

void OdimH5v21::PolarScan::setAntGain ( double val)
virtual

Set the 'antgain' attribute value.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::HOWDatasetMetadata.

◆ getBeamWH() [1/2]

double OdimH5v21::PolarScan::getBeamWH ( )
virtual

Get the 'beamwH' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::HOWDatasetMetadata.

◆ getBeamWH() [2/2]

double OdimH5v21::PolarScan::getBeamWH ( double defaultValue)
virtual

Get the 'beamwH' attribute value.

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

Implements OdimH5v21::HOWDatasetMetadata.

◆ setBeamWH()

void OdimH5v21::PolarScan::setBeamWH ( double val)
virtual

Set the 'beamwH' attribute value.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::HOWDatasetMetadata.

◆ getBeamWV() [1/2]

double OdimH5v21::PolarScan::getBeamWV ( )
virtual

Get the 'beamwV' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::HOWDatasetMetadata.

◆ getBeamWV() [2/2]

double OdimH5v21::PolarScan::getBeamWV ( double defaultValue)
virtual

Get the 'beamwV' attribute value.

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

Implements OdimH5v21::HOWDatasetMetadata.

◆ setBeamWV()

void OdimH5v21::PolarScan::setBeamWV ( double val)
virtual

Set the 'beamwV' attribute value.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::HOWDatasetMetadata.

◆ getGasAttn() [1/2]

double OdimH5v21::PolarScan::getGasAttn ( )
virtual

Get the 'gasattn' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::HOWDatasetMetadata.

◆ getGasAttn() [2/2]

double OdimH5v21::PolarScan::getGasAttn ( double defaultValue)
virtual

Get the 'gasattn' attribute value.

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

Implements OdimH5v21::HOWDatasetMetadata.

◆ setGasAttn()

void OdimH5v21::PolarScan::setGasAttn ( double val)
virtual

Set the 'gasattn' attribute value.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::HOWDatasetMetadata.

◆ getRadConstH() [1/2]

double OdimH5v21::PolarScan::getRadConstH ( )
virtual

Get the 'radconstH' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::HOWDatasetMetadata.

◆ getRadConstH() [2/2]

double OdimH5v21::PolarScan::getRadConstH ( double defaultValue)
virtual

Get the 'radconstH' attribute value.

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

Implements OdimH5v21::HOWDatasetMetadata.

◆ setRadConstH()

void OdimH5v21::PolarScan::setRadConstH ( double val)
virtual

Set the 'radconstH' attribute value.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::HOWDatasetMetadata.

◆ getRadConstV() [1/2]

double OdimH5v21::PolarScan::getRadConstV ( )
virtual

Get the 'radconstV' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::HOWDatasetMetadata.

◆ getRadConstV() [2/2]

double OdimH5v21::PolarScan::getRadConstV ( double defaultValue)
virtual

Get the 'radconstV' attribute value.

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

Implements OdimH5v21::HOWDatasetMetadata.

◆ setRadConstV()

void OdimH5v21::PolarScan::setRadConstV ( double val)
virtual

Set the 'radconstV' attribute value.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::HOWDatasetMetadata.

◆ getNomTXPower() [1/2]

double OdimH5v21::PolarScan::getNomTXPower ( )
virtual

Get the 'nomTXpower' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::HOWDatasetMetadata.

◆ getNomTXPower() [2/2]

double OdimH5v21::PolarScan::getNomTXPower ( double defaultValue)
virtual

Get the 'nomTXpower' attribute value.

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

Implements OdimH5v21::HOWDatasetMetadata.

◆ setNomTXPower()

void OdimH5v21::PolarScan::setNomTXPower ( double val)
virtual

Set the 'nomTXpower' attribute value.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::HOWDatasetMetadata.

◆ getTXPower() [1/2]

std::vector< double > OdimH5v21::PolarScan::getTXPower ( )
virtual

Get the 'TXpower' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::HOWDatasetMetadata.

◆ getTXPower() [2/2]

std::vector< double > OdimH5v21::PolarScan::getTXPower ( double defaultValue)
virtual

Get the 'TXpower' attribute value.

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

Implements OdimH5v21::HOWDatasetMetadata.

◆ setTXPower()

void OdimH5v21::PolarScan::setTXPower ( double val)
virtual

Set the 'TXpower' attribute value.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::HOWDatasetMetadata.

◆ getNI() [1/2]

double OdimH5v21::PolarScan::getNI ( )
virtual

Get the 'NI' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::HOWDatasetMetadata.

◆ getNI() [2/2]

double OdimH5v21::PolarScan::getNI ( double defaultValue)
virtual

Get the 'NI' attribute value.

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

Implements OdimH5v21::HOWDatasetMetadata.

◆ setNI()

void OdimH5v21::PolarScan::setNI ( double val)
virtual

Set the 'NI' attribute value.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::HOWDatasetMetadata.

◆ getVSamples() [1/2]

double OdimH5v21::PolarScan::getVSamples ( )
virtual

Get the 'Vsamples' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::HOWDatasetMetadata.

◆ getVSamples() [2/2]

double OdimH5v21::PolarScan::getVSamples ( double defaultValue)
virtual

Get the 'Vsamples' attribute value.

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

Implements OdimH5v21::HOWDatasetMetadata.

◆ setVSamples()

void OdimH5v21::PolarScan::setVSamples ( double val)
virtual

Set the 'Vsamples' attribute value.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::HOWDatasetMetadata.

◆ getAzimuthMethod()

std::string OdimH5v21::PolarScan::getAzimuthMethod ( )
virtual

Get the 'azmethod' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::HOWPolarMetadata.

◆ setAzimuthMethod()

void OdimH5v21::PolarScan::setAzimuthMethod ( const std::string & val)
virtual

Set the 'azmethod' attribute value.

Parameters
valthe value tro write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::HOWPolarMetadata.

◆ getBinMethod()

std::string OdimH5v21::PolarScan::getBinMethod ( )
virtual

Get the 'binmethod' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::HOWPolarMetadata.

◆ setBinMethod()

void OdimH5v21::PolarScan::setBinMethod ( const std::string & val)
virtual

Set the 'binmethod' attribute value.

Parameters
valthe value tro write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::HOWPolarMetadata.

◆ getAzimuthAngles()

std::vector< AZAngles > OdimH5v21::PolarScan::getAzimuthAngles ( )
virtual

Get the 'startazA' and 'stopazA' attributes values (formerly azangles attribute in odimh5v2.0) - available only in a Polar Data.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::HOWPolarMetadata.

◆ setAzimuthAngles()

void OdimH5v21::PolarScan::setAzimuthAngles ( const std::vector< AZAngles > & val,
int precision = 0 )
virtual

Set the 'startazA' and 'stopazA' attributes values (formerly azangles attribute in odimh5v2.0) - available only in a Polar Data.

Parameters
valthe values to write
precisionprecisio. This parameter is not used. It is leaved for compatibility with odimh5v2.0
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::HOWPolarMetadata.

◆ getElevationAngles()

std::vector< double > OdimH5v21::PolarScan::getElevationAngles ( )
virtual

Get the 'elangles' attribute values.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::HOWPolarMetadata.

◆ setElevationAngles()

void OdimH5v21::PolarScan::setElevationAngles ( const std::vector< double > & val)
virtual

Set the 'elangles' attribute values.

Parameters
valthe values to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::HOWPolarMetadata.

◆ getStartAzimuthAngles()

std::vector< double > OdimH5v21::PolarScan::getStartAzimuthAngles ( )
virtual

Get the 'startazA' attribute values.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::HOWPolarMetadata.

◆ setStartAzimuthAngles()

void OdimH5v21::PolarScan::setStartAzimuthAngles ( const std::vector< double > & val)
virtual

Set the 'startazA' attribute values.

Parameters
valthe values to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::HOWPolarMetadata.

◆ getStopAzimuthAngles()

std::vector< double > OdimH5v21::PolarScan::getStopAzimuthAngles ( )
virtual

Get the 'stopazA' attribute values.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::HOWPolarMetadata.

◆ setStopAzimuthAngles()

void OdimH5v21::PolarScan::setStopAzimuthAngles ( const std::vector< double > & val)
virtual

Set the 'stopazA' attribute values.

Parameters
valthe values to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::HOWPolarMetadata.

◆ getStartAzimuthTimes()

std::vector< double > OdimH5v21::PolarScan::getStartAzimuthTimes ( )
virtual

Get the 'startazT' attribute values.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::HOWPolarMetadata.

◆ setStartAzimuthTimes()

void OdimH5v21::PolarScan::setStartAzimuthTimes ( const std::vector< double > & val)
virtual

Set the 'startazT' attribute values.

Parameters
valthe values to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::HOWPolarMetadata.

◆ getStopAzimuthTimes()

std::vector< double > OdimH5v21::PolarScan::getStopAzimuthTimes ( )
virtual

Get the 'stopazT' attribute values.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::HOWPolarMetadata.

◆ setStopAzimuthTimes()

void OdimH5v21::PolarScan::setStopAzimuthTimes ( const std::vector< double > & val)
virtual

Set the 'stopazT' attribute values.

Parameters
valthe values to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::HOWPolarMetadata.

◆ getPointAccEl()

double OdimH5v21::PolarScan::getPointAccEl ( )
virtual

Get the 'pointaccEL' attribute values.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::HOWPolarMetadata.

◆ setPointAccEl()

void OdimH5v21::PolarScan::setPointAccEl ( double val)
virtual

Set the 'pointaccEL' attribute values.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::HOWPolarMetadata.

◆ getPointAccAZ()

double OdimH5v21::PolarScan::getPointAccAZ ( )
virtual

Get the 'pointaccAZ' attribute values.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::HOWPolarMetadata.

◆ setPointAccAZ()

void OdimH5v21::PolarScan::setPointAccAZ ( double val)
virtual

Set the 'pointaccAZ' attribute values.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::HOWPolarMetadata.

◆ getMalfunc()

bool OdimH5v21::PolarScan::getMalfunc ( )
virtual

Get the 'malfunc' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::HOWPolarMetadata.

◆ setMalfunc()

void OdimH5v21::PolarScan::setMalfunc ( bool val)
virtual

Set the 'malfunc' attribute value.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::HOWPolarMetadata.

◆ getRadarMsg()

std::string OdimH5v21::PolarScan::getRadarMsg ( )
virtual

Get the 'radarmsg' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::HOWPolarMetadata.

◆ setRadarMsg()

void OdimH5v21::PolarScan::setRadarMsg ( const std::string & val)
virtual

Set the 'radarmsg' attribute value.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::HOWPolarMetadata.

◆ getRadarHorizon()

double OdimH5v21::PolarScan::getRadarHorizon ( )
virtual

Get the 'radhoriz' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::HOWPolarMetadata.

◆ setRadarHorizon()

void OdimH5v21::PolarScan::setRadarHorizon ( double val)
virtual

Set the 'radhoriz' attribute value.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::HOWPolarMetadata.

◆ getNEZ()

double OdimH5v21::PolarScan::getNEZ ( )
virtual

Get the 'NEZ' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::HOWPolarMetadata.

◆ setNEZ()

void OdimH5v21::PolarScan::setNEZ ( double val)
virtual

Set the 'NEZ' attribute value.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::HOWPolarMetadata.

◆ getOUR()

double OdimH5v21::PolarScan::getOUR ( )
virtual

Get the 'OUR' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::HOWPolarMetadata.

◆ setOUR()

void OdimH5v21::PolarScan::setOUR ( double val)
virtual

Set the 'OUR' attribute value.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::HOWPolarMetadata.

◆ getDClutter()

std::vector< std::string > OdimH5v21::PolarScan::getDClutter ( )
virtual

Get the 'Dclutter' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::HOWPolarMetadata.

◆ setDClutter()

void OdimH5v21::PolarScan::setDClutter ( const std::vector< std::string > & val)
virtual

Set the 'Dclutter' attribute value.

Parameters
valthe values to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::HOWPolarMetadata.

◆ getComment()

std::string OdimH5v21::PolarScan::getComment ( )
virtual

Get the 'comment' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::HOWPolarMetadata.

◆ setComment()

void OdimH5v21::PolarScan::setComment ( const std::string & val)
virtual

Set the 'comment' attribute value.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::HOWPolarMetadata.

◆ getSQI()

double OdimH5v21::PolarScan::getSQI ( )
virtual

Get the 'SQI' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::HOWPolarMetadata.

◆ setSQI()

void OdimH5v21::PolarScan::setSQI ( double val)
virtual

Set the 'SQI' attribute value.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::HOWPolarMetadata.

◆ getCSR()

double OdimH5v21::PolarScan::getCSR ( )
virtual

Get the 'CSR' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::HOWPolarMetadata.

◆ setCSR()

void OdimH5v21::PolarScan::setCSR ( double val)
virtual

Set the 'CSR' attribute value.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::HOWPolarMetadata.

◆ getLOG()

double OdimH5v21::PolarScan::getLOG ( )
virtual

Get the 'LOG' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::HOWPolarMetadata.

◆ setLOG()

void OdimH5v21::PolarScan::setLOG ( double val)
virtual

Set the 'LOG' attribute value.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::HOWPolarMetadata.

◆ getVPRCorr()

bool OdimH5v21::PolarScan::getVPRCorr ( )
virtual

Get the 'VPRCoor' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::HOWPolarMetadata.

◆ setVPRCorr()

void OdimH5v21::PolarScan::setVPRCorr ( bool val)
virtual

Set the 'VPRCoor' attribute value.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::HOWPolarMetadata.

◆ getFreeze()

double OdimH5v21::PolarScan::getFreeze ( )
virtual

Get the 'freeze' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::HOWPolarMetadata.

◆ setFreeze()

void OdimH5v21::PolarScan::setFreeze ( double val)
virtual

Set the 'freeze' attribute value.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::HOWPolarMetadata.

◆ getMin()

double OdimH5v21::PolarScan::getMin ( )
virtual

Get the 'min' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::HOWPolarMetadata.

◆ setMin()

void OdimH5v21::PolarScan::setMin ( double val)
virtual

Set the 'min' attribute value.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::HOWPolarMetadata.

◆ getMax()

double OdimH5v21::PolarScan::getMax ( )
virtual

Get the 'max' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::HOWPolarMetadata.

◆ setMax()

void OdimH5v21::PolarScan::setMax ( double val)
virtual

Set the 'max' attribute value.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::HOWPolarMetadata.

◆ getStep()

double OdimH5v21::PolarScan::getStep ( )
virtual

Get the 'step' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::HOWPolarMetadata.

◆ setStep()

void OdimH5v21::PolarScan::setStep ( double val)
virtual

Set the 'step' attribute value.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::HOWPolarMetadata.

◆ getLevels()

int OdimH5v21::PolarScan::getLevels ( )
virtual

Get the 'levels' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::HOWPolarMetadata.

◆ setLevels()

void OdimH5v21::PolarScan::setLevels ( int val)
virtual

Set the 'levels' attribute value.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::HOWPolarMetadata.

◆ getPeakPwr()

double OdimH5v21::PolarScan::getPeakPwr ( )
virtual

Get the 'peakpwr' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::HOWPolarMetadata.

◆ setPeakPwr()

void OdimH5v21::PolarScan::setPeakPwr ( double val)
virtual

Set the 'peakpwr' attribute value.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::HOWPolarMetadata.

◆ getAvgPwr()

double OdimH5v21::PolarScan::getAvgPwr ( )
virtual

Get the 'avgpwr' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::HOWPolarMetadata.

◆ setAvgPwr()

void OdimH5v21::PolarScan::setAvgPwr ( double val)
virtual

Set the 'awgpwr' attribute value.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::HOWPolarMetadata.

◆ getDynRange()

double OdimH5v21::PolarScan::getDynRange ( )
virtual

Get the 'dynrange' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::HOWPolarMetadata.

◆ setDynRange()

void OdimH5v21::PolarScan::setDynRange ( double val)
virtual

Set the 'dynrange' attribute value.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::HOWPolarMetadata.

◆ getRAC()

double OdimH5v21::PolarScan::getRAC ( )
virtual

Get the 'RAC' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::HOWPolarMetadata.

◆ setRAC()

void OdimH5v21::PolarScan::setRAC ( double val)
virtual

Set the 'RAC' attribute value.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::HOWPolarMetadata.

◆ getBBC()

bool OdimH5v21::PolarScan::getBBC ( )
virtual

Get the 'BBC' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::HOWPolarMetadata.

◆ setBBC()

void OdimH5v21::PolarScan::setBBC ( bool val)
virtual

Set the 'BBC' attribute value.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::HOWPolarMetadata.

◆ getPAC()

double OdimH5v21::PolarScan::getPAC ( )
virtual

Get the 'PAC' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::HOWPolarMetadata.

◆ setPAC()

void OdimH5v21::PolarScan::setPAC ( double val)
virtual

Set the 'PAC' attribute value.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::HOWPolarMetadata.

◆ getS2N()

double OdimH5v21::PolarScan::getS2N ( )
virtual

Get the 'S2N' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::HOWPolarMetadata.

◆ setS2N()

void OdimH5v21::PolarScan::setS2N ( double val)
virtual

Set the 'S2N' attribute value.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::HOWPolarMetadata.

◆ getPolarization()

std::string OdimH5v21::PolarScan::getPolarization ( )
virtual

Get the 'polarization' attribute value.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::HOWPolarMetadata.

◆ setPolarization()

void OdimH5v21::PolarScan::setPolarization ( const std::string & val)
virtual

Set the 'polarization' attribute value.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implements OdimH5v21::HOWPolarMetadata.

◆ getQuantityDataCount()

int OdimH5v21::PolarScan::getQuantityDataCount ( )
virtual

Get number of quantities stored in the scan.

Returns
The number of quantities
Exceptions
OdimH5ExceptionThrowed if an error occurs

◆ createQuantityData()

PolarScanData * OdimH5v21::PolarScan::createQuantityData ( const char * name)
virtual

Create a new group for a quantity in the scan.

Parameters
nameThe quantity type to be created
Returns
The number of quantities
Exceptions
OdimH5ExceptionThrowed if an error occurs

◆ getQuantityData() [1/2]

PolarScanData * OdimH5v21::PolarScan::getQuantityData ( int index)
virtual

Get the data associated to a quantity.

Get the data associated to a quantity using its index.

Returns
The object associated to the quantity
Exceptions
OdimH5ExceptionThrowed if an error occurs
Remarks
User is responsible for deleting the returned object

◆ getQuantityData() [2/2]

PolarScanData * OdimH5v21::PolarScan::getQuantityData ( const char * name)
virtual

Get the data associated to a quantity.

Get the data associated to a quantity using its OdimH5 name.

Returns
The object associated to the quantity
Exceptions
OdimH5ExceptionThrowed if an error occurs
Remarks
User is responsible for deleting the returned object

◆ removeQuantityData()

void OdimH5v21::PolarScan::removeQuantityData ( const char * name)
virtual

Delete the data associated to a quantity.

Delete the data associated to a quantity using its OdimH5 name.

Exceptions
OdimH5ExceptionThrowed if an error occurs

◆ hasQuantityData()

bool OdimH5v21::PolarScan::hasQuantityData ( const char * name)
virtual

Check if the scan contains the data associated to a quantity.

Check if the scan contains the data associated to a quantity using its OdimH5 name.

Parameters
nameThe quantity name to find
Exceptions
OdimH5ExceptionThrowed if an error occurs

◆ getQuantityDataIndex()

int OdimH5v21::PolarScan::getQuantityDataIndex ( const char * name)
virtual

Return the index of the 'data' group containing the given quantity.

Parameters
nameThe quantity name to find
Returns
A non negative value if the given quantity is found, -1 otherwise
Exceptions
OdimH5ExceptionThrowed if an error occurs

◆ getDirection()

int OdimH5v21::PolarScan::getDirection ( )
virtual

Get the direction of the scan

Get the direction of the scan. The result is > 0 if the scan is clockwise, < 0 if the scan is counter-clockwise.
This value is calculated using the RPM attribute or the AZTimes attribute.
If it is not possibile to calculate the direction of the scan, 0 is returned.

Exceptions
OdimH5ExceptionThrowed if an error occurs

◆ getStoredQuantities()

std::set< std::string > OdimH5v21::PolarScan::getStoredQuantities ( )

Get the name of all quantities present in this scan.

Returns
A std::set containing the name of each quantity present in the scan
Exceptions
OdimH5ExceptionThrowed if an error occurs

◆ originaRayIndex()

static int OdimH5v21::PolarScan::originaRayIndex ( int index,
int originalDirection,
int numrays,
int a1gate )
static

Calculate the original ray index of a scan.

Scan's rays are always ordered clockwise, with the first ray pointing to the geographic north.
Starting from a index, this function can calculate the index of rays in temporal order.

Parameters
indexthe index of a ray in the scan
originalDirectionthe direction of the scan (1 or -1)
numraysthe total number of rays in the scan
a1gatethe value of the a1gate attribute
Exceptions
OdimH5ExceptionThrowed if an error occurs

◆ getH5Object()

H5::Group * OdimH5v21::OdimDataset::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 OdimH5v21::OdimDataset::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

◆ existWhere()

bool OdimH5v21::OdimDataset::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

◆ existHow()

bool OdimH5v21::OdimDataset::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

◆ getWhat()

MetadataGroup * OdimH5v21::OdimDataset::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

◆ getWhere()

MetadataGroup * OdimH5v21::OdimDataset::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

◆ getHow()

MetadataGroup * OdimH5v21::OdimDataset::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

◆ getDataCount()

int OdimH5v21::OdimDataset::getDataCount ( )
virtualinherited

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

Returns
the number of 'data' groups
Exceptions
OdimH5Exceptionif an unexpected error occurs

◆ createData()

OdimData * OdimH5v21::OdimDataset::createData ( )
virtualinherited

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

◆ getData()

OdimData * OdimH5v21::OdimDataset::getData ( int index)
virtualinherited

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

◆ removeData()

void OdimH5v21::OdimDataset::removeData ( int index)
virtualinherited

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

◆ getQualityCount()

int OdimH5v21::OdimDataset::getQualityCount ( )
virtualinherited

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

Returns
the number of 'quality' groups
Exceptions
OdimH5Exceptionif an unexpected error occurs

◆ createQuality()

OdimQuality * OdimH5v21::OdimDataset::createQuality ( )
virtualinherited

Create a new group 'Quality' inside this dataset.

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

◆ getQuality()

OdimQuality * OdimH5v21::OdimDataset::getQuality ( int index)
virtualinherited

Get an existing Quality group using the given index.

Get an existing dataset using the given index

Parameters
indexthe quality index from 0 to n-1
Returns
the OdimQuality 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

◆ removeQuality()

void OdimH5v21::OdimDataset::removeQuality ( int index)
virtualinherited

Remove a 'quality' group from this dataset.

Remove a 'quality' group from this dataset

Parameters
indexthe dataset index from 0 to n-1
Exceptions
OdimH5Exceptionif an unexpected error occurs

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