Skip to content
Snippets Groups Projects
Commit 37f779d5 authored by Rainer Kartmann's avatar Rainer Kartmann
Browse files

Update doc

parent cd77f159
No related branches found
No related tags found
No related merge requests found
......@@ -2,10 +2,12 @@
\page ArmarXGui-HowTos ArmarXGui HowTos
- \subpage ArmarXGui-HowTos-Build-Gui-Plugin
- \subpage ArmarXGui-HowTos-Build-Gui-Plugin "Create your own GUI plugin"
- \subpage ArmarXGui-HowTos-Add-Proxy-To-StatechartContext
- \subpage ArmarXGui-HowTos-Statechart-Editor-Migration "Migrate to Statechart Editor codegenerator"
- \subpage ArmarXGui-HowTos-Add-DataType-To-StatechartContext
- \subpage ArmarXGui-HowTos-Statechart-Editor-Migration "Migrate to Statechart Editor codegenerator"
\page ArmarXGui-HowTos-Build-Gui-Plugin How to create your own gui plugin
Every plugin consits of:
......@@ -66,13 +68,18 @@ QTimer or timerEvent(QTimerEvent) are running in the same thread as the main app
suitable for network calls.
Especially periodic network calls like updating data should be in a seperate thread.
\page ArmarXGui-HowTos-Add-Proxy-To-StatechartContext How to add your own interfaces to a statechart context
In the Statechart Editor in the statechart group settings dialog it is possible to specify which
components should be accessible from states inside of this statechart group.
This list of interfaces is specified in VariantInfo-${PACKAGENAME}.xml files in each package.
This file is located in each package at ${PACKAGENAME}/data/${PACKAGENAME}/VariantInfo-${PACKAGENAME}.xml.
This file might look like this:
In the Statechart Editor, in the statechart group settings dialog, it is possible to specify which
topics and components (proxies) should be accessible from states inside this statechart group.
To make new topics and components (proxies) available in this dialog, they need to be specified and
described in the `VariantInfo-${PACKAGENAME}.xml` file of the containing package.
This file is located in each package at `${PACKAGENAME}/data/${PACKAGENAME}/VariantInfo-${PACKAGENAME}.xml`.
The file might look like this:
\verbatim
<?xml version="1.0" encoding="utf-8"?>
<VariantInfo>
......@@ -97,14 +104,20 @@ This file might look like this:
</VariantInfo>
\endverbatim
To add a new proxy, add another *Proxy*-tag with the content like in the example matching to your proxy.
To add a new proxy, add another `Proxy` tag with the content like in the example matching to your proxy.
The same can be done for topics using the `Topic` tag.
If the file is in your own package, you also need to add your package to the defaultpackages:
In ~/.armarx/default.cfg add the line (the package list speficies the global default packages for all applications):
If the file is in your own package, you also need to add your package to the additional packages:
In `~/.armarx/default.cfg` add the line (the package list speficies the global default packages for all applications):
\verbatim
ArmarX.DefaultPackages=${YOURPACKAGENAME},ArmarXCore, ArmarXGui, MemoryX, RobotAPI, RobotComponents, RobotSkillTemplates, ArmarXSimulation, VisionX
ArmarX.AdditionalPackages=${YOURPACKAGENAME},Armar6Skills,...
\endverbatim
If not done already, you might also have to add the path to your package to the Statechart Groups
Search Paths. This is done by clicking the settings wheel icon (right of the save button) in the
Statechart Editor and choosing "Add Path".
\page ArmarXGui-HowTos-Add-DataType-To-StatechartContext How to add your own data type to a statechart
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment