optris::MeasurementFieldConfig Class Reference

Encapsulates the configuration of a measurement field. More...

#include <MeasurementFieldConfig.h>

Collaboration diagram for optris::MeasurementFieldConfig:

Public Member Functions
OTC_SDK_API	MeasurementFieldConfig () noexcept
	Constructor.
OTC_SDK_API void	validate ()
	Validates the configuration settings.

Public Attributes
std::string	name
	Name of the measurement field.
FieldShape	shape
	Shape of the measurement field.
FieldMode	mode
	Mode for the measurement field.
int	positionX
	x position of the measurement field in pixels.
int	positionY
	y position of the measurement field in pixels.
int	width
	Width of the measurement field in pixels.
int	height
	Height of the measurement field in pixels.
RadiationParameters	radiation
	Radiation parameters for the measurement field.

Detailed Description

Encapsulates the configuration of a measurement field.

Member Function Documentation

validate()

OTC_SDK_API void optris::MeasurementFieldConfig::validate

(

)

Validates the configuration settings.

Exceptions

SDKException

if the configuration contains invalid settings.

Member Data Documentation

height

int optris::MeasurementFieldConfig::height

Height of the measurement field in pixels.

Applicable for the following shapes:

• rectangle

positionX

int optris::MeasurementFieldConfig::positionX

x position of the measurement field in pixels.

Depending of the shape of the field this may refer to different things:

• rectangle: Position of the upper left corner.

positionY

int optris::MeasurementFieldConfig::positionY

y position of the measurement field in pixels.

Depending of the shape of the field this may refer to different things:

• rectangle: Position of the upper left corner.

width

int optris::MeasurementFieldConfig::width

Width of the measurement field in pixels.

Applicable for the following shapes:

• rectangle

---

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

• MeasurementFieldConfig.h