From 2311992eee825f5070ef0cc0897e124cb99cf1cc Mon Sep 17 00:00:00 2001 From: ArturTomczak Date: Wed, 13 Nov 2024 15:33:40 +0100 Subject: [PATCH 1/2] #223 update URI explanation --- Documentation/UserManual/classification-facet.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Documentation/UserManual/classification-facet.md b/Documentation/UserManual/classification-facet.md index a2636427..8dc55981 100644 --- a/Documentation/UserManual/classification-facet.md +++ b/Documentation/UserManual/classification-facet.md @@ -14,7 +14,7 @@ IFC models keep track of **Classification** names, dates, versions, and other da | ---------- | -------- | -------------------- | -------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **System** | ✔️ | ✔️ | The name of the **Classification System** | The element must be classified with a reference that is part of a classification system with this name | | **Value** | ❌ | ✔️ | The value of a **Refeference** code in the **Classification System** | The element must be classified with a **Reference** which has a code that matches this value. The value is typically a short code with a separating character that denotes the level of classification | -| **URI** | ❌ | ❌ | Uniform Resource Identifier of the class. The resource should include a name and a definition, and preferably comply with ISO 23386. | One source of valid URIs is [the bSDD](https://search.bsdd.buildingsmart.org/). An example URI for a "beam": [https://identifier.buildingsmart.org/uri/buildingsmart/ifc/4.3/class/IfcBeam](https://identifier.buildingsmart.org/uri/buildingsmart/ifc/4.3/class/IfcBeam). | +| **URI** | ❌ | ❌ | Uniform Resource Identifier of the class. | Used to reference a standardized definition of a class, to ensure consistentcy of interpretation. The target resource should include a name and definition, and preferably comply with the ISO 23386. This is an optional attribute that is not subject to IDS checking - the IFC model does not need to have the same or any URI. One source of valid URIs is [the bSDD](https://search.bsdd.buildingsmart.org/), and an example URI is that of a "Beam": [https://identifier.buildingsmart.org/uri/buildingsmart/ifc/4.3/class/IfcBeam](https://identifier.buildingsmart.org/uri/buildingsmart/ifc/4.3/class/IfcBeam). | If no parameters are specified, then it means that any **Classification** should be present, regardless of **System** name or **Reference** code. From d97d3b285e7dea80cdb949c10607e2f0e3fea1ef Mon Sep 17 00:00:00 2001 From: Claudio Benghi Date: Thu, 1 May 2025 09:47:28 +0100 Subject: [PATCH 2/2] Clerical fixes Removed markdownlint warnings and typo identified by @andyward. --- .../UserManual/classification-facet.md | 24 +++++++++---------- 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/Documentation/UserManual/classification-facet.md b/Documentation/UserManual/classification-facet.md index 8dc55981..24d80cdb 100644 --- a/Documentation/UserManual/classification-facet.md +++ b/Documentation/UserManual/classification-facet.md @@ -10,20 +10,20 @@ IFC models keep track of **Classification** names, dates, versions, and other da ## Parameters -| Parameter | Required | Restrictions Allowed | Allowed Values | Meaning | -| ---------- | -------- | -------------------- | -------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| **System** | ✔️ | ✔️ | The name of the **Classification System** | The element must be classified with a reference that is part of a classification system with this name | -| **Value** | ❌ | ✔️ | The value of a **Refeference** code in the **Classification System** | The element must be classified with a **Reference** which has a code that matches this value. The value is typically a short code with a separating character that denotes the level of classification | -| **URI** | ❌ | ❌ | Uniform Resource Identifier of the class. | Used to reference a standardized definition of a class, to ensure consistentcy of interpretation. The target resource should include a name and definition, and preferably comply with the ISO 23386. This is an optional attribute that is not subject to IDS checking - the IFC model does not need to have the same or any URI. One source of valid URIs is [the bSDD](https://search.bsdd.buildingsmart.org/), and an example URI is that of a "Beam": [https://identifier.buildingsmart.org/uri/buildingsmart/ifc/4.3/class/IfcBeam](https://identifier.buildingsmart.org/uri/buildingsmart/ifc/4.3/class/IfcBeam). | +| Parameter | Required | Restrictions Allowed | Allowed Values | Meaning | +| ---------- | -------- | -------------------- | -------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| **System** | ✔️ | ✔️ | The name of the **Classification System** | The element must be classified with a reference that is part of a classification system with this name | +| **Value** | ❌ | ✔️ | The value of a **Refeference** code in the **Classification System** | The element must be classified with a **Reference** which has a code that matches this value. The value is typically a short code with a separating character that denotes the level of classification | +| **URI** | ❌ | ❌ | Uniform Resource Identifier of the class. | Used to reference a standardized definition of a class, to ensure consistency of interpretation. The target resource should include a name and definition, and preferably comply with the ISO 23386. This is an optional attribute that is not subject to IDS checking - the IFC model does not need to have the same or any URI. One source of valid URIs is [the bSDD](https://search.bsdd.buildingsmart.org/), and an example URI is that of a "Beam": [https://identifier.buildingsmart.org/uri/buildingsmart/ifc/4.3/class/IfcBeam](https://identifier.buildingsmart.org/uri/buildingsmart/ifc/4.3/class/IfcBeam). | If no parameters are specified, then it means that any **Classification** should be present, regardless of **System** name or **Reference** code. ## Examples -Applicability Intention | Requirement Intention | Facet Definition ---- | --- | --- -Any classified element | The entity must be classified | No parameters -Any entity classified using OmniClass | The entity must be classified using OmniClass | System="OmniClass" -Any entity classified with either OmniClass or Uniclass 2015 | The entity must be classified using either OmniClass or Uniclass 2015 | System=["OmniClass", "Uniclass 2015"] -Any entity with a classification reference of "EF_25_10_25" | The element (e.g. a wall) must be classified using the reference "EF_25_10_25" | Value="EF_25_10_25" -Any element with a Uniclass 2015 classification reference starting with EF_25_10 | The entity (e.g. a wall) must use Uniclass 2015 and have are reference starting with EF_25_10 | System="Uniclass 2015", Value="EF_25_10.*" +| Applicability Intention | Requirement Intention | Facet Definition | +| -------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | ------------------------------------------ | +| Any classified element | The entity must be classified | No parameters | +| Any entity classified using OmniClass | The entity must be classified using OmniClass | System="OmniClass" | +| Any entity classified with either OmniClass or Uniclass 2015 | The entity must be classified using either OmniClass or Uniclass 2015 | System=["OmniClass", "Uniclass 2015"] | +| Any entity with a classification reference of "EF_25_10_25" | The element (e.g. a wall) must be classified using the reference "EF_25_10_25" | Value="EF_25_10_25" | +| Any element with a Uniclass 2015 classification reference starting with EF_25_10 | The entity (e.g. a wall) must use Uniclass 2015 and have are reference starting with EF_25_10 | System="Uniclass 2015", Value="EF_25_10.*" |