Commit 37b573fd authored by Maxime Lefrançois's avatar Maxime Lefrançois
Browse files

better documentation

parent 8a1d66b4
......@@ -12,7 +12,7 @@
<h3>Device Taxonomy</h3>
<p>The main contribution of this extension is the representation of the devices defined in the IFC standard and their connections to SAREF. In this sense, a hierarchy consisting in 62 classes has been created taking into account the subset of the IFC hierarchy related to devices, as defined in the buildingSMART documentation (https://standards.buildingsmart.org/IFC/RELEASE/IFC4/ADD1/HTML/annex/annex-c/common-use-definitions/index.htm), and adding several classes to clarify its categorization. The device classes are organized into 6 hierarchical levels that, for the sake of clarity, will be displayed in <a href="Figure_2">Figure 2</a> and <a href="Figure_3">Figure 3</a>. </p>
<p>The main contribution of this extension is the representation of the devices defined in the IFC standard and their connections to SAREF. In this sense, a hierarchy consisting in 62 classes has been created taking into account the subset of the IFC hierarchy related to devices, as defined in the buildingSMART documentation (<a href="https://standards.buildingsmart.org/IFC/RELEASE/IFC4/ADD1/HTML/annex/annex-c/common-use-definitions/index.htm">https://standards.buildingsmart.org/IFC/RELEASE/IFC4/ADD1/HTML/annex/annex-c/common-use-definitions/index.htm</a>), and adding several classes to clarify its categorization. The device classes are organized into 6 hierarchical levels that, for the sake of clarity, will be displayed in <a href="Figure_2">Figure 2</a> and <a href="Figure_3">Figure 3</a>. </p>
<p><a href="Figure_2">Figure 2</a> shows the first five levels of the hierarchy. Since transport elements (<a href="#s4bldg:TransportElement">s4bldg:TransportElement</a>) and vibration isolations (<a href="#s4bldg:VibrationIsolation">s4bldg:VibrationIsolation</a>) are not classified under IFC elements, they belong directly to the class <a href="#s4bldg:Device">s4bldg:Device</a>. The building elements are divided into <a href="#s4bldg:ShadingDevice">s4bldg:ShadingDevice</a> and <a href="#s4bldg:DistributionDevice">s4bldg:DistributionDevice</a>. In fact, most of the device types included in IFC belong to the distribution device category which contains the classes <a href="#s4bldg:DistributionControlDevice">s4bldg:DistributionControlDevice</a> and <a href="#s4bldg:DistributionFlowDevice">s4bldg:DistributionFlowDevice</a>. The hierarchy under the <a href="#s4bldg:DistributionFlowDevice">s4bldg:DistributionFlowDevice</a> is depicted in <a href="Figure_3">Figure 3</a>.</p>
<p>As can be observed in <a href="Figure_2">Figure 2</a>, some classes defined in SAREF4BLDG are also defined in the SAREF ontology. More precisely, this occurs in the classes <a href="#s4bldg:Actuator">s4bldg:Actuator</a> and <a href="#s4bldg:Sensor">s4bldg:Sensor</a> that extend the classes <a href="https://saref.etsi.org/core/Actuator">saref:Actuator</a> and <a href="https://saref.etsi.org/core/Sensor">saref:Sensor</a>, respectively. This decision has been taken because in the SAREF4BLDG extension these concepts refer to specific sensors and actuators that are placed in or related to buildings. </p>
......@@ -26,13 +26,13 @@
<figcaption id="Figure_3">Figure 3: Device hierarchy in SAREF4BLDG (Part 2)</figcaption>
</figure>
<p>For each class extracted from the IFC specification, <a href="https://www.w3.org/TR/rdf-schema/#ch_label">rdfs:label</a> and <a href="https://www.w3.org/TR/rdf-schema/#ch_comment">rdfs:comment</a> annotations have been generated including the identifier and an excerpt of the definition provided in the IFC online documentation. In addition, provenance information has been included using the PROV-O ontology (https://www.w3.org/TR/prov-o/), which has been published by the W3C as recommendation. In our case, the property prov:hadPrimarySource is used to link each class with:</p>
<p>For each class extracted from the IFC specification, <a href="https://www.w3.org/TR/rdf-schema/#ch_label">rdfs:label</a> and <a href="https://www.w3.org/TR/rdf-schema/#ch_comment">rdfs:comment</a> annotations have been generated including the identifier and an excerpt of the definition provided in the IFC online documentation. In addition, provenance information has been included using the PROV-O ontology (<a href="https://www.w3.org/TR/prov-o/">https://www.w3.org/TR/prov-o/</a>), which has been published by the W3C as recommendation. In our case, the property prov:hadPrimarySource is used to link each class with:</p>
(a) the online document in IFC describing the concept; and
(b) the online document in IFC describing the properties defined for such concept.
<p>It should be noted that properties are not specified in IFC for all the concepts but just for those representing particular devices. That is, there is no description of properties for the following general classes: </p>
- <a href="#s4bldg:EnergyConversionDevice">s4bldg:EnergyConversionDevice</a>, <a href="#s4bldg:FlowController">s4bldg:FlowController</a>, <a href="#s4bldg:FlowMovingDevice">s4bldg:FlowMovingDevice</a>, <a href="#s4bldg:FlowStorageDevice">s4bldg:FlowStorageDevice</a>, <a href="#s4bldg:FlowTerminal">s4bldg:FlowTerminal</a>, and <a href="#s4bldg:FlowTreatmentDevice">s4bldg:FlowTreatmentDevice</a>.
<p>In addition, the classes created in this extension have been related to the ifcOWL ontology (https://w3id.org/ifc/IFC4_ADD1) when possible. This relation has been declared by means of the annotation property <a href="https://www.w3.org/TR/rdf-schema/#ch_seealso">rdfs:seeAlso</a> from the SAREF4BLDG classes to the ifcOWL ones.</p>
<p>In addition, the classes created in this extension have been related to the ifcOWL ontology (<a href="https://w3id.org/ifc/IFC4_ADD1">https://w3id.org/ifc/IFC4_ADD1</a>) when possible. This relation has been declared by means of the annotation property <a href="https://www.w3.org/TR/rdf-schema/#ch_seealso">rdfs:seeAlso</a> from the SAREF4BLDG classes to the ifcOWL ones.</p>
<h3>Measurements</h3>
......@@ -51,7 +51,7 @@
<p>In the SAREF4BLDG extension 179 object properties (177 defined in SAREF4BLDG and 2 reused from the SAREF and geo ontologies) and 83 datatype properties (82 defined in SAREF4BLDG and 1 reused from the SAREF ontology) have been included. 172 out the 179 object properties and 81 out of the 83 datatype properties have been created according to the IFC specification of properties for devices.</p>
<p>For each of the created object and datatype properties, their documentation from IFC has been attached as documentation, including information about their use, such as the expected units of measurement.</p>
<p>The naming of the created object and datatype properties is consistent with the naming used in IFC. More precisely, the names of the properties in the ontology are the names assigned in IFC transformed into Camel Case starting with lowercase. For example, the property "IdealShaftPower" (extracted from https://standards.buildingsmart.org/IFC/RELEASE/IFC4/ADD1/HTML/schema/ifchvacdomain/pset/pset_compressortypecommon.htm) has been transformed into the object property <a href="#s4bldg:idealShaftPower">s4bldg:idealShaftPower</a>.</p>
<p>The naming of the created object and datatype properties is consistent with the naming used in IFC. More precisely, the names of the properties in the ontology are the names assigned in IFC transformed into Camel Case starting with lowercase. For example, the property "IdealShaftPower" (extracted from <a href="https://standards.buildingsmart.org/IFC/RELEASE/IFC4/ADD1/HTML/schema/ifchvacdomain/pset/pset_compressortypecommon.htm">https://standards.buildingsmart.org/IFC/RELEASE/IFC4/ADD1/HTML/schema/ifchvacdomain/pset/pset_compressortypecommon.htm</a>) has been transformed into the object property <a href="#s4bldg:idealShaftPower">s4bldg:idealShaftPower</a>.</p>
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment