optris::FieldStatus Class Reference

Encapsulates the status of a processed measurement field. More...

#include <FieldStatus.h>

Collaboration diagram for optris::FieldStatus:

Public Member Functions
OTC_SDK_API	FieldStatus () noexcept
	Constructor.
const std::string &	getName () const noexcept
	Returns the field name.
std::int32_t	getId () const noexcept
	Returns the unique field ID.
std::uint32_t	getIndex () const noexcept
	Returns the field index.
const FieldStats &	getStats () const noexcept
	Returns the results of the statistical analysis of the measurement field.
const RadiationParameters &	getRadiation () const noexcept
	Returns the radiation parameters used to process the measurement field.
RadiationParameterSource	getEmissivitySource () const noexcept
	Returns the source of the emissivity value used to process the measurement field.
RadiationParameterSource	getTransmissivitySource () const noexcept
	Returns the source of the transmissivity value used to process the measurement field.
RadiationParameterSource	getAmbientTemperatureSource () const noexcept
	Returns the source of the ambient temperature value used to process the measurement field.
OTC_SDK_API void	update (std::int32_t id, const FieldStats &stats, const ProcessingParams &params) noexcept
	Sets the field status.

Detailed Description

Encapsulates the status of a processed measurement field.

Member Function Documentation

getAmbientTemperatureSource()

RadiationParameterSource optris::FieldStatus::getAmbientTemperatureSource ( ) const

inlinenoexcept

Returns the source of the ambient temperature value used to process the measurement field.

Returns

source of the ambient temperature value.

getEmissivitySource()

RadiationParameterSource optris::FieldStatus::getEmissivitySource ( ) const

inlinenoexcept

Returns the source of the emissivity value used to process the measurement field.

Returns

source of the emissivity value.

getId()

std::int32_t optris::FieldStatus::getId ( ) const

inlinenoexcept

Returns the unique field ID.

Returns

unique field ID.

getIndex()

std::uint32_t optris::FieldStatus::getIndex ( ) const

inlinenoexcept

Returns the field index.

Returns

field index.

getName()

const std::string & optris::FieldStatus::getName ( ) const

inlinenoexcept

Returns the field name.

Returns

field name.

getRadiation()

const RadiationParameters & optris::FieldStatus::getRadiation ( ) const

inlinenoexcept

Returns the radiation parameters used to process the measurement field.

Returns

radiation parameters used to process the measurement field.

getStats()

const FieldStats & optris::FieldStatus::getStats ( ) const

inlinenoexcept

Returns the results of the statistical analysis of the measurement field.

Returns

field statistics.

getTransmissivitySource()

RadiationParameterSource optris::FieldStatus::getTransmissivitySource ( ) const

inlinenoexcept

Returns the source of the transmissivity value used to process the measurement field.

Returns

source of the transmissivity value.

update()

OTC_SDK_API void optris::FieldStatus::update ( std::int32_t id, const FieldStats & stats, const ProcessingParams & params )

noexcept

Sets the field status.

Parameters

[in]	id	measurement field ID.
[in]	stats	results of the statistical analysis of the measurement field.
[in]	params	processing parameters.

---

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

• FieldStatus.h