optris::TemperatureConverter Class Reference

Converts temperatures in °C to and from their internal SDK representation. More...

#include <TemperatureConverter.h>

Collaboration diagram for optris::TemperatureConverter:

Public Member Functions
OTC_SDK_API	TemperatureConverter () noexcept
	Constructor.
OTC_SDK_API	TemperatureConverter (TemperaturePrecision precision) noexcept
	Constructor.
OTC_SDK_API void	setPrecision (TemperaturePrecision precision) noexcept
	Set the temperature precision.
TemperaturePrecision	getPrecision () const noexcept
	Returns the temperature precision.
float	toTemperature (float value) const noexcept
	Converts an internal value to a temperature in °C.
unsigned short	toValue (float temperature) const noexcept
	Converts a temperature in °C to an internal value.
bool	isTemperatureValid (float temperature) noexcept
	Checks if the given temperature in °C is valid.
bool	isValueValid (unsigned short value) noexcept
	Checks if an internal value is valid.

Detailed Description

Converts temperatures in °C to and from their internal SDK representation.

Constructor & Destructor Documentation

TemperatureConverter()

OTC_SDK_API optris::TemperatureConverter::TemperatureConverter ( TemperaturePrecision precision )

noexcept

Constructor.

Parameters

[in]

precision

of the temperature.

Member Function Documentation

getPrecision()

TemperaturePrecision optris::TemperatureConverter::getPrecision ( ) const

inlinenoexcept

Returns the temperature precision.

Returns

temperature precision.

isTemperatureValid()

bool optris::TemperatureConverter::isTemperatureValid ( float temperature )

inlinenoexcept

Checks if the given temperature in °C is valid.

Parameters

[in]

temperature

in °C to check.

Returns

true if the temperature is valid. False otherwise.

isValueValid()

bool optris::TemperatureConverter::isValueValid ( unsigned short value )

inlinenoexcept

Checks if an internal value is valid.

Parameters

[in]

value

to check.

Returns

true if the value is valid. False otherwise.

setPrecision()

OTC_SDK_API void optris::TemperatureConverter::setPrecision ( TemperaturePrecision precision )

noexcept

Set the temperature precision.

Parameters

[in]

precision

to set.

toTemperature()

float optris::TemperatureConverter::toTemperature ( float value ) const

inlinenoexcept

Converts an internal value to a temperature in °C.

Parameters

[in]

value

internal value to convert.

Returns

temperature in °C.

toValue()

unsigned short optris::TemperatureConverter::toValue ( float temperature ) const

inlinenoexcept

Converts a temperature in °C to an internal value.

Parameters

[in]

temperature

in °C to convert.

Returns

internal value.

---

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

• TemperatureConverter.h