Skip to content

Commit

Permalink
Forgot to commit IfcTester fix for missing failed entities
Browse files Browse the repository at this point in the history
  • Loading branch information
Moult committed May 9, 2024
1 parent c5a7a86 commit d453adb
Show file tree
Hide file tree
Showing 3 changed files with 30 additions and 0 deletions.
13 changes: 13 additions & 0 deletions src/ifcopenshell-python/ifcopenshell/api/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,19 @@
functions that hide this complexity from you. Things like managing differences
between IFC versions, tracking owernship changes, or cleaning up after orphaned
relationships are all handled automatically.
If you're new to IFC authoring, start by looking at the following APIs:
- See :func:`ifcopenshell.api.project.create_file` to create a new IFC.
- See :func:`ifcopenshell.api.root.create_entity` to create new entities, like
the mandatory IfcProject, and then an IfcSite, IfcWall, etc.
- See :func:`ifcopenshell.api.aggregate.assign_object` to create a spatial
hierarchy.
- See :func:`ifcopenshell.api.spatial.assign_container` to place physical
elements (e.g. walls) inside spatial elements (e.g. building storeys).
Also see how to `create a simple model from scratch
<https://docs.ifcopenshell.org/ifcopenshell-python/code_examples.html#create-a-simple-model-from-scratch>`_.
"""

import json
Expand Down
16 changes: 16 additions & 0 deletions src/ifcopenshell-python/ifcopenshell/util/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -25,4 +25,20 @@
This module makes it easy to get commonly requested data from IFC
relationships, such as properties of a wall, what elements are connected to
pipes, dates from work schedules, filtering maintainable elements, and more.
The most commonly used utilities to help you get started are:
- See :mod:`ifcopenshell.util.element` which contains a lot of useful functions
for getting most common relationships on elements.
- See :func:`ifcopenshell.util.element.get_psets` to get all properties of an
entity, like a wall.
- See :func:`ifcopenshell.util.element.get_type` to get the corresponding type
object (e.g. the wall type definition) of a single occurrence (e.g. an
individual wall).
- See :func:`ifcopenshell.util.placement.get_local_placement` to get the XYZ
placement point of a single object.
- See :func:`ifcopenshell.util.unit.calculate_unit_scale` to convert between SI
units and project units.
- See :mod:`ifcopenshell.util.shape` to calculate quantities from processed
geometry.
"""
1 change: 1 addition & 0 deletions src/ifctester/ifctester/ids.py
Original file line number Diff line number Diff line change
Expand Up @@ -174,6 +174,7 @@ def __init__(
self.instructions = instructions

self.applicable_entities: list[ifcopenshell.entity_instance] = []
self.failed_entities: set[ifcopenshell.entity_instance] = set()
self.status = None

def asdict(self):
Expand Down

0 comments on commit d453adb

Please sign in to comment.