Skip to content

Commit

Permalink
Merge pull request #220 from ipa320/SystemVisualization
Browse files Browse the repository at this point in the history
System visualization
  • Loading branch information
ipa-nhg authored Apr 17, 2024
2 parents b2cbe8d + 96b4267 commit 4837a2c
Show file tree
Hide file tree
Showing 31 changed files with 823 additions and 323 deletions.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@ Publications:

- Combine components to form a ROS System
- [Create manually a new RosSystem description](docu/RosSystemModelDescription.md)
- [Visualize a system using PlantUML](docu/PlantUML.md)

- Examples:
- [Simple publisher-subscriber](docu/Example_PubSub.md)
Expand Down
8 changes: 8 additions & 0 deletions docu/PlantUML.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
## System Models visualization

The visualization of the models is built on top of the [PlantUML](https://plantuml.com/eclipse) viewer for Eclipse. To install this plugin the Eclipse Marketplace can be used. This tool can be easily opened under the menu Help->Eclipse Marketplace. Then Search the "PlantUML plugin" and install it.

The RosTooling will generate for every rossystem file a new PlaUML textual model compatible with the viewer. By default, the RosSystem compiler creates for every valid system model a file under src-gen/**SystemName**/resources/ called **SystemName**.puml.

The file can be opened with a standard textual editor and the corresponding model can be visualized by opening the visualizer, under "Window"->"Show View"->"Other" and searching for "PlantUML".
:bangbang the file with the extension *.puml must be open, otherwise, the visualizer will not detect it.
99 changes: 23 additions & 76 deletions plugins/de.fraunhofer.ipa.ros.feature/feature.xml
Original file line number Diff line number Diff line change
Expand Up @@ -66,135 +66,82 @@ POSSIBILITY OF SUCH DAMAGE.

<plugin
id="de.fraunhofer.ipa.rossystem"
download-size="0"
install-size="0"
version="3.0.0.qualifier"
unpack="false"/>
version="3.0.0.qualifier"/>

<plugin
id="de.fraunhofer.ipa.rossystem.xtext.ide"
download-size="0"
install-size="0"
version="3.0.0.qualifier"
unpack="false"/>
version="3.0.0.qualifier"/>

<plugin
id="de.fraunhofer.ipa.ros.edit"
download-size="0"
install-size="0"
version="3.0.0.qualifier"
unpack="false"/>
version="3.0.0.qualifier"/>

<plugin
id="de.fraunhofer.ipa.ros.xtext.ui"
download-size="0"
install-size="0"
version="3.0.0.qualifier"
unpack="false"/>
version="3.0.0.qualifier"/>

<plugin
id="de.fraunhofer.ipa.rossystem.edit"
download-size="0"
install-size="0"
version="3.0.0.qualifier"
unpack="false"/>
version="3.0.0.qualifier"/>

<plugin
id="de.fraunhofer.ipa.rossystem.xtext"
download-size="0"
install-size="0"
version="3.0.0.qualifier"
unpack="false"/>
version="3.0.0.qualifier"/>

<plugin
id="de.fraunhofer.ipa.ros.plugin"
download-size="0"
install-size="0"
version="3.0.0.qualifier"
unpack="false"/>
version="3.0.0.qualifier"/>

<plugin
id="de.fraunhofer.ipa.ros"
download-size="0"
install-size="0"
version="3.0.0.qualifier"
unpack="false"/>
version="3.0.0.qualifier"/>

<plugin
id="de.fraunhofer.ipa.rossystem.editor"
download-size="0"
install-size="0"
version="3.0.0.qualifier"
unpack="false"/>
version="3.0.0.qualifier"/>

<plugin
id="de.fraunhofer.ipa.rossystem.xtext.ui"
download-size="0"
install-size="0"
version="3.0.0.qualifier"
unpack="false"/>
version="3.0.0.qualifier"/>

<plugin
id="de.fraunhofer.ipa.ros.xtext.ide"
download-size="0"
install-size="0"
version="3.0.0.qualifier"
unpack="false"/>
version="3.0.0.qualifier"/>

<plugin
id="de.fraunhofer.ipa.ros.xtext"
download-size="0"
install-size="0"
version="3.0.0.qualifier"
unpack="false"/>
version="3.0.0.qualifier"/>

<plugin
id="de.fraunhofer.ipa.ros.editor"
download-size="0"
install-size="0"
version="3.0.0.qualifier"
unpack="false"/>
version="3.0.0.qualifier"/>

<plugin
id="de.fraunhofer.ipa.ros1.xtext"
download-size="0"
install-size="0"
version="3.0.0.qualifier"
unpack="false"/>
version="3.0.0.qualifier"/>

<plugin
id="de.fraunhofer.ipa.ros1.xtext.ide"
download-size="0"
install-size="0"
version="3.0.0.qualifier"
unpack="false"/>
version="3.0.0.qualifier"/>

<plugin
id="de.fraunhofer.ipa.ros1.xtext.ui"
download-size="0"
install-size="0"
version="3.0.0.qualifier"
unpack="false"/>
version="3.0.0.qualifier"/>

<plugin
id="de.fraunhofer.ipa.ros2.xtext"
download-size="0"
install-size="0"
version="3.0.0.qualifier"
unpack="false"/>
version="3.0.0.qualifier"/>

<plugin
id="de.fraunhofer.ipa.ros2.xtext.ide"
download-size="0"
install-size="0"
version="3.0.0.qualifier"
unpack="false"/>
version="3.0.0.qualifier"/>

<plugin
id="de.fraunhofer.ipa.ros2.xtext.ui"
download-size="0"
install-size="0"
version="3.0.0.qualifier"
unpack="false"/>
version="3.0.0.qualifier"/>

<plugin
id="de.fraunhofer.ipa.ros.sirius"
version="3.0.0.qualifier"/>

</feature>
7 changes: 7 additions & 0 deletions plugins/de.fraunhofer.ipa.ros.sirius/.classpath
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<classpath>
<classpathentry kind="src" path="src"/>
<classpathentry kind="con" path="org.eclipse.jdt.launching.JRE_CONTAINER"/>
<classpathentry kind="con" path="org.eclipse.pde.core.requiredPlugins"/>
<classpathentry kind="output" path="bin"/>
</classpath>
28 changes: 28 additions & 0 deletions plugins/de.fraunhofer.ipa.ros.sirius/.project
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
<?xml version="1.0" encoding="UTF-8"?>
<projectDescription>
<name>de.fraunhofer.ipa.ros.sirius</name>
<comment></comment>
<projects>
</projects>
<buildSpec>
<buildCommand>
<name>org.eclipse.jdt.core.javabuilder</name>
<arguments>
</arguments>
</buildCommand>
<buildCommand>
<name>org.eclipse.pde.ManifestBuilder</name>
<arguments>
</arguments>
</buildCommand>
<buildCommand>
<name>org.eclipse.pde.SchemaBuilder</name>
<arguments>
</arguments>
</buildCommand>
</buildSpec>
<natures>
<nature>org.eclipse.pde.PluginNature</nature>
<nature>org.eclipse.jdt.core.javanature</nature>
</natures>
</projectDescription>
23 changes: 23 additions & 0 deletions plugins/de.fraunhofer.ipa.ros.sirius/META-INF/MANIFEST.MF
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
Manifest-Version: 1.0
Bundle-ManifestVersion: 2
Bundle-Name: %pluginName
Bundle-SymbolicName: de.fraunhofer.ipa.ros.sirius;singleton:=true
Bundle-Version: 3.0.0.qualifier
Bundle-Activator: de.fraunhofer.ipa.ros.sirius.Activator
Bundle-Localization: plugin
Require-Bundle: org.eclipse.ui,
org.eclipse.core.runtime,
org.eclipse.core.resources,
org.eclipse.sirius,
org.eclipse.sirius.common.acceleo.aql,
de.fraunhofer.ipa.ros,
org.eclipse.ui.workbench,
org.eclipse.ui.ide,
org.eclipse.sirius.common,
org.eclipse.sirius.diagram.ui,
de.fraunhofer.ipa.rossystem
Bundle-ActivationPolicy: lazy
Bundle-RequiredExecutionEnvironment: JavaSE-19
Bundle-Vendor: Fraunhofer IPA
Automatic-Module-Name: de.fraunhofer.ipa.ros.sirius
Export-Package: de.fraunhofer.ipa.ros.sirius
8 changes: 8 additions & 0 deletions plugins/de.fraunhofer.ipa.ros.sirius/build.properties
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
source.. = src/
output.. = bin/
bin.includes = META-INF/,\
.,\
description/,\
icons/,\
plugin.properties,\
plugin.xml
Loading

0 comments on commit 4837a2c

Please sign in to comment.