Ocean::Media::FrameCollection Class Reference

This class implements a simple buffer holding several frames combined with their timestamps and optional camera calibrations. More...

#include <FrameCollection.h>

Public Member Functions
	FrameCollection ()=default
	Creates an empty frame collection able to hold one frame.
	FrameCollection (FrameCollection &&frameCollection)=default
	Move constructor.
	FrameCollection (const FrameCollection &frameCollection)=default
	Copy constructor.
	FrameCollection (const size_t capacity)
	Creates a new frame collection.
	~FrameCollection ()
	Destructs a frame collection.
size_t	capacity () const
	Returns the capacity of this frame collection object.
FrameRef	recent (SharedAnyCamera *anyCamera=nullptr) const
	Returns the most recent frame.
FrameRef	get (const Timestamp timestamp, SharedAnyCamera *anyCamera=nullptr) const
	Returns the frame with a specific timestamp.
bool	has (const Timestamp timestamp) const
	Returns whether a frame with specific timestamp is currently stored inside the frame collection.
FrameRef	set (const Frame &frame, SharedAnyCamera anyCamera=nullptr)
	Sets a new frame and overwrites the oldest frame.
FrameRef	set (Frame &&frame, SharedAnyCamera anyCamera=nullptr)
	Sets a new frame and overwrites the oldest frame.
bool	setCapacity (const size_t capacity)
	Sets or changes the capacity of this frame collection.
bool	isNull () const
	Returns whether the frame collection is empty.
void	clear ()
	Removes all frames from this frame collection.
	operator bool () const
	Returns whether the frame collection is not empty.
FrameCollection &	operator= (FrameCollection &&frameCollection)=default
	Default move operator.
FrameCollection &	operator= (const FrameCollection &frameCollection)=default
	Default assign operator.

Protected Types
using	FrameCameraPair = std::pair< FrameRef, SharedAnyCamera >
	Definition of a pair combining a frame with a camera profile.
using	RingMap = RingMapT< Timestamp, FrameCameraPair, true, true >
	Definition of a ring map mapping timestamps to frame pairs.

Protected Attributes
RingMap	ringMap_ = RingMap(1)
	The ring map mapping timestamps to frame/camera pairs.

Detailed Description

This class implements a simple buffer holding several frames combined with their timestamps and optional camera calibrations.

Member Typedef Documentation

FrameCameraPair

using Ocean::Media::FrameCollection::FrameCameraPair = std::pair<FrameRef, SharedAnyCamera>

protected

Definition of a pair combining a frame with a camera profile.

RingMap

using Ocean::Media::FrameCollection::RingMap = RingMapT<Timestamp, FrameCameraPair, true , true >

protected

Definition of a ring map mapping timestamps to frame pairs.

Constructor & Destructor Documentation

FrameCollection() [1/4]

Ocean::Media::FrameCollection::FrameCollection ( )

default

Creates an empty frame collection able to hold one frame.

FrameCollection() [2/4]

Ocean::Media::FrameCollection::FrameCollection ( FrameCollection &&  frameCollection )

default

Move constructor.

Parameters

frameCollection

Frame collection to move

FrameCollection() [3/4]

Ocean::Media::FrameCollection::FrameCollection ( const FrameCollection &  frameCollection )

default

Copy constructor.

Parameters

frameCollection

Frame collection to copy

FrameCollection() [4/4]

Ocean::Media::FrameCollection::FrameCollection ( const size_t  capacity )

explicit

Creates a new frame collection.

Parameters

capacity

Number of maximal frames this object can store [1, infinity)

~FrameCollection()

Ocean::Media::FrameCollection::~FrameCollection

(

)

Destructs a frame collection.

Member Function Documentation

capacity()

size_t Ocean::Media::FrameCollection::capacity ( ) const

inline

Returns the capacity of this frame collection object.

Returns

The frame collection object's capacity, with range [0, infinity)

clear()

void Ocean::Media::FrameCollection::clear

(

)

Removes all frames from this frame collection.

The capacity will be kept.

get()

FrameRef Ocean::Media::FrameCollection::get	(	const Timestamp	timestamp,
		SharedAnyCamera *	anyCamera = nullptr
	)		const

Returns the frame with a specific timestamp.

If no frame with the given timestamp exists, the most recent frame will be returned.

Parameters

timestamp	The timestamp of the frame to return
anyCamera	Optional resulting camera if known; nullptr if not of interest

Returns

Frame with the specific timestamp

has()

bool Ocean::Media::FrameCollection::has

(

const Timestamp

timestamp

)

const

Returns whether a frame with specific timestamp is currently stored inside the frame collection.

Parameters

timestamp

The timestamp to be checked

Returns

True, if so

isNull()

bool Ocean::Media::FrameCollection::isNull ( ) const

inline

Returns whether the frame collection is empty.

Returns

True, if so

operator bool()

Ocean::Media::FrameCollection::operator bool ( ) const

inlineexplicit

Returns whether the frame collection is not empty.

Returns

True, if so

operator=() [1/2]

FrameCollection & Ocean::Media::FrameCollection::operator= ( const FrameCollection &  frameCollection )

default

Default assign operator.

Parameters

frameCollection

Frame collection to assign

operator=() [2/2]

FrameCollection & Ocean::Media::FrameCollection::operator= ( FrameCollection &&  frameCollection )

default

Default move operator.

Parameters

frameCollection

Frame collection to move

recent()

FrameRef Ocean::Media::FrameCollection::recent

(

SharedAnyCamera *

anyCamera = nullptr

)

const

Returns the most recent frame.

Parameters

anyCamera

Optional resulting camera if known; nullptr if not of interest

Returns

Most recent frame

set() [1/2]

FrameRef Ocean::Media::FrameCollection::set	(	const Frame &	frame,
		SharedAnyCamera	anyCamera = nullptr
	)

Sets a new frame and overwrites the oldest frame.

Parameters

frame	The frame to set, a copy will be created
anyCamera	Optional camera profile associated with the given frame, nullptr if unknown

Returns

Reference to the stored frame, if succeeded

set() [2/2]

FrameRef Ocean::Media::FrameCollection::set	(	Frame &&	frame,
		SharedAnyCamera	anyCamera = nullptr
	)

Sets a new frame and overwrites the oldest frame.

Parameters

frame	The frame to set
anyCamera	Optional camera profile associated with the given frame, nullptr if unknown

Returns

Reference to the stored frame, if succeeded

setCapacity()

bool Ocean::Media::FrameCollection::setCapacity

(

const size_t

capacity

)

Sets or changes the capacity of this frame collection.

In case the capacity is reduced, the oldest frames will be removed

Parameters

capacity

The capacity to set, with range [1, infinity)

Returns

True, if succeeded

Field Documentation

ringMap_

RingMap Ocean::Media::FrameCollection::ringMap_ = RingMap(1)

protected

The ring map mapping timestamps to frame/camera pairs.

---

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

• FrameCollection.h