# -*- coding: utf-8 -*-
#
#
# TheVirtualBrain-Framework Package. This package holds all Data Management, and
# Web-UI helpful to run brain-simulations. To use it, you also need do download
# TheVirtualBrain-Scientific Package (for simulators). See content of the
# documentation-folder for more details. See also http://www.thevirtualbrain.org
#
# (c) 2012-2020, Baycrest Centre for Geriatric Care ("Baycrest") and others
#
# This program is free software: you can redistribute it and/or modify it under the
# terms of the GNU General Public License as published by the Free Software Foundation,
# either version 3 of the License, or (at your option) any later version.
# This program is distributed in the hope that it will be useful, but WITHOUT ANY
# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
# PARTICULAR PURPOSE.  See the GNU General Public License for more details.
# You should have received a copy of the GNU General Public License along with this
# program.  If not, see <http://www.gnu.org/licenses/>.
#
#
#   CITATION:
# When using The Virtual Brain for scientific publications, please cite it as follows:
#
#   Paula Sanz Leon, Stuart A. Knock, M. Marmaduke Woodman, Lia Domide,
#   Jochen Mersmann, Anthony R. McIntosh, Viktor Jirsa (2013)
#       The Virtual Brain: a simulator of primate brain network dynamics.
#   Frontiers in Neuroinformatics (7:10. doi: 10.3389/fninf.2013.00010)
#
#
from tvb.simulator.integrators import Integrator, IntegratorStochastic
from tvb.core.entities.file.simulator.configurations_h5 import SimulatorConfigurationH5
from tvb.core.neotraits.h5 import Scalar, Reference


class IntegratorH5(SimulatorConfigurationH5):

    def __init__(self, path):
        super(IntegratorH5, self).__init__(path)
        self.dt = Scalar(Integrator.dt, self)
        # TODO: store these?
        # self.clamped_state_variable_indices = DataSet(Integrator.clamped_state_variable_indices, self)
        # self.clamped_state_variable_values = DataSet(Integrator.clamped_state_variable_values, self)


class IntegratorStochasticH5(IntegratorH5):

    def __init__(self, path):
        super(IntegratorStochasticH5, self).__init__(path)
        self.noise = Reference(IntegratorStochastic.noise, self)

    def store(self, datatype, scalars_only=False, store_references=False):
        # type: (IntegratorStochastic) -> None
        super(IntegratorStochasticH5, self).store(datatype, scalars_only, store_references)
        noise_gid = self.store_config_as_reference(datatype.noise)
        self.noise.store(noise_gid)

    def load_into(self, datatype):
        # type: (IntegratorStochastic) -> None
        super(IntegratorStochasticH5, self).load_into(datatype)
        datatype.noise = self.load_from_reference(self.noise.load())
