# IfcOpenShell - IFC toolkit and geometry engine
# Copyright (C) 2021 Dion Moult <dion@thinkmoult.com>
#
# This file is part of IfcOpenShell.
#
# IfcOpenShell is free software: you can redistribute it and/or modify
# it under the terms of the GNU Lesser General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# IfcOpenShell 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 Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public License
# along with IfcOpenShell.  If not, see <http://www.gnu.org/licenses/>.

import ifcopenshell
import ifcopenshell.api


class Usecase:
    def __init__(self, file: ifcopenshell.entity_instance, ifc_class: str = "IfcDistributionSystem"):
        """Add a new distribution system

        A distribution system is a group of distribution elements, like ducts,
        pipes, pumps, filters, fans, and so on that distribute a medium (air,
        liquid, or electricity) throughout a facility. Systems may be
        hierarchical, with larger systems composed of smaller subsystems.

        :param ifc_class: The type of system, chosen from IfcDistributionSystem
            for mechanical, electrical, communications, plumbing, fire, or
            security systems. Alternatively you may choose IfcBuildingSystem for
            specialised building facade systems or similar. For IFC2X3, choose
            IfcSystem.
        :type ifc_class: str
        :return: The newly created IfcSystem.
        :rtype: ifcopenshell.entity_instance.entity_instance

        Example:

        .. code:: python

            # A completely empty distribution system
            system = ifcopenshell.api.run("system.add_system", model)
        """
        self.file = file
        self.settings = {"ifc_class": ifc_class}

    def execute(self) -> ifcopenshell.entity_instance:
        ifc_class = self.settings["ifc_class"]
        # workaround for failing default argument in ifc2x3
        if self.file.schema == "IFC2X3" and ifc_class == "IfcDistributionSystem":
            ifc_class = "IfcSystem"

        return self.file.create_entity(
            ifc_class,
            **{
                "GlobalId": ifcopenshell.guid.new(),
                "OwnerHistory": ifcopenshell.api.run("owner.create_owner_history", self.file),
                "Name": "Unnamed",
            }
        )