sbl::dsp::diagram Namespace Reference

A model's wiring as data, for pictures. More...

Detailed Description

A model's wiring as data, for pictures.

Namespaces
namespace	detail

Classes
struct	Edge
class	Graph
struct	Group
struct	Node
struct	Ports
	The ports a component exposes after describing itself, so an owner can wire them. More...

Enumerations
enum class	Kind : uint8_t {   DelayLine , Loss , Allpass , DcBlock ,   Reflection , Junction , Source , Load ,   Resonator , Bandpass , Gain , Sum ,   Tap , Component }
	What a node is, in the paper's vocabulary. More...
enum class	Wave : uint8_t { Velocity , Force , Signal }
	What travels along an edge. More...
enum class	Depth : uint8_t { Full , Components }

Functions
size_t	render_mermaid (const Graph &g, char *buf, size_t cap, Depth depth=Depth::Full)
	Render the graph as a Mermaid flowchart into a buffer.

Variables
constexpr uint8_t	NO_GROUP = 0xFF
constexpr uint8_t	NO_NODE = 0xFF

Enumeration Type Documentation

Kind

enum class sbl::dsp::diagram::Kind : uint8_t

strong

What a node is, in the paper's vocabulary.

Enumerator
DelayLine	value: length in samples
Loss	value: cutoff in Hz
Allpass	value: delay in samples
DcBlock	value: corner in Hz
Reflection	value: coefficient (−1 wall, +1 free end)
Junction	where waves scatter or a source meets the string
Source	a driving signal (bow velocity, pluck)
Load	a lumped body; value: Hz, value2: Q
Resonator	a modal source; value: Hz, value2: Q
Bandpass	a banded-waveguide band; value: Hz, value2: Q
Gain	value: the factor
Sum	where signals add
Tap	an output
Component	a folded group, made by the renderer

Definition at line 26 of file graph.hpp.

Wave

enum class sbl::dsp::diagram::Wave : uint8_t

strong

What travels along an edge.

Enumerator
Velocity
Force
Signal

Definition at line 44 of file graph.hpp.

Depth

enum class sbl::dsp::diagram::Depth : uint8_t

strong

Enumerator
Full	every node, as the components described them
Components	nested groups folded to one box each

Definition at line 22 of file mermaid.hpp.

Function Documentation

render_mermaid()

size_t sbl::dsp::diagram::render_mermaid ( const Graph &  g, char *  buf, size_t  cap, Depth  depth = Depth::Full  )

inline

Render the graph as a Mermaid flowchart into a buffer.

Returns

characters written (excluding the terminator)

Definition at line 141 of file mermaid.hpp.

References Components, sbl::dsp::diagram::Graph::edge(), sbl::dsp::diagram::Graph::edge_count(), sbl::dsp::diagram::detail::edge_decl(), sbl::dsp::diagram::detail::emit_group(), sbl::dsp::diagram::detail::fold_target(), sbl::dsp::diagram::Edge::from, sbl::dsp::diagram::Node::group, sbl::dsp::diagram::Graph::group(), sbl::dsp::diagram::Graph::group_count(), sbl::dsp::diagram::detail::Out::line(), sbl::dsp::diagram::Graph::MAX_EDGES, NO_GROUP, sbl::dsp::diagram::Graph::node(), sbl::dsp::diagram::Graph::node_count(), sbl::dsp::diagram::detail::node_decl(), sbl::dsp::diagram::Group::parent, sbl::dsp::diagram::Edge::to, and sbl::dsp::diagram::Edge::wave.

Variable Documentation

NO_GROUP

constexpr uint8_t sbl::dsp::diagram::NO_GROUP = 0xFF

constexpr

Definition at line 46 of file graph.hpp.

Referenced by sbl::dsp::diagram::Graph::add_group(), sbl::dsp::diagram::detail::fold_target(), and render_mermaid().

NO_NODE

constexpr uint8_t sbl::dsp::diagram::NO_NODE = 0xFF

constexpr

Definition at line 47 of file graph.hpp.

Referenced by sbl::dsp::diagram::Graph::add_edge(), sbl::dsp::diagram::Graph::add_node(), sbl::dsp::pm::StringBase< Exciter, Load, MaxPeriod >::describe(), and sbl::dsp::diagram::Ports::find().