Skip to content

Commit

Permalink
Refs #19743: Apply rev suggestions
Browse files Browse the repository at this point in the history
Signed-off-by: JesusPoderoso <[email protected]>
  • Loading branch information
JesusPoderoso committed Nov 20, 2023
1 parent f0abee9 commit ef470ff
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 13 deletions.
10 changes: 5 additions & 5 deletions docs/rst/user_manual/chart_panel_index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,20 +7,20 @@
Main Panel
##########

In the central panel, there is a tan section that allows multiple views, including a collapsed menu that reports the
In the central panel, there is a tab section that allows multiple views, including a collapsed menu that reports the
possible problems that have been detected on the DDS entities.

The main feature of the *Fast DDS Monitor* application is to graphically display the data that is being monitored in
the *Chartbox* or *Chart view*.
the *Chart View*.
DDS entities have associated different types of data (so-called *DataKind*) that could be visualize by configuring
a chart.
For example, it can be displayed the mean, median and standard deviation latency between two machines (*Hosts*) running
*Fast DDS* applications for the period of two hours in intervals of ten minutes.

There are other features to represent the detected entities graphically in a graph.
The *Fast DDS Monitor* can also show the detected entities in a graph.
The *Domain view* would filter all entities that belong to the same DDS Domain, and represent the inheritance of the
physical entities and DDS entities (the DataWriters or DataReaders that belong to a DomainParticipant, the
DomainParticipants that runs on the same process, the processes that a user is running, and the users that are on a
physical and DDS entities (the DataWriters or DataReaders that belong to a DomainParticipant, the
DomainParticipants that run on the same process, the processes that a user is running, and the users that are on a
host).
Those relations are represented in different boxes that contain the sub-category of entities.
Also, the connections between different endpoints that are publishing or subscribed to a Topic are represented with
Expand Down
17 changes: 9 additions & 8 deletions docs/rst/user_manual/layout.rst
Original file line number Diff line number Diff line change
Expand Up @@ -220,26 +220,27 @@ For the explanation of this information refer to the section :ref:`log_panel`.
Main Panel
==========
The central window allows multiple tabs for different views.
Also it is displayed a collapsed menu with the possible problems that have been detected on the DDS entities.
The tab panel allows multiple tabs generation so different views are contemplated in the same window.
It is also displayed a collapsed menu with the possible problems that have been detected on the DDS entities.
It will display the data charts, so-called *Chartbox*, that the user has configured.
It will display a domain graph where the physical, logical and DDS entities from a domain are represented,
focusing on the connection between endpoints through the topics, and the entities physical inheritance.

.. figure:: /rst/figures/screenshots/main_panel.png
:align: center

For further information about how to create a chart refer to the section :ref:`chart_panel`.

.. _chartbox_layout:

Chartbox
--------
These windows in the main panel store some *series* or *data configurations* to show a specific data type for
one or several entities in a specified time interval and with different accumulative operations on the data.

To create a new *Chartbox* go to *Chart View* in the Main Panel default tab.
To create a new *Chartbox* go to *Chart View* in the Main Panel default tab, and click on *Create new chart* button.
This button will create a new *Chartbox* where new series could be added, removed or modified.

These Chartbox could be moved along the main window.
These Chartbox could be moved along the *Chart View* tab.
In order to move one of this charts, press in the *Chartbox* title and grab the object to its new location inside the
main panel.
The rest of the *Chartboxes* will automatically rearrange when one of them is moved to a different position.
Expand Down Expand Up @@ -281,10 +282,10 @@ connection to the topic they are published and subscribed, respectively.
.. figure:: /rst/figures/screenshots/domain_graph.png
:align: center

Clicking on any entity displays its detailed information in the :ref:`info_panel`.
By clicking on any entity, its detailed information is displayed in the :ref:`info_panel`.
Right click allows changing the alias of the entity, filter the problems to display only the selected entity's problems
and, in the case of topics, filter the domain graph by topic, so they are displayed only the entities related to the
selected topic.
and, in the case of topics, filtering the domain graph by topic so that only the entities related to the selected topic
are displayed.

.. _problem_summary:

Expand All @@ -295,7 +296,7 @@ This section that can be expanded and collapsed displays all the collected probl
Those problems are related to DataReader samples lost, incompatible QoS between endpoints, or DataWriter deadline missed
counter, for instance.

The entities that has reported a problem would display a warning or error icon in close to the entity name, based on
The entities that have reported a problem would display a warning or an error icon close to the entity name, based on
the severity of the problem.
The entity representation in the domain graph may also display that icon.

Expand Down

0 comments on commit ef470ff

Please sign in to comment.