finesse.components.general.Connector
¶
Overview
- class finesse.components.general.Connector(name)[source]¶
Bases:
ModelElement
Base class for any component which connects nodes together.
Internally it stores the nodes and the connections associated with the component. During the matrix build this class will then ensure that the matrix elements for each coupling requested are allocated and and the required matrix view for editing their values is retrieved.
The inheriting class should call
_register_node
and_register_coupling
to define the connections it wants to use.- Parameters
- namestr
Name of the new Connector instance.
Properties
A dictionary of all the connections this element is making between its nodes. |
|
A dictionary of all the optical connections this element is making between its nodes. |
|
Whether this element borrows node references from another. |
|
All the nodes of all the ports at this component. |
|
The optical nodes stored by the connector. |
|
Retrieves the ports available at the object. |
|
The signal nodes stored by the connector. |
Methods
|
|
|
|
|
Checks that a coupling exists between from_node -> to_node and raises a |
|
Obtains the type of coupling (see |
|
Obtains the type of interaction (see |
|
Flags whether the provided node coupling exists at this connector. |
|
Register an ABCD matrix of the given symbolic form for a sequence of coupling(s). |