Source code for pybpodgui_api.models.experiment.experiment_base

# !/usr/bin/python3
# -*- coding: utf-8 -*-

import logging
import uuid
import os
from pybpodgui_api.models.setup import Setup
from pybpodgui_api.utils.generate_name import generate_name

logger = logging.getLogger(__name__)


class ExperimentBase(object):
    """
    Experiment entity details.
    Each experiment should have a name, a list of setups, a project belonging to, a path and a task.
    """

    def __init__(self, project):
        """
        :ivar Project project: project object reference
        """
        self.uuid4 = uuid.uuid4()

        self.name = generate_name([x.name for x in project.experiments], "experiment")
        self._setups = []
        self.project = project

        self.project += self

    ##########################################################################
    ####### PROPERTIES #######################################################
    ##########################################################################

    @property
    def name(self):
        """
        Get and set the experiment name

        :rtype: str
        """
        return self._name

    @name.setter
    def name(self, value):
        self._name = value

    @property
    def task(self):
        """
        Get and set the experiment task

        :rtype: Task
        """
        return self._task

    @task.setter
    def task(self, value):
        if isinstance(value, str):
            value = self.project.find_task(value)

        self._task = value

        for setup in self.setups:
            setup.task = value

    @property
    def project(self):
        """
        Get and set the experiment project

        :rtype: Project
        """
        return self._project

    @project.setter
    def project(self, value):
        self._project = value

    @property
    def setups(self):
        """
        Get the experiment setups

        :rtype: list(Setup)
        """
        return self._setups

    @property
    def path(self):
        """
        Get and set the experiment files path

        :rtype: str
        """
        if self.project.path is None:
            return None

        return os.path.join(self.project.path, 'experiments', self.name)

    ##########################################################################
    ####### FUNCTIONS ########################################################
    ##########################################################################

    def remove(self):
        """
        Remove experiment

        """
        pass

    def create_setup(self):
        """
        Create new instance of setup

        :rtype: Setup
        """
        return Setup(self)

    def __add__(self, obj):
        if isinstance(obj, Setup):
            self._setups.append(obj)
        return self

    def __sub__(self, obj):
        if isinstance(obj, Setup):
            self._setups.remove(obj)
        return self

    def __unicode__(self):
        return self.name

    def __str__(self):
        return self.__unicode__()