Source code for spinn_front_end_common.interface.buffer_management.buffer_models.sends_buffers_from_host_pre_buffered_impl
# 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/>.
import logging
from six import add_metaclass
from spinn_utilities.abstract_base import AbstractBase, abstractproperty
from .abstract_sends_buffers_from_host import AbstractSendsBuffersFromHost
logger = logging.getLogger(__name__)
[docs]@add_metaclass(AbstractBase)
class SendsBuffersFromHostPreBufferedImpl(AbstractSendsBuffersFromHost):
""" Implementation of \
:py:class:`~spinn_front_end_common.interface.buffer_management.buffer_models.AbstractReceiveBuffersToHost`\
which uses an existing set of buffers for the details.
"""
# pylint: disable=unsubscriptable-object, no-member
__slots__ = ()
@abstractproperty
def send_buffers(self):
"""
:rtype: \
dict(int,~spinn_front_end_common.interface.buffer_management.storage_objects.BufferedSendingRegion)
"""
[docs] def get_regions(self):
""" Return the regions which has buffers to send
"""
return self.send_buffers.keys()
[docs] def is_next_timestamp(self, region):
""" Check if there are more time stamps which need transmitting
:param region: the region to check
:return: boolean
"""
return self.send_buffers[region].is_next_timestamp
[docs] def get_next_timestamp(self, region):
""" Return the next time stamp available in the buffered region
:param region: the region ID which is being asked
:return: the next time stamp
"""
return self.send_buffers[region].next_timestamp
[docs] def is_next_key(self, region, timestamp):
""" Check if there is more keys to transmit for a given region in a\
given timestamp
:param region: the region ID to check
:param timestamp: the timestamp to check
:return: bool
"""
return self.send_buffers[region].is_next_key(timestamp)
[docs] def get_next_key(self, region):
""" Get the next key for a given region
:param region: the region to get the next key from
"""
return self.send_buffers[region].next_key
[docs] def is_empty(self, region):
""" Check if a region is empty
:param region: the region ID to check
:return: bool
"""
return len(self.send_buffers[region].timestamps) == 0
[docs] def rewind(self, region):
""" Rewinds the internal buffer in preparation of re-sending\
the spikes
:param region: The region to rewind
:type region: int
"""
self.send_buffers[region].rewind()