Source code for pacman.executor.algorithm_decorators.output

# 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/>.


class Output(object):
    """ Represents an output from an algorithm.
    """

    __slots__ = [
        # The type of the output
        "_output_type",
        # The name of the type holding the file name
        "_file_name_type"
    ]

    def __init__(self, output_type, file_name_type=None):
        """
        :param output_type: The type of the output
        :param file_name_type:\
            If the output is file based, the type of the input holding\
            the file name
        """
        self._output_type = output_type
        self._file_name_type = file_name_type

    @property
    def output_type(self):
        return self._output_type

    @property
    def file_name_type(self):
        return self._file_name_type

    def __repr__(self):
        return "Output(output_type={}, file_name_type={})".format(
            self._output_type, self._file_name_type)