Thermal Camera SDK 11.3.0
SDK for Optris Thermal Cameras
Loading...
Searching...
No Matches
optris::MeasurementField Class Referenceabstract

Measurement field or region of interest (ROI) within the thermal frame. More...

#include <MeasurementField.h>

Collaboration diagram for optris::MeasurementField:
Collaboration graph

Public Types

using ConstShared = std::shared_ptr<const MeasurementField>
 Shared pointer type for measurement fields.
 

Public Member Functions

 MeasurementField ()=default
 Constructor.
 
 MeasurementField (MeasurementField &)=delete
 No copy constructor.
 
MeasurementFieldoperator= (MeasurementField &)=delete
 No copy assignment operator.
 
 MeasurementField (MeasurementField &&)=delete
 No move constructor.
 
MeasurementFieldoperator= (MeasurementField &&)=delete
 No move assignment operator.
 
virtual ~MeasurementField ()=default
 Destructor.
 
virtual std::int32_t getId () const noexcept=0
 Returns the unique ID of the measurement field.
 
virtual std::uint32_t getIndex () const noexcept=0
 Returns the index of the measurement field.
 
virtual const std::string & getName () const noexcept=0
 Returns the name of the measurement field.
 
virtual const MeasurementFieldConfiggetConfig () const noexcept=0
 Returns the configuration of the measurement field.
 

Detailed Description

Measurement field or region of interest (ROI) within the thermal frame.

Member Function Documentation

◆ getConfig()

virtual const MeasurementFieldConfig & optris::MeasurementField::getConfig ( ) const
pure virtualnoexcept

Returns the configuration of the measurement field.

Returns
configuration of the measurement field.

◆ getId()

virtual std::int32_t optris::MeasurementField::getId ( ) const
pure virtualnoexcept

Returns the unique ID of the measurement field.

Returns
unique ID of the measurement field.

◆ getIndex()

virtual std::uint32_t optris::MeasurementField::getIndex ( ) const
pure virtualnoexcept

Returns the index of the measurement field.

The index determines the order in which measurement fields are rendered on top of each other. Fields with a higher index are rendered on top of fields with a lower index. The thermal frame will always be in the background.

Returns
index of the measurement field.

◆ getName()

virtual const std::string & optris::MeasurementField::getName ( ) const
pure virtualnoexcept

Returns the name of the measurement field.

Returns
name of the measurement field.

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