radarlib  1.4.4
OdimH5v21::AZAngles Class Reference

Azimuth angles pair. More...

#include <radarlib/odimh5v21_support.hpp>

Public Member Functions

 AZAngles ()
 Create an object with start and stop set to 0. More...
 
 AZAngles (double start, double stop)
 Create a pair and set fields using the values passed. More...
 
 AZAngles (const std::string &value)
 Create a pair and object fields decoding the indicated string. More...
 
void set (double start, double stop)
 Set fields. More...
 
void parse (const std::string &str)
 Set object fields decoding the indicated string. More...
 
std::string toString () const
 Convert angles to a string formated acording to OdimH5 specifications. More...
 
std::string toString (int precision) const
 Convert angles to a string formated acording to OdimH5 specifications. More...
 
double averagedAngle (int direction=0)
 Compute the averarged angle between start and stop tacking into account direction of antenna movement. (if not passed it is sassumed CW) More...
 

Static Public Member Functions

static std::vector< AZAnglesparseSequence (const std::string &str)
 Create a collection of azimuth angles splitting and decoding a string. More...
 
static std::vector< AZAnglesparseSimpleArrays (const std::vector< double > &first, const std::vector< double > &second)
 Create a collection of azimuth angles importing two vector of double. More...
 
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 according to OdimH5 specifications. More...
 

Public Attributes

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

Detailed Description

Azimuth angles pair.

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

See Also
PolarScan | AZTimes

Constructor & Destructor Documentation

OdimH5v21::AZAngles::AZAngles ( )

Create an object with start and stop set to 0.

OdimH5v21::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
OdimH5v21::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

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

Set fields.

Parameters
startvalue for start angle
stopvalue for stop angle
void OdimH5v21::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
std::string OdimH5v21::AZAngles::toString ( ) const

Convert angles to a string formated acording to OdimH5 specifications.

std::string OdimH5v21::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
std::vector< AZAngles > OdimH5v21::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
std::vector< AZAngles > OdimH5v21::AZAngles::parseSimpleArrays ( const std::vector< double > &  first,
const std::vector< double > &  second 
)
static

Create a collection of azimuth angles importing two vector of double.

Parameters
firsta vector of double
seconda vector of double
Exceptions
OdimH5FormatExceptionThrowed when string format is not valid
std::string OdimH5v21::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
std::string OdimH5v21::AZAngles::toString ( const std::vector< AZAngles > &  right,
int  precision 
)
static

Convert a collection of azimuth angles to a string formated according 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
double OdimH5v21::AZAngles::averagedAngle ( int  direction = 0)

Compute the averarged angle between start and stop tacking into account direction of antenna movement. (if not passed it is sassumed CW)

Parameters
directionsign of antenna speed rotation

Member Data Documentation

double OdimH5v21::AZAngles::start

Start azimuth angle.

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

double OdimH5v21::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: