Skip to content

Commit

Permalink
Refs #19743: Include new images
Browse files Browse the repository at this point in the history
Signed-off-by: JesusPoderoso <[email protected]>
  • Loading branch information
JesusPoderoso committed Nov 7, 2023
1 parent 91140be commit d2d253a
Show file tree
Hide file tree
Showing 9 changed files with 18 additions and 3 deletions.
Binary file added docs/rst/figures/screenshots/domain_graph.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/rst/figures/screenshots/init-monitor.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/rst/figures/screenshots/main_panel.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/rst/figures/screenshots/problem.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/rst/figures/screenshots/problem_detail.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/rst/figures/screenshots/shapes_domain.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/rst/figures/screenshots/shapes_topic.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
12 changes: 12 additions & 0 deletions docs/rst/user_manual/chart_panel_index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,21 @@ arrows.
Those arrows would start from the DataWriter and point to the Topic, or start from the Topic and point to the
DataReader (in publication and subscription cases, respectively).

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

If filtering that graph by Topic, only the entities whose endpoints are publishing in, or subscribed to the selected
Topic would be represented in the view.

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

If there are problems reported by a DDS entity, they are condensed by entity in the bottom layout problem section.
Among the problem counter, the problem is described and, in some cases, followed by a link to the documentation.

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

.. toctree::
:maxdepth: 2

Expand Down
9 changes: 6 additions & 3 deletions docs/rst/user_manual/layout.rst
Original file line number Diff line number Diff line change
Expand Up @@ -275,13 +275,13 @@ Domain View
-----------
This view in the main panel shows the connections between DataWriters and DataReaders that belong to the same
DDS Domain.
They are represented encapsulated inside their physical entities (see :ref:`_entities` relationship), and with a
They are represented encapsulated inside their physical entities (see :ref:`entities` relationship), and with a
connection to the topic they are published and subscribed, respectively.

.. figure:: /rst/figures/screenshots/chartbox.png
.. figure:: /rst/figures/screenshots/domain_graph.png
:align: center

Clicking on any entity displays its detailed information in the :ref:`_info_panel`.
Clicking on any entity displays its detailed information 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.
Expand All @@ -298,3 +298,6 @@ 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 severity of the problem.
The entity representation in the domain graph may also display that icon.

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

0 comments on commit d2d253a

Please sign in to comment.