# Copyright (c) 2016 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 spinn_utilities.abstract_base import AbstractBase, abstractmethod
from spinn_utilities.require_subclass import require_subclass
from pacman.model.graphs.machine import MachineVertex
from pacman.model.placements import Placement


@require_subclass(MachineVertex)
class AbstractProvidesProvenanceDataFromMachine(
        object, metaclass=AbstractBase):
    """
    Indicates that an object provides provenance data retrieved from the
    machine.
    """

    __slots__ = ()

    @abstractmethod
    def get_provenance_data_from_machine(self, placement: Placement):
        """
        Get provenance data items for a placement and store them in the
        provenance DB.

        :param ~pacman.model.placements.Placement placement:
            the placement of the object
        """
        raise NotImplementedError
