radarlib  1.4.6
OdimH5v21::WHATRootMetadata Class Referenceabstract

Interface fot WHAT root attributes methods. More...

#include <radarlib/odimh5v21_metadata.hpp>

Inheritance diagram for OdimH5v21::WHATRootMetadata:
OdimH5v21::OdimObject OdimH5v21::WHATDatasetMetadata OdimH5v21::Object_2D OdimH5v21::PolarVolume OdimH5v21::PolarScan OdimH5v21::PolarScanData OdimH5v21::Product_2D OdimH5v21::Product_2D_Data OdimH5v21::HorizontalObject_2D OdimH5v21::XsecObject OdimH5v21::Horizontal_Product_2D OdimH5v21::Vertical_Product_2D OdimH5v21::CompObject OdimH5v21::ImageObject 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 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 root attributes methods.

This interface declare the methods to read and write root WHAT attributes

Member Function Documentation

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

Get the value of 'object' attribute.

Exceptions
OdimH5Exceptionif an unexpected error occurs

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

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

Set the value of 'object' attribute.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

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

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

Get the value of 'version' attribute.

Exceptions
OdimH5Exceptionif an unexpected error occurs

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

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

Set the value of 'version' attribute.

Parameters
valthe value to write
Exceptions
OdimH5Exceptionif an unexpected error occurs

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

virtual void OdimH5v21::WHATRootMetadata::setDateTime ( const time_t  val)
pure 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

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

virtual time_t OdimH5v21::WHATRootMetadata::getDateTime ( )
pure 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

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

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

Get the value of 'source' attribute.

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

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

virtual void OdimH5v21::WHATRootMetadata::setSource ( const SourceInfo val)
pure 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

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


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