radarlib 1.4.6
OdimH5v20::AZAngles Class Reference

Azimuth angles pair. More...

#include <radarlib/odimh5v20_support.hpp>

Public Member Functions

 AZAngles ()
 Create an object with start and stop set to 0.
 
 AZAngles (double start, double stop)
 Create a pair and set fields using the values passed.
 
 AZAngles (const std::string &value)
 Create a pair and object fields decoding the indicated string.
 
void set (double start, double stop)
 Set fields.
 
void parse (const std::string &str)
 Set object fields decoding the indicated string.
 
std::string toString () const
 Convert angles to a string formated acording to OdimH5 specifications.
 
std::string toString (int precision) const
 Convert angles to a string formated acording to OdimH5 specifications.
 

Static Public Member Functions

static std::vector< AZAnglesparseSequence (const std::string &str)
 Create a collection of azimuth angles splitting and decoding a string.
 
static std::string toString (const std::vector< AZAngles > &right)
 
static std::string toString (const std::vector< AZAngles > &right, int precision)
 Convert a collection of azimuth angles to a string formated acording to OdimH5 specifications.
 

Public Attributes

double start
 Start azimuth angle.
 
double stop
 Stop azimuth angle.
 

Detailed Description

Azimuth angles pair.

This class represent a ray's start and stop azimuth angles

See also
PolarScan | AZTimes

Constructor & Destructor Documentation

◆ AZAngles() [1/3]

OdimH5v20::AZAngles::AZAngles ( )

Create an object with start and stop set to 0.

◆ AZAngles() [2/3]

OdimH5v20::AZAngles::AZAngles ( double  start,
double  stop 
)

Create a pair and set fields using the values passed.

Parameters
startvalue for start angle
stopvalue for stop angle

◆ AZAngles() [3/3]

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

Create a pair and object fields decoding the indicated string.

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

Member Function Documentation

◆ set()

void OdimH5v20::AZAngles::set ( double  start,
double  stop 
)

Set fields.

Parameters
startvalue for start angle
stopvalue for stop angle

◆ parse()

void OdimH5v20::AZAngles::parse ( const std::string &  str)

Set object fields decoding the indicated string.

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

◆ toString() [1/4]

std::string OdimH5v20::AZAngles::toString ( ) const

Convert angles to a string formated acording to OdimH5 specifications.

◆ toString() [2/4]

std::string OdimH5v20::AZAngles::toString ( int  precision) const

Convert angles to a string formated acording to OdimH5 specifications.

Parameters
precisionprecision to use when converting double values to strings

◆ parseSequence()

std::vector< AZAngles > OdimH5v20::AZAngles::parseSequence ( const std::string &  str)
static

Create a collection of azimuth angles splitting and decoding a string.

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

◆ toString() [3/4]

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

◆ toString() [4/4]

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

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

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

Member Data Documentation

◆ start

double OdimH5v20::AZAngles::start

Start azimuth angle.

Azimuth angles are clock-wise ordered, so start value is lower than stop value

◆ stop

double OdimH5v20::AZAngles::stop

Stop azimuth angle.

Azimuth angles are clock-wise ordered, so stop value is bigger than stat value


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