Source code for pacman.model.graphs.machine.machine_spinnaker_link_vertex

# Copyright (c) 2016 The University of Manchester
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
from __future__ import annotations
from typing import List, Optional, TYPE_CHECKING

from spinn_utilities.overrides import overrides

from pacman.model.graphs import AbstractVirtual
from pacman.model.resources import ConstantSDRAM
from .machine_vertex import MachineVertex

if TYPE_CHECKING:
    from spinn_utilities.typing.coords import XY
    from spinn_machine import Machine
    from spinn_machine.link_data_objects import SpinnakerLinkData
    from pacman.model.graphs.application import ApplicationVertex
    from pacman.model.graphs.common import Slice
    from pacman.model.routing_info import BaseKeyAndMask




[docs]
class MachineSpiNNakerLinkVertex(MachineVertex, AbstractVirtual):
    """
    A virtual vertex on a SpiNNaker Link.
    """

    __slots__ = (
        "_spinnaker_link_id",
        "_board_address",
        "_linked_chip_coordinates",
        "_virtual_chip_x",
        "_virtual_chip_y",
        "_outgoing_keys_and_masks",
        "_incoming",
        "_outgoing")

    def __init__(
            self, spinnaker_link_id: int, board_address: Optional[str] = None,
            linked_chip_coordinates: Optional[XY] = None,
            label: Optional[str] = None,
            app_vertex: Optional[ApplicationVertex] = None,
            vertex_slice: Optional[Slice] = None,
            outgoing_keys_and_masks: Optional[List[BaseKeyAndMask]] = None,
            incoming: bool = True, outgoing: bool = False):
        """
        :param spinnaker_link_id:
            The id of the spinnaker link as passed into the init.
        :param board_address:
            The IP address of the board to which the device is connected,
        :param linked_chip_coordinates:
           The coordinates of the chip to which the device is connected,
        :param label: The optional name of the vertex
        :param app_vertex:
            The application vertex that caused this machine vertex to be
            created. If `None`, there is no such application vertex.
        :param vertex_slice:
            The slice of the application vertex that this machine vertex
            implements.
        :param outgoing_keys_and_masks:  key and mask to be used by the device
        :param incoming: Whether this device sends traffic into SpiNNaker.
        :param outgoing:  Whether this device receives traffic from SpiNNaker.
        """
        super().__init__(
            label=label, app_vertex=app_vertex, vertex_slice=vertex_slice)
        self._spinnaker_link_id = spinnaker_link_id
        self._board_address = board_address
        self._linked_chip_coordinates = linked_chip_coordinates
        self._outgoing_keys_and_masks = outgoing_keys_and_masks
        self._incoming = incoming
        self._outgoing = outgoing

    @property
    @overrides(MachineVertex.sdram_required)
    def sdram_required(self) -> ConstantSDRAM:
        return ConstantSDRAM(0)

    @property
    def spinnaker_link_id(self) -> int:
        """
        The id of the spinnaker link as passed into the init.
        """
        return self._spinnaker_link_id

    @property
    @overrides(AbstractVirtual.board_address)
    def board_address(self) -> Optional[str]:
        return self._board_address

    @property
    @overrides(AbstractVirtual.linked_chip_coordinates)
    def linked_chip_coordinates(self) -> Optional[XY]:
        return self._linked_chip_coordinates



[docs]
    @overrides(AbstractVirtual.outgoing_keys_and_masks)
    def outgoing_keys_and_masks(self) -> Optional[List[BaseKeyAndMask]]:
        return self._outgoing_keys_and_masks



    @property
    @overrides(AbstractVirtual.incoming)
    def incoming(self) -> bool:
        return self._incoming

    @property
    @overrides(AbstractVirtual.outgoing)
    def outgoing(self) -> bool:
        return self._outgoing