optris::OperationInfo Class Reference

Encapsulates information about an operation module within the processing pipeline. More...

#include <OperationInfo.h>

Collaboration diagram for optris::OperationInfo:

Public Member Functions
	OperationInfo () noexcept
	Constructor.
	OperationInfo (int index, int previousIndex, std::string name, float processingTime, short pixelValue) noexcept
	Constructor.
int	getIndex () const noexcept
	Returns the unique index of the module.
int	getPreviousIndex () const noexcept
	Returns the unique index of the module that precedes this module in the processing pipeline.
const std::string &	getName () const noexcept
	Returns the name of the module.
float	getProcessingTime () const noexcept
	Returns the average processing time in ms of the module.
short	getPixelValue () const noexcept
	Returns the processed internal thermal value of a given pixel.

Detailed Description

Encapsulates information about an operation module within the processing pipeline.

Constructor & Destructor Documentation

OperationInfo()

optris::OperationInfo::OperationInfo ( int index, int previousIndex, std::string name, float processingTime, short pixelValue )

inlinenoexcept

Constructor.

Parameters

[in]	index	unique index of the module.
[in]	previousIndex	unique index of the module that precedes this module in the processing pipeline.
[in]	name	of the module.
[in]	processingTime	average processing time in ms.
[in]	pixelValue	processed internal thermal value of a given pixel.

Member Function Documentation

getIndex()

int optris::OperationInfo::getIndex ( ) const

inlinenoexcept

Returns the unique index of the module.

Returns

unique index of the operation module or -1 if an index is not available.

getName()

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

inlinenoexcept

Returns the name of the module.

Returns

name of the module or an empty string if a name is not available.

getPixelValue()

short optris::OperationInfo::getPixelValue ( ) const

inlinenoexcept

Returns the processed internal thermal value of a given pixel.

Returns

processed internal thermal value of a given pixel or minimal short value if no value is available.

getPreviousIndex()

int optris::OperationInfo::getPreviousIndex ( ) const

inlinenoexcept

Returns the unique index of the module that precedes this module in the processing pipeline.

Returns

unique index of the module that precedes this module in the processing pipeline or -1 if an index is not available.

getProcessingTime()

float optris::OperationInfo::getProcessingTime ( ) const

inlinenoexcept

Returns the average processing time in ms of the module.

Returns

processing time in ms of the module.

---

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

• OperationInfo.h