Skip to content
This repository was archived by the owner on Sep 1, 2024. It is now read-only.

Commit 0470450

Browse files
committed
Documentation update
1 parent 6fa7990 commit 0470450

3 files changed

Lines changed: 11 additions & 10 deletions

File tree

docs/ReatMetric System Manual.adoc

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
= ReatMetric System Manual
1+
= System Manual
22
Dario Lucia <dario.lucia@gmail.com>
3-
v1.0, 2024-05-04
3+
v1.0.0, 2024-05-04
44
:title-logo-image: image:docimg/ReatMetric-Logo.png[top=42%,align=left,pdfwidth=6in]
55
:doctype: book
66
:toc:
@@ -22,12 +22,12 @@ A Monitoring and Control (abbreviated as M&C) system is an application used to:
2222
* present such information to human users, operators and other software systems,
2323
* detect non-nominal situation and raise alarms accordingly,
2424
* schedule operations and activities to be executed on the devices,
25-
* record the most important data for later analysis.
25+
* record the most important data for subsequent analysis.
2626

2727
ReatMetric is designed as a modular M&C framework, whereas each module follows the Java Platform Module System
28-
(https://en.wikipedia.org/wiki/Java_Platform_Module_System). Each module provide a specific set of functionalities,
29-
data structures and interfaces that can be used by other modules. While some modules provide data structures and
30-
interfaces that are at the foundation of the framework, other modules can be replaced in isolation.
28+
specification (https://en.wikipedia.org/wiki/Java_Platform_Module_System). Each module provide a specific set of
29+
functionalities, data structures and interfaces that can be used by other modules. While some modules provide data
30+
structures and interfaces that are at the foundation of the framework, other modules can be replaced in isolation.
3131

3232
The modules that form the foundation of the ReatMetric system are shown in the following figure.
3333

@@ -76,7 +76,7 @@ The arrangement of the hierarchy is sometimes obvious to design, while in other
7676
the example above, for instance, the hierarchy is a functional hierarchy, based on the functional elements present in
7777
the domotic system. However, a hierarchical breakdown based on the rooms of the house could have been an alternative.
7878
What it is not a matter of taste are the physical objects (labelled as 'device'), which are ultimately monitored and
79-
controlled. Such objects are characterised by having:
79+
controlled. Such objects are characterised by:
8080

8181
* A readable state - i.e. a set of _parameters_ - with related values, which you can actively monitor and, in some cases,
8282
also change. For instance, a television has the following state parameters: if it is on or off, selected input source,
@@ -90,8 +90,9 @@ accepted and, after a while, that the operation has been completed - with succes
9090
* A way to signal when something happened - i.e. an _event_ - which is relevant for the functioning purpose of the device.
9191
For instance, a television might signal when a new version of the firmware is detected.
9292

93-
ReatMetric concepts are derived as described above. As it is a M&C framework oriented to the space domain, such concepts
94-
are a re-elaboration of the M&C concepts reported in the ECSS standard ECSS-E-ST-70C
93+
ReatMetric concepts are derived from this general device characterisation, as described above. As it is a M&C framework
94+
oriented to the space domain, such concepts are actually a re-elaboration of the M&C concepts reported in the ECSS
95+
standard ECSS-E-ST-70C
9596
(https://esastar-publication.sso.esa.int/api/filemanagement/download?url=emits.sso.esa.int/emits-doc/ESOC/1-6223/ECSS-E-ST-70-31C(31July2008).pdf).
9697
ReatMetric manages a hierarchical tree composed of so-called _System Entities_. A _System Entity_ (at any level of the
9798
hierarchy) is characterised by _parameters_, _activities_ and _events_. Some system entities are mapped to actual devices,

docs/ReatMetric System Manual.pdf

1.04 KB
Binary file not shown.

eu.dariolucia.reatmetric.ui/Documentation.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -228,7 +228,7 @@ This attribute can be present several times attached to a single SVG element. If
228228
is evaluated in lexicographical order. As soon as one item's evaluation is successful, the list evaluation
229229
stops.
230230

231-
Allowed expression values: a real number. Null value _##NULL##_ removes the attribute.
231+
Allowed expression values: a real number. Null value _\\##NULL##_ removes the attribute.
232232

233233
*data-rtmt-width-[nn]*
234234

0 commit comments

Comments
 (0)