optris::ConstFrameIterator Class Reference

Iterates over the frame in a row major fashion and grants read access. More...

#include <FrameIterator.h>

Collaboration diagram for optris::ConstFrameIterator:

Public Types
using	Container = std::vector<unsigned short>
	Container type storing the frame values.

Public Member Functions
OTC_SDK_API	ConstFrameIterator (const Frame &frame) noexcept
	Constructor.
OTC_SDK_API bool	hasNext () const noexcept
	Returns whether there is a next frame value.
OTC_SDK_API void	next ()
	Moves to the next frame value.
OTC_SDK_API unsigned short	getValue () const noexcept
	Returns the current frame value.
OTC_SDK_API int	getIndex () const noexcept
	Returns the index of the current frame value.
OTC_SDK_API int	getX () const noexcept
	Returns the x-coordinate of the current frame value.
OTC_SDK_API int	getY () const noexcept
	Returns the y-coordinate of the current frame value.

Detailed Description

Iterates over the frame in a row major fashion and grants read access.

Constructor & Destructor Documentation

ConstFrameIterator()

OTC_SDK_API optris::ConstFrameIterator::ConstFrameIterator ( const Frame & frame )

explicitnoexcept

Constructor.

Parameters

[in]

frame

to iterate over.

Member Function Documentation

getIndex()

int optris::ConstFrameIterator::getIndex ( ) const

inlinenoexcept

Returns the index of the current frame value.

Returns

index of the current frame value.

getValue()

unsigned short optris::ConstFrameIterator::getValue ( ) const

inlinenoexcept

Returns the current frame value.

Returns

current frame value.

getX()

int optris::ConstFrameIterator::getX ( ) const

inlinenoexcept

Returns the x-coordinate of the current frame value.

Returns

x-coordinate of the current frame value.

getY()

int optris::ConstFrameIterator::getY ( ) const

inlinenoexcept

Returns the y-coordinate of the current frame value.

Returns

y-coordinate of the current frame value.

hasNext()

bool optris::ConstFrameIterator::hasNext ( ) const

inlinenoexcept

Returns whether there is a next frame value.

Returns

true if there is a next frame value. False otherwise.

---

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

• FrameIterator.h