radarlib 1.4.6
OdimH5v21::Angles Class Reference

Elevation angle. More...

#include <radarlib/odimh5v21_support.hpp>

Public Member Functions

 Angles ()
 Create an object with values set to 0. More...
 
 Angles (double value)
 Create an object set to the value passed. More...
 
 Angles (const std::string &value)
 Create an object set to the value passed. More...
 
void set (double value)
 Set field. More...
 
void parse (const std::string &str)
 Set object fields decoding the indicated string. More...
 
std::string toString () const
 Convert angle to a string formated according to OdimH5 specifications. More...
 
std::string toString (int precision) const
 Convert angles to a string formated according to OdimH5 specifications. More...
 

Static Public Member Functions

static std::vector< AnglesparseSimpleArray (const std::vector< double > &value)
 Create a collection of angles importing a vector of double. More...
 
static std::vector< AnglesparseSequence (const std::string &str)
 Create a collection of angles decoding a string. More...
 
static std::string toString (const std::vector< Angles > &right)
 
static std::string toString (const std::vector< Angles > &right, int precision)
 Convert a collection of azimuth angles to a string formated acording to OdimH5 specifications. More...
 

Public Attributes

double value
 Elevation angle Elevation angles are ordered from lower to upper values. More...
 

Detailed Description

Elevation angle.

This class represent an elevation angle

See also
Horizontal_Product_2D | Angles

Constructor & Destructor Documentation

◆ Angles() [1/3]

OdimH5v21::Angles::Angles ( )

Create an object with values set to 0.

◆ Angles() [2/3]

OdimH5v21::Angles::Angles ( double  value)

Create an object set to the value passed.

Parameters
[in]valuea double value for the elevation angle

◆ Angles() [3/3]

OdimH5v21::Angles::Angles ( const std::string &  value)

Create an object set to the value passed.

Parameters
[in]valuea string value for the elevation angle

Member Function Documentation

◆ set()

void OdimH5v21::Angles::set ( double  value)

Set field.

Parameters
valuevalue for elevation angle

◆ parse()

void OdimH5v21::Angles::parse ( const std::string &  str)

Set object fields decoding the indicated string.

Parameters
stra string formatted like "value"
Exceptions
OdimH5FormatExceptionThrowed when string format is not valid

◆ toString() [1/4]

std::string OdimH5v21::Angles::toString ( ) const

Convert angle to a string formated according to OdimH5 specifications.

◆ toString() [2/4]

std::string OdimH5v21::Angles::toString ( int  precision) const

Convert angles to a string formated according to OdimH5 specifications.

Parameters
precisionprecision to use when converting double values to strings

◆ parseSimpleArray()

std::vector< Angles > OdimH5v21::Angles::parseSimpleArray ( const std::vector< double > &  value)
static

Create a collection of angles importing a vector of double.

Parameters
valuea vector of double to be imported
Exceptions
OdimH5FormatExceptionThrowed when string format is not valid

◆ parseSequence()

std::vector< Angles > OdimH5v21::Angles::parseSequence ( const std::string &  str)
static

Create a collection of angles decoding a string.

Parameters
stra string formatted like "value,value,..."
Exceptions
OdimH5FormatExceptionThrowed when string format is not valid

◆ toString() [3/4]

std::string OdimH5v21::Angles::toString ( const std::vector< Angles > &  right)
static
Parameters
rightthe values to convert Convert a collection of azimuth angles to a string formated according to OdimH5 specifications

◆ toString() [4/4]

std::string OdimH5v21::Angles::toString ( const std::vector< Angles > &  right,
int  precision 
)
static

Convert a collection of azimuth angles to a string formated acording to OdimH5 specifications.

Parameters
rightthe destination string
precisionprecision to use when converting double values to strings

Member Data Documentation

◆ value

double OdimH5v21::Angles::value

Elevation angle Elevation angles are ordered from lower to upper values.


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