Utility to extract documentation for all maintainable assets

src/ifccobie/get_maintainable_assets.py

@@ -0,0 +1,43 @@
+import json
+import ifcopenshell
+import ifcopenshell.util.selector
+
+with open('../ifcblenderexport/blenderbim/bim/schema/entity_descriptions.json') as f:
+    entity_descriptions = json.load(f)
+with open('../ifcblenderexport/blenderbim/bim/schema/enum_descriptions.json') as f:
+    enum_descriptions = json.load(f)
+
+print('{|class="wikitable"')
+print('! IFC Class')
+print('! Predefined Type')
+
+def print_entity(entity):
+    print('|-')
+    print('| ' + entity.name())
+    print('| ')
+    if entity.name() in entity_descriptions:
+        print('{} ... [https://standards.buildingsmart.org/IFC/DEV/IFC4_3/RC1/HTML/link/{}.htm read more]'.format(entity_descriptions[entity.name()], entity.name().lower()))
+    else:
+        print('No description provided ... [https://standards.buildingsmart.org/IFC/DEV/IFC4_3/RC1/HTML/link/{}.htm read more]'.format(entity_descriptions[entity.name()], entity.name().lower()))
+    for attribute in entity.attributes():
+        if attribute.name() == 'PredefinedType':
+            enum = attribute.type_of_attribute().declared_type()
+            print('\nThe following predefined types are defined:\n')
+            for item in enum.enumeration_items():
+                #print('|-')
+                #print('| ' + entity.name())
+                #print('| ' + item)
+                if enum.name() in enum_descriptions \
+                        and item in enum_descriptions[enum.name()]:
+                    print('* \'\'\'{}\'\'\' - {} ... [https://standards.buildingsmart.org/IFC/DEV/IFC4_3/RC1/HTML/link/{}.htm read more]'.format(item, enum_descriptions[enum.name()][item], enum.name().lower()))
+                else:
+                    print('* \'\'\'{}\'\'\' - No description provided ... [https://standards.buildingsmart.org/IFC/DEV/IFC4_3/RC1/HTML/link/{}.htm read more]'.format(item, enum.name().lower()))
+
+    for subtype in entity.subtypes():
+        print_entity(subtype)
+
+for asset in ifcopenshell.util.selector.cobie_component_assets:
+    schema = ifcopenshell.ifcopenshell_wrapper.schema_by_name('IFC4')
+    print_entity(schema.declaration_by_name(asset))
+
+print('|}')

src/ifcopenshell-python/ifcopenshell/util/selector.py

@@ -2,10 +2,7 @@ import ifcopenshell.util
 import ifcopenshell.util.element
 import lark
 
-class Selector():
+cobie_type_assets = [
-    def parse(self, ifc_file, query):
-        self.file = ifc_file
-        self.cobie_type_assets = [
     'IfcDoorStyle',
     'IfcBuildingElementProxyType',
     'IfcChimneyType',
@@ -36,7 +33,7 @@ class Selector():
     'IfcSpatialZoneType',
     'IfcWindowStyle',
 ]
-        self.cobie_component_assets = [
+cobie_component_assets = [
     'IfcBuildingElementProxy',
     'IfcChimney',
     'IfcCovering',
@@ -60,6 +57,10 @@ class Selector():
     'IfcTransportElement',
 ]
 
+class Selector():
+    def parse(self, ifc_file, query):
+        self.file = ifc_file
+
         l = lark.Lark('''start: query (lfunction query)*
                     query: selector | group
                     group: "(" query (lfunction query)* ")"
@@ -172,14 +173,14 @@ class Selector():
     def get_class_selector(self, class_selector):
         if class_selector.children[0] == 'COBie':
             elements = []
-            for ifc_class in self.cobie_component_assets:
+            for ifc_class in cobie_component_assets:
                 try:
                     elements += self.file.by_type(ifc_class)
                 except:
                     pass
         elif class_selector.children[0] == 'COBieType':
             elements = []
-            for ifc_class in self.cobie_type_assets:
+            for ifc_class in cobie_type_assets:
                 try:
                     elements += self.file.by_type(ifc_class)
                 except: