Skip to content

Commit

Permalink
fix image rendering, add section links, add section numbering, fix se…
Browse files Browse the repository at this point in the history
…ction headings, improved readability
  • Loading branch information
humaidkidwai committed Mar 8, 2024
1 parent d96165d commit 5c9c959
Show file tree
Hide file tree
Showing 2 changed files with 37 additions and 62 deletions.
72 changes: 26 additions & 46 deletions sections/clause_07b_sensing_entities.adoc
Original file line number Diff line number Diff line change
@@ -1,11 +1,10 @@
:sectnums: |,all|
:sectanchors:
[[sensing-entities]]
=== Sensing Entities

== The SensorThings API Sensing Entities
All data model requirements classes are grouped in the following requirements class:

[requirements_class]
.Sensing Entities

====
[%metadata]
identifier:: {identifier}/req-class/datamodel/sensing
Expand All @@ -23,21 +22,20 @@ requirement:: {identifier}/req-class/datamodel/sensing/observation
requirement:: {identifier}/req-class/datamodel/sensing/feature
====

[[sensing-entities2]]
=== Sensing Entities

The OGC SensorThings API v2.0 depicts the Core Sensing entities in Figure {counter:figure-num}
[#img-sta-core,link=../images/GRP0002.png]
image::../images/GRP0002.png[Sensing Core]
[.text-center]
.Figure 1. Sensing Core
[#img-sta-core,link=images/GRP0002.png, reftext='{figure-caption} {counter:figure-num}', title='Sensing Core']
image::images/GRP0002.png[Sensing Core, align="center"]


In this section, we define each entity depicted in Figure 1 and its relationships with other entities. Additionally, we also provide examples to model the entities in different contexts.
In this section, we define each entity depicted in <<img-sta-core>> and its relationships with other entities. Additionally, we also provide examples to model the entities in different contexts.

==== Requirement Class: Thing
[[thing]]
==== Thing

[requirements_class]
.Thing

====
[%metadata]
identifier:: {identifier}/req-class/datamodel/sensing/thing
Expand Down Expand Up @@ -99,12 +97,10 @@ Each Thing entity SHALL have the direct relation between a Thing entity and othe




==== Requirement Class: Location
[[location]]
==== Location

[requirements_class]
.Location

====
[%metadata]
identifier:: {identifier}/req-class/datamodel/sensing/location
Expand Down Expand Up @@ -170,12 +166,10 @@ Each Location entity SHALL have the direct relation between a Location entity an




==== Requirement Class: HistoricalLocation
[[historicallocation]]
==== HistoricalLocation

[requirements_class]
.HistoricalLocation

====
[%metadata]
identifier:: {identifier}/req-class/datamodel/sensing/historical-location
Expand Down Expand Up @@ -254,12 +248,10 @@ When a user directly adds new HistoricalLocation, and the time of this new Histo




==== Requirement Class: Datastream
[[datastream]]
==== Datastream

[requirements_class]
.Datastream

====
[%metadata]
identifier:: {identifier}/req-class/datamodel/sensing/datastream
Expand Down Expand Up @@ -391,13 +383,10 @@ The observationType defines the result types for specialized single and multi ob




==== Requirement Class: Sensor
[[sensor]]
==== Sensor

[requirements_class]
.Sensor


====
[%metadata]
identifier:: {identifier}/req-class/datamodel/sensing/sensor
Expand Down Expand Up @@ -462,13 +451,10 @@ Each Sensor entity SHALL have the direct relation between a Sensor entity and ot

The Sensor encodingType allows clients to know how to interpret metadata’s value. Currently SensorThings API defines two common Sensor metadata encodingTypes. Most sensor manufacturers provide their sensor datasheets in a PDF format. As a result, PDF is a Sensor encodingType supported by SensorThings API. The second Sensor encodingType is SensorML. Lastly, some sensor datasheets are HTML documents rather than PDFs. Other encodingTypes are permitted (e.g., text/plain). Note that the metadata property may contain either a URL to metadata content (e.g., an https://, ftp://, etc. link to a PDF, SensorML, or HTML document) or the metadata content itself (in the case of text/plain or other encodingTypes that can be represented as valid JSON). It is up to clients to perform string parsing necessary to properly handle metadata content.


==== Requirement Class: ObservedProperty
[[observedproperty]]
==== ObservedProperty

[requirements_class]
.ObservedProperty


====
[%metadata]
identifier:: {identifier}/req-class/datamodel/sensing/observed-property
Expand Down Expand Up @@ -520,13 +506,10 @@ Each ObservedProperty entity SHALL have the direct relation between an ObservedP




==== Requirement Class: Observation
[[observation]]
==== Observation

[requirements_class]
.Observation


====
[%metadata]
identifier:: {identifier}/req-class/datamodel/sensing/observation
Expand All @@ -549,7 +532,7 @@ Each Observation entity SHALL have the mandatory properties and MAY have the opt
[requirement]
====
[%metadata]
identifier:: {identifier}/req/datamodel/sensing/observed-property/relations
identifier:: {identifier}/req/datamodel/sensing/observation/relations
Each Observation entity SHALL have the direct relation between an Observation entity and other entity types listed in Table {counter:table-num}.
====
Expand Down Expand Up @@ -582,13 +565,10 @@ Note: Many resource-constrained sensing devices do not have a clock. As a result
|====



==== Requirement Class: Feature
[[feature]]
==== Feature

[requirements_class]
.Feature


====
[%metadata]
identifier:: {identifier}/req-class/datamodel/sensing/feature
Expand Down Expand Up @@ -622,7 +602,7 @@ Each Feature entity SHALL have the mandatory properties and MAY have the optiona
[requirement]
====
[%metadata]
identifier:: {identifier}/req/datamodel/sensing/observed-property/relations
identifier:: {identifier}/req/datamodel/sensing/feature/relations
Each Feature entity SHALL have the direct relation between a Feature entity and other entity types listed in Table {counter:table-num}.
====
Expand Down
27 changes: 11 additions & 16 deletions sections/clause_07c_sensing_OM_extension.adoc
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
:sectnums: |,all|
:sectanchors:
[[sensing-OM-extension]]
=== Sensing Extension (Observations & Measurements)

All Sensing Extension (Observations & Measurements) requirements classes are grouped in the following requirements class:

[requirements_class]
.Sensing Extension (Observations & Measurements) Entities

====
[%metadata]
identifier:: {identifier}/req-class/datamodel/sensing-extension-om
Expand All @@ -15,19 +15,17 @@ requirement:: {identifier}/req-class/datamodel/sensing/deployment
requirement:: {identifier}/req-class/datamodel/sensing/observing-procedure
====

The Sensing Extension (Observations & Measurements) is described by the entities in Figure {counter:figure-num}
[#img-sta-core,link=../images/GRP0001.png]
image::../images/GRP0001.png[Sensing Core]
[.text-center]
.Figure . Sensing Extension (Observations & Measurements)
[[sensing-entities-om-extn]]
==== Sensing Extension (Observations & Measurements) Entities

The Sensing Extension (Observations & Measurements) is described by the entities in Figure {counter:figure-num}
[#img-sta-extn,link=images/GRP0001.png, reftext='{figure-caption} {counter:figure-num}', title='Sensing Extension (Observations & Measurements)']
image::images/GRP0001.png["Sensing Extension (Observations & Measurements)", align="center"]

==== Requirement Class: Deployment
[[deployment]]
===== Deployment

[requirements_class]
.Deployment


====
[%metadata]
identifier:: {identifier}/req-class/datamodel/sensing/deployment
Expand Down Expand Up @@ -90,13 +88,10 @@ Each Deployment entity SHALL have the direct relation between a Deployment entit
====



==== Requirement Class: ObservingProcedure
[[observingprocedure]]
===== ObservingProcedure

[requirements_class]
.ObservingProcedure


====
[%metadata]
identifier:: {identifier}/req-class/datamodel/sensing/observing-procedure
Expand Down

0 comments on commit 5c9c959

Please sign in to comment.