Unverified Commit 0a226bdf authored by Maxime Lefrançois's avatar Maxime Lefrançois
Browse files

doc generated from pipeline

parent 602b0020
Loading
Loading
Loading
Loading
Loading
+2 −1
Original line number Diff line number Diff line
@@ -5,3 +5,4 @@ saref-pipeline.jar
target
ts
scripts
documentation/ts_*
+11 −11
Original line number Diff line number Diff line
@@ -25,7 +25,7 @@ Note that Figure 1 aims at showing a global overview of the main classes of SARE



<figure id="Figure_1">
<figure>
        <img data-docx-width="18.73cm" src="diagrams/Overview.png" alt="SAREF4CITY overview"/>
        <figcaption>Figure 1: SAREF4CITY overview</figcaption>
    </figure>
@@ -42,7 +42,7 @@ Note that Figure 1 aims at showing a global overview of the main classes of SARE
In the SAREF4CITY ontology existing models have been reused when needed in order to increase interoperability and reduce effort in modelling general domains. As an example, for modelling the requirements related to the topology domain, standard ontologies already developed have been reused and connected to the SARE4CITY elements. As shown in Figure 2, for representing spatial objects the `geo:SpatialObject` class from GeoSPARQL has been reused along with its subclasses `geo:Feature`, `geo:Geometry` and the classes from the simple features ontology sf:Geometry and sf:Point and the properties `geo:sfContains`, `geo:sfWithin` and `geo:hasGeometry`. 


<figure id="Figure_2">
<figure>
        <img data-docx-width="11.74cm" src="diagrams/Topology.png" alt="Topology model"/>
        <figcaption>Figure 2: Topology model</figcaption>
    </figure>
@@ -53,7 +53,7 @@ In the SAREF4CITY ontology existing models have been reused when needed in order
The model defined to describe administrative areas is depicted in Figure 3. As it can be observed, this model heavily relies on the topology pattern described in clause 4.2.2. In this sense, the ability to connect administrative areas (e.g. a city) with their inner areas, (e.g. its neighbourhoods) is given by inheritance of the `geo:SpatialObject` class and through the `geo:Feature` class. That is, as `s4city:AdministrativeArea` is subclass of `geo:SpatialObject`, the `geo:sfContains` and `geo:sfWithin` properties could also be applied to all the administrative areas defined, namely `s4city:City`, `s4city:Country`, `s4city:District` and `s4city:Neighbourhood`.


<figure id="Figure_3">
<figure>
        <img data-docx-width="9.51cm" src="diagrams/AdministrativeArea.png" alt="Administrative Area model"/>
        <figcaption>Figure 3: Administrative Area model</figcaption>
    </figure>
@@ -64,7 +64,7 @@ The model defined to describe administrative areas is depicted in Figure 3. As i
The model developed to represent city objects is shown in Figure 4. This model also relies on the topology pattern described in clause 4.2.2, as for the administrative area case. The ability to connect city objects with the city or with the parts in which they are located is enabled by means of the properties `geo:sfContains` and `geo:sfWithin` inherited from the `geo:SpatialObject` class.


<figure id="Figure_4">
<figure>
        <img data-docx-width="11.94cm" src="diagrams/CityObject.png" alt="City Object model"/>
        <figcaption>Figure 4: City Object model</figcaption>
    </figure>
@@ -75,7 +75,7 @@ The model developed to represent city objects is shown in Figure 4. This model a
Figure 5 presents the model developed to represent temporal and scheduled events. The main concept of this pattern is the class `s4city:Event`. Such event is linked to the agent organizing it by means of the `s4city:organizedBy` property. Note that a public administration is a subclass of agent; therefore, this model includes the possibility of events being organized by public administrations as well as by other types of agents. The events can take place at a particular facility (`s4city:Facility`) which is indicated by the `s4city:takesPlaceAtFacility` property and at a given time, which is represented by the `s4city:takesPlaceAtTime` property that links the event to temporal entities (`time:TemporalEntity`) defined by the W3C Time ontology. Finally, as events can be part of bigger events, this relation has been modelled by means of the property `s4city:isSubEventOf`.


<figure id="Figure_5">
<figure>
        <img data-docx-width="11.96cm" src="diagrams/Event.png" alt="Event model"/>
        <figcaption>Figure 5: Event model</figcaption>
    </figure>
@@ -84,7 +84,7 @@ Figure 5 presents the model developed to represent temporal and scheduled events
Table 2 summarizes the properties that characterize the `s4city:Event`.


<table id="Table_2" data-docx-preferred-width="7.69cm 8.48cm">
<table data-docx-preferred-width="7.69cm 8.48cm">
  <caption>Table 2: Properties of s4city:Event</caption>
  <tr>
    <th>Property</th>
