Source code for spynnaker.pyNN.models.abstract_models.abstract_synapse_expandable

# Copyright (c) 2017 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.abstract_base import AbstractBase, abstractmethod
from spinn_utilities.require_subclass import require_subclass
from pacman.model.graphs.machine import MachineVertex
from pacman.model.placements import Placement

SYNAPSE_EXPANDER_APLX = "synapse_expander.aplx"


@require_subclass(MachineVertex)
class AbstractSynapseExpandable(object, metaclass=AbstractBase):
    """
    Indicates a class (a
    :py:class:`~pacman.model.graphs.machine.MachineVertex`)
    that has may need to run the synapse expander APLX.

    .. note::
        This is *not* implemented by the
        :py:class:`~.DelayExtensionMachineVertex`,
        which needs a different expander APLX
    """

    __slots__ = ()



    @abstractmethod
    def gen_on_machine(self) -> bool:
        """
        True if the synapses of this vertex should be generated on the machine.

        .. note::
            The typical implementation for this method will be to ask the
            app_vertex's synapse_manager

        :returns: True if this vertex can generate its data on machine
        """
        raise NotImplementedError


    @property
    @abstractmethod
    def connection_generator_region(self) -> int:
        """
        The region ID containing the parameters of synaptic expansion.
        """
        raise NotImplementedError



    @abstractmethod
    def read_generated_connection_holders(self, placement: Placement) -> None:
        """
        Fill in the connection holders.

        :param placement: Where the data is on the machine
        """
        raise NotImplementedError


    @property
    @abstractmethod
    def max_gen_data(self) -> int:
        """
        The maximum amount of synaptic data to be generated.
        This is used to calculate the timeout of the execution.
        """
        raise NotImplementedError

    @property
    @abstractmethod
    def bit_field_size(self) -> int:
        """
        The amount of bit field data to be generated.
        This is used to calculate the timeout of the execution.
        """
        raise NotImplementedError