Postal address - how to check?

[marszulc]

Hello,
I need to check the AddressLines attribute of Postal address and I tried it in multiple ways but none of them worked.

This is one of my ideas:

<specification name="Building Address" ifcVersion="IFC2X3" description="Check if building address is xxxxxx">
		    <applicability minOccurs="1" maxOccurs="1" >
			    <entity>
				    <name>
					    <simpleValue>IFCBUILDING</simpleValue>
					</name>
				</entity>
			</applicability>
			<requirements>
				<attribute>
					<name>
					    <simpleValue>IfcPostalAddress</simpleValue>
					</name>
					<value>
						<xs:restriction base="xs:string">
                        <xs:enumeration value="xxxxx" />
                        <xs:enumeration value="yyyyy" />
			<xs:enumeration value="zzzz" />
						
                        </xs:restriction>
					</value>
				</attribute>
			</requirements>
		</specification>

Image:

Is it anyhow possible?

[atomczak]

IfcPostalAddress is a tricky entity within an entity, and that's also why it was deprecated in IFC4.3. It's better to use Pset_Address for this.

BTW, you didn't tell it that you are interested in AddressLines.

Assuming you want to achieve this in IFC2x3, I propose that you just move IfcPostalAddress to applicability and forget the IfcBuilding:

<applicability minOccurs="1" maxOccurs="1">
	<entity>
		<name>
			<simpleValue>IFCPOSTALADDRESS</simpleValue>
		</name>
	</entity>
</applicability>
<requirements>
	<attribute>
		<name>
			<simpleValue>AddressLines</simpleValue>
		</name>
		<value>
			<xs:restriction base="xs:string">
				<xs:enumeration value="xxxxx"/>
				<xs:enumeration value="yyyyy"/>
				<xs:enumeration value="zzzz"/>
			</xs:restriction>
		</value>
	</attribute>
</requirements>

[marszulc]

I tried it that way, it breaks ifcopenshell reporter creation.
I assume that was correct solution and I should report an issue to the ifcopenshell community?
@Moult Maybe you could spot the problem?

AttributeError                            Traceback (most recent call last)
Cell In[4], line 84
     81 model_number = file_name[26:31]
     83 #Run IDS0 validation
---> 84 run_ids_validation(file_name, model, ids_0, main_path)

Cell In[3], line 8, in run_ids_validation(file_name, ifc_model, ids_obj, report_path)
      6 #HTML report with ids number:
      7 reporter_obj = reporter.Html(ids_obj)
----> 8 reporter_obj.report()
      9 report_file_path = report_path + file_name.replace('.ifc',('_' + ids_obj.info['title'][:4] + '.html'))
     10 reporter_obj.to_file(report_file_path)

File ~\Documents\PYTHON PKGS\blenderbim\libs\site\packages\ifctester\reporter.py:432, in Html.report(self)
    431 def report(self) -> None:
--> 432     super().report()
    433     entity_limit = 100
    434     for spec in self.results["specifications"]:

File ~\Documents\PYTHON PKGS\blenderbim\libs\site\packages\ifctester\reporter.py:255, in Json.report(self)
    253 self.results["specifications"] = []
    254 for specification in self.ids.specifications:
--> 255     specification_report = self.report_specification(specification)
    256     self.results["specifications"].append(specification_report)
    257     total_specifications += 1

File ~\Documents\PYTHON PKGS\blenderbim\libs\site\packages\ifctester\reporter.py:344, in Json.report_specification(self, specification)
    333         if requirement.value:
    334             value = requirement.value
    335     requirements.append(
    336         ResultsRequirement(
    337             facet_type=facet_type,
    338             metadata=requirement.asdict("requirement"),
    339             label=label,
    340             value=value,
    341             description=requirement.to_string("requirement", specification, requirement),
    342             status=requirement.status,
    343             passed_entities=self.report_passed_entities(requirement),
--> 344             failed_entities=self.report_failed_entities(requirement),
    345             total_applicable=total_applicable,
    346             total_pass=total_pass,
    347             total_fail=total_fail,
    348             percent_pass=percent_pass,
    349         )
    350     )
    351 total_applicable_pass = total_applicable - len(specification.failed_entities)
    352 percent_applicable_pass = (
    353     math.floor((total_applicable_pass / total_applicable) * 100) if total_applicable else "N/A"
    354 )

File ~\Documents\PYTHON PKGS\blenderbim\libs\site\packages\ifctester\reporter.py:394, in Json.report_failed_entities(self, requirement)
    393 def report_failed_entities(self, requirement: Facet) -> list[ResultsEntity]:
--> 394     return [
    395         ResultsEntity(
    396             {
    397                 "reason": f["reason"],
    398                 "element": f["element"],
    399                 "element_type": ifcopenshell.util.element.get_type(f["element"]),
    400                 "class": f["element"].is_a(),
    401                 "predefined_type": ifcopenshell.util.element.get_predefined_type(f["element"]),
    402                 "name": getattr(f["element"], "Name", None),
    403                 "description": getattr(f["element"], "Description", None),
    404                 "id": f["element"].id(),
    405                 "global_id": getattr(f["element"], "GlobalId", None),
    406                 "tag": getattr(f["element"], "Tag", None),
    407             }
    408         )
    409         for f in requirement.failures
    410     ]