@@ -115,7 +115,7 @@ A `s4city:KeyPerformanceIndicator` is related to a `saref:FeatureOfInterest` by
The relation between a specific assessment of a KPI (`s4city:KeyPerformanceIndicatorAssessment`) and the general KPI definition (`s4city:KeyPerformanceIndicator`) can be established by means of the property `s4city:quantifiesKPI`. A `s4city:KeyPerformanceIndicatorAssessment` is related to the `saref:FeatureOfInterest` by means of the property `s4city:assesses`. The temporal entity to which the assessment of the KPI refers to is represented by the property `s4city:refersToTime`. The agent assessing the KPI is linked by means of the property `s4city:isAssessedBy`. In order to express the administrative area or geographical location assessed by the KPI, the property `s4city:refersToFeature` is included in the model. In case the KPI represents a value extracted from an aggregation of observations, the property `s4city:isDerivedFrom` can be used to link to such observations (`saref:Observation`). The unit of measure in which a KPI value is expressed is indicated by means of the reused property `saref:isMeasuredIn` while the value itself is indicated by the attribute `saref:hasValue`. The name and a natural language description of the `s4city:KeyPerformanceIndicatorAssessment` are indicated by the attributes `s4city:hasName` and `s4city:hasDescription`, respectively. The creation, expiration and last update dates of the value are represented by the attributes `s4city:hasCreationDate`, `s4city:hasExpirationDate` and `s4city:hasLastUpdateDate`, respectively.


<figure id="Figure_6">
<figure>
        <img data-docx-width="10.50cm" src="diagrams/KPI.png" alt="Key Performance Indicator model"/>
        <figcaption>Figure 6: Key Performance Indicator model</figcaption>
    </figure>
@@ -124,7 +124,7 @@ The relation between a specific assessment of a KPI (`s4city:KeyPerformanceIndic
Table 3 summarizes the properties that characterize the `s4city:KeyPerformanceIndicator` class. 


<table id="Table_3" data-docx-preferred-width="8.24cm 7.93cm">
<table data-docx-preferred-width="8.24cm 7.93cm">
  <caption>Table 3: Restrictions of the s4city:KeyPerformanceIndicator class</caption>
  <tr>
    <th>Property</th>
@@ -146,7 +146,7 @@ Table 3 summarizes the properties that characterize the `s4city:KeyPerformanceIn
Table 4 summarizes the properties that characterize the `s4city:KeyPerformanceIndicatorAssessment` class.


<table id="Table_4" data-docx-preferred-width="8.14cm 8.97cm">
<table data-docx-preferred-width="8.14cm 8.97cm">
  <caption>Table 4: Restrictions of the s4city:KeyPerformanceIndicatorAssessment class</caption>
  <tr>
    <th>Property</th>
@@ -202,7 +202,7 @@ Table 4 summarizes the properties that characterize the `s4city:KeyPerformanceIn
The model developed to describe public services within the SAREF4CITY ontology is depicted in Figure 7. The main entity included is the `s4city:PublicService` class which is a specialization of the reused concept `cpsv:PublicService` class defined in the Public Service vocabulary provided by the ISA vocabularies European initiative. The facility in which the service is provided is indicated by the `s4city:involvesFacility` property. It can be also possible to indicate in which administrative area it is provided, for example a neighbourhood, by means of the property `cpsv:physicallyAvailableAt`. The public services that an agent (`s4city:Agent`) provides or uses are indicated by means of the properties `cpsv:provides` and `cpsv:uses`, respectively. The languages in which a service is provided are indicated by the property `s4city:isAvailableInLanguage`. The name and a natural language description of the `s4city:PublicService` are indicated by the attributes `s4city:hasName` and `s4city:hasDescription`, respectively.


<figure id="Figure_7">
<figure>
        <img data-docx-width="10.92cm" src="diagrams/PublicService.png" alt="Public Service model"/>
        <figcaption>Figure 7: Public Service model</figcaption>
    </figure>
@@ -211,7 +211,7 @@ The model developed to describe public services within the SAREF4CITY ontology i
Table 5 summarizes the properties that characterize the `s4city:PublicService` class.


<table id="Table_5" data-docx-preferred-width="8.14cm 8.97cm">
<table data-docx-preferred-width="8.14cm 8.97cm">
  <caption>Table 5: Properties of Public Service</caption>
  <tr>
    <th>Property</th>
+1 −1
Original line number Diff line number Diff line
@@ -19,7 +19,7 @@ Finally, some examples of public services are shown. One service example is the



<figure id="Figure_8">
<figure>
        <img data-docx-width="21.58cm" src="diagrams/S4CITY Example 1.png" alt="SAREF4CITY Road Congestion example"/>
        <figcaption>Figure 8: SAREF4CITY Road Congestion example</figcaption>
    </figure>
+4 −2
Original line number Diff line number Diff line
### Normative references
# References

## Normative references

* <a id="[0]">[0]</a> [ETSI TS 103 410-4 (V2.1.1)](https://www.etsi.org/deliver/etsi_ts/103400_103499/10341004/02.01.01_60/ts_10341004v020101p.pdf): "SmartM2M;; Extension to SAREF; Part 4: Smart Cities Domain".
* <a id="[1]">[1]</a>	[ETSI TS 103 264](https://www.etsi.org/deliver/etsi_ts/103200_103299/103264/): "SmartM2M; Smart Applications; Reference Ontology and oneM2M Mapping".
@@ -6,7 +8,7 @@
* <a id="[3]">[3]</a>	Void.


### Informative references
## Informative references

* <a id="[i.1]">[i.1]</a>	ETSI TR 103 506 (V1.1.1): "SmartM2M; SAREF extension investigation; Requirements for Smart Cities".
* <a id="[i.2]">[i.2]</a>	ETSI TR 103 781: "SmartM2M; Study for SAREF ontology patterns and usage guidelines".