Skip to main content

FanOut Class

Stage executor that duplicates each incoming sample to multiple output ports. More...

Declaration

class simaai::neat::graph::nodes::FanOut { ... }

Included Headers

#include <FanOut.h>

Base class

classStageExecutor

Actor-style executor base class — implement to add a new runtime-graph stage. More...

Public Constructors Index

FanOut (FanOutOptions opt)

Construct a FanOut from the given options. More...

Public Member Functions Index

voidset_ports (const StagePorts &ports) override

Bind the executor to its runtime ports; resolves output PortIds. More...

voidon_input (StageMsg &&msg, std::vector< StageOutMsg > &out) override

Replicate the incoming message onto each configured output port. More...

Private Member Functions Index

voidvalidate_outputs_ (const StagePorts &ports)

Private Member Attributes Index

FanOutOptionsopt_
std::vector< PortId >out_ports_
boolvalidated_ = false

Description

Stage executor that duplicates each incoming sample to multiple output ports.

Receives a sample on its single input port and emits a copy on every output port listed in FanOutOptions::outputs. Used to fan a single stream out to multiple downstream consumers in the runtime graph.

See Also

FanOutNode

See Also

StageExecutor

Definition at line 40 of file FanOut.h.

Public Constructors

FanOut()

simaai::neat::graph::nodes::FanOut::FanOut (FanOutOptions opt)
explicit

Construct a FanOut from the given options.

Definition at line 43 of file FanOut.h.

Public Member Functions

on_input()

void simaai::neat::graph::nodes::FanOut::on_input (StageMsg && msg, std::vector< StageOutMsg > & out)
virtual

Replicate the incoming message onto each configured output port.

Definition at line 48 of file FanOut.h.

set_ports()

void simaai::neat::graph::nodes::FanOut::set_ports (const StagePorts & ports)
virtual

Bind the executor to its runtime ports; resolves output PortIds.

Definition at line 46 of file FanOut.h.

Private Member Functions

validate_outputs_()

void simaai::neat::graph::nodes::FanOut::validate_outputs_ (const StagePorts & ports)

Definition at line 51 of file FanOut.h.

Private Member Attributes

opt_

FanOutOptions simaai::neat::graph::nodes::FanOut::opt_

Definition at line 53 of file FanOut.h.

53 FanOutOptions opt_;

out_ports_

std::vector<PortId> simaai::neat::graph::nodes::FanOut::out_ports_

Definition at line 54 of file FanOut.h.

54 std::vector<PortId> out_ports_;

validated_

bool simaai::neat::graph::nodes::FanOut::validated_ = false

Definition at line 55 of file FanOut.h.

55 bool validated_ = false;

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


Generated via doxygen2docusaurus 2.0.0 by Doxygen 1.9.8.