Signal.py

"""Signal class definition file."""

from parapy.core import Base, Input, Part, derived
from parapy.geom import Point, Polyline

from model.Node import Node


class Signal(Base):
    """Represent the Signal class.

    This class is the template for each signal object.

    """

    signal_dict: dict = Input()
    weight: float = Input(0.)
    source: str = Input(derived)
    destination: str = Input(derived)
    source_coordinate: Point = Input(derived)
    destination_coordinate: Point = Input(derived)
    system_code: int = Input(derived)
    mass_per_meter: float = Input(derived)

    color: str = Input("red")

    @source.getter
    def source(self) -> str:
        """Return the source name from the dict."""
        return self.signal_dict["source"]

    @source_coordinate.getter
    def source_coordinate(self) -> Point:
        """Return the source coordinate from the dict."""
        return self.signal_dict["source_coordinate"]

    @destination.getter
    def destination(self) -> str:
        """Return the destination name from the dict."""
        return self.signal_dict["destination"]

    @destination_coordinate.getter
    def destination_coordinate(self) -> Point:
        """Return the destination coordinate from the dict."""
        return self.signal_dict["destination_coordinate"]

    @system_code.getter
    def system_code(self) -> int:
        """Return the system code from the dict."""
        return self.signal_dict["system_code"]

    @mass_per_meter.getter
    def mass_per_meter(self) -> float:
        """Return the mass per unit length from the dict. If not available, return a default value."""
        if "mass_per_length" in self.signal_dict:
            return self.signal_dict["mass_per_meter"]
        else:
            return 0.25 # 0.25 kg per meter as default value

    @Input
    def path(self) -> list[Node]:
        """Initialize the path as a straight line from the source to the destination."""
        return [
            Node(number=-1, coordinate=self.source_coordinate),
            Node(number=-1, coordinate=self.destination_coordinate),
        ]

    @Part
    def path_line(self) -> Polyline:
        """Create edges to display in GUI."""
        return Polyline(points=[node.coordinate for node in self.path],
                        line_thickness=2)