The ports a component exposes after describing itself, so an owner can wire them. More...

Detailed Description

The ports a component exposes after describing itself, so an owner can wire them.

Definition at line 130 of file graph.hpp.

#include <graph.hpp>

Classes
struct	Named

Public Member Functions
void	add (const char *name, uint8_t node)
	Add a named port; a ninth is refused and find() answers NO_NODE for it.

uint8_t	find (const char *name) const
	The node behind a name, or NO_NODE.

Public Attributes
uint8_t	in = NO_NODE
	where a wave enters (the junction, the load)

uint8_t	out = NO_NODE
	where a wave leaves (the pickup, the reflection)

uint8_t	group = NO_GROUP

Named	named [MAX_NAMED] = {}

uint8_t	named_count = 0

Static Public Attributes
static constexpr uint8_t	MAX_NAMED = 8

Member Function Documentation

◆ add()

void sbl::dsp::diagram::Ports::add	(	const char *	name,
		uint8_t	node
	)

inline

Add a named port; a ninth is refused and find() answers NO_NODE for it.

Definition at line 147 of file graph.hpp.

References MAX_NAMED, named, and named_count.

Referenced by sbl::dsp::pm::TableSet::describe(), sbl::dsp::pm::LoadJunction< Load >::describe(), and sbl::dsp::pm::StringLoop::describe().

◆ find()

uint8_t sbl::dsp::diagram::Ports::find ( const char * name ) const

inline

The node behind a name, or NO_NODE.

Definition at line 153 of file graph.hpp.

References sbl::dsp::diagram::Ports::Named::name, named, named_count, sbl::dsp::diagram::NO_NODE, and sbl::dsp::diagram::Ports::Named::node.

Member Data Documentation

◆ MAX_NAMED

constexpr uint8_t sbl::dsp::diagram::Ports::MAX_NAMED = 8

staticconstexpr

Definition at line 131 of file graph.hpp.

Referenced by add().

◆ in

uint8_t sbl::dsp::diagram::Ports::in = NO_NODE

where a wave enters (the junction, the load)

Definition at line 133 of file graph.hpp.

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

◆ out

uint8_t sbl::dsp::diagram::Ports::out = NO_NODE

where a wave leaves (the pickup, the reflection)

Definition at line 134 of file graph.hpp.

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

◆ group

uint8_t sbl::dsp::diagram::Ports::group = NO_GROUP

Definition at line 135 of file graph.hpp.

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

◆ named

Named sbl::dsp::diagram::Ports::named[MAX_NAMED] = {}

Definition at line 143 of file graph.hpp.

Referenced by add(), and find().

◆ named_count

uint8_t sbl::dsp::diagram::Ports::named_count = 0

Definition at line 144 of file graph.hpp.