Commit 159722f8 authored by María's avatar María
Browse files

replaced old documentation

parent 39ac5097
Loading
Loading
Loading
Loading
+26 −36
Original line number Diff line number Diff line
@@ -11,37 +11,13 @@ function loadHash() {
	if($(hash).offset()!=null){
	  $('html, body').animate({scrollTop: $(hash).offset().top}, 0);
	}
	loadTOC();
}function loadTOC(){
	//process toc dynamically
	  var t='<h2>Table of contents</h2><ul>';i = 1;j=0;
	  jQuery(".list").each(function(){
		if(jQuery(this).is('h2')){
			if(j>0){
				t+='</ul>';
				j=0;
			}
			t+= '<li>'+i+'. <a href=#'+ jQuery(this).attr('id')+'>'+ jQuery(this).text()+'</a></li>';
			i++;
		}
		if(jQuery(this).is('h3')){
			if(j==0){
				t+='<ul>';
			}
			j++;
			t+= '<li>'+(i-1)+'.'+j+'. '+'<a href=#'+ jQuery(this).attr('id')+'>'+ jQuery(this).text()+'</a></li>';
		}
		t = t.replace(' back to ToC','');
	  });
	  t+='</ul>';
	  $("#toc").html(t); 
}    $(function(){
      $("#abstract").load("sections/abstract-en.html"); 
      $("#introduction").load("sections/introduction-en.html"); 
      $("#overview").load("sections/overview-en.html"); 
      $("#description").load("sections/description-en.html"); 
      $("#references").load("sections/references-en.html"); 
      $("#crossref").load("sections/crossref-en.html", null, loadHash); 
      $("#references").load("sections/references-en.html"); 
    });
    </script> 
  </head> 
