# Source code for spinn_front_end_common.abstract_models.abstract_rewrites_data_specification

# Copyright (c) 2017-2019 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 import MachineVertex

[docs]@require_subclass(MachineVertex)
class AbstractRewritesDataSpecification(object, metaclass=AbstractBase):
""" Indicates an object that allows data to be changed after run,\
and so can rewrite the data specification
"""

__slots__ = []

[docs]    @abstractmethod
def regenerate_data_specification(self, spec, placement):
""" Regenerate the data specification, only generating regions that\
have changed and need to be reloaded

:param ~data_specification.DataSpecificationGenerator spec:
Where to write the regenerated spec
:param ~pacman.model.placements.Placement placement:
Where are we regenerating for?
"""

[docs]    @abstractmethod