Source code for spinn_front_end_common.utility_models.command_sender

# Copyright (c) 2014 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 pacman.model.graphs.application import ApplicationEdge, ApplicationVertex
from pacman.model.graphs.application.abstract import (
    AbstractOneAppOneMachineVertex)
from .command_sender_machine_vertex import CommandSenderMachineVertex
from spinn_utilities.overrides import overrides


class CommandSender(
        AbstractOneAppOneMachineVertex):
    """
    A utility for sending commands to a vertex (possibly an external device)
    at fixed times in the simulation or in response to simulation events
    (e.g., starting and stopping).
    """

    def __init__(self, label):
        """
        :param str label: The label of this vertex
        """
        super().__init__(
            CommandSenderMachineVertex(label, self), label)

    def add_commands(
            self, start_resume_commands, pause_stop_commands,
            timed_commands, vertex_to_send_to):
        """
        Add commands to be sent down a given edge.

        :param iterable(MultiCastCommand) start_resume_commands:
            The commands to send when the simulation starts or resumes from
            pause
        :param iterable(MultiCastCommand) pause_stop_commands:
            The commands to send when the simulation stops or pauses after
            running
        :param iterable(MultiCastCommand) timed_commands:
            The commands to send at specific times
        :param ~pacman.model.graphs.AbstractVertex vertex_to_send_to:
            The vertex these commands are to be sent to
        """
        self._machine_vertex.add_commands(
            start_resume_commands, pause_stop_commands, timed_commands,
            vertex_to_send_to)

    def edges_and_partitions(self):
        """
        Construct application edges from this vertex to the app vertices
        that this vertex knows how to target (and has keys allocated for).

        :return: edges, partition IDs
        :rtype: tuple(list(~pacman.model.graphs.application.ApplicationEdge),
            list(str))
        """
        return self._machine_vertex.get_edges_and_partitions(
            self, ApplicationVertex, ApplicationEdge)

    @overrides(AbstractOneAppOneMachineVertex.get_fixed_key_and_mask)
    def get_fixed_key_and_mask(self, partition_id):
        return self._machine_vertex.get_fixed_key_and_mask(partition_id)