aditof::Frame Class Reference

Frame of a camera. More...

#include <frame.h>

Public Member Functions
SDK_API	Frame ()
	Constructor. More...
SDK_API	Frame (const Frame &op)
	Copy constructor. More...
SDK_API	Frame (Frame &&) noexcept
	Move constructor. More...
SDK_API Status	getData (const std::string &dataType, uint16_t **dataPtr)
	Gets the address where the specified data is being stored. More...
SDK_API Status	getDataDetails (const std::string &dataType, FrameDataDetails &details) const
	Gets details of a type of data within the frame. More...
SDK_API Status	getDetails (FrameDetails &details) const
	Gets the current details of the frame. More...
virtual SDK_API Status	getMetadataStruct (Metadata &metadata) const
	Extracts the metadata content and returns a struct with values. More...
SDK_API Frame &	operator= (const Frame &op)
	Copy assignment. More...
SDK_API Frame &	operator= (Frame &&) noexcept
	Move assignment. More...
SDK_API Status	setDetails (const FrameDetails &details)
	Configures the frame with the given details. More...
SDK_API	~Frame ()
	Destructor. More...

Private Attributes
std::unique_ptr< FrameImpl >	m_impl

Detailed Description

Frame of a camera.

Definition at line 50 of file frame.h.

Constructor & Destructor Documentation

Frame() [1/3]

aditof::Frame::Frame

(

)

Constructor.

Definition at line 39 of file frame.cpp.

~Frame()

aditof::Frame::~Frame ( )

default

Destructor.

Frame() [2/3]

aditof::Frame::Frame

(

const Frame &

op

)

Copy constructor.

Definition at line 47 of file frame.cpp.

Frame() [3/3]

aditof::Frame::Frame ( Frame &&  )

defaultnoexcept

Move constructor.

Member Function Documentation

getData()

Status aditof::Frame::getData	(	const std::string &	dataType,
		uint16_t **	dataPtr
	)

Gets the address where the specified data is being stored.

Parameters

	dataType
[out]	dataPtr

Returns

Status

Definition at line 70 of file frame.cpp.

getDataDetails()

Status aditof::Frame::getDataDetails	(	const std::string &	dataType,
		FrameDataDetails &	details
	)		const

Gets details of a type of data within the frame.

Parameters

	dataType
[out]	details

Returns

Status

Definition at line 65 of file frame.cpp.

getDetails()

Status aditof::Frame::getDetails

(

FrameDetails &

details

)

const

Gets the current details of the frame.

Parameters

[out]

details

Returns

Status

Definition at line 61 of file frame.cpp.

getMetadataStruct()

Status aditof::Frame::getMetadataStruct ( Metadata &  metadata ) const

virtual

Extracts the metadata content and returns a struct with values.

Parameters

[out]

metadata

- struct containing all metadata fields

Returns

Status

Definition at line 74 of file frame.cpp.

operator=() [1/2]

Frame & aditof::Frame::operator=

(

const Frame &

op

)

Copy assignment.

Definition at line 50 of file frame.cpp.

operator=() [2/2]

Frame & aditof::Frame::operator= ( Frame &&  )

defaultnoexcept

Move assignment.

setDetails()

Status aditof::Frame::setDetails

(

const FrameDetails &

details

)

Configures the frame with the given details.

Parameters

details

Returns

Status

Definition at line 57 of file frame.cpp.

Member Data Documentation

m_impl

std::unique_ptr<FrameImpl> aditof::Frame::m_impl

private

Definition at line 121 of file frame.h.

---

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

• frame.h
• frame.cpp