ADTF
Loading...
Searching...
No Matches
adtf::streaming::IBlockableSampleStream Class Referenceabstract

#include <samplestream_intf.h>

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

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]bBlockfalse: 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.

◆ IsSampleStreamingBlocked()

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

Indicates wether sample streaming is blocked or not.

Return values
truesample stream is blocking samples and their corresponding triggers.
falsesample stream is not blocked.

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