#include <UDUnitsClass.h>
|
| | UDUnits () |
| |
| | ~UDUnits () |
| |
| int | Initialize () |
| |
| bool | IsPressureUnit (std::string unitstr) const |
| |
| bool | IsTimeUnit (std::string unitstr) const |
| |
| bool | IsLatUnit (std::string unitstr) const |
| |
| bool | IsLonUnit (std::string unitstr) const |
| |
| bool | IsLatOrLonUnit (std::string unitstr) const |
| |
| bool | IsLengthUnit (std::string unitstr) const |
| |
| bool | AreUnitsConvertible (const ut_unit *unit, std::string unitstr) const |
| |
| bool | ValidUnit (std::string unitstr) const |
| |
| bool | Convert (const std::string from, const std::string to, const float *src, float *dst, size_t n) const |
| |
| bool | Convert (const std::string from, const std::string to, const double *src, double *dst, size_t n) const |
| |
| void | DecodeTime (double seconds, int *year, int *month, int *day, int *hour, int *minute, int *second) const |
| |
| double | EncodeTime (int year, int month, int day, int hour, int minute, int second) const |
| |
| std::string | GetErrMsg () const |
| |
Provides a C++ wrapper for Unidata's Udunits-2 package: http://www.unidata.ucar.edu/software/udunits/udunits-2/udunits2.html
Error handling: most methods in this class return an integer status flag, with a negative value indicating error. Error messages for the most recent error can be retrieved with GetErrMsg().
Definition at line 28 of file UDUnitsClass.h.
◆ UDUnits()
| VAPoR::UDUnits::UDUnits |
( |
| ) |
|
◆ ~UDUnits()
| VAPoR::UDUnits::~UDUnits |
( |
| ) |
|
◆ AreUnitsConvertible()
| bool VAPoR::UDUnits::AreUnitsConvertible |
( |
const ut_unit * |
unit, |
|
|
std::string |
unitstr |
|
) |
| const |
Return true if the unit identified by the string contained in unitstr can be converted into the unit identified by unit. Otherwise false is returned
◆ Convert() [1/2]
| bool VAPoR::UDUnits::Convert |
( |
const std::string |
from, |
|
|
const std::string |
to, |
|
|
const double * |
src, |
|
|
double * |
dst, |
|
|
size_t |
n |
|
) |
| const |
◆ Convert() [2/2]
| bool VAPoR::UDUnits::Convert |
( |
const std::string |
from, |
|
|
const std::string |
to, |
|
|
const float * |
src, |
|
|
float * |
dst, |
|
|
size_t |
n |
|
) |
| const |
Convert one unit to another
This method performs conversion between different units, when possible (see AreUnitsConvertible()). For example, converting meters to feet. The string from specifies the unit to convert from, and the string to specifies the unit to convert to.
- Parameters
-
| [in] | from | A string specifying the source unit |
| [in] | to | A string specifying the destination unit |
| [in] | src | An array of source unit values |
| [out] | dst | An array large enough to store the converted unit values. |
| [in] | n | The number of elements in from |
- Return values
-
| boolean | A boolean status is returned indicating whether the conversion took place. Conversion will fail if the units are not convertible. No error message is generated. |
- See also
- AreUnitsConvertible
◆ DecodeTime()
| void VAPoR::UDUnits::DecodeTime |
( |
double |
seconds, |
|
|
int * |
year, |
|
|
int * |
month, |
|
|
int * |
day, |
|
|
int * |
hour, |
|
|
int * |
minute, |
|
|
int * |
second |
|
) |
| const |
Decode time specified in seconds to year, month, day, hour, minute and second.
This method uses Udunits-2 ut_decode_time() function to perform time conversion
◆ EncodeTime()
| double VAPoR::UDUnits::EncodeTime |
( |
int |
year, |
|
|
int |
month, |
|
|
int |
day, |
|
|
int |
hour, |
|
|
int |
minute, |
|
|
int |
second |
|
) |
| const |
Encode time specified to years, month, day, hour, minute and seconds to seconds
This method uses Udunits-2 ut_encode_time() function to perform time conversion
◆ GetDatabasePath()
| static std::string VAPoR::UDUnits::GetDatabasePath |
( |
| ) |
|
|
static |
◆ GetErrMsg()
| std::string VAPoR::UDUnits::GetErrMsg |
( |
| ) |
const |
Get the most recent error message
This method returns a string containing the most recently occurring error message, if any.
◆ Initialize()
| int VAPoR::UDUnits::Initialize |
( |
| ) |
|
Initialize the Udunits-2 data base. Must be called after the constructor, prior to any other class methods
- Return values
-
| status | A negative int is returned on failure |
◆ IsLatOrLonUnit()
| bool VAPoR::UDUnits::IsLatOrLonUnit |
( |
std::string |
unitstr | ) |
const |
Return true if the string provided by unitstr is recognized by Udunits-2 as a unit of Longitude or Latitude
◆ IsLatUnit()
| bool VAPoR::UDUnits::IsLatUnit |
( |
std::string |
unitstr | ) |
const |
Return true if the string provided by unitstr is recognized by Udunits-2 as a unit of Latitude
◆ IsLengthUnit()
| bool VAPoR::UDUnits::IsLengthUnit |
( |
std::string |
unitstr | ) |
const |
Return true if the string provided by unitstr is recognized by Udunits-2 as a unit of length
◆ IsLonUnit()
| bool VAPoR::UDUnits::IsLonUnit |
( |
std::string |
unitstr | ) |
const |
Return true if the string provided by unitstr is recognized by Udunits-2 as a unit of Longitude
◆ IsPressureUnit()
| bool VAPoR::UDUnits::IsPressureUnit |
( |
std::string |
unitstr | ) |
const |
Return true if the string provided by unitstr is recognized by Udunits-2 as a unit of pressure
◆ IsTimeUnit()
| bool VAPoR::UDUnits::IsTimeUnit |
( |
std::string |
unitstr | ) |
const |
Return true if the string provided by unitstr is recognized by Udunits-2 as a unit of time
◆ ValidUnit()
| bool VAPoR::UDUnits::ValidUnit |
( |
std::string |
unitstr | ) |
const |
Returns true if the string contained in unitstr is recognized as a valid unit by the Udunits-2 data base
The documentation for this class was generated from the following file:
