optris::OperationMode Class Reference

Defines the interface for classes realizing operation modes. More...

#include <OperationMode.h>

Collaboration diagram for optris::OperationMode:

Public Member Functions
	OperationMode ()=default
	Constructor.
	OperationMode (const OperationMode &)=delete
	No copy constructor.
OperationMode &	operator= (const OperationMode &)=delete
	No copy assignment.
	OperationMode (OperationMode &&)=delete
	No move constructor.
OperationMode &	operator= (OperationMode &&)=delete
	No move assignment.
virtual	~OperationMode ()=default
	Destructor.
virtual int	getIndex () const noexcept=0
	Returns the index of the mode.
virtual int	getFieldOfView () const noexcept=0
	Returns the field of view in degrees of the optics.
virtual std::string	getOpticsText () const noexcept=0
	Returns an optional string that further specifies the optics.
virtual int	getOpticsSerialNumber () const noexcept=0
	Returns the serial number of the optics.
virtual float	getTemperatureLowerLimit () const noexcept=0
	Returns the lower limit temperature in °C.
virtual float	getTemperatureUpperLimit () const noexcept=0
	Returns the upper limit temperature in °C.
virtual float	getTemperatureNormalLowerLimit () const noexcept=0
	Returns the lower non-extended limit temperature in °C.
virtual float	getTemperatureNormalUpperLimit () const noexcept=0
	Returns the upper non-extended limit temperature in °C.
virtual float	getTemperatureExtendedLowerLimit () const noexcept=0
	Returns the lower extended limit temperature in °C.
virtual float	getTemperatureExtendedUpperLimit () const noexcept=0
	Returns the upper extended limit temperature in °C.
virtual bool	isTemperatureRangeExtended () const noexcept=0
	Returns whether the temperature range is currently extended.
virtual bool	isTemperatureRangeExtendable () const noexcept=0
	Returns whether the temperature range can be extended.
virtual bool	isTemperatureHighPrecision () const noexcept=0
	Returns whether the temperatures were measured with high precision.
virtual bool	isTemperatureHighPrecisionAvailable () const noexcept=0
	Returns whether measurements with high precision are available for the temperature range.
virtual int	getFrameWidth () const noexcept=0
	Returns the width of the frame in pixels.
virtual int	getFrameHeight () const noexcept=0
	Returns the height of the frame in pixels.
virtual int	getFramerate () const noexcept=0
	Returns the framerate in Hz (not sub-sampled).
virtual std::string	toString () const noexcept=0
	Returns a string representation of the operation mode.

Detailed Description

Defines the interface for classes realizing operation modes.

Each operation mode encapsulates a valid combination of the following configuration settings:

• Optics
• Temperature range
• Output video format

The available operation modes depend on the device, its optics, its calibrations, the video format definitions and the type of connection to the device (USB, Ethernet).

Member Function Documentation

getFieldOfView()

virtual int optris::OperationMode::getFieldOfView ( ) const

pure virtualnoexcept

Returns the field of view in degrees of the optics.

Returns

field of view in degrees of the optics.

getFrameHeight()

virtual int optris::OperationMode::getFrameHeight ( ) const

pure virtualnoexcept

Returns the height of the frame in pixels.

Returns

height of the frame in pixels.

getFramerate()

virtual int optris::OperationMode::getFramerate ( ) const

pure virtualnoexcept

Returns the framerate in Hz (not sub-sampled).

Returns

framerate in Hz (not sub-sampled).

getFrameWidth()

virtual int optris::OperationMode::getFrameWidth ( ) const

pure virtualnoexcept

Returns the width of the frame in pixels.

Returns

width of the frame in pixels.

getIndex()

virtual int optris::OperationMode::getIndex ( ) const

pure virtualnoexcept

Returns the index of the mode.

Convenience method to easily locate the mode within the container returned by IRImager::getOperationModes().

Returns

index of the mode.

See also

IRImager::getOperationModes()

getOpticsSerialNumber()

virtual int optris::OperationMode::getOpticsSerialNumber ( ) const

