fast::NewestFrameDataChannel Class Reference

#include <NewestFrameDataChannel.hpp>

Inheritance diagram for fast::NewestFrameDataChannel:

Collaboration diagram for fast::NewestFrameDataChannel:

Public Member Functions
virtual void	addFrame (DataObject::pointer data) override
int	getSize () override
void	setMaximumNumberOfFrames (uint frames) override
void	stop () override
bool	hasCurrentData () override
DataObject::pointer	getFrame () override
Public Member Functions inherited from fast::DataChannel
template<class T = DataObject>
std::shared_ptr< T >	getNextFrame ()
std::shared_ptr< ProcessObject >	getProcessObject () const
void	setProcessObject (std::shared_ptr< ProcessObject > po)
template<>
FAST_EXPORT std::shared_ptr< DataObject >	getNextFrame ()
Public Member Functions inherited from fast::Object
	Object ()
virtual	~Object ()
Reporter &	getReporter ()

Protected Member Functions
DataObject::pointer	getNextDataFrame () override
Protected Member Functions inherited from fast::DataChannel
	DataChannel ()
Protected Member Functions inherited from fast::Object
Reporter &	reportError ()
Reporter &	reportWarning ()
Reporter &	reportInfo ()
ReporterEnd	reportEnd () const

Protected Attributes
std::condition_variable	m_frameConditionVariable
std::shared_ptr< DataObject >	m_frame
Protected Attributes inherited from fast::DataChannel
bool	m_stop
std::mutex	m_mutex
std::shared_ptr< ProcessObject >	m_processObject
Protected Attributes inherited from fast::Object
std::weak_ptr< Object >	mPtr

Additional Inherited Members
Public Types inherited from fast::DataChannel
typedef std::shared_ptr< DataChannel >	pointer
Public Types inherited from fast::Object
typedef std::shared_ptr< Object >	pointer
Static Public Member Functions inherited from fast::Object
static std::string	getStaticNameOfClass ()

Detailed Description

This data channel is used on the output data channels of streamers when streaming mode is NEWEST_FRAME_ONLY

Member Function Documentation

addFrame()

virtual void fast::NewestFrameDataChannel::addFrame ( DataObject::pointer  data )

overridevirtual

Add frame to the data channel

Implements fast::DataChannel.

getFrame()

DataObject::pointer fast::NewestFrameDataChannel::getFrame ( )

overridevirtual

Get current frame, throws if current frame is not available.

Implements fast::DataChannel.

getNextDataFrame()

DataObject::pointer fast::NewestFrameDataChannel::getNextDataFrame ( )

overrideprotectedvirtual

Implements fast::DataChannel.

Reimplemented in fast::StaticDataChannel.

getSize()

int fast::NewestFrameDataChannel::getSize ( )

overridevirtual

Returns

the number of frames stored in this DataChannel

Implements fast::DataChannel.

hasCurrentData()

bool fast::NewestFrameDataChannel::hasCurrentData ( )

overridevirtual

Implements fast::DataChannel.

setMaximumNumberOfFrames()

void fast::NewestFrameDataChannel::setMaximumNumberOfFrames ( uint  frames )

overridevirtual

Set the maximum nr of frames that can be stored in this data channel. Not used in this data channel.

Implements fast::DataChannel.

stop()

void fast::NewestFrameDataChannel::stop ( )

overridevirtual

This will unblock if this DataChannel is currently blocking. Used to stop a pipeline.

Implements fast::DataChannel.

Member Data Documentation

m_frame

std::shared_ptr<DataObject> fast::NewestFrameDataChannel::m_frame

protected

m_frameConditionVariable

std::condition_variable fast::NewestFrameDataChannel::m_frameConditionVariable

protected

---

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

• DataChannels/NewestFrameDataChannel.hpp