aditof::Frame Class Reference

Frame of a camera. More...

#include <frame.h>

Public Member Functions
SDK_API	Frame ()
	Constructor.
SDK_API	~Frame ()
	Destructor.
SDK_API	Frame (const Frame &op)
	Copy constructor.
SDK_API Frame &	operator= (const Frame &op)
	Copy assignment.
SDK_API	Frame (Frame &&) noexcept
	Move constructor.
SDK_API Frame &	operator= (Frame &&) noexcept
	Move assignment.
SDK_API Status	setDetails (const FrameDetails &details)
	Configures the frame with the given details. More...
SDK_API Status	getDetails (FrameDetails &details) const
	Gets the current details of the frame. 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	getData (const std::string &dataType, uint16_t **dataPtr)
	Gets the address where the specified data is being stored. More...
virtual SDK_API Status	getAvailableAttributes (std::vector< std::string > &attributes) const
	Gets the frames's list of attributes. More...
virtual SDK_API Status	setAttribute (const std::string &attribute, const std::string &value)
	Sets a specific frame attribute. More...
virtual SDK_API Status	getAttribute (const std::string &attribute, std::string &value) const
	Gets the value of a specific frame attribute. More...
virtual SDK_API Status	getMetadataStruct (Metadata &metadata) const
	Extracts the metadata content and returns a struct with values. More...

Detailed Description

Frame of a camera.

Definition at line 50 of file frame.h.

Member Function Documentation

getAttribute()

virtual SDK_API Status aditof::Frame::getAttribute ( const std::string &  attribute, std::string &  value  ) const

virtual

Gets the value of a specific frame attribute.

Parameters

[in]	attribute	- Attribute name
[out]	value	- Attribute value

Returns

Status

getAvailableAttributes()

virtual SDK_API Status aditof::Frame::getAvailableAttributes ( std::vector< std::string > &  attributes ) const

virtual

Gets the frames's list of attributes.

Parameters

[out]

attributes

Returns

Status

getData()

SDK_API 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

getDataDetails()

SDK_API 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

getDetails()

SDK_API Status aditof::Frame::getDetails

(

FrameDetails &

details

)

const

Gets the current details of the frame.

Parameters

[out]

details

Returns

Status

getMetadataStruct()

virtual SDK_API 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

setAttribute()

virtual SDK_API Status aditof::Frame::setAttribute ( const std::string &  attribute, const std::string &  value  )

virtual

Sets a specific frame attribute.

Parameters

[in]	attribute	- Attribute name
[in]	value	- Attribute value

Returns

Status

setDetails()

SDK_API Status aditof::Frame::setDetails

(

const FrameDetails &

details

)

Configures the frame with the given details.

Parameters

details

Returns

Status

---

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

• /home/vsts/work/1/s/sdk/include/aditof/frame.h