Source code for spinn_front_end_common.abstract_models.abstract_rewrites_data_specification
# Copyright (c) 2017 The University of Manchester
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
from __future__ import annotations
from typing import TYPE_CHECKING
from spinn_utilities.abstract_base import AbstractBase, abstractmethod
from spinn_utilities.require_subclass import require_subclass
from pacman.model.placements import Placement
from .abstract_generates_data_specification import (
AbstractGeneratesDataSpecification)
if TYPE_CHECKING:
from spinn_front_end_common.interface.ds import DataSpecificationReloader
@require_subclass(AbstractGeneratesDataSpecification)
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: DataSpecificationReloader, placement: 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?
"""
raise NotImplementedError
[docs]
@abstractmethod
def reload_required(self) -> bool:
"""
Return true if any data region needs to be reloaded.
:rtype: bool
"""
raise NotImplementedError
[docs]
@abstractmethod
def set_reload_required(self, new_value: bool):
"""
Indicate that the regions have been reloaded.
:param new_value: the new value
"""
raise NotImplementedError