Class Entity

src/ifctester/ifctester/facet.py:182–257

class Entity(Facet):
    def __init__(self, name="IFCWALL", predefinedType=None, instructions=None):
        self.parameters = ["name", "predefinedType", "@instructions"]
        self.applicability_templates = [
            "All {name} data of type {predefinedType}",
            "All {name} data",
        ]
        self.requirement_templates = [
            "Shall be {name} data of type {predefinedType}",
            "Shall be {name} data",
        ]
        self.prohibited_templates = [
            "Shall not be {name} data of type {predefinedType}",
            "Shall not be {name} data",
        ]
        super().__init__(name, predefinedType, instructions)

    def filter(
        self, ifc_file: ifcopenshell.file, elements: Optional[list[ifcopenshell.entity_instance]] = None
    ) -> list[ifcopenshell.entity_instance]:
        if isinstance(elements, list):
            return super().filter(ifc_file, elements)

        if isinstance(self.name, str):
            try:
                results = ifc_file.by_type(self.name, include_subtypes=False)
            except:
                # If the user has specified a class that doesn't exist in the version
                results = []
                if not self.name.endswith("TYPE"):
                    try:
                        for element_type in ifc_file.by_type(f"{self.name}Type"):
                            results.extend(ifcopenshell.util.element.get_types(element_type))
                    except:
                        pass
        else:
            results = []
            ifc_classes = [t for t in ifc_file.wrapped_data.types() if t.upper() == self.name]
            for ifc_class in ifc_classes:
                try:
                    results.extend(ifc_file.by_type(ifc_class, include_subtypes=False))
                except:
                    # If the user has specified a class that doesn't exist in the version
                    continue
        if self.predefinedType:
            return [r for r in results if self(r)]
        return results

    def __call__(self, inst: ifcopenshell.entity_instance, logger: Optional[Logger] = None) -> EntityResult:
        is_pass = inst.is_a().upper() == self.name
        reason = None

        if (
            not is_pass
            and inst.file.schema == "IFC2X3"
            and not self.name.endswith("TYPE")
            and (element_type := ifcopenshell.util.element.get_type(inst))
        ):