ImFusion::SubstreamBase Class Reference

#include <ImFusion/Stream/StreamGroupBase.h>

Non-templated base class for substreams in a StreamGroup. More...

Inheritance diagram for ImFusion::SubstreamBase:

Detailed Description

Non-templated base class for substreams in a StreamGroup.

SubstreamBase provides the common interface for all substream types within a stream group. Substreams are streams that are owned and controlled by a proxy stream, appearing as normal Stream objects within a CompoundData in the data model, which are tightly bound to the proxy stream's lifecycle.

Concrete substream implementations include Substream (template-based) and SubstreamWrapper.

See also

Substream, SubstreamWrapper, StreamGroupBase

Public Member Functions
	SubstreamBase (StreamGroupBase *streamGroup)
	Constructs a substream associated with the owning stream group.
StreamGroupBase *	streamGroup () const
	Returns the stream group this substream belongs to.
virtual Stream *	stream ()=0
	Returns non-owning pointer to the Stream base class representation of this substream.

Protected Attributes
StreamGroupBase *	m_streamGroup = nullptr

Member Function Documentation

streamGroup()

StreamGroupBase * ImFusion::SubstreamBase::streamGroup ( ) const

inline

Returns the stream group this substream belongs to.

Returns

Non-owning pointer to the parent stream group, valid for the lifetime of this substream.

stream()

virtual Stream * ImFusion::SubstreamBase::stream ( )

pure virtual

Returns non-owning pointer to the Stream base class representation of this substream.

Implemented in ImFusion::Substream< BaseStream >, ImFusion::Substream< ImageStream >, ImFusion::Substream< TrackingStream >, and ImFusion::SubstreamWrapper.

---

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

• ImFusion/Stream/StreamGroupBase.h