Source code for spinn_front_end_common.interface.provenance.abstract_provides_provenance_data_from_machine
# 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 six import add_metaclass
from spinn_utilities.abstract_base import AbstractBase, abstractmethod
[docs]@add_metaclass(AbstractBase)
class AbstractProvidesProvenanceDataFromMachine(object):
""" Indicates that an object provides provenance data retrieved from the\
machine
"""
__slots__ = ()
[docs] @abstractmethod
def get_provenance_data_from_machine(self, transceiver, placement):
""" Get an iterable of provenance data items
:param transceiver: the SpinnMan interface object
:type transceiver: ~spinnman.transceiver.Transceiver
:param placement: the placement of the object
:type placement: ~pacman.model.placements.Placement
:return: the provenance items
:rtype: iterable(ProvenanceDataItem)
"""