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

# Copyright (c) 2017-2020 The University of Manchester
#
# This program is free software: you can redistribute it and/or modify
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program.  If not, see <http://www.gnu.org/licenses/>.

from spinn_utilities.abstract_base import AbstractBase, abstractmethod
from spinn_utilities.require_subclass import require_subclass
from pacman.model.graphs.machine.machine_vertex import MachineVertex

SYNAPSE_EXPANDER_APLX = "synapse_expander.aplx"

[docs]@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

Cores that do not use the synapse_manager should not implement this
API even though their app vertex may hold a synapse_manager.

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

__slots__ = ()

[docs]    @abstractmethod
def gen_on_machine(self):
""" True if the synapses of a the slice 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

:rtype: bool
"""

[docs]    @abstractmethod