This guide covers the functionality of the GUI Control. After reading this guide, you will know:
Although the ADTF GUI Control is a GUI application it still has some command line arguments.
adtf_guicontrol.exe --help into a console to get the list of the supported commandline arguments:
ADTF GUI Control adtf_guicontrol Usage: adtf_guicontrol [-h] [-o <adtfsession|adtfproject>] [-c] [-l <adtfsessionfile>] [--launcher <launcher>] [-r] [-i] [--environment <adtfenvironmentfile>] [-u <url>] [--console] [--logview] [--statusmonitor] [<adtfsession|adtfproject>] Options: -h, --help Print the usage info and quit. -o, --open <adtfsession|adtfproject> Open the given project or session. Note: Explicit option --open does not work in combination with using <adtfsession|adtfproject> as argument. -c, --connect Connect to an ADTF instance on the default URL ('http://localhost:8000'). -l, --launch <adtfsessionfile> Launch an ADTF system with the given session file. --launcher <launcher> Use the given launcher. If not specified the first one in the adtf_control.adtfsettings file will be used. -r, --run If used in conjunction with --launch, will pass the --run flag on to the launcher. -i, --init If used in conjunction with --launch, will pass the --init flag on to the launcher. --environment <adtfenvironmentfile> Specify an ADTF environment file that should be passed on to the launcher. -u, --url <url> Connect to an ADTF system using the given URL for RPC communication. If used in conjunction with '--launch', '--logview' and/or '--statusmonitor' the URL will be passed to the related tool. --console Will forward the --console flag to the launcher. --logview Will additionally open the ADTF Log View Tool on the specified '--url', default URL ('http://localhost:8000') will be used if not set. --statusmonitor Will additionally open the ADTF Status Monitor on the specified '--url', default URL ('http://localhost:8000') will be used if not set. <adtfsession|adtfproject> Load the given session or project.
The GUI-Control offers two ways to control an ADTF launcher:
Click the "Open Session or Project" button to select an ADTF Session file
(*.adtfsession) directly or a project file
(*.adtfproject) to list all ADTF Session files contained in this project.
Next select one of the available ADTF Sessions and click the
Launch button. A dialog with start settings
will show up. You can adopt the launcher command and the port the URL however should not be changed because it has no effect.
The launcher is always started on the local PC and the URL is shown for convenience only.
If you want to control an already running ATDF launcher maybe on an other PC in the same network click on the
"Connect to Session" button. A dialog will show up where you can specify the URL and port pointing to the remote
ADTF Launcher. The ADTF Launcher must have been started something like this on another pc to listen on the public interface:
adtf_launcher.exe -session="path/to/session.adtfsession" -control-url="http://10.10.10.36:8000" -console
As soon as the connection to the ADTF Launcher is established a new tab with the name of the running ADTF Session will
show up inside the GUI-Control representing the new connection. Pressing the "X" on the tab header terminates the
connection and optionaly shuts down the ADTF Launcher.
The GUI Control offers the same functionality as the ADTF Control but with a convenient graphical user interface.
To make further connection you can switch back to the first tab with the name "Start" and repeat the preceding
In the header section you can see some common information about the connected ADTF Launcher e.g. the loaded ADTF System, loaded ADTF Session and the currently active Streaming Graph and Filter Graph. Bellow you can find the buttons
Run to control the runlevel of the Filter Graph. Pressing
Run button starts the data flow through the Streaming Graph and Filter Graph.
Runlevel mapping between GUI-Control and ADTF Launcher:
|Button Clicked||Runlevel change within ADTF Launcher|
A red button means recording a green button means ready to start recording. The recorded data goes into a DAT file. The DAT files can be split into several chunks by clicking the split button. The given name to a recoreded file is configured as property of the ADTFDAT File Recorder inside the Configuration Editor.
The GUI-Control offers two possibilities to mark important events during recording. On the one hand you can use Quick Markers to place a marker immediately with a default label and the current time. On the other hand you can use the marker dialog button to specify a name and adjust the timestamp.
Quick Marker button and a marker is set immediatly at the current stream time with the default marker name
ctrl + 0 sets a QuickMarker for all recorders, note it is zero not the character 'O'
ctrl + m opens the marker dialog for all recorders
All recorded DAT files are displayed in this table. Remember that the files are generated on the system where the ADTF Launcher was started which is not necessarily the ADTF System where the GUI Control is running! Each row of the table offers a context menu: