First Commit

2026-05-31 10:17:09 +07:00
commit 17a9c69379
4547 changed files with 1170384 additions and 0 deletions
@@ -0,0 +1,71 @@
+# 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/>.
+from typing import Literal
+
+import ifcopenshell
+
+ADDRESS_TYPE = Literal["IfcPostalAddress", "IfcTelecomAddress"]
+
+
+def add_address(
+    file: ifcopenshell.file, assigned_object: ifcopenshell.entity_instance, ifc_class: ADDRESS_TYPE = "IfcPostalAddress"
+) -> ifcopenshell.entity_instance:
+    """Add a new telecom or postal address to an organisation or person
+
+    A person or organisation may have associated contact details such as
+    phone numbers, mailing addresses, websites, email addresses, and instant
+    messaging handles. This information is critical in recording the contact
+    information of manufacturers and suppliers for facility management, or
+    liable actors.
+
+    There are two types of addresses, postal addresses for physical snail
+    mail, and telecom addresses for telephone or internet contact numbers
+    and addresses.
+
+    :param assigned_object: The IfcOrganization or IfcPerson the contact
+        address belongs to.
+    :param ifc_class: Either IfcPostalAddress or IfcTelecomAddress. Defaults
+        to IfcPostalAddress.
+    :return: The new IfcPostalAddress or IfcTelecomAddress
+
+    Example:
+
+    .. code:: python
+
+        organisation = ifcopenshell.api.owner.add_organisation(model)
+
+        # A snail mail address
+        postal = ifcopenshell.api.owner.add_address(model,
+            assigned_object=organisation, ifc_class="IfcPostalAddress")
+        ifcopenshell.api.owner.edit_address(model, address=postal,
+            attributes={"Purpose": "OFFICE", "AddressLines": ["42 Wallaby Way"],
+            "Town": "Sydney", "Region": "NSW", "PostalCode": "2000"})
+
+        # A phone or internet address
+        telecom = ifcopenshell.api.owner.add_address(model,
+            assigned_object=organisation, ifc_class="IfcTelecomAddress")
+        ifcopenshell.api.owner.edit_address(model, address=telecom,
+            attributes={"Purpose": "OFFICE", "TelephoneNumbers": ["+61432466949"],
+            "ElectronicMailAddresses": ["bobthebuilder@example.com"],
+            "WWWHomePageURL": "https://thinkmoult.com"})
+    """
+    address = file.create_entity(ifc_class, "OFFICE")
+    addresses = list(assigned_object.Addresses) if assigned_object.Addresses else []
+    addresses.append(address)
+    assigned_object.Addresses = addresses
+    return address