@@ -55,32 +31,46 @@ function loadHash() {
<h1 property="dc:title schema:name">SAREF extension for building devices</h1>
<dl>
<dt>This version:</dt>
<dd><a href="http://saref.linkeddata.es/def/v1/bldg">http://saref.linkeddata.es/def/v1/bldg</a></dd>
<dd><a href="https://w3id.org/def/saref4bldg">https://w3id.org/def/saref4bldg</a></dd>
</dl><dt>Revision:</dt>
<dd property="schema:version">1.0</dd>
<dl><dt>Authors:</dt>
<dd><a property="dc:creator schema:author prov:wasAttributedTo" resource="http://purl.org/net/mpoveda" href="http://purl.org/net/mpoveda">http://purl.org/net/mpoveda</a></dd><dd><a property="dc:creator schema:author prov:wasAttributedTo" resource="http://www.garcia-castro.com/foaf.rdf#me" href="http://www.garcia-castro.com/foaf.rdf#me">http://www.garcia-castro.com/foaf.rdf#me</a></dd></dl>
<dd><a property="dc:creator schema:author prov:wasAttributedTo" resource="http://purl.org/net/mpoveda" href="http://purl.org/net/mpoveda">María Poveda Villalón</a></dd><dd><a property="dc:creator schema:author prov:wasAttributedTo" resource="http://www.garcia-castro.com/foaf.rdf#me" href="http://www.garcia-castro.com/foaf.rdf#me">Raúl García Castro</a></dd></dl>

<dl><dt>Download serialization:</dt><dd><span><a href="ontology.n3" target="_blank"><img src="https://img.shields.io/badge/Format-N_Triples-blue.svg"</img></a> </span><span><a href="ontology.xml" target="_blank"><img src="https://img.shields.io/badge/Format-RDF/XML-blue.svg"</img></a> </span><span><a href="ontology.ttl" target="_blank"><img src="https://img.shields.io/badge/Format-TTL-blue.svg"</img></a> </span></dd></dl><dl><dt>License: </dt><dd><a rel="license" href="http://purl.org/NET/rdflicense/cc-by4.0" target="_blank"><img src ="https://img.shields.io/badge/License-Creative Commons CC_BY-blue.svg"</img></a>

<dl><dt>Download serialization:</dt><dd><span><a href="ontology.n3" target="_blank"><img src="https://img.shields.io/badge/Format-N_Triples-blue.svg" alt="N-Triples"></img></a> </span><span><a href="ontology.xml" target="_blank"><img src="https://img.shields.io/badge/Format-RDF/XML-blue.svg" alt="RDF/XML"></img></a> </span><span><a href="ontology.ttl" target="_blank"><img src="https://img.shields.io/badge/Format-TTL-blue.svg" alt="TTL"></img></a> </span></dd></dl><dl><dt>License: </dt><dd><a rel="license" href="http://purl.org/NET/rdflicense/cc-by4.0" target="_blank"><img src ="https://img.shields.io/badge/License-null-blue.svg" alt="http://purl.org/NET/rdflicense/cc-by4.0"></img></a>
<span property="dc:license" resource="http://purl.org/NET/rdflicense/cc-by4.0"></span>
<a property="dc:rights" href="http://purl.org/NET/rdflicense/cc-by4.0" rel="license" target="_blank">
<img src="null" style="border-width:0" alt="License"></img>
</a>
<br/></dd></dl><dl><a href="provenance/provenance-en.html" target="_blank">Provenance of this page</a></dl><hr/>
</div>
<div class="status">
<div>
<span>Specification Draft</span>
<span>SAREF4BLDG Specification</span>
</div>
</div>     <div id="abstract"></div>
<div id="toc"></div>     <div id="introduction"></div>
<div id="toc"><h2>Table of contents</h2>
<ul>
<li><a href="#introduction">1. Introduction</a></li>
<ul><li><a href="#namespacedeclarations">1.1 Namespace declarations</a></li></ul>
<li><a href="#overview">2. bldg: Overview</a></li>
<li><a href="#description">3. bldg: Description</a></li>
<li><a href="#crossref">4. Cross reference for bldg classes, properties and dataproperties</a></li>
<ul>
<li><a href="#classes">4.1 Classes</a></li>
<li><a href="#objectproperties">4.2 Object Properties</a></li>
        <li><a href="#dataproperties">4.3 Data Properties</a></li>
</ul>
<li><a href="#references">5. References</a></li>
<li><a href="#acknowledgements">6. Acknowledgements</a></li>
</ul>
</div>
     <div id="introduction"></div>
     <div id="overview"></div>
     <div id="description"></div>
     <div id="crossref"></div>
     <div id="references"></div>
<div id="acknowledgements">
<h2 id="ack" class="list">Acknowledgements <span class="backlink"> back to <a href="#toc">ToC</a></span></h2>
<p>The authors would like to thank <a href="http://www.essepuntato.it/">Silvio Peroni</a> for developing <a href="http://www.essepuntato.it/lode">LODE</a>, a Live OWL Documentation Environment, which is used for representing the Cross Referencing Section of this document and <a href="https://w3id.org/people/dgarijo">Daniel Garijo</a> for developing <a href="https://github.com/dgarijo/Widoco">Widoco</a>, the program used to create the template used in this documentation.</p>
<h2>6. Acknowledgements <span class="backlink"> back to <a href="#toc">ToC</a></span></h2>
<p>The authors would like to thank <a href="http://www.essepuntato.it/">Silvio Peroni</a> for developing <a href="http://www.essepuntato.it/lode">LODE</a>, a Live OWL Documentation Environment, which is used for representing the Cross Referencing Section of this document and <a href="http://purl.org/net/dgarijo">Daniel Garijo</a> for developing <a href="https://github.com/dgarijo/Widoco">Widoco</a>, the program used to create the document template used in this documentation.</p>
</div>
</body> 
</html>
 No newline at end of file
+2 −1
Original line number Diff line number Diff line
<h2>Abstract</h2><p>This is a place holder text for the abstract. The abstract should contain a couple of sentences summarizing the ontology and its prupose.</p>
<h2>Abstract</h2><p>The present document presents the SAREF4BLDG ontology, an extension of SAREF for the building domain based on the ISO 16739 standard (IFC).
</p>
+1711 −1711

File changed.

Preview size limit exceeded, changes collapsed.

+68 −2
Original line number Diff line number Diff line
<h2 id="desc" class="list">bldg: Description <span class="backlink"> back to <a href="#toc">ToC</a></span></h2>
<p>This is a placeholder text for the description of your ontology. The description should include an explanation and a diagram explaining how the classes are related, examples of usage, etc.</p>
<h2>3. bldg: Description <span class="backlink"> back to <a href="#toc">ToC</a></span></h2>

<p>Figure 1 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 s4bldg:Building, s4bldg:BuildingSpace and s4bldg:PhysicalObject 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 saref:BuildingObject and saref:BuildingSpace classes. In addition, a new class has been created, the s4bldg:Building class, to represent buildings.</p>

<p>
The concepts s4bldg:Building and s4bldg:BuildingSpace are related to each other by means of the properties s4bldg:hasSpace and s4bldg:isSpaceOf; such properties are defined as inverse properties among them. These properties might also be used to declare that a s4bldg:BuildingSpace has other spaces belonging to the class s4bldg:BuildingSpace.</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, we can see that a s4bldg:BuildingSpace can contain (represented by the property s4bldg:contains) individuals belonging to the class s4bldg:PhysicalObject. This generalization has been implemented in order to support building spaces to contain both building objects and devices. Accordingly, the classes s4bldg:BuildingObject and saref:Device are declared as subclasses of s4bldg:PhysicalObject.</p>

<center><img src="resources/images/saref4bldg3.png" alt="General overview of the top levels of the SAREF4BLDG extension.">   <figcaption>Figure 1. - General overview of the top levels of the SAREF4BLDG extension.</figcaption></center>

<p>The device classes are organized into 6 hierarchical levels that, for the sake of clarity, will be displayed in Figure 2 and Figure 3.</p>

<p>Figure 2 shows the first five levels of the hierarchy. Since transport elements (s4bldg:TransportElement) and vibration isolations (s4bldg:VibrationIsolation) are not classified under IFC elements, they belong directly to the class s4bldg:Device. The building elements are divided into s4bldg:ShadingDevice and s4bldg:DistributionDevice. In fact, most of the device types included in IFC belong to the distribution device category which contains the classes s4bldg:DistributionControlDevice and s4bldg:DistributionFlowDevice. The hierarchy under the s4bldg:DistributionFlowDevice is depicted in Figure 3.</p>

<p>As can be observed in Figure 2, some classes defined in SAREF4BLDG are also defined in the SAREF ontology. More precisely, this occurs in the classes s4bldg:Actuator and s4bldg:Sensor that extend the classes saref:Actuator and saref:Sensor, 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>


<center><img src="resources/images/saref4bldg1.png" alt="Device hierarchy in SAREF4BLDG (Part 1).">   <figcaption>Figure 2. - Device hierarchy in SAREF4BLDG (Part 1).</figcaption></center>

<p>For each class extracted from the IFC specification, rdfs:label and rdfs:comment 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 <a href="https://www.w3.org/TR/prov-o/">PROV-O ontology</a>, which has been published by the W3C as recommendation. In our case, the property prov:hadPrimarySource is used to link each class with (a) the online document in IFC describing the concept and (b) the online document in IFC describing the properties defined for such concept. 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: s4bldg:EnergyConversionDevice, s4bldg:FlowController, s4bldg:FlowMovingDevice, s4bldg:FlowStorageDevice, s4bldg:FlowTerminal, and s4bldg:FlowTreatmentDevice.</p>

<p>In addition, the classes created in this extension have been related to the <a href="https://w3id.org/ifc/IFC4_ADD1">ifcOWL ontology</a> when possible. This relation has been declared by means of the annotation property rdfs:seeAlso from the SAREF4BLDG classes to the ifcOWL ones.</p>



 

<center><img src="resources/images/saref4bldg2.png" alt="Device hierarchy in SAREF4BLDG (Part 2).">   <figcaption>Figure 3. - Device hierarchy in SAREF4BLDG (Part 2).</figcaption></center>


<h3>Instantiating SAREF4BLDG <span class="backlink"> back to <a href="#toc">ToC</a></span></h3>

<p>This section shows an example of instantiation of the SAREF4BLDG ontology. Such example aims to illustrate how to describe a given device that can be found in a building, in this case a compressor, using the SAREF4BLDG ontology.  In addition, the example is complemented with energy consumption information for which the SAREF4ENER ontology is used. The example is graphically represented in Figure 4, Figure 5 and Figure 6 and the corresponding Turtle code is provided in <a href="http://saref.linkeddata.es/data/bldg/example1">example code</a>.</p>

<p>Figure 4 represents the core part of the example. In such figure a compressor of type SIERRA 02-0434C3 is depicted by a purple box. This purple box represents the instance ex:Compressor001SIERRA02-0434C3 that belongs to the class s4bldg:Compressor. This compressor is named “Compressor 001 SIERRA 02-0434C3” and is manufactured by “SIEMENS” as indicated by the values of the datatype properties saref:hasName and saref:hasManufacturer.</p>

<p>The refrigerant used by the compressor is R407C which is a hydrofluorocarbon. This information is represented by the datatype property s4bldg:refrigerantClass and the value expressed “HFC” that refers to hydrofluorocarbon according to IFC.</p>

<p>The fact that the compressor is motor driven is indicated by the datatype property s4bldg:powerSource and the associated literal value. Besides, since the compressor has no hot gas by pass, the value for the datatype property s4bldg:hasHotGasByPass is set to the Boolean “False”.</p>

<p>So far we have shown values that are represented directly by a datatype property and in which only one triple is involved. Next we present those descriptions about the compressor that need to instantiate an n-ary pattern in order to relate the value for a given property with the unit of measurement in which such value is provided.</p>

<p>In order to indicate the compressor speed, we need to have an instance linking the value “3.0” with the unit of measurement of such value, in this case cycles per second. For doing so we have created the instance ex:CompressorSpeedCompressor001SIERRA02-0434C3 that belongs to the class saref:Measurement. The compressor is linked to such instance by means of the property s4bldg:compressorSpeed. Finally, this new instance represents the value of the compressor speed by means of the datatype property saref:hasValue and the unit of measurement by the object property saref:isMeasuredIn. The specific unit of measurement is represented by the instance ex:cyclesPerSecond that belongs to the class saref:UnitOfMeasure.</p>

<p>The same pattern is used to represent the ideal capacity of the compressor, the nominal capacity and the impeller diameter using the object properties s4bldg:idealCapacity, s4bldg:nominalCapacity and s4bldg:impellerDiameter, respectively, between the compressor and the new instance created in each case. It is worth noting that in each case the unit of measurement used has been adapted according to the needs, for example using watts (represented by the instance wurvoc:watt) for the measurements about capacity and using inches (represented by the instance wurvoc:inch-international) for the measurement about the diameter.</p>

<center><img src="resources/images/saref4bldgEx1.png" alt="Compressor description example.">   <figcaption>Figure 4. - Compressor description example.</figcaption></center>

<p>Figure 5 complements the compressor description including location information also provided by the SAREF4BLDG ontology. In this case we can observe the geographical coordinates of the compressor (40.405155, -3.839203) represented by the instance of the class geo:SpatialThing named ex:LocationCompressor001SIERRA02-0434C3. Such instance indicates the value of the coordinates by means of the properties geo:latitude and geo:longitude. The compressor is linked to such instance by means of the object property geo:location.</p>

<p>It is also shown that the compressor is located in the refrigeration store of the building 1 in a Computer Science faculty. </p>

<p>The refrigeration store is represented by the instance ex:RefrigerationStoreComputerScienceBuilding1 that belongs to the class s4bldg:BuildingSpace. And the computer science building is represented by the instance ex:ComputerScienceBuilding1 that belongs to the class s4bldg:Building.</p>

<p>It is indicated that the compressor is located in the refrigeration store by means of the object property s4bldg:isContainedIn established between the instance representing the compressor and the instance representing the refrigeration store.</p>

<p>The fact that the refrigeration store belongs to the building 1 is represented by means of the object property s4bldg:isSpaceOf established between the instance representing the refrigeration store and the instance representing the building.</p>

<p>The geographical coordinates of the refrigeration store and the building are indicated following the same pattern as for the compressor by means of the object property geo:location and the creation of an instance from which the values of the latitude and longitude are linked.</p>


<center><img src="resources/images/saref4bldgEx2.png" alt="Compressor location example.">   <figcaption>Figure 5. - Compressor location example.</figcaption></center>

<p>Figure 6 shows an example that combines ontological elements from the SAREF4BLDG ontology with the SAREF4ENER one. More precisely, it indicates the power consumption of the compressor described above. For doing so, the instance representing the compressor, namely ex:Compressor001SIERRA02-0434C3, is linked to an instance named ex:PowerProfileCompressor001SIERRA02-0434C3 that belongs to the class s4ee:PowerProfile, which represents the power profile of the compressor. This later instance indicates the compressor power consumption by linking, using the object property saref:hasConsumption, to an instance named ex:PowerCompressor001SIERRA02-0434C3 that belongs to the class s4ener:Power. Finally, this instance indicates the power consumption value “902.0” by means of the datatype property saref:hasValue and the unit in which such value is measured by means of the object property saref:isMeasuredIn that points to the instance wurvoc:watt. 
</p>

<center><img src="resources/images/saref4bldgEx3.png" alt="Compressor related to the energy extension example.">   <figcaption>Figure 6. - Compressor related to the energy extension example.</figcaption></center>
 No newline at end of file
+15 −4
Original line number Diff line number Diff line
<h2 id="intro" class="list">Introduction <span class="backlink"> back to <a href="#toc">ToC</a></span></h2>
<p>This is a place holder text for the introduction. The introduction should briefly describe the ontology, its motivation, state of the art and goals.</p>
<h2>1. Introduction <span class="backlink"> back to <a href="#toc">ToC</a></span></h2>
<p>A more efficient interaction and integration of actors, methods and tools during the different phases of the building life cycle is being demanded in the Architecture, Engineering and Construction (AEC) and Facilities Management (FM) fields. Along its life cycle, multiple tools interact with building models to extract information for different purposes (e.g., energy demand, appliance characteristics, etc.). Therefore, mechanisms to facilitate the exchange of data between actors along the different stages of the building life cycle and to provide the required interoperability between tools are needed. As the ISO standard data model Industry Foundation Classes (IFC) supports interoperability between data and tools, we decided to extend the SAREF ontology with the subset of this standard related to devices and appliances. </p>

<p>This document describes the SAREF4BLDG ontology, an extension of the SAREF ontology that was created based on the Industry Foundation Classes (IFC) standard for building information. It should be noted that not the whole standard has been transformed since it exceeds the scope of this extension, which is limited to devices and appliances within the building domain.</p>

<p>The IFC specification is developed and maintained by buildingSMART International as its "Data standard" and, since its version IFC4, it is published as the ISO 16739 standard. SAREF4BLDG is meant to enable the (currently missing) interoperability among various actors (architects, engineers, consultants, contractors, and product component manufacturers, among others) and applications managing building information involved in the different phases of the building life cycle (Planning and Design, Construction, Commissioning, Operation, Retrofitting/Refurbishment/Reconfiguration, and Demolition/Recycling). By using SAREF4BLDG, smart appliances from manufacturers that support the IFC data model will easily communicate with each other. Towards this aim, SAREF4BLDG should be used to annotate (or generate) neutral device descriptions to be shared among various stakeholders.</p>

<p>SAREF4BLDG is an OWL-DL ontology that extends SAREF with 72 classes (67 defined in SAREF4EBLDG and 5 reused from the SAREF and geo ontologies), 179 object properties (177 defined in SAREF4EBLDG and 2 reused from the SAREF and geo ontologies), and 83 data type properties (82 defined in SAREF4EBLDG and 1 reused from the SAREF ontology).</p>

<p>SAREF4BLDG focuses on extending the SAREF ontology to include those devices defined by the IFC version 4 - Addendum 1 and to enable the representation of such devices and other physical objects in building spaces.</p>


<div id="namespacedeclarations">
<h3 id="ns" class="list">Namespace declarations</h3>
<div id="ns" align="center">
<h2>1.1. Namespace declarations<span class="backlink"> back to <a href="#toc">ToC</a></span></h2>
</p><div id="ns" align="center">
<table>
<caption> <a href="#ns"> Table 1</a>: Namespaces used in the document </caption>
<tbody>
@@ -25,6 +35,7 @@
<tr><td><b>saref</b></td><td>&lt;https://w3id.org/saref#&gt;</td></tr>
<tr><td><b>lexical</b></td><td>&lt;http://www.buildingsmart-tech.org/ifc/IFC4/Add1/html/schema/ifcbuildingcontrolsdomain/lexical/&gt;</td></tr>
<tr><td><b>pset</b></td><td>&lt;http://www.buildingsmart-tech.org/ifc/IFC4/Add1/html/schema/ifcbuildingcontrolsdomain/pset/&gt;</td></tr>
<tr><td><b>bldg</b></td><td>&lt;http://w3id.org/def/bldg#&gt;</td></tr>
</tbody>
</table>
</div>
Loading