File ~\Documents\PYTHON PKGS\blenderbim\libs\site\packages\ifctester\reporter.py:399, in <listcomp>(.0)
    393 def report_failed_entities(self, requirement: Facet) -> list[ResultsEntity]:
    394     return [
    395         ResultsEntity(
    396             {
    397                 "reason": f["reason"],
    398                 "element": f["element"],
--> 399                 "element_type": ifcopenshell.util.element.get_type(f["element"]),
    400                 "class": f["element"].is_a(),
    401                 "predefined_type": ifcopenshell.util.element.get_predefined_type(f["element"]),
    402                 "name": getattr(f["element"], "Name", None),
    403                 "description": getattr(f["element"], "Description", None),
    404                 "id": f["element"].id(),
    405                 "global_id": getattr(f["element"], "GlobalId", None),
    406                 "tag": getattr(f["element"], "Tag", None),
    407             }
    408         )
    409         for f in requirement.failures
    410     ]

File ~\Documents\PYTHON PKGS\blenderbim\libs\site\packages\ifcopenshell\util\element.py:486, in get_type(element)
    483         return is_typed_by[0].RelatingType
    484     return
--> 486 if is_defined_by := element.IsDefinedBy:  # IFC2X3
    487     for relationship in is_defined_by:
    488         if relationship.is_a("IfcRelDefinesByType"):

File ~\Documents\PYTHON PKGS\blenderbim\libs\site\packages\ifcopenshell\entity_instance.py:229, in entity_instance.__getattr__(self, name)
    226         return fn(self)
    228 if attr_cat != FORWARD:
--> 229     raise AttributeError(
    230         "entity instance of type '%s' has no attribute '%s'" % (self.wrapped_data.is_a(True), name)
    231     )

AttributeError: entity instance of type 'IFC2X3.IfcPostalAddress' has no attribute 'IsDefinedBy'

[atomczak]

I didn't test that code above, turns out there was a mistake in maxOccurs. But that's not the source of the problem you get in IfcOpenShell. Can you try with the full example:

<ids:ids xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://standards.buildingsmart.org/IDS http://standards.buildingsmart.org/IDS/1.0/ids.xsd" xmlns:ids="http://standards.buildingsmart.org/IDS">
  <ids:info>
    <ids:title>example</ids:title>
  </ids:info>
  <ids:specifications>
    <ids:specification ifcVersion="IFC2X3" name="example">
        <ids:applicability minOccurs="1" maxOccurs="unbounded">
            <ids:entity>
                <ids:name>
                    <ids:simpleValue>IFCPOSTALADDRESS</ids:simpleValue>
                </ids:name>
            </ids:entity>
        </ids:applicability>
        <ids:requirements>
			<ids:attribute>
				<ids:name>
					<ids:simpleValue>AddressLines</ids:simpleValue>
				</ids:name>
				<ids:value>
					<xs:restriction base="xs:string">
                        <xs:enumeration value="xxxxx"/>
                        <xs:enumeration value="yyyyy"/>
                        <xs:enumeration value="zzzz"/>
					</xs:restriction>
				</ids:value>
			</ids:attribute>
        </ids:requirements>
    </ids:specification>
  </ids:specifications>
</ids:ids>```

Additionally, your example helped to discover another issue. Looks like the attribute restriction in 2x3 on 'AddressLines' doesn't allow any base type, but at the same time one is required. I suspect it has to do with IDS Audit tool not processing the fact that 'AddressLines' is a list, not a single-value property. I will follow up there (https://github.com/buildingSMART/IDS-Audit-tool/issues/46).

[marszulc]

I tried with the exact example you provided, and I got the same error.
BTW, why can`t I use maxOccurs = 1 ?

---------------------------------------------------------------------------
AttributeError                            Traceback (most recent call last)
Cell In[3], line 86
     83 model_number = file_name[26:31]
     85 #Run IDS0 validation
---> 86 run_ids_validation(file_name, model, ids_0, main_path)
     88 '''#Run IDS1 and IDS2 validation
     89 if model_number in sum(model_list.values(),[]):
     90     key = [key for key, val in model_list.items() if model_number in val][0]
   (...)
    100 else:
    101     print('Model number '+model_number+' not found in the list!')'''
    103 #Check bldg name

Cell In[2], line 8, in run_ids_validation(file_name, ifc_model, ids_obj, report_path)
      6 #HTML report with ids number:
      7 reporter_obj = reporter.Html(ids_obj)
----> 8 reporter_obj.report()
      9 report_file_path = report_path + file_name.replace('.ifc',('_' + ids_obj.info['title'][:4] + '.html'))
     10 reporter_obj.to_file(report_file_path)

File ~\Documents\PYTHON PKGS\blenderbim\libs\site\packages\ifctester\reporter.py:432, in Html.report(self)
    431 def report(self) -> None:
