Skip to main content

StageEmitter Class

Runtime-owned output handle for stages that stream while on_input() is active. More...

Declaration​

class simaai::neat::graph::StageEmitter { ... }

Included Headers​

#include <StageExecutor.h>

Public Destructor Index​

~StageEmitter ()=default

Public Member Functions Index​

boolemit (StageOutMsg msg)=0

Route one output sample through the same graph paths used for returned StageOutMsgs. More...

boolstop_requested () const =0

True once the graph runtime has begun stopping. More...

Description​

Runtime-owned output handle for stages that stream while on_input() is active.

Most stages can keep appending to the out vector passed to on_input(). Long-running stages may use this emitter to route samples immediately, before on_input() returns.

The pointer supplied through StageExecutor::set_emitter() is owned by the runtime and remains valid until the executor is stopped.

Definition at line 59 of file StageExecutor.h.

Public Destructor​

~StageEmitter()​

virtual simaai::neat::graph::StageEmitter::~StageEmitter ()
virtual default

Definition at line 61 of file StageExecutor.h.

Public Member Functions​

emit()​

virtual bool simaai::neat::graph::StageEmitter::emit (StageOutMsg msg)

Route one output sample through the same graph paths used for returned StageOutMsgs.

Definition at line 64 of file StageExecutor.h.

stop_requested()​

virtual bool simaai::neat::graph::StageEmitter::stop_requested ()

True once the graph runtime has begun stopping.

Definition at line 66 of file StageExecutor.h.


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


Generated via doxygen2docusaurus 2.0.0 by Doxygen 1.9.1.