artec::sdk::capturing::IArrayFrame Class Reference

This class represents an array of the IFrame pointers with methods for getting array size as well as getting and setting particular elements by their index in the array. More...

#include <artec/sdk/capturing/IArrayFrame.h>

Inheritance diagram for artec::sdk::capturing::IArrayFrame:

Public Types
typedef IFrame	elementType

Public Member Functions
virtual int	getSize () const =0
	Get number of array elements. More...
virtual const IFrame *	getElement (int index) const =0
	Get frame pointer by its index in the array. More...
virtual ErrorCode	setElement (int index, const IFrame *frame)=0
	Set a new frame object at a certain index in the array. More...
Public Member Functions inherited from artec::sdk::base::IRef
virtual int	addRef () const =0
	Increase object reference counter. More...
virtual int	release () const =0
	Decrease object reference counter. More...

Detailed Description

This class represents an array of the IFrame pointers with methods for getting array size as well as getting and setting particular elements by their index in the array.

Definition at line 35 of file IArrayFrame.h.

Member Typedef Documentation

typedef IFrame artec::sdk::capturing::IArrayFrame::elementType

Definition at line 38 of file IArrayFrame.h.

Member Function Documentation

virtual const IFrame* artec::sdk::capturing::IArrayFrame::getElement ( int  index ) const

pure virtual

Get frame pointer by its index in the array.

Parameters

index

index of the frame to retrieve.

Returns

pointer to the IFrame interface at a particular index in the array.

virtual int artec::sdk::capturing::IArrayFrame::getSize ( ) const

pure virtual

Get number of array elements.

Returns

array size.

virtual ErrorCode artec::sdk::capturing::IArrayFrame::setElement ( int  index, const IFrame *  frame  )

pure virtual

Set a new frame object at a certain index in the array.

Parameters

index	index of the frame to set.
frame	pointer to the frame object that will be stored in this location.

---

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

• artec/sdk/capturing/IArrayFrame.h