Commit 7381f4c9 authored by Maxime Lefrançois's avatar Maxime Lefrançois
Browse files

better documentation

parent 37b573fd
<h3>General Overview</h3>
<p><a href="Figure_1">Figure 1</a> presents an overview of the classes (only the top levels of the hierarchy) and the properties included in the SAREF4BLDG extension. As it can be observed the classes <a href="#s4bldg:Building">s4bldg:Building</a>, <a href="#s4bldg:BuildingSpace">s4bldg:BuildingSpace</a> and <a href="#s4bldg:PhysicalObject">s4bldg:PhysicalObject</a> have been declared as subclasses of the class geo:SpatialThing in order to reuse the conceptualization for locations already proposed by the geo ontology. The modelling of building objects and building spaces has been adapted from the SAREF ontology; in this sense, the new classes deprecate the <a href="https://saref.etsi.org/core/BuildingObject">saref:BuildingObject</a> and <a href="https://saref.etsi.org/core/BuildingSpace">saref:BuildingSpace</a> classes. In addition, a new class has been created, the <a href="#s4bldg:Building">s4bldg:Building</a> class, to represent buildings.</p>
<p><a href="#Figure_1">Figure 1</a> presents an overview of the classes (only the top levels of the hierarchy) and the properties included in the SAREF4BLDG extension. As it can be observed the classes <a href="#s4bldg:Building">s4bldg:Building</a>, <a href="#s4bldg:BuildingSpace">s4bldg:BuildingSpace</a> and <a href="#s4bldg:PhysicalObject">s4bldg:PhysicalObject</a> have been declared as subclasses of the class geo:SpatialThing in order to reuse the conceptualization for locations already proposed by the geo ontology. The modelling of building objects and building spaces has been adapted from the SAREF ontology; in this sense, the new classes deprecate the <a href="https://saref.etsi.org/core/BuildingObject">saref:BuildingObject</a> and <a href="https://saref.etsi.org/core/BuildingSpace">saref:BuildingSpace</a> classes. In addition, a new class has been created, the <a href="#s4bldg:Building">s4bldg:Building</a> class, to represent buildings.</p>
<p>The concepts <a href="#s4bldg:Building">s4bldg:Building</a> and <a href="#s4bldg:BuildingSpace">s4bldg:BuildingSpace</a> are related to each other by means of the properties <a href="#s4bldg:hasSpace">s4bldg:hasSpace</a> and <a href="#s4bldg:isSpaceOf">s4bldg:isSpaceOf</a>; such properties are defined as inverse properties among them. These properties might also be used to declare that a <a href="#s4bldg:BuildingSpace">s4bldg:BuildingSpace</a> has other spaces belonging to the class <a href="#s4bldg:BuildingSpace">s4bldg:BuildingSpace</a>.</p>
<p>The relationship between building spaces and devices and building objects has also been transferred and generalized from the SAREF ontology. In this regard, a <a href="#s4bldg:BuildingSpace">s4bldg:BuildingSpace</a> can contain (represented by the property <a href="#s4bldg:contains">s4bldg:contains</a>) individuals belonging to the class <a href="#s4bldg:PhysicalObject">s4bldg:PhysicalObject</a>. This generalization has been implemented in order to support building spaces to contain both building objects and devices. Accordingly, the classes <a href="#s4bldg:BuildingObject">s4bldg:BuildingObject</a> and <a href="https://saref.etsi.org/core/Device">saref:Device</a> are declared as subclasses of <a href="#s4bldg:PhysicalObject">s4bldg:PhysicalObject</a>.</p>
<p>Finally, the class representing building devices, namely <a href="#s4bldg:BuildingDevice">s4bldg:BuildingDevice</a>, is defined as a subclass of both <a href="https://saref.etsi.org/core/Device">saref:Device</a> and <a href="#s4bldg:BuildingObject">s4bldg:BuildingObject</a>. This class is a candidate for replacing the <a href="https://saref.etsi.org/core/BuildingRelated">saref:BuildingRelated</a> class.</p>
......@@ -12,9 +12,9 @@
<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 (<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>
<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>
<figure>
<a href="diagrams/Hierarchy1.png"><img src="diagrams/Hierarchy1.png" alt="Device hierarchy in SAREF4BLDG (Part 1)"/></a>
......@@ -37,7 +37,7 @@
<h3>Measurements</h3>
<p>Measurements are depicted in <a href="Figure_4">Figure 4</a>. This model represents an n-ary pattern that allows users to relate measurements for different properties that are measured in different units. That is, the <a href="https://saref.etsi.org/core/Measurement">saref:Measurement</a> class aims at describing a measurement of a physical quantity (using the <a href="https://saref.etsi.org/core/hasValue">saref:hasValue</a> property) for a given <a href="https://saref.etsi.org/core/Property">saref:Property</a> and according to a given <a href="https://saref.etsi.org/core/UnitOfMeasure">saref:UnitOfMeasure</a>. </p>
<p>Measurements are depicted in <a href="#Figure_4">Figure 4</a>. This model represents an n-ary pattern that allows users to relate measurements for different properties that are measured in different units. That is, the <a href="https://saref.etsi.org/core/Measurement">saref:Measurement</a> class aims at describing a measurement of a physical quantity (using the <a href="https://saref.etsi.org/core/hasValue">saref:hasValue</a> property) for a given <a href="https://saref.etsi.org/core/Property">saref:Property</a> and according to a given <a href="https://saref.etsi.org/core/UnitOfMeasure">saref:UnitOfMeasure</a>. </p>
<p>This pattern enables to differentiate between properties and the measurements made for such properties and to store measurements for a concrete property in different units of measurement.</p>
<p>Furthermore, it allows adding a timestamp (using the <a href="https://saref.etsi.org/core/hasTimeStamp">saref:hasTimeStamp</a> property) to identify when the measurement applies to the property, which can be used either for single measurements or for series of measurements (e.g. measurement streams).</p>
<p>It is worth noting that this modelling was included in SAREF2.0 after the SAREF4BLDG extension was developed. This pattern was first included in the SAREF4ENVI and SAREF4BLDG extensions and then proposed to be extrapolated to SAREF 2.0; this explains why the prefix used for this part of the model refers to SAREF instead of to SAREF4BLDG. However, as its origin is the SAREF4ENVI and SAREF4BLDG extensions requirements and modellings, the explanations are kept in the present document.</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