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

# ---------------------------------------------------------------------
# Copyright (c) 2012 Michael Hull.
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions
# are met:
#
#  - Redistributions of source code must retain the above copyright
#    notice, this list of conditions and the following disclaimer.
#  - Redistributions in binary form must reproduce the above copyright
#    notice, this list of conditions and the following disclaimer in
#    the documentation and/or other materials provided with the
#    distribution.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
# HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
#  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
# ----------------------------------------------------------------------

from morphforge import units
from morphforge.simulation.neuron.objects.neuronobject import NEURONObject
from morphforge.simulation.base import VoltageClamp
from morphforge.simulation.base import VoltageClampStepChange
from morphforge.simulation.neuron.simulationdatacontainers import MHocFileData
#from morphforge.units import qty
from morphforge.simulation.neuron.hocmodbuilders.hocmodutils import HocModUtils
from morphforge.simulation.neuron.hocmodbuilders import HocBuilder
from morphforge.simulation.neuron.objects.neuronrecordable import NEURONRecordable
from morphforge.constants.standardtags import StandardTags
from morphforge.simulation.neuron.core.neuronsimulationenvironment import NEURONEnvironment


[docs]class VoltageClampCurrentRecord(NEURONRecordable):

[docs]    def __init__(self, vclamp, **kwargs):
        super(VoltageClampCurrentRecord, self).__init__(**kwargs)
        self.vclamp = vclamp

[docs]    def get_unit(self):
        return units.nA

[docs]    def get_std_tags(self):
        return [StandardTags.Current]

[docs]    def build_hoc(self, hocfile_obj):
        obj_name_hoc = hocfile_obj[MHocFileData.VoltageClamps][self.vclamp]['stimname']
        HocModUtils.create_record_from_object(hocfile_obj=hocfile_obj,
                vecname='RecVec%s' % self.name, objname=obj_name_hoc,
                objvar='i', recordobj=self)

[docs]    def build_mod(self, modfile_set):
        pass


[docs]class NEURONVoltageClampStepChange(VoltageClampStepChange, NEURONObject):

[docs]    def __init__(self, **kwargs):
        super(NEURONVoltageClampStepChange, self).__init__(**kwargs)

[docs]    def build_hoc(self, hocfile_obj):
        HocBuilder.VoltageClamp(hocfile_obj=hocfile_obj,
                                voltageclamp=self)

[docs]    def build_mod(self, modfile_set):
        pass

[docs]    def get_recordable(self, what, name, **kwargs):
        recorders = {
            VoltageClamp.Recordables.Current: VoltageClampCurrentRecord
        }

        return recorders[what](vclamp=self, name=name, **kwargs)

NEURONEnvironment.voltageclamps.register_plugin(VoltageClampStepChange, NEURONVoltageClampStepChange)