radarlib 1.4.6
OdimH5v21::WHATDatasetMetadata Class Referenceabstract

Interface fot WHAT dataset attributes methods. More...

#include <radarlib/odimh5v21_metadata.hpp>

Inheritance diagram for OdimH5v21::WHATDatasetMetadata:
OdimH5v21::WHATRootMetadata OdimH5v21::PolarScan OdimH5v21::PolarScanData OdimH5v21::Product_2D OdimH5v21::Product_2D_Data OdimH5v21::Horizontal_Product_2D OdimH5v21::Vertical_Product_2D OdimH5v21::Product_CAPPI OdimH5v21::Product_COMP OdimH5v21::Product_ETOP OdimH5v21::Product_LBM OdimH5v21::Product_MAX OdimH5v21::Product_PCAPPI OdimH5v21::Product_POH OdimH5v21::Product_PPI OdimH5v21::Product_RR OdimH5v21::Product_VIL OdimH5v21::Product_Panel OdimH5v21::Product_RHI OdimH5v21::Product_XSEC

Public Member Functions

virtual std::string getProduct ()=0
 Get the value of 'product' attribute. More...
 
virtual void setProduct (const std::string &val)=0
 Set the value of 'product' attribute. More...
 
virtual void setProdPar (double val)=0
 Set the value of 'prodpar' attribute. More...
 
virtual void setProdPar (const VILHeights &val)=0
 Set the value of 'prodpar' attribute using the given VILHeights values. More...
 
virtual double getProdPar ()=0
 Get the value of 'prodpar' attribute as double value. More...
 
virtual VILHeights getProdParVIL ()=0
 Get the value of 'prodpar' attribute as VILHeights pair. More...
 
virtual std::string getQuantity ()=0
 Set the value of 'quantity' attribute. More...
 
virtual void setQuantity (const std::string &val)=0
 Get the value of 'quantity' attribute. More...
 
virtual void setStartDateTime (time_t val)=0
 Set the value of 'startdate' and 'starttime' attributes. More...
 
virtual time_t getStartDateTime ()=0
 Get the value of 'startdate' and 'starttime' attributes. More...
 
virtual void setEndDateTime (time_t val)=0
 Set the value of 'enddate' and 'endtime' attributes. More...
 
virtual time_t getEndDateTime ()=0
 Get the value of 'enddate' and 'endtime' attributes. More...
 
virtual double getGain ()=0
 Get the value of 'gain' attribute. More...
 
virtual void setGain (double val)=0
 Set the value of 'gain' attribute. More...
 
virtual double getOffset ()=0
 Get the value of 'offset' attribute. More...
 
virtual void setOffset (double val)=0
 Set the value of 'offset' attribute. More...
 
virtual double getNodata ()=0
 Get the value of 'nodata' attribute. More...
 
virtual void setNodata (double val)=0
 Set the value of 'nodata' attribute. More...
 
virtual double getUndetect ()=0
 Get the value of 'undetect' attribute. More...
 
virtual void setUndetect (double val)=0
 Set the value of 'undetect' attribute. More...
 
virtual std::string getObject ()=0
 Get the value of 'object' attribute. More...
 
virtual void setObject (const std::string &val)=0
 Set the value of 'object' attribute. More...
 
virtual std::string getVersion ()=0
 Get the value of 'version' attribute. More...
 
virtual void setVersion (const std::string &val)=0
 Set the value of 'version' attribute. More...
 
virtual void setDateTime (const time_t val)=0
 Set the value of 'date' and 'time' attributes. More...
 
virtual time_t getDateTime ()=0
 Get the joined value of 'date' and 'time' attributes. More...
 
virtual SourceInfo getSource ()=0
 Get the value of 'source' attribute. More...
 
virtual void setSource (const SourceInfo &val)=0
 Set the value of 'source' attribute. More...
 

Detailed Description

Interface fot WHAT dataset attributes methods.

Member Function Documentation

◆ getProduct()

virtual std::string OdimH5v21::WHATDatasetMetadata::getProduct ( )
pure virtual

Get the value of 'product' attribute.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implemented in OdimH5v21::PolarScan, OdimH5v21::PolarScanData, OdimH5v21::Product_2D, and OdimH5v21::Product_2D_Data.

◆ setProduct()

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

Set the value of 'product' attribute.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implemented in OdimH5v21::PolarScan, OdimH5v21::PolarScanData, OdimH5v21::Product_2D, and OdimH5v21::Product_2D_Data.

