#########################################################################################
##
## PORT REFERENCE CLASS
## (utils/portreference.py)
##
## Milan Rother 2025
##
#########################################################################################
# IMPORTS ===============================================================================
import numpy as np
# CLASS =================================================================================
[docs]
class PortReference:
"""This is a container class that holds a reference to a block
and a list of ports.
Note
----
The default port, when no ports are defined in the arguments is `0`.
Parameters
----------
block : Block
internal block reference
ports : list[int]
list of port indices
"""
__slots__ = ["block", "ports"]
def __init__(self, block=None, ports=[0]):
#type validation for ports
if not isinstance(ports, list):
raise ValueError(f"'ports' must be 'list[int]' but is '{type(ports)}'!")
#ports are positive integers
if not all(isinstance(p, int) and p >= 0 for p in ports):
raise ValueError("'ports' must be positive integers!")
#unique ports
if len(ports) != len(set(ports)):
raise ValueError("'ports' must be unique!")
self.block = block
self.ports = ports
def __len__(self):
"""The number of ports managed by 'PortReference'"""
return len(self.ports)
[docs]
def to(self, other):
"""Transfer the data between two `PortReference` instances,
in this direction `self` -> `other`. From outputs to inputs.
Parameters
----------
other : PortReference
the `PortReference` instance to transfer data to from `self`
"""
for a, b in zip(other.ports, self.ports):
other.block.inputs[a] = self.block.outputs[b]
[docs]
def get_outputs(self):
"""Return the output values of the block at specified ports
Returns
-------
out : list[float, obj]
output values of block
"""
return np.array([self.block.outputs[p] for p in self.ports])
[docs]
def set_outputs(self, vals):
"""Set the block outputs with values at specified ports
Parameters
----------
vals : list[float, obj]
values to set at block output ports
"""
for v, p in zip(vals, self.ports):
self.block.outputs[p] = v
[docs]
def to_dict(self):
"""Serialization into dict"""
return {
"block": id(self.block),
"ports": self.ports
}