Syntalos::StreamOutputPort

Syntalos::StreamOutputPort

Syntalos::StreamOutputPort

Inherits from Syntalos::AbstractStreamPort

Public Functions

Name
StreamOutputPort(AbstractModule * owner, const QString & id, const QString & title, std::shared_ptr< VariantDataStream > stream)
virtual~StreamOutputPort()
boolcanSubscribe(const QString & typeName)
virtual intdataTypeId() const override
virtual QStringdataTypeName() const override
template <typename T >
std::shared_ptr< DataStream< T > >
stream()
std::shared_ptr< VariantDataStream >streamVar()
std::shared_ptr< VariantStreamSubscription >subscribe()
voidsetDormant(bool dormant)
boolisDormant() const
voidstartStream()
voidstopStream()
virtual QStringid() const override
virtual QStringtitle() const override
virtual PortDirectiondirection() const override
virtual AbstractModule *owner() const override

Additional inherited members

Public Functions inherited from Syntalos::AbstractStreamPort

Name
virtual~AbstractStreamPort() =default

Public Functions Documentation

function StreamOutputPort

explicit StreamOutputPort(
    AbstractModule * owner,
    const QString & id,
    const QString & title,
    std::shared_ptr< VariantDataStream > stream
)

function ~StreamOutputPort

virtual ~StreamOutputPort()

function canSubscribe

bool canSubscribe(
    const QString & typeName
)

function dataTypeId

virtual int dataTypeId() const override

Reimplements: Syntalos::AbstractStreamPort::dataTypeId

function dataTypeName

virtual QString dataTypeName() const override

Reimplements: Syntalos::AbstractStreamPort::dataTypeName

function stream

template <typename T >
inline std::shared_ptr< DataStream< T > > stream()

function streamVar

std::shared_ptr< VariantDataStream > streamVar()

function subscribe

std::shared_ptr< VariantStreamSubscription > subscribe()

function setDormant

void setDormant(
    bool dormant
)

Parameters:

  • dormant True if port id disabled.

Explicitly marks this port/stream as dormant. A dormant stream will not, and can not, publish any data.

function isDormant

bool isDormant() const

function startStream

void startStream()

function stopStream

void stopStream()

function id

virtual QString id() const override

Reimplements: Syntalos::AbstractStreamPort::id

function title

virtual QString title() const override

Reimplements: Syntalos::AbstractStreamPort::title

function direction

virtual PortDirection direction() const override

Reimplements: Syntalos::AbstractStreamPort::direction

function owner

virtual AbstractModule * owner() const override

Reimplements: Syntalos::AbstractStreamPort::owner


Updated on 2026-04-24 at 23:36:58 +0000