◆ setProdPar() [1/2]

virtual void OdimH5v21::WHATDatasetMetadata::setProdPar ( double  val)
pure 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

Implemented in OdimH5v21::PolarScan, OdimH5v21::PolarScanData, OdimH5v21::Product_2D, and OdimH5v21::Product_2D_Data.

◆ setProdPar() [2/2]

virtual void OdimH5v21::WHATDatasetMetadata::setProdPar ( const VILHeights val)
pure 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

Implemented in OdimH5v21::PolarScan, OdimH5v21::PolarScanData, OdimH5v21::Product_2D, and OdimH5v21::Product_2D_Data.

◆ getProdPar()

virtual double OdimH5v21::WHATDatasetMetadata::getProdPar ( )
pure 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

Implemented in OdimH5v21::PolarScan, OdimH5v21::PolarScanData, OdimH5v21::Product_2D, and OdimH5v21::Product_2D_Data.

◆ getProdParVIL()

virtual VILHeights OdimH5v21::WHATDatasetMetadata::getProdParVIL ( )
pure 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

Implemented in OdimH5v21::PolarScan, OdimH5v21::PolarScanData, OdimH5v21::Product_2D, and OdimH5v21::Product_2D_Data.

◆ getQuantity()

virtual std::string OdimH5v21::WHATDatasetMetadata::getQuantity ( )
pure virtual

Set the value of 'quantity' attribute.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implemented in OdimH5v21::PolarScan, OdimH5v21::PolarScanData, OdimH5v21::Product_2D, and OdimH5v21::Product_2D_Data.

◆ setQuantity()

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

Get the value of 'quantity' attribute.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implemented in OdimH5v21::PolarScan, OdimH5v21::PolarScanData, OdimH5v21::Product_2D, and OdimH5v21::Product_2D_Data.

◆ setStartDateTime()

virtual void OdimH5v21::WHATDatasetMetadata::setStartDateTime ( time_t  val)
pure 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

Implemented in OdimH5v21::PolarScan, OdimH5v21::PolarScanData, OdimH5v21::Product_2D, and OdimH5v21::Product_2D_Data.

◆ getStartDateTime()

virtual time_t OdimH5v21::WHATDatasetMetadata::getStartDateTime ( )
pure 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

Implemented in OdimH5v21::PolarScan, OdimH5v21::PolarScanData, OdimH5v21::Product_2D, and OdimH5v21::Product_2D_Data.

◆ setEndDateTime()

virtual void OdimH5v21::WHATDatasetMetadata::setEndDateTime ( time_t  val)
pure 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

Implemented in OdimH5v21::PolarScan, OdimH5v21::PolarScanData, OdimH5v21::Product_2D, and OdimH5v21::Product_2D_Data.

◆ getEndDateTime()

virtual time_t OdimH5v21::WHATDatasetMetadata::getEndDateTime ( )
pure 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

Implemented in OdimH5v21::PolarScan, OdimH5v21::PolarScanData, OdimH5v21::Product_2D, and OdimH5v21::Product_2D_Data.

◆ getGain()

virtual double OdimH5v21::WHATDatasetMetadata::getGain ( )
pure virtual

Get the value of 'gain' attribute.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implemented in OdimH5v21::PolarScan, OdimH5v21::PolarScanData, OdimH5v21::Product_2D, and OdimH5v21::Product_2D_Data.

◆ setGain()

virtual void OdimH5v21::WHATDatasetMetadata::setGain ( double  val)
pure virtual

Set the value of 'gain' attribute.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implemented in OdimH5v21::PolarScan, OdimH5v21::PolarScanData, OdimH5v21::Product_2D, and OdimH5v21::Product_2D_Data.

◆ getOffset()

virtual double OdimH5v21::WHATDatasetMetadata::getOffset ( )
pure virtual

Get the value of 'offset' attribute.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implemented in OdimH5v21::PolarScan, OdimH5v21::PolarScanData, OdimH5v21::Product_2D, and OdimH5v21::Product_2D_Data.

◆ setOffset()

virtual void OdimH5v21::WHATDatasetMetadata::setOffset ( double  val)
pure virtual

Set the value of 'offset' attribute.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implemented in OdimH5v21::PolarScan, OdimH5v21::PolarScanData, OdimH5v21::Product_2D, and OdimH5v21::Product_2D_Data.

