ImFusion SDK 4.3
StreamAlgorithmBase Class Referenceabstract

#include <ImFusion/Stream/StreamAlgorithmBase.h>

Interface for algorithms that work on streams. More...

+ Inheritance diagram for StreamAlgorithmBase:

Detailed Description

Interface for algorithms that work on streams.

It is implemented by StreamAlgorithm and StreamIoAlgorithm. To create an algorithm for a stream a user should use CreateStreamAlgorithm or CreateStreamIoAlgorithm.

Public Member Functions

bool isOutputTaken () const
 
virtual Streamstream ()=0
 
virtual DataGroupdataGroup ()
 
virtual OwningDataList takeOutput ()
 Returns an OwningDataList containing the stream and sets m_isOutputTaken to true.
 
- Public Member Functions inherited from SignalReceiver
 SignalReceiver ()=default
 Default constructor.
 
 SignalReceiver (const SignalReceiver &other)
 Copy constructor, does not copy any existing signal connections from other.
 
SignalReceiveroperator= (SignalReceiver rhs)
 Assignment operator, disconnects all existing connections, does not copy any existing signal connections from rhs.
 
virtual ~SignalReceiver ()
 Virtual destructor disconnects from all connected signals.
 

Protected Member Functions

virtual void resetStream ()=0
 Deletes the stream if m_isOutputTaken is false. In any case sets the stream to nullptr.
 
- Protected Member Functions inherited from SignalReceiver
void disconnectAll ()
 Disconnects all existing connections.
 

Protected Attributes

bool m_isOutputTaken = false
 

Member Function Documentation

◆ stream()

virtual Stream * stream ( )
pure virtual

◆ takeOutput()

◆ resetStream()


The documentation for this class was generated from the following file:
Search Tab / S to search, Esc to close