#!/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.morphology.core import Region

[docs]class Targeter(object):

[docs]    def __init__(self, priority, **kwargs):
        super(Targeter,self).__init__(**kwargs)
        self.priority = priority

[docs]    def get_priority(self):
        return self.priority
        #raise NotImplementedError()

[docs]    def does_target_section(self, section):
        raise NotImplementedError()

[docs]    def get_description(self):
        raise NotImplementedError()


[docs]class PassiveTargetterEverywhereDefault(Targeter):

[docs]    def __init__(self, priority=0, **kwargs):
        super(PassiveTargetterEverywhereDefault, self).__init__(priority=priority,**kwargs)

[docs]    def does_target_section(self, section):
        return True

[docs]    def get_description(self):
        return 'Default'


[docs]class PassiveTargetterEverywhere(Targeter):

[docs]    def __init__(self, priority=5, **kwargs):
        super(PassiveTargetterEverywhere, self).__init__(priority=priority, **kwargs)

[docs]    def does_target_section(self, section):
        return True

[docs]    def get_description(self):
        return 'Everywhere'


[docs]class PassiveTargetterRegion(Targeter):

[docs]    def __init__(self, region, priority=10, **kwargs):
        super(PassiveTargetterRegion, self).__init__(priority=priority, **kwargs)
        self.region = region

[docs]    def does_target_section(self, section):
        return section.region == self.region

[docs]    def get_description(self):
        return 'Passive-Region:%s' % self.region.name





[docs]class ChannelTargeterEverywhere(Targeter):
[docs]    def __init__(self, priority=10, **kwargs):
        super(ChannelTargeterEverywhere,self).__init__(priority=priority, **kwargs)


[docs]    def does_target_section(self, section):
        return True

[docs]    def get_description(self):
        return 'Everywhere'


[docs]class ChannelTargeterRegion(Targeter):

[docs]    def __init__(self, region, priority=20, **kwargs):
        super(ChannelTargeterRegion, self).__init__(priority=priority, **kwargs)
        assert isinstance(region, Region)
        self.region = region


[docs]    def does_target_section(self, section):
        return section.region == self.region

[docs]    def get_description(self):
        region_name = self.region.name
        return 'Region: %s' % region_name


[docs]class ChannelTargeterSectionPath(Targeter):

[docs]    def does_target_section(self, section):
        assert False

[docs]    def get_description(self):
        return 'MM-SectionPath: ??'


[docs]class ChannelTargeterSection(Targeter):

[docs]    def __init__(self, section, priority=40, **kwargs):
        super(ChannelTargeterSection, self).__init__(priority=priority, **kwargs)
        self.section = section


[docs]    def does_target_section(self, section):
        return self.section == section

[docs]    def get_description(self):
        if self.section.idtag:
            section_desc = self.section.idtag
        else:
            section_desc = '[No idtag]'
        return 'Section: %s' % section_desc