Skip to content

Commit

Permalink
improve URI documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@atomczak
atomczak committed May 24, 2024
1 parent 92e9583 commit 4c87893
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 3 deletions.
2 changes: 1 addition & 1 deletion Documentation/classification-facet.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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** | ❌ | ❌ | A URI identifying the classification compliant with ISO 23386 | You may find valid URIs using the [buildingSMART Data Dictionary](https://search.bsdd.buildingsmart.org/), for example for a [Uniclass-based aluminium window walls](https://identifier.buildingsmart.org/uri/nbs/uniclass2015-1/class/Pr_30_59_99_02 ) 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). |

If no parameters are specified, then it means that any **Classification** should be present, regardless of **System** name or **Reference** code.

Expand Down
3 changes: 2 additions & 1 deletion Documentation/material-facet.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,8 @@ Many disciplines, such as costing, scheduling, sustainability analysis, or const
| Parameter | Required | Restrictions Allowed | Allowed Values | Meaning |
| --------- | -------- | -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Value** | ❌ | ✔️ | Any material name or material category. The material name is typically specific to the project or local convention. The material category is recommended to be one of 'concrete', 'steel', 'aluminium', 'block', 'brick', 'stone', 'wood', 'glass', 'gypsum', 'plastic', or 'earth'. | The element must be made out of a **Material** with the specified name or category. If there are multiple **Materials**, then any **Material**, **Layer**, **Profile** or **Constituent** with that name or category will also satisfy the requirement. |
| **URI** | ❌ | ❌ | A URI identifying the material compliant with ISO 23386 | You may find valid URIs using the [buildingSMART Data Dictionary](https://search.bsdd.buildingsmart.org/). Materials are found in the data dictionary as classifications with the keyword "/mat/" in the URI. |
| **URI** | ❌ | ❌ | Uniform Resource Identifier of the material. 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 "Plywood": [https://identifier.buildingsmart.org/uri/cei-bois.org/wood/1.0.0/class/8dca70a2-01a2-489b-9381-fbeff09db8dc](https://identifier.buildingsmart.org/uri/cei-bois.org/wood/1.0.0/class/8dca70a2-01a2-489b-9381-fbeff09db8dc). |


If no parameters are specified, then it means that any **Material** should be present, regardless of name or category.

Expand Down
2 changes: 1 addition & 1 deletion Documentation/property-facet.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ It is encouraged to follow buildingSMART standardised **Properties** wherever po
| **Base Name** | ✔️ | ✔️ | Any text property name. Standardised buildingSMART property names can be found in the buildingSMART documentation. | The property must exist in the specified property set and have a non-empty value. |
| **Data Type** | ❌ | ✔️ | A valid data type compatible with the referenced schema version, expressed in UPPERCASE. | The value must use the specified data type. The units specified in the IDS use the [IDS units table](units.md), though the project may use any unit, so project values will have to be converted to the SI unit before comparison. User Interfaces are permitted to display any unit that the developers or the users prefer. |
| **Value** | ❌ | ✔️ | Any value appropriate to the data type of the property. If not specified, any non-empty value is allowed. The value of measures types will be stored according to the unit defined in the [IDS units table](units.md) | The value of the property must match, see [DataType documentation](DataTypes.md#xml-base-types) for more information. |
| **URI** | ❌ | ❌ | A URI identifying the property compliant with ISO 23386 | You may find valid URIs using the [buildingSMART Data Dictionary](https://search.bsdd.buildingsmart.org/), for example for a [Fire Rating](https://search.bsdd.buildingsmart.org/Property/Index/115666) property. |
| **URI** | ❌ | ❌ | Uniform Resource Identifier of the property. 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 "Fire Rating": [https://identifier.buildingsmart.org/uri/buildingsmart/ifc/4.3/prop/FireRating](https://identifier.buildingsmart.org/uri/buildingsmart/ifc/4.3/prop/FireRating). |

## Examples

Expand Down

0 comments on commit 4c87893

Please sign in to comment.