Skip to content

#223 update URI explanation #381

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
atomczak merged 2 commits into from
May 12, 2025
Merged

#223 update URI explanation #381

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2311992
#223 update URI explanation
atomczak Nov 13, 2024
d97d3b2
Clerical fixes
CBenghi May 1, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 12 additions & 12 deletions Documentation/UserManual/classification-facet.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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. 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). |
| 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.*" |