ALLEN INSTITUTE

# Source code for bmtk.simulator.popnet.popedge

    # Copyright 2017. Allen Institute. All rights reserved
    #
    # Redistribution and use in source and binary forms, with or without modification, are permitted provided that the
    # following conditions are met:
    #
    # 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following
    # disclaimer.
    #
    # 2. 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.
    #
    # 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote
    # products derived from this software without specific prior written permission.
    #
    # 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.
    #

    class SimEdge(object):
        def __init__(self, original_params, dynamics_params):
            self._orig_params = original_params
            self._dynamics_params = dynamics_params
            self._updated_params = {'dynamics_params': self._dynamics_params}

        @property
        def edge_type_id(self):
            return self._orig_params['edge_type_id']

        def __getitem__(self, item):
            if item in self._updated_params:
                return self._updated_params[item]
            else:
                return self._orig_params[item]

    class PopEdge(SimEdge):
        def __init__(self, source_pop, target_pop, edge_params, dynamics_params):
            super(PopEdge, self).__init__(edge_params, dynamics_params)
            self.__source_pop = source_pop
            self.__target_pop = target_pop
            self._weight = self.__get_prop('weight', 0.0)
            self._nsyns = self.__get_prop('nsyns', 0)
            self._delay = self.__get_prop('delay', 0.0)

        @property
        def source(self):
            return self.__source_pop

        @property
        def target(self):
            return self.__target_pop

        @property
        def params(self):
            return self._orig_params

        @property
        def weight(self):
            return self._weight

        @weight.setter
        def weight(self, value):
            self._weight = value

        @property
        def nsyns(self):
            return self._nsyns

        @nsyns.setter
        def nsyns(self, value):
            self._nsyns = value

        @property
        def delay(self):
            return self._delay

        @delay.setter
        def delay(self, value):
            self._delay = value

        def __get_prop(self, name, default=None):
            if name in self._orig_params:
                return self._orig_params[name]
            elif name in self._dynamics_params:
                return self._dynamics_params[name]
            else:
                return default

        def __repr__(self):
            relevant_params = "weight: {}, delay: {}, nsyns: {}".format(self.weight, self.delay, self.nsyns)
            rstr = "{} --> {} {{{}}}".format(self.source.pop_id, self.target.pop_id, relevant_params)
            return rstr