finesse.components.wire.Wire

Overview

class finesse.components.wire.Wire(name, nodeA, nodeB, *args, **kwargs)

Bases: Connector

A wire represents a flow of information between signal nodes. It connects two specific signal nodes. Signal nodes have a direction associated with them: input, output, or bidirectional. Depending on what direction each node has depends on what the wire will setup when it is connected. When connecting ports the wire will look at the name of each node in the port and connect nodes with the same name.

Parameters

namestr, optional

Name of newly created wire.

nodeA, nodeBSignalNode

Signal nodes to connect together.

delayfloat, optional

A delay time for the signal to flow from A to B in seconds

gainfloat, optional

An scaling factor that can be used to scale the output relative to the input.

Properties

Wire.nodeA
Wire.nodeB

Methods

Wire.__init__(name, nodeA, nodeB[, delay, gain])
Wire.connect(A, B)	Connects A to B signal nodes together with a Wire element.
Wire.fill(ws)