ifm3d::Frame Class Reference

#include <ifm3d/fg/frame.h>

Public Types
using	Ptr = std::shared_ptr< Frame >

Public Member Functions
	Frame (const BufferDataListMap &images, const std::vector< TimePointT > timestamps, uint64_t frame_count)
	Frame (const Frame &t)
Frame &	operator= (const Frame &t)
	Frame (Frame &&t)
Frame &	operator= (Frame &&t)
std::vector< TimePointT >	TimeStamps ()
	Get the timestamps of the frame. More...
bool	HasBuffer (buffer_id id)
	Check if a image with the given id is available in this frame. More...
Buffer &	GetBuffer (buffer_id id, std::optional< size_t > index=std::nullopt)
	Get the image with the given id. More...
size_t	GetBufferCount (buffer_id id)
	Get the total number of image with the given id.
uint32_t	FrameCount ()
	Get the frame count according to algorithm output.
std::vector< buffer_id >	GetBuffers ()
	Get the list of available buffers. More...
decltype(std::declval< std::map< buffer_id, BufferList >>().begin())	begin () noexcept
decltype(std::declval< const std::map< buffer_id, BufferList >>().begin())	begin () const noexcept
decltype(std::declval< std::map< buffer_id, BufferList >>().end())	end () noexcept
decltype(std::declval< const std::map< buffer_id, BufferList >>().end())	end () const noexcept

Detailed Description

Represent a frame of data received from the the device.

Member Function Documentation

GetBuffer()

Buffer& ifm3d::Frame::GetBuffer	(	buffer_id	id,
		std::optional< size_t >	index = std::nullopt
	)

Get the image with the given id.

Parameters

id	the id of the image to get
index	of the image

Returns

Image& Reference to the requested buffer

Exceptions

std::out_of_range

if no image with the give id exists

GetBuffers()

std::vector<buffer_id> ifm3d::Frame::GetBuffers

(

)

Get the list of available buffers.

Parameters

id	the id of the image to get

Returns

the list of available buffer_ids

HasBuffer()

bool ifm3d::Frame::HasBuffer

(

buffer_id

id

)

Check if a image with the given id is available in this frame.

Parameters

id	the id of the image

Returns

true if a image with the give id is available

false if no image with the given id is availale

TimeStamps()

std::vector<TimePointT> ifm3d::Frame::TimeStamps

(

)

Get the timestamps of the frame.

Returns

the timestamps

---

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

• ifm3d/fg/frame.h