radarlib 1.4.6
OdimH5v20::AZTimes Class Reference

Azimuth angles pair. More...

#include <radarlib/odimh5v20_support.hpp>

Public Member Functions

 AZTimes ()
 Create an object with start and stop set to 0.
 
 AZTimes (double start, double stop)
 Create a pair and set fields decoding the indicated string.
 
 AZTimes (const std::string &str)
 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 The string must be formated acording to OdimH5 specifications.
 
std::string toString () const
 Convert times to a string formated acording to OdimH5 specifications.
 

Static Public Member Functions

static std::vector< AZTimesparseSequence (const std::string &str)
 Create a collection of azimuth times splitting and decoding a string.
 
static std::string toString (const std::vector< AZTimes > &right)
 Convert a collection of azimuth timesto a string formated acording to OdimH5 specifications.
 

Public Attributes

double start
 Start azimuth time (seconds.milliseconds)
 
double stop
 Start azimuth time (seconds.milliseconds)
 

Detailed Description

Azimuth angles pair.

This class represent a ray's start and stop azimuth times expressed as 'secconds.milliseconds' from 1970

See also
PolarScan | AZAngles
Examples
read_attributes.cpp, and write_attributes.cpp.

Constructor & Destructor Documentation

◆ AZTimes() [1/3]

OdimH5v20::AZTimes::AZTimes ( )

Create an object with start and stop set to 0.

◆ AZTimes() [2/3]

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

Create a pair and set fields decoding the indicated string.

Parameters
startvalue for start time
stopvalue for stop time

◆ AZTimes() [3/3]

OdimH5v20::AZTimes::AZTimes ( const std::string & str)

Create a pair and object fields decoding the indicated string.

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

Member Function Documentation

◆ set()

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

Set fields.

Parameters
startvalue for start time
stopvalue for stop time

◆ parse()

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

Set object fields decoding the indicated string The string must be formated acording to OdimH5 specifications.

Parameters
strthe string to parse
Exceptions
OdimH5FormatExceptionThrowed when string format is not valid

◆ toString() [1/2]

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

Convert times to a string formated acording to OdimH5 specifications.

◆ parseSequence()

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

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

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

◆ toString() [2/2]

std::string OdimH5v20::AZTimes::toString ( const std::vector< AZTimes > & right)
static

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

Member Data Documentation

◆ start

double OdimH5v20::AZTimes::start

Start azimuth time (seconds.milliseconds)

Azimuth start time is always lower than stop time

Examples
write_attributes.cpp.

◆ stop

double OdimH5v20::AZTimes::stop

Start azimuth time (seconds.milliseconds)

Azimuth stop time is always bigger than start time

Examples
write_attributes.cpp.

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