Source code for spinn_machine.exceptions

class SpinnMachineException(Exception):
    """ A generic exception which all other exceptions extend
    """
    pass


class SpinnMachineAlreadyExistsException(SpinnMachineException):
    """ Indicates that something already exists of which there can only be one
    """

    def __init__(self, item, value):
        """

        :param item: The item of which there is already one of
        :type item: str
        :param value: The value of the item
        :type value: str
        """
        super(SpinnMachineAlreadyExistsException, self).__init__(
            "There can only be one {} with a value of {}".format(
                item, value))
        self._item = item
        self._value = value

    @property
    def item(self):
        """ The item of which there is already one
        """
        return self._item

    @property
    def value(self):
        """ The value of the item
        """
        return self._value


class SpinnMachineInvalidParameterException(SpinnMachineException):
    """ Indicates that there is a problem with a parameter value
    """

    def __init__(self, parameter, value, problem):
        """

        :param parameter: The name of the parameter that has an invalid value
        :type parameter: str
        :param value: The value of the parameter that is invalid
        :type value: str
        :param problem: The reason for the exception
        :type problem: str
        """
        super(SpinnMachineInvalidParameterException, self).__init__(
            "It is invalid to set {} to {}: {}".format(
                parameter, value, problem))
        self._parameter = parameter
        self._value = value
        self._problem = problem

    @property
    def parameter(self):
        """ The name of the parameter
        """
        return self._parameter

    @property
    def value(self):
        """ The value of the parameter
        """
        return self._value

    @property
    def problem(self):
        """ The problem with the setting of the parameter
        """
        return self._problem