PortConnection Struct Reference

A connection between two ports. More...

#include <dsp/port_connection.h>

Collaboration diagram for PortConnection:

Data Fields
PortIdentifier *	src_id
PortIdentifier *	dest_id
float	multiplier
	Multiplier to apply, where applicable.
bool	locked
	Whether the connection can be removed or the multiplier edited by the user.
bool	enabled
	Whether the connection is enabled.
float	base_value
	Used for CV -> control port connections.

Detailed Description

A connection between two ports.

Definition at line 27 of file port_connection.h.

Field Documentation

base_value

float PortConnection::base_value

Used for CV -> control port connections.

Definition at line 59 of file port_connection.h.

dest_id

PortIdentifier* PortConnection::dest_id

Definition at line 30 of file port_connection.h.

enabled

bool PortConnection::enabled

Whether the connection is enabled.

Note

The user can disable port connections only if they are not locked.

Definition at line 56 of file port_connection.h.

locked

bool PortConnection::locked

Whether the connection can be removed or the multiplier edited by the user.

Ignored when connecting things internally and only used to deter the user from breaking necessary connections.

Definition at line 48 of file port_connection.h.

multiplier

float PortConnection::multiplier

Multiplier to apply, where applicable.

Range: 0 to 1. Default: 1.

Definition at line 38 of file port_connection.h.

src_id

PortIdentifier* PortConnection::src_id

Definition at line 29 of file port_connection.h.

---

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

• dsp/port_connection.h