--> 432     super().report()
    433     entity_limit = 100
    434     for spec in self.results["specifications"]:

File ~\Documents\PYTHON PKGS\blenderbim\libs\site\packages\ifctester\reporter.py:255, in Json.report(self)
    253 self.results["specifications"] = []
    254 for specification in self.ids.specifications:
--> 255     specification_report = self.report_specification(specification)
    256     self.results["specifications"].append(specification_report)
    257     total_specifications += 1

File ~\Documents\PYTHON PKGS\blenderbim\libs\site\packages\ifctester\reporter.py:344, in Json.report_specification(self, specification)
    333         if requirement.value:
    334             value = requirement.value
    335     requirements.append(
    336         ResultsRequirement(
    337             facet_type=facet_type,
    338             metadata=requirement.asdict("requirement"),
    339             label=label,
    340             value=value,
    341             description=requirement.to_string("requirement", specification, requirement),
    342             status=requirement.status,
    343             passed_entities=self.report_passed_entities(requirement),
--> 344             failed_entities=self.report_failed_entities(requirement),
    345             total_applicable=total_applicable,
    346             total_pass=total_pass,
    347             total_fail=total_fail,
    348             percent_pass=percent_pass,
    349         )
    350     )
    351 total_applicable_pass = total_applicable - len(specification.failed_entities)
    352 percent_applicable_pass = (
    353     math.floor((total_applicable_pass / total_applicable) * 100) if total_applicable else "N/A"
    354 )

File ~\Documents\PYTHON PKGS\blenderbim\libs\site\packages\ifctester\reporter.py:394, in Json.report_failed_entities(self, requirement)
    393 def report_failed_entities(self, requirement: Facet) -> list[ResultsEntity]:
--> 394     return [
    395         ResultsEntity(
    396             {
    397                 "reason": f["reason"],
    398                 "element": f["element"],
    399                 "element_type": ifcopenshell.util.element.get_type(f["element"]),
    400                 "class": f["element"].is_a(),
    401                 "predefined_type": ifcopenshell.util.element.get_predefined_type(f["element"]),
    402                 "name": getattr(f["element"], "Name", None),
    403                 "description": getattr(f["element"], "Description", None),
    404                 "id": f["element"].id(),
    405                 "global_id": getattr(f["element"], "GlobalId", None),
    406                 "tag": getattr(f["element"], "Tag", None),
    407             }
    408         )
    409         for f in requirement.failures
    410     ]

File ~\Documents\PYTHON PKGS\blenderbim\libs\site\packages\ifctester\reporter.py:399, in <listcomp>(.0)
    393 def report_failed_entities(self, requirement: Facet) -> list[ResultsEntity]:
    394     return [
    395         ResultsEntity(
    396             {
    397                 "reason": f["reason"],
    398                 "element": f["element"],
--> 399                 "element_type": ifcopenshell.util.element.get_type(f["element"]),
    400                 "class": f["element"].is_a(),
    401                 "predefined_type": ifcopenshell.util.element.get_predefined_type(f["element"]),
    402                 "name": getattr(f["element"], "Name", None),
    403                 "description": getattr(f["element"], "Description", None),
    404                 "id": f["element"].id(),
    405                 "global_id": getattr(f["element"], "GlobalId", None),
    406                 "tag": getattr(f["element"], "Tag", None),
    407             }
    408         )
    409         for f in requirement.failures
    410     ]

File ~\Documents\PYTHON PKGS\blenderbim\libs\site\packages\ifcopenshell\util\element.py:486, in get_type(element)
    483         return is_typed_by[0].RelatingType
    484     return
--> 486 if is_defined_by := element.IsDefinedBy:  # IFC2X3
    487     for relationship in is_defined_by:
    488         if relationship.is_a("IfcRelDefinesByType"):

File ~\Documents\PYTHON PKGS\blenderbim\libs\site\packages\ifcopenshell\entity_instance.py:229, in entity_instance.__getattr__(self, name)
    226         return fn(self)
    228 if attr_cat != FORWARD:
--> 229     raise AttributeError(
    230         "entity instance of type '%s' has no attribute '%s'" % (self.wrapped_data.is_a(True), name)
    231     )

AttributeError: entity instance of type 'IFC2X3.IfcPostalAddress' has no attribute 'IsDefinedBy'

[atomczak]

because it is only allowed to do:

• min:1, max: unbounded
• min: 0, max: 0
• min 0, max: unbounded
  see: https://github.com/buildingSMART/IDS/blob/development/Documentation/UserManual/specifications.md#cardinality-of-the-applicability-entity

[atomczak]

Ah, I found the reason. The IfcPostalAddress is not a child of IfcObject, and only those are allowed entities in IDS. In other words, it is out of the scope for IDS. The error in IfcOpenShell says that it lacks 'IsDefinedBy' - that's because it only applies to IfcObjects.
Again, I suggest to follow the recommendation and use property for that instead: https://ifc43-docs.standards.buildingsmart.org/IFC/RELEASE/IFC4x3/HTML/lexical/IfcPostalAddress.htm

[marszulc]

Thanks