Source code for spinnman.processes.most_direct_connection_selector

# Copyright (c) 2015 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 spinn_utilities.overrides import overrides
from spinnman.data import SpiNNManDataView
from .abstract_multi_connection_process_connection_selector import (
    AbstractMultiConnectionProcessConnectionSelector)


class MostDirectConnectionSelector(
        AbstractMultiConnectionProcessConnectionSelector):
    """
    A selector that goes for the most direct connection for the message.
    """
    __slots__ = [
        "_connections",
        "_first_connection"]

    # pylint: disable=super-init-not-called
    def __init__(self, connections):
        """
        :param list(SCAMPConnection) connections:
            The connections to be used
        """
        self._connections = dict()
        self._first_connection = None
        for connection in connections:
            if connection.chip_x == 0 and connection.chip_y == 0:
                self._first_connection = connection
            self._connections[
                (connection.chip_x, connection.chip_y)] = connection
        if self._first_connection is None:
            self._first_connection = next(iter(connections))

    @overrides(
        AbstractMultiConnectionProcessConnectionSelector.get_next_connection)
    def get_next_connection(self, message):
        key = (message.sdp_header.destination_chip_x,
               message.sdp_header.destination_chip_y)
        if key in self._connections:
            return self._connections[key]

        if not SpiNNManDataView.has_machine() or len(self._connections) == 1:
            return self._first_connection

        x, y = key
        key = SpiNNManDataView.get_nearest_ethernet(x, y)

        if key in self._connections:
            return self._connections[key]
        else:
            return self._first_connection