Syntalos::SyntalosLink

Syntalos::SyntalosLink

Syntalos::SyntalosLink

Connection to a Syntalos instance.

#include <syntaloslink.h>

Inherits from QObject

Public Functions

Name
~SyntalosLink()
QStringinstanceId() const
voidraiseError(const QString & message)
voidraiseError(const QString & title, const QString & message)
voidsetLoadScriptCallback(LoadScriptFn callback)
voidsetPrepareStartCallback(PrepareStartFn callback)
voidsetStartCallback(StartFn callback)
voidsetStopCallback(StopFn callback)
voidsetShutdownCallback(ShutdownFn callback)
SyncTimer *timer() const
voidawaitData(int timeoutUsec =-1)
voidawaitDataForever()
ModuleStatestate() const
voidsetState(ModuleState state)
voidsetStatusMessage(const QString & message)
intmaxRealtimePriority() const
voidsetSettingsData(const QByteArray & data)
voidsetShowSettingsCallback(ShowSettingsFn callback)
voidsetShowDisplayCallback(ShowDisplayFn callback)
std::vector< std::shared_ptr< InputPortInfo > >inputPorts() const
std::vector< std::shared_ptr< OutputPortInfo > >outputPorts() const
std::shared_ptr< InputPortInfo >registerInputPort(const QString & id, const QString & title, const QString & dataTypeName)
std::shared_ptr< OutputPortInfo >registerOutputPort(const QString & id, const QString & title, const QString & dataTypeName, const QVariantHash & metadata =QVariantHash())
voidupdateOutputPort(const std::shared_ptr< OutputPortInfo > & oport)
voidupdateInputPort(const std::shared_ptr< InputPortInfo > & iport)
boolsubmitOutput(const std::shared_ptr< OutputPortInfo > & oport, const BaseDataType & data)

Friends

Name
std::unique_ptr< SyntalosLink >initSyntalosModuleLink()

Public Functions Documentation

function ~SyntalosLink

~SyntalosLink()

function instanceId

QString instanceId() const

function raiseError

void raiseError(
    const QString & message
)

function raiseError

void raiseError(
    const QString & title,
    const QString & message
)

function setLoadScriptCallback

void setLoadScriptCallback(
    LoadScriptFn callback
)

function setPrepareStartCallback

void setPrepareStartCallback(
    PrepareStartFn callback
)

function setStartCallback

void setStartCallback(
    StartFn callback
)

function setStopCallback

void setStopCallback(
    StopFn callback
)

function setShutdownCallback

void setShutdownCallback(
    ShutdownFn callback
)

function timer

SyncTimer * timer() const

function awaitData

void awaitData(
    int timeoutUsec =-1
)

function awaitDataForever

void awaitDataForever()

function state

ModuleState state() const

function setState

void setState(
    ModuleState state
)

function setStatusMessage

void setStatusMessage(
    const QString & message
)

function maxRealtimePriority

int maxRealtimePriority() const

function setSettingsData

void setSettingsData(
    const QByteArray & data
)

function setShowSettingsCallback

void setShowSettingsCallback(
    ShowSettingsFn callback
)

function setShowDisplayCallback

void setShowDisplayCallback(
    ShowDisplayFn callback
)

function inputPorts

std::vector< std::shared_ptr< InputPortInfo > > inputPorts() const

function outputPorts

std::vector< std::shared_ptr< OutputPortInfo > > outputPorts() const

function registerInputPort

std::shared_ptr< InputPortInfo > registerInputPort(
    const QString & id,
    const QString & title,
    const QString & dataTypeName
)

function registerOutputPort

std::shared_ptr< OutputPortInfo > registerOutputPort(
    const QString & id,
    const QString & title,
    const QString & dataTypeName,
    const QVariantHash & metadata =QVariantHash()
)

function updateOutputPort

void updateOutputPort(
    const std::shared_ptr< OutputPortInfo > & oport
)

function updateInputPort

void updateInputPort(
    const std::shared_ptr< InputPortInfo > & iport
)

function submitOutput

bool submitOutput(
    const std::shared_ptr< OutputPortInfo > & oport,
    const BaseDataType & data
)

Friends

friend initSyntalosModuleLink

friend std::unique_ptr< SyntalosLink > initSyntalosModuleLink();

Updated on 2024-09-05 at 17:39:59 +0000