pure virtualnoexcept

Returns the serial number of the optics.

Returns

serial number of the optics.

getOpticsText()

virtual std::string optris::OperationMode::getOpticsText ( ) const

pure virtualnoexcept

Returns an optional string that further specifies the optics.

Returns

optional string that further specifies the optics.

getTemperatureExtendedLowerLimit()

virtual float optris::OperationMode::getTemperatureExtendedLowerLimit ( ) const

pure virtualnoexcept

Returns the lower extended limit temperature in °C.

The extended limit will equal the non-extended one, if the temperature range is not extendable.

Returns

lower extended limit temperature in °C.

getTemperatureExtendedUpperLimit()

virtual float optris::OperationMode::getTemperatureExtendedUpperLimit ( ) const

pure virtualnoexcept

Returns the upper extended limit temperature in °C.

The extended limit will equal the non-extended one, if the temperature range is not extendable.

Returns

upper extended limit temperature in °C.

getTemperatureLowerLimit()

virtual float optris::OperationMode::getTemperatureLowerLimit ( ) const

pure virtualnoexcept

Returns the lower limit temperature in °C.

Note

The returned temperature may vary depended on whether the temperature range is extended.

Returns

lower limit temperature in °C.

See also

OperationMode::isTemperatureRangeExtended()

getTemperatureNormalLowerLimit()

virtual float optris::OperationMode::getTemperatureNormalLowerLimit ( ) const

pure virtualnoexcept

Returns the lower non-extended limit temperature in °C.

Returns

lower non-extended limit temperature in °C.

getTemperatureNormalUpperLimit()

virtual float optris::OperationMode::getTemperatureNormalUpperLimit ( ) const

pure virtualnoexcept

Returns the upper non-extended limit temperature in °C.

Returns

upper non-extended limit temperature in °C.

getTemperatureUpperLimit()

virtual float optris::OperationMode::getTemperatureUpperLimit ( ) const

pure virtualnoexcept

Returns the upper limit temperature in °C.

Note

The returned temperature may vary depended on whether the temperature range is extended.

Returns

upper limit temperature in °C.

See also

OperationMode::isTemperatureRangeExtended()

isTemperatureHighPrecision()

virtual bool optris::OperationMode::isTemperatureHighPrecision ( ) const

pure virtualnoexcept

Returns whether the temperatures were measured with high precision.

The return value depends on whether the temperature range actually feature high precision measurements and whether high precision is enabled.

Returns

true if the temperatures were measured with high precision. False if the standard precision was used.

See also

OperationMode::isTemperatureHighPrecisionAvailable(), IRImager::isTemperatureHighPrecisionEnabled()

isTemperatureHighPrecisionAvailable()

virtual bool optris::OperationMode::isTemperatureHighPrecisionAvailable ( ) const

pure virtualnoexcept

Returns whether measurements with high precision are available for the temperature range.

Note

Not all temperature ranges on all devices feature high precision temperature measurements.

Returns

true, if measurements with high precision are available for the temperature range. False, otherwise.

isTemperatureRangeExtendable()

virtual bool optris::OperationMode::isTemperatureRangeExtendable ( ) const

pure virtualnoexcept

Returns whether the temperature range can be extended.

Note

Not all temperature ranges can be extended.

Returns

true, if the temperature range can be extended. False, otherwise.

isTemperatureRangeExtended()

virtual bool optris::OperationMode::isTemperatureRangeExtended ( ) const

pure virtualnoexcept

Returns whether the temperature range is currently extended.

The return value depends on whether the temperature range can actually be extended and whether temperature range extension is enabled.

Returns

true, if the temperature range is currently extended. False, otherwise.

See also

OperationMode::isTemperatureRangeExtendable(), IRImager::isTemperatureRangeExtensionEnabled()

toString()

virtual std::string optris::OperationMode::toString ( ) const

pure virtualnoexcept

Returns a string representation of the operation mode.

Returns

string representation of the operation mode.

---

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

• OperationMode.h