finesse.components.node.Port

Overview

class finesse.components.node.Port(name, component, node_type)[source]

Bases: finesse.freeze.Freezable

A collection of all the nodes at a specific point/surface of a component.

Parameters

name : str

Name of newly created node.

component : Sub-class of Connector

The component that this node belongs to.

node_type : NodeType

Physical node type.

Properties

Port.attached_to

Component that the port is attached to.

Port.component

The component which has ownership of this port.

Port.enabled

Port.full_name

getter

Returns a full name of the port: {component name}.{port name}

Port.is_connected

Flag indicating whether the port is attached to another component.

Port.name

Name of the port object.

Port.nodes

Nodes associated with the port.

Port.space

Space that the port is attached to.

Port.type

NodeType of the port object.