radarlib  1.4.4
OdimH5v20::SourceInfo Class Reference

OdimH5 object source informations. More...

#include <radarlib/odimh5v20_support.hpp>

Public Member Functions

 SourceInfo ()
 Create an empty source information object. More...
 
 SourceInfo (const std::string &value)
 Create and inizalize a source information decoding the indicated string. More...
 
void parse (const std::string value)
 Set object fields decoding the indicated string. More...
 
std::string toString () const
 Convert fields into a string formated acording to OdimH5 specifications. More...
 
SourceInfosetWMO (const std::string &value)
 Set WMO value and return a reference to this object. More...
 
SourceInfosetOperaRadarSite (const std::string &value)
 Set OperaRadarSite value and return a reference to this object. More...
 
SourceInfosetOriginatingCenter (int value)
 Set OriginatingCenter value and return a reference to this object. More...
 
SourceInfosetPlace (const std::string &value)
 Set Place value and return a reference to this object. More...
 
SourceInfosetCountry (int value)
 Set Country value and return a reference to this object. More...
 
SourceInfosetComment (const std::string &value)
 Set Comment value and return a reference to this object. More...
 

Public Attributes

std::string WMO
 Combined WMO block and station number in the form A1bwnnnnn, or 0 if none assigned. More...
 
std::string OperaRadarSite
 Radar site as indexed in the OPERA database. More...
 
int OriginatingCenter
 Originating centre. More...
 
std::string Place
 Place according to Table 9 of OdimH5 standard. More...
 
int Country
 Country according to BUFR tables 14 0 1 101. More...
 
std::string Comment
 Free comment. More...
 

Detailed Description

OdimH5 object source informations.

This class represent a OdimH5 object source info
For further details see OdimH5 v2.0 specifications/page 10

Remarks
From OdimH5 documentation is not clear a single type of subinformation can have multiple values, so we assume thet every sub info has only one value
See Also
OdimObject
Examples:
create_odim_object.cpp, create_polar_volume.cpp, and odimh5scanner.cpp.

Constructor & Destructor Documentation

OdimH5v20::SourceInfo::SourceInfo ( )

Create an empty source information object.

OdimH5v20::SourceInfo::SourceInfo ( const std::string &  value)

Create and inizalize a source information decoding the indicated string.

Parameters
valuea string formatted like "type:value,type:value,..."
Exceptions
OdimH5FormatExceptionThrowed when string format is not valid

Member Function Documentation

void OdimH5v20::SourceInfo::parse ( const std::string  value)

Set object fields decoding the indicated string.

Parameters
valuea string formatted like "type:value,type:value,..."
Exceptions
OdimH5FormatExceptionThrowed when string format is not valid
std::string OdimH5v20::SourceInfo::toString ( ) const

Convert fields into a string formated acording to OdimH5 specifications.

Examples:
odimh5scanner.cpp, read_polar_volume.cpp, read_polar_volume2.cpp, and read_polar_volume_scans.cpp.
SourceInfo& OdimH5v20::SourceInfo::setWMO ( const std::string &  value)

Set WMO value and return a reference to this object.

Examples:
create_polar_volume.cpp.
SourceInfo& OdimH5v20::SourceInfo::setOperaRadarSite ( const std::string &  value)

Set OperaRadarSite value and return a reference to this object.

Examples:
create_polar_volume.cpp.
SourceInfo& OdimH5v20::SourceInfo::setOriginatingCenter ( int  value)

Set OriginatingCenter value and return a reference to this object.

Examples:
create_polar_volume.cpp.
SourceInfo& OdimH5v20::SourceInfo::setPlace ( const std::string &  value)

Set Place value and return a reference to this object.

Examples:
create_odim_object.cpp, and create_polar_volume.cpp.
SourceInfo& OdimH5v20::SourceInfo::setCountry ( int  value)

Set Country value and return a reference to this object.

Examples:
create_odim_object.cpp, and create_polar_volume.cpp.
SourceInfo& OdimH5v20::SourceInfo::setComment ( const std::string &  value)

Set Comment value and return a reference to this object.

Examples:
create_odim_object.cpp, and create_polar_volume.cpp.

Member Data Documentation

std::string OdimH5v20::SourceInfo::WMO

Combined WMO block and station number in the form A1bwnnnnn, or 0 if none assigned.

std::string OdimH5v20::SourceInfo::OperaRadarSite

Radar site as indexed in the OPERA database.

int OdimH5v20::SourceInfo::OriginatingCenter

Originating centre.

std::string OdimH5v20::SourceInfo::Place

Place according to Table 9 of OdimH5 standard.

int OdimH5v20::SourceInfo::Country

Country according to BUFR tables 14 0 1 101.

std::string OdimH5v20::SourceInfo::Comment

Free comment.


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