Last modified by cmot on 2023/09/11 16:16
<
From version < 4.1 >
edited by cmot
on 2014/06/26 13:24
To version < 6.1 >
edited by cmot
on 2014/06/26 13:41
>
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -1,9 +1,10 @@
1 +(% class="confluence-link" %)
1 1  [[image:attach:klighd.png]]
2 2  
3 3  The KIELER KLighD Console Diagram Renderer is a pure Java program that together with a KIELER RCA allows to call the KIELER KLighD Rendering for model diagrams from the console. For using the KIELER Console Rendering you need to
4 4  
5 5  1. Enable the KLighD HTTP Server in the KIELER RCA and
6 -1. Download [[KLighD>>url:http://git.rtsys.informatik.uni-kiel.de:7990/projects/KIELER/repos/semantics/browse/standalone/KLighD.jar||shape="rect"]] ([[alternati>>attach:KIELER Compiler Console@KielerCompiler.jar]][[ve Download>>attach:KIELER Compiler Console@KielerCompiler.jar]]) as a runnable Java JAR archive and run it.
7 +1. Download [[KLighD>>url:http://git.rtsys.informatik.uni-kiel.de:7990/projects/KIELER/repos/semantics/browse/standalone/KLighD.jar||shape="rect"]] ([[alternative download>>attach:KLighD.jar]]) as a runnable Java JAR archive and run it.
7 7  
8 8  In the following we give a short quick start guide and describe the details for both, the enabling of the HTTP server and the possible command line calls of KiCo from the command line:
9 9  
... ... @@ -16,7 +16,7 @@
16 16  == Quick Start Guide ==
17 17  
18 18  1. Download KIELER RCA from [[http:~~/~~/rtsys.informatik.uni-kiel.de/~~~~kieler/files/nightly/kieler/>>url:http://rtsys.informatik.uni-kiel.de/%7Ekieler/files/nightly/kieler/||shape="rect"]] extract it to some location x on your hard drive
19 -1. Download [[KLighD>>url:http://git.rtsys.informatik.uni-kiel.de:7990/projects/KIELER/repos/semantics/browse/standalone/KLighD.jar||shape="rect"]] ([[alternati>>attach:KIELER Compiler Console@KielerCompiler.jar]][[ve Download>>attach:KIELER Compiler Console@KielerCompiler.jar]]) as a runnable Java JAR archive and save it to some location y on your hard drive
20 +1. Download [[KLighD>>url:http://git.rtsys.informatik.uni-kiel.de:7990/projects/KIELER/repos/semantics/browse/standalone/KLighD.jar||shape="rect"]] ([[alternative download>>attach:KLighD.jar]]) as a runnable Java JAR archive and save it to some location y on your hard drive
20 20  1. Open console window and change directory to location x, then type:
21 21  
22 22  
... ... @@ -32,108 +32,34 @@
32 32  
33 33  == Enable the HTTP Server ==
34 34  
35 -Before you can use the KielerCompiler.jar from the console, you need to start the KIELER RCA and activate the HTTP Server. This is done using the button at 1. shown in the screenshot below. When pressing it the windows shown at 2. is displayed and allows to enable or disable the server and also to modify the default port of 5555. Whenever the server was enabled and is started, you will see its job running at 3. in the lower region of the KIELER RCA. When you enabled the server in previous runs of the KIELER RCA it will automatically started when you run KIELER again.
36 +Before you can use KLighD.jar from the console, you need to start the KIELER RCA and activate the KLighD HTTP Server. This is done using the button at 1. shown in the screenshot below. When pressing it the windows shown at 2. is displayed and allows to enable or disable the server and also to modify the default port of 4444. Whenever the server was enabled and is started, you will see its job running at 3. in the lower region of the KIELER RCA. When you enabled the server in previous runs of the KIELER RCA it will automatically started when you run KIELER again.
36 36  
37 -[[image:attach:KIELER Compiler Console@KiCoConsole0.jpg]]
38 +[[image:attach:klighd2.png]]
38 38  
39 39  === Non-GUI HTTP Server ===
40 40  
41 -Alternatively (after you configured the port) you can start the KiCo HTTP Server via command line:
42 +Alternatively (after you configured the port) you can start the KLighD HTTP Server via command line:
42 42  
43 -{{{kieler -application de.cau.cs.kieler.kico.server.headless -noExit [-p &#x3c;port&#x3e;] [-d]}}}
44 +{{{kieler -application de.cau.cs.kieler.klighd.server.headless -noExit [-p &#x3c;port&#x3e;] [-d]}}}
44 44  
45 -This will start a background process with the KIELER Compiler HTTP Server. Optionally you can specify a (new) listening port for the HTTP server using "-p <port>" or  "–port <port>",e.g. "-p 5555". The option -d or ~-~-debug enables the debug mode with verbose debug output messages.
46 +This will start a background process with the KIELER KLighD HTTP Server. Optionally you can specify a (new) listening port for the HTTP server using "-p <port>" or  "–port <port>",e.g. "-p 4444". The option -d or ~-~-debug enables the debug mode with verbose debug output messages.
46 46  
47 47  
48 48  
49 -== Using the KielerCompiler from Console ==
50 +== Using  KLighD.jar from Console ==
50 50  
51 -Download the [[KielerCompilerConsole>>url:http://git.rtsys.informatik.uni-kiel.de:7990/projects/KIELER/repos/semantics/browse/standalone/KielerCompiler.jar?at=1c807c15f863b699d96d97038501663608d0f2bf&raw||shape="rect"]] ([[alternative Download>>attach:KIELER Compiler Console@KielerCompiler.jar]]) as a runnable Java JAR archive and start it using java:
52 +Download the  [[KLighD>>url:http://git.rtsys.informatik.uni-kiel.de:7990/projects/KIELER/repos/semantics/browse/standalone/KLighD.jar||shape="rect"]] ([[alternative download>>attach:KLighD.jar]]) as a runnable Java JAR archive and start it using java:
52 52  
53 -{{{java -jar KielerCompiler.jar &#x3c;host&#x3e;:&#x3c;port&#x3e; [Options] &#x3c;transformationID_1&#x3e; .. &#x3c;transformationID_n&#x3e;}}}
54 +{{{java -jar KLighD.jar &#x3c;host&#x3e;:&#x3c;port&#x3e; [Options] }}}
54 54  
55 -In the above screenshot you see the KielerCompiler options when calling with no/too few parameters. The host or the port are mandatory parameters. By default the port **5555** is used and the default host is **localhost**. If you secify the port you do not need to specify localhost, if you specify the host you do not need to specify 5555. The following options are available:
56 +In the above screenshot you see the KLighD options when calling with no/too few parameters. The host or the port are mandatory parameters. By default the port **4444 **is used and the default host is **localhost**. If you specify the port you do not need to specify localhost, if you specify the host you do not need to specify 4444. The following options are available:
56 56  
57 57  * -f <filename> : Use a specific input file for the main model (and not the console)
58 58  * -i <filename> : Include additional input files that are referenced by the main model, note that the order for using multiple -i options is important: Use the order -i file1 -i file2 if file1 has references to file2 but file2 has NO references to file1!
59 59  * -o <filename> : Use a specific output file (and not the console)
60 -* -v : Use verbose compilation, more error messages
61 -* -s: Use strict mode compilation (only apply selected transformations)
61 +* -r <svg or png> : Use a specific output rendering, png or svg, default is png
62 +* -s <1 - 5>: Use a specific scale factor, e.g. 1, default is 1
62 62  
63 63  
64 64  
65 -== Transformation IDs ==
66 -
67 -In order to use the KIELER Compiler from the command line you need to know the ID of the transformations you would like to apply.
68 -
69 -|=(((
70 -Common Transformation IDs
71 -)))|=(((
72 -More Transformation IDs
73 -)))
74 -|(((
75 -Here are the most common ones:
76 -
77 -|=(((
78 -Transformation ID
79 -)))|=(((
80 -Description
81 -)))
82 -|(((
83 -REFERENCE
84 -)))|(((
85 -Expand reference states
86 -)))
87 -|(((
88 -EXTENDED
89 -)))|(((
90 -All extended SCCharts transformations resulting in a Core SCChart
91 -)))
92 -|(((
93 -CORE
94 -)))|(((
95 -All core SCCharts transformations resulting in a Normalized SCChart
96 -)))
97 -|(((
98 -SCGRAPH
99 -)))|(((
100 -Transform to an SCG
101 -)))
102 -|(% colspan="1" %)(% colspan="1" %)
103 -(((
104 -CODEGENERATION
105 -)))|(% colspan="1" %)(% colspan="1" %)
106 -(((
107 -Generate C code
108 -)))
109 -)))|(((
110 -In order to get other transformation IDs you can use the KIELER Compiler Selection View. It will show the transformation ID for each transformation or transformation group as a tooltip text that will show up if you place and hold the mouse over the transformation node as shown below:
111 -
112 -[[image:attach:KIELER Compiler Console@TRANSFORMATIONIDs.jpg]]
113 -)))
114 -
115 115  
116 -
117 -
118 -
119 -== Example Calls ==
120 -
121 -=== Example 1 ===
122 -
123 -[[image:attach:KIELER Compiler Console@KiCoConsole2.jpg]]
124 -
125 -When calling the KielerCompiler with the ABORT transformation and console output.
126 -
127 -
128 -
129 -=== Example 2
130 -[[image:attach:KIELER Compiler Console@KiCoConsole3.jpg]] ===
131 -
132 -Using the KielerCompiler with CODEGENERATION transformation and a specific output file.
133 -
134 -
135 -
136 -=== Example 3
137 -[[image:attach:KIELER Compiler Console@KiCoConsole4.jpg]] ===
138 -
139 -Using the KielerCompiler with a non exisiting transformation which generates an error message.
Confluence.Code.ConfluencePageClass[0]
Id
... ... @@ -1,1 +1,1 @@
1 -9471229
1 +9471305
URL
... ... @@ -1,1 +1,1 @@
1 -https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/KIELER/pages/9471229/KIELER KLighD Console Diagram Rendering
1 +https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/KIELER/pages/9471305/KIELER KLighD Console Diagram Rendering

Navigation

Quick Links

KIELER on GitHub
RTSYS Homepage