mirror of
https://github.com/IfcOpenShell/IfcOpenShell.git
synced 2026-08-09 09:21:46 +00:00
Dion Moult
64 lines
2.4 KiB
Python
64 lines
2.4 KiB
Python
# 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, Name="Unnamed", Description=None):
|
|
"""Adds a new group
|
|
|
|
An IFC group is an arbitrary collection of products, which are typically
|
|
physical. It may be used when there is no other more specific group
|
|
which may be used. Other types of groups include distribution systems,
|
|
which group together products that are connected and circulate a medium
|
|
(such as fluid or electricity), or zones, which group together spaces,
|
|
or structural load groups, which group together loads for structural
|
|
analysis, or inventories, which are groups of assets.
|
|
|
|
:param Name: The name of the group. Defaults to "Unnamed"
|
|
:type Name: str, optional
|
|
:param Description: The description of the purpose of the group.
|
|
:type Description: str, optional
|
|
:return: The newly created IfcGroup
|
|
:rtype: ifcopenshell.entity_instance.entity_instance
|
|
|
|
Example:
|
|
|
|
.. code:: python
|
|
|
|
ifcopenshell.api.run("group.add_group", model, Name="Unit 1A")
|
|
"""
|
|
self.file = file
|
|
self.settings = {
|
|
"Name": Name or "Unnamed",
|
|
"Description": Description,
|
|
}
|
|
|
|
def execute(self):
|
|
return self.file.create_entity(
|
|
"IfcGroup",
|
|
**{
|
|
"GlobalId": ifcopenshell.guid.new(),
|
|
"OwnerHistory": ifcopenshell.api.run("owner.create_owner_history", self.file),
|
|
"Name": self.settings["Name"],
|
|
"Description": self.settings["Description"],
|
|
}
|
|
)
|