Source code for spinn_front_end_common.interface.buffer_management.buffer_models.abstract_sends_buffers_from_host

# Copyright (c) 2017-2019 The University of Manchester
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# 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 import MachineVertex


[docs]@require_subclass(MachineVertex) class AbstractSendsBuffersFromHost(object, metaclass=AbstractBase): """ Interface to an object that sends buffers of keys to be\ transmitted at given timestamps in the simulation. """ __slots__ = ()
[docs] @abstractmethod def buffering_input(self): """ Return True if the input of this vertex is to be buffered. :rtype: bool """
[docs] @abstractmethod def get_regions(self): """ Get the set of regions for which there are keys to be sent :return: Iterable of region IDs :rtype: iterable(int) """
[docs] @abstractmethod def get_region_buffer_size(self, region): """ Get the size of the buffer to be used in SDRAM on the machine\ for the region in bytes :param int region: The region to get the buffer size of :return: The size of the buffer space in bytes :rtype: int """
[docs] @abstractmethod def is_next_timestamp(self, region): """ Determine if there is another timestamp with data to be sent :param int region: The region to determine if there is more data for :return: Whether there is more data :rtype: bool """
[docs] @abstractmethod def get_next_timestamp(self, region): """ Get the next timestamp at which there are still keys to be sent\ for the given region :param int region: The region to get the timestamp for :return: The timestamp of the next available keys :rtype: int """
[docs] @abstractmethod def is_next_key(self, region, timestamp): """ Determine if there are still keys to be sent at the given\ timestamp for the given region :param int region: The region to determine if there are keys for :param int timestamp: The timestamp to determine if there are more keys for :return: Whether there are more keys to send for the parameters :rtype: bool """
[docs] @abstractmethod def get_next_key(self, region): """ Get the next key in the given region :param int region: The region to get the next key from :return: The next key, or None if there are no more keys :rtype: int """
[docs] @abstractmethod def is_empty(self, region): """ Return true if there are no spikes to be buffered for the\ specified region :param int region: The region to get the next key from :return: Whether there are no keys to send for the region :rtype: bool """
[docs] @abstractmethod def rewind(self, region): """ Rewinds the internal buffer in preparation of re-sending\ the spikes :param int region: The region to rewind """