Equipment.py

"""Equipment class definition file."""

from parapy.core import Attribute, Base, Input, Part, derived
from parapy.geom import Box, Orientation, Point, Position, Vector


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

    This class is the template for each equipment object and contains the name, position and size.

    """

    equipment_dict: dict = Input()
    name: str = Input(derived)
    coordinate: Point = Input(derived)
    node_number: int = Input()

    size: float = Input(100)

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

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

    @Attribute
    def position(self) -> Position:
        """Create a position attribute.

        Returns:
            Position: position attribute.

        """
        return Position(
            location=self.coordinate,
            orientation=Orientation(
                x=Vector(1, 0, 0), y=Vector(0, 1, 0), z=Vector(0, 0, 1)
            ),
        )

    @Part
    def box(self) -> Box:
        """Create a box to display the equipment visually in the gui.

        Returns:
            Box: box representing equipment.

        """
        return Box(
            width=self.size,
            length=self.size,
            height=self.size,
            position=self.position,
            centered=True
        )