Source code for tasks.taskTemplate

# -*- coding: utf-8 -*-
"""
:Author: Dominic
"""


class Task(object):
    """The abstract tasks class from which all others inherit

    Many general methods for tasks are found only here

    Parameters
    ----------


    Attributes
    ----------
    Name : string
        The name of the class used when recording what has been used.

    """

    def __init__(self):

        self.Name = self.get_name()

        self.parameters = {"Name": self.Name
                           }

        self.record_actions = []

    def __iter__(self):
        """
        Returns the iterator for the tasks
        """

        return self

    def __next__(self):
        """
        Produces the next stimulus for the iterator

        Returns
        -------
        stimulus : None
        nextValidActions : Tuple of ints
            The list of valid actions that the model can respond with. Set to
            ``None``, as they never vary.

        Raises
        ------
        StopIteration
        """

        # Since there is nothing to iterate over, just return the final state

        raise StopIteration

    def __eq__(self, other):

        if self.Name == other.Name:
            return True
        else:
            return False

    def __ne__(self, other):

        if self.Name != other.Name:
            return True
        else:
            return False

    def __hash__(self):

        return hash(self.Name)

    @classmethod
    def get_name(cls):
        """
        Returns the name of the class
        """

        return cls.__name__

    def __repr__(self):

        params = self.params()
        name = params.pop('Name')

        label = ["{}(".format(name)]
        label.extend(["{}={}, ".format(k, repr(v)) for k, v in params.items()])
        label.append(")")

        representation = ' '.join(label)

        return representation

    def receiveAction(self, action):
        """
        Receives the next action from the participant

        Parameters
        ----------
        action : int or string
            The action taken by the model
        """

        self.record_actions.append(action)

    def proceed(self):
        """
        Updates the task before the next trialstep
        """

        pass

    def feedback(self):
        """
        Responds to the action from the participant

        Returns
        -------
        feedback : None, int or float

        """
        return None

    def returnTaskState(self):
        """
        Returns all the relevant data for this task run

        Returns
        -------
        results : dictionary
            A dictionary containing the class parameters  as well as the other useful data
        """

        results = self.standardResultOutput()

        results["Actions"] = self.record_actions

        return results

    def storeState(self):
        """
        Stores the state of all the important variables so that they can be
        output later
        """

        pass

    def standardResultOutput(self):

        results = self.parameters.copy()

        return results

    def params(self):
        """
        Returns the parameters of the task as a dictionary

        Returns
        -------
        parameters : dict
            The parameters of the task
        """

        return self.parameters.copy()