remove deprecated api method type.get_related_objects

This commit is contained in:
Andrej730
2024-05-09 18:04:25 +05:00
parent bdc5a7a01b
commit b2920996be
2 changed files with 0 additions and 59 deletions
@@ -26,7 +26,6 @@ Using types is critical to the success of any project.
from .. import wrap_usecases
from .assign_type import assign_type
from .get_related_objects import get_related_objects
from .map_type_representations import map_type_representations
from .unassign_type import unassign_type
@@ -1,58 +0,0 @@
# 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
def get_related_objects(file, related_object=None, relating_type=None) -> None:
"""Gets all the related occurrences of a type
Do not use this function. It will be removed. Use
ifcopenshell.util.element.get_type or
ifcopenshell.util.element.get_types instead.
:param related_object: The IfcElement occurrence.
:type related_object: ifcopenshell.entity_instance
:param relating_type: The IfcElementType type.
:type relating_type: ifcopenshell.entity_instance
:return: A list of occurrences of the type.
:rtype: list[ifcopenshell.entity_instance]
"""
settings = {
"related_object": related_object,
"relating_type": relating_type,
}
if settings["related_object"]:
if file.schema == "IFC2X3":
is_defined_by = settings["related_object"].IsDefinedBy
for rel in is_defined_by:
if rel.is_a("IfcRelDefinesByType"):
return set([int(o.id()) for o in rel.RelatedObjects])
else:
is_typed_by = settings["related_object"].IsTypedBy
if is_typed_by:
return set([int(o.id()) for o in is_typed_by[0].RelatedObjects])
elif settings["relating_type"]:
if file.schema == "IFC2X3":
types = settings["relating_type"].ObjectTypeOf
else:
types = settings["relating_type"].Types
if types:
return set([int(o.id()) for o in types[0].RelatedObjects])
return set()