solph._facades

Complexity

Total Complexity

5

Size/Duplication

Total Lines	43
Duplicated Lines	0 %

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	Facade.__init__()	0	4	1
A	Facade.define_subnetwork()	0	2	1
A	Facade.add_subnetwork()	0	3	1
A	Facade.sub_component_labelling()	0	5	1
A	Facade.sub_label_error()	0	7	1

# -*- coding: utf-8 -*-

"""
Solph Facade based on oemof.network.SubNetwork

SPDX-FileCopyrightText: Uwe Krien <krien@uni-bremen.de>
SPDX-FileCopyrightText: Pierre-François Duc

SPDX-License-Identifier: MIT

"""

from oemof.network import SubNetwork


class Facade(SubNetwork):
    # attributes
    def __init__(self, label, facade_type, *args, **kwargs):
        super().__init__(label=label)
        self.facade_type = facade_type
        self.define_subnetwork()

    def define_subnetwork(self):
        pass

    def add_subnetwork(self):
        """Instanciate and add Node instance to the sub network"""
        pass

    def sub_component_labelling(self, sub_label):
        """
        Method to always keep the Facade instance label in its subcomponents
        """
        return f"{self.label}_{sub_label}"

    def sub_label_error(self, sub_component):
        msg = (
            f"Sublabel ERROR in Facade instance:\n{self.label}, "
            f"{self.facade_type}, {sub_component}, "
            f"{sub_component.custom_properties}"
        )
        raise AttributeError(msg)