◆ getNodata()

virtual double OdimH5v21::WHATDatasetMetadata::getNodata ( )
pure virtual

Get the value of 'nodata' attribute.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implemented in OdimH5v21::PolarScan, OdimH5v21::PolarScanData, OdimH5v21::Product_2D, and OdimH5v21::Product_2D_Data.

◆ setNodata()

virtual void OdimH5v21::WHATDatasetMetadata::setNodata ( double  val)
pure virtual

Set the value of 'nodata' attribute.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implemented in OdimH5v21::PolarScan, OdimH5v21::PolarScanData, OdimH5v21::Product_2D, and OdimH5v21::Product_2D_Data.

◆ getUndetect()

virtual double OdimH5v21::WHATDatasetMetadata::getUndetect ( )
pure virtual

Get the value of 'undetect' attribute.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implemented in OdimH5v21::PolarScan, OdimH5v21::PolarScanData, OdimH5v21::Product_2D, and OdimH5v21::Product_2D_Data.

◆ setUndetect()

virtual void OdimH5v21::WHATDatasetMetadata::setUndetect ( double  val)
pure virtual

Set the value of 'undetect' attribute.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implemented in OdimH5v21::PolarScan, OdimH5v21::PolarScanData, OdimH5v21::Product_2D, and OdimH5v21::Product_2D_Data.

◆ getObject()

virtual std::string OdimH5v21::WHATRootMetadata::getObject ( )
pure virtualinherited

Get the value of 'object' attribute.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implemented in OdimH5v21::OdimObject, OdimH5v21::PolarScan, OdimH5v21::PolarScanData, OdimH5v21::Product_2D, and OdimH5v21::Product_2D_Data.

◆ setObject()

virtual void OdimH5v21::WHATRootMetadata::setObject ( const std::string &  val)
pure virtualinherited

Set the value of 'object' attribute.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implemented in OdimH5v21::OdimObject, OdimH5v21::PolarScan, OdimH5v21::PolarScanData, OdimH5v21::Product_2D, and OdimH5v21::Product_2D_Data.

◆ getVersion()

virtual std::string OdimH5v21::WHATRootMetadata::getVersion ( )
pure virtualinherited

Get the value of 'version' attribute.

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implemented in OdimH5v21::OdimObject, OdimH5v21::PolarScan, OdimH5v21::PolarScanData, OdimH5v21::Product_2D, and OdimH5v21::Product_2D_Data.

◆ setVersion()

virtual void OdimH5v21::WHATRootMetadata::setVersion ( const std::string &  val)
pure virtualinherited

Set the value of 'version' attribute.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implemented in OdimH5v21::OdimObject, OdimH5v21::PolarScan, OdimH5v21::PolarScanData, OdimH5v21::Product_2D, and OdimH5v21::Product_2D_Data.

◆ setDateTime()

virtual void OdimH5v21::WHATRootMetadata::setDateTime ( const time_t  val)
pure virtualinherited

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

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

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implemented in OdimH5v21::OdimObject, OdimH5v21::PolarScan, OdimH5v21::PolarScanData, OdimH5v21::Product_2D, and OdimH5v21::Product_2D_Data.

◆ getDateTime()

virtual time_t OdimH5v21::WHATRootMetadata::getDateTime ( )
pure virtualinherited

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

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

Exceptions
OdimH5Exceptionif an unexpected error occurs

Implemented in OdimH5v21::OdimObject, OdimH5v21::PolarScan, OdimH5v21::PolarScanData, OdimH5v21::Product_2D, and OdimH5v21::Product_2D_Data.

◆ getSource()

virtual SourceInfo OdimH5v21::WHATRootMetadata::getSource ( )
pure virtualinherited

Get the value of 'source' attribute.

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

Implemented in OdimH5v21::OdimObject, OdimH5v21::PolarScan, OdimH5v21::PolarScanData, OdimH5v21::Product_2D, and OdimH5v21::Product_2D_Data.

◆ setSource()

virtual void OdimH5v21::WHATRootMetadata::setSource ( const SourceInfo val)
pure virtualinherited

Set the value of 'source' attribute.

Set the value of 'source' attribute according to OdimH5 format, using the values stored in a SourceInfo object

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

Implemented in OdimH5v21::OdimObject, OdimH5v21::PolarScan, OdimH5v21::PolarScanData, OdimH5v21::Product_2D, and OdimH5v21::Product_2D_Data.


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