sbl::dsp::diagram::Graph Class Reference

Detailed Description

Definition at line 68 of file graph.hpp.

#include <graph.hpp>

Public Member Functions
uint8_t	add_group (const char *name, uint8_t parent=NO_GROUP)
	Open a group (a component); returns its id. Nodes added with it belong to it.
uint8_t	add_node (Kind kind, const char *name, uint8_t group, float value=0.0f, float value2=0.0f)
void	add_edge (uint8_t from, uint8_t to, Wave wave)
uint8_t	node_count () const
uint8_t	edge_count () const
uint8_t	group_count () const
const Node &	node (uint8_t i) const
const Edge &	edge (uint8_t i) const
const Group &	group (uint8_t i) const
uint8_t	count (Kind kind) const
	How many nodes of a kind the graph holds — the structural tests' question.
bool	overflowed () const
	True if a describe() lost something: a node, edge or group was refused.
void	clear ()

Static Public Attributes
static constexpr uint8_t	MAX_NODES = 64
	a 32-mode bank and the string around it
static constexpr uint8_t	MAX_EDGES = 128
static constexpr uint8_t	MAX_GROUPS = 16

Member Function Documentation

add_group()

uint8_t sbl::dsp::diagram::Graph::add_group ( const char *  name, uint8_t  parent = NO_GROUP  )

inline

Open a group (a component); returns its id. Nodes added with it belong to it.

Definition at line 75 of file graph.hpp.

References MAX_GROUPS, and sbl::dsp::diagram::NO_GROUP.

Referenced by sbl::dsp::pm::StringBase< Exciter, Load, MaxPeriod >::describe(), sbl::dsp::pm::LoadJunction< Load >::describe(), sbl::dsp::pm::ModalResonator< MaxModes >::describe(), and sbl::dsp::pm::StringLoop::describe().

add_node()

uint8_t sbl::dsp::diagram::Graph::add_node ( Kind  kind, const char *  name, uint8_t  group, float  value = 0.0f, float  value2 = 0.0f  )

inline

Definition at line 81 of file graph.hpp.

References group(), MAX_NODES, and sbl::dsp::diagram::NO_NODE.

Referenced by sbl::dsp::pm::StringBase< Exciter, Load, MaxPeriod >::describe(), sbl::dsp::pm::ThermalFriction::describe(), sbl::dsp::pm::TableFriction::describe(), sbl::dsp::pm::Bow< Law >::describe(), sbl::dsp::pm::MassSpringDamper::describe(), sbl::dsp::pm::LoadJunction< Load >::describe(), sbl::dsp::pm::ModalResonator< MaxModes >::describe(), and sbl::dsp::pm::StringLoop::describe().

add_edge()

void sbl::dsp::diagram::Graph::add_edge ( uint8_t  from, uint8_t  to, Wave  wave  )

inline

Definition at line 88 of file graph.hpp.

References MAX_EDGES, and sbl::dsp::diagram::NO_NODE.

Referenced by sbl::dsp::pm::StringBase< Exciter, Load, MaxPeriod >::describe(), sbl::dsp::pm::Bow< Law >::describe(), sbl::dsp::pm::LoadJunction< Load >::describe(), sbl::dsp::pm::ModalResonator< MaxModes >::describe(), and sbl::dsp::pm::StringLoop::describe().

node_count()

uint8_t sbl::dsp::diagram::Graph::node_count ( ) const

inline

Definition at line 93 of file graph.hpp.

Referenced by sbl::dsp::diagram::detail::emit_group(), and sbl::dsp::diagram::render_mermaid().

edge_count()

uint8_t sbl::dsp::diagram::Graph::edge_count ( ) const

inline

Definition at line 94 of file graph.hpp.

Referenced by sbl::dsp::diagram::render_mermaid().

group_count()

uint8_t sbl::dsp::diagram::Graph::group_count ( ) const

inline

Definition at line 95 of file graph.hpp.

Referenced by sbl::dsp::diagram::detail::emit_group(), and sbl::dsp::diagram::render_mermaid().

node()

const Node & sbl::dsp::diagram::Graph::node ( uint8_t  i ) const

inline

Definition at line 96 of file graph.hpp.

Referenced by sbl::dsp::diagram::detail::emit_group(), and sbl::dsp::diagram::render_mermaid().

edge()

const Edge & sbl::dsp::diagram::Graph::edge ( uint8_t  i ) const

inline

Definition at line 97 of file graph.hpp.

Referenced by sbl::dsp::diagram::render_mermaid().

group()

const Group & sbl::dsp::diagram::Graph::group ( uint8_t  i ) const

inline

Definition at line 98 of file graph.hpp.

Referenced by add_node(), sbl::dsp::diagram::detail::emit_group(), sbl::dsp::diagram::detail::fold_target(), and sbl::dsp::diagram::render_mermaid().

count()

uint8_t sbl::dsp::diagram::Graph::count ( Kind  kind ) const

inline

How many nodes of a kind the graph holds — the structural tests' question.

Definition at line 101 of file graph.hpp.

overflowed()

bool sbl::dsp::diagram::Graph::overflowed ( ) const

inline

True if a describe() lost something: a node, edge or group was refused.

Definition at line 110 of file graph.hpp.

clear()

void sbl::dsp::diagram::Graph::clear ( )

inline

Definition at line 112 of file graph.hpp.

Member Data Documentation

MAX_NODES

constexpr uint8_t sbl::dsp::diagram::Graph::MAX_NODES = 64

staticconstexpr

a 32-mode bank and the string around it

Definition at line 70 of file graph.hpp.

Referenced by add_node().

MAX_EDGES

constexpr uint8_t sbl::dsp::diagram::Graph::MAX_EDGES = 128

staticconstexpr

Definition at line 71 of file graph.hpp.

Referenced by add_edge(), and sbl::dsp::diagram::render_mermaid().

MAX_GROUPS

constexpr uint8_t sbl::dsp::diagram::Graph::MAX_GROUPS = 16

staticconstexpr

Definition at line 72 of file graph.hpp.

Referenced by add_group().

---

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

• src/sbl/dsp/diagram/graph.hpp