#!/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.units import qty

from morphforge.simulation.neuron.objects.neuronobject import NEURONObject
from morphforge.simulation.base import Cell

from morphforge.simulation.neuron.hocmodbuilders import HocBuilder
from morphforge.simulation.neuron.simulationdatacontainers import MHocFileData
from morphforge.simulation.neuron.simulationdatacontainers import MHOCSections
from morphforge.simulation.neuron.objects.neuronrecordable import NEURONRecordable

from Cheetah.Template import Template
from morphforge.constants.standardtags import StandardTags


[docs]class MembraneVoltageRecord(NEURONRecordable):

    initial_buffer_size = 50000

    _tmpl_str_obj_ref = """
objref $recVecName
$recVecName = new Vector()
${recVecName}.buffer_size(%d)
${recVecName}.record(& ${cellname}.internalsections[${sectionindex}].v ($sectionpos))
    """ % initial_buffer_size

[docs]    def __init__(self, cell, cell_location=None, **kwargs):
        super(MembraneVoltageRecord, self).__init__(**kwargs)
        self.cell = cell
        self.cell_location = cell_location if cell_location is not None else cell.soma



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

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

[docs]    def get_description(self):
        desc = 'Vm %s' % self.cell_location.cell.name
        if self.cell_location.morphlocation.section.idtag:
            desc += ':%s' % self.cell_location.morphlocation.section.idtag
        return desc

[docs]    def build_hoc(self, hocfile_obj):
        cell = self.cell_location.cell
        section = self.cell_location.morphlocation.section
        cell_name = hocfile_obj[MHocFileData.Cells][cell]['cell_name']
        section_index = hocfile_obj[MHocFileData.Cells][cell]['section_indexer'][section]


        tmpl_dict = {
            'recVecName': self.name,
            'cellname': cell_name,
            'sectionindex': section_index,
            'sectionpos': self.cell_location.morphlocation.sectionpos,
            }

        sect_txt = Template(MembraneVoltageRecord._tmpl_str_obj_ref, tmpl_dict).respond()
        hocfile_obj.add_to_section(MHOCSections.InitRecords, sect_txt)

        hocfile_obj[MHocFileData.Recordables][self] = tmpl_dict

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


[docs]class NEURONCell(Cell, NEURONObject):

[docs]    def build_hoc(self, hocfile_obj):
        HocBuilder.Cell(hocfile_obj=hocfile_obj, cell=self)

[docs]    def build_mod(self, modfile_set):
        for chl in self.get_biophysics().get_all_channels_applied_to_cell():
            chl.create_modfile(modfile_set)

[docs]    def get_recordable(self, what=Cell.Recordables.MembraneVoltage, **kwargs):
        recordables = { 
                Cell.Recordables.MembraneVoltage: MembraneVoltageRecord
                }
        return recordables[what](cell=self, **kwargs)