#include <samplestream_intf.h>

Inherits adtf::ucom::ant::IObject.

Inherited by adtf::streaming::sample_stream<>, adtf::streaming::sample_stream< IStreamingPort, IStreamingInPort, ISampleStreamInPort >, adtf::streaming::sample_stream< IStreamingPort, IStreamingOutPort, ISampleStreamOutPort >, and adtf::streaming::sample_stream< INTERFACES >.

Public Member Functions
	ADTF_IID (IBlockableSampleStream, "blockable_samplestream.vision.streaming.adtf.iid")
	definition of interface identifier

virtual void	BlockSampleStreaming (bool bBlock)=0

virtual bool	IsSampleStreamingBlocked () const =0

Public Member Functions inherited from adtf::ucom::ant::IObject
	ADTF_IID (IObject, "object.ant.ucom.adtf.iid")

Protected Member Functions
virtual	~IBlockableSampleStream ()=default

Protected Member Functions inherited from adtf::ucom::ant::IObject
	~IObject ()=default
	Protected destructor --> Only the final implementation can be destroyed!

Detailed Description

Extension interface for sample stream that support blocking of sample streaming. If sample streaming is blocked all samples and there corresponding triggers are dropped and not forwarded. This will not effect stream type updates and they will still forwarded to the connected readers.

Constructor & Destructor Documentation

◆ ~IBlockableSampleStream()

virtual adtf::streaming::vision::IBlockableSampleStream::~IBlockableSampleStream ( )

protectedvirtualdefault

DTOR.

Member Function Documentation

◆ BlockSampleStreaming()

virtual void adtf::streaming::vision::IBlockableSampleStream::BlockSampleStreaming ( bool bBlock )

pure virtual

Blocks the streaming of samples if bBlock is set to true.

Parameters

[in] bBlock false: Samples and corresponding triggers will be forwarded. true: Samples and corresponding triggers will not be forwarded and dropped, only stream types and their triggers are forwarded.

Implemented in adtf::streaming::sample_stream< INTERFACES >, adtf::streaming::sample_stream< IStreamingPort, IStreamingInPort, ISampleStreamInPort >, adtf::streaming::sample_stream< IStreamingPort, IStreamingOutPort, ISampleStreamOutPort >, and adtf::streaming::sample_stream<>.

◆ IsSampleStreamingBlocked()

virtual bool adtf::streaming::vision::IBlockableSampleStream::IsSampleStreamingBlocked ( ) const

pure virtual

Indicates wether sample streaming is blocked or not.

Return values

true	sample stream is blocking samples and their corresponding triggers.
false	sample stream is not blocked.