finesse.components.wire module

Wire-type objects representing electrical connections between components.

class finesse.components.wire.Wire(*args, **kwargs)[source]

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: A scaling factor that can be used to scale the output relative to the input.

connect(A, B)[source]

Connects A to B signal nodes together with a Wire element. If A or B are ports then the first node is selected from the port to connect. If A or B have more than one node then you should specify.

explicitly which one to use - an exception will be raised in this case.

Parameters

ASignalNode or Port: First signal node or Electrical port with a single node
BSignalNode or Port: Second signal node or Electrical port with a single node

property delay: delay : float, optional A delay time for the signal to flow from A to B in seconds

fill(ws)[source]

property gain: gain : float, optional A scaling factor that can be used to scale the output relative to the input.

property nodeA[source]

property nodeB[source]

class finesse.components.wire.WireWorkspace[source]: Bases: ConnectorWorkspace