Skip to content

Commit 7ec3982

Browse files
author
Sonia Mathew
committed
Generated HTML for Release 3.6.0
1 parent cb5f363 commit 7ec3982

59 files changed

Lines changed: 2686 additions & 183 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

docs/404.html

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1132,12 +1132,14 @@
11321132

11331133

11341134

1135+
1136+
11351137

11361138

11371139

11381140

11391141
<div class="md-nav__link md-nav__link--index ">
1140-
<a href="/code-realtime/migration-modelrt/">Migration from Model RT</a>
1142+
<a href="/code-realtime/migration-modelrt/">Migration from Model RealTime</a>
11411143

11421144
<label for="__nav_2_11">
11431145
<span class="md-nav__icon md-icon"></span>
@@ -1148,7 +1150,7 @@
11481150
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_11_label" aria-expanded="false">
11491151
<label class="md-nav__title" for="__nav_2_11">
11501152
<span class="md-nav__icon md-icon"></span>
1151-
Migration from Model RT
1153+
Migration from Model RealTime
11521154
</label>
11531155
<ul class="md-nav__list" data-md-scrollfix>
11541156

@@ -1168,6 +1170,20 @@
11681170

11691171

11701172

1173+
1174+
1175+
1176+
1177+
1178+
<li class="md-nav__item">
1179+
<a href="/code-realtime/migration-modelrt/best-practices/" class="md-nav__link">
1180+
Best Practices
1181+
</a>
1182+
</li>
1183+
1184+
1185+
1186+
11711187
</ul>
11721188
</nav>
11731189
</li>

docs/art-lang/cpp-extensions/index.html

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1321,12 +1321,14 @@
13211321

13221322

13231323

1324+
1325+
13241326

13251327

13261328

13271329

13281330
<div class="md-nav__link md-nav__link--index ">
1329-
<a href="../../migration-modelrt/">Migration from Model RT</a>
1331+
<a href="../../migration-modelrt/">Migration from Model RealTime</a>
13301332

13311333
<label for="__nav_2_11">
13321334
<span class="md-nav__icon md-icon"></span>
@@ -1337,7 +1339,7 @@
13371339
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_11_label" aria-expanded="false">
13381340
<label class="md-nav__title" for="__nav_2_11">
13391341
<span class="md-nav__icon md-icon"></span>
1340-
Migration from Model RT
1342+
Migration from Model RealTime
13411343
</label>
13421344
<ul class="md-nav__list" data-md-scrollfix>
13431345

@@ -1357,6 +1359,20 @@
13571359

13581360

13591361

1362+
1363+
1364+
1365+
1366+
1367+
<li class="md-nav__item">
1368+
<a href="../../migration-modelrt/best-practices/" class="md-nav__link">
1369+
Best Practices
1370+
</a>
1371+
</li>
1372+
1373+
1374+
1375+
13601376
</ul>
13611377
</nav>
13621378
</li>

docs/art-lang/index.html

Lines changed: 22 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1149,12 +1149,14 @@
11491149

11501150

11511151

1152+
1153+
11521154

11531155

11541156

11551157

11561158
<div class="md-nav__link md-nav__link--index ">
1157-
<a href="../migration-modelrt/">Migration from Model RT</a>
1159+
<a href="../migration-modelrt/">Migration from Model RealTime</a>
11581160

11591161
<label for="__nav_2_11">
11601162
<span class="md-nav__icon md-icon"></span>
@@ -1165,7 +1167,7 @@
11651167
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_11_label" aria-expanded="false">
11661168
<label class="md-nav__title" for="__nav_2_11">
11671169
<span class="md-nav__icon md-icon"></span>
1168-
Migration from Model RT
1170+
Migration from Model RealTime
11691171
</label>
11701172
<ul class="md-nav__list" data-md-scrollfix>
11711173

@@ -1185,6 +1187,20 @@
11851187

11861188

11871189

1190+
1191+
1192+
1193+
1194+
1195+
<li class="md-nav__item">
1196+
<a href="../migration-modelrt/best-practices/" class="md-nav__link">
1197+
Best Practices
1198+
</a>
1199+
</li>
1200+
1201+
1202+
1203+
11881204
</ul>
11891205
</nav>
11901206
</li>
@@ -2665,6 +2681,10 @@ <h4 id="transition-code">Transition Code</h4>
26652681
<p>A guard code snippet can either be written as a C++ statement that returns the boolean guard condition (as in the guard for transition <code>requestReceived</code> in the above example), or it can be written as a boolean expression (as in the trigger guard for the <code>timeout</code> trigger in the above example). If the guard condition is simple, as is often the case, using a boolean expression is recommended. However, if needed you can use any number of C++ statements in a guard condition where the last statement should return a boolean expression. For example, you can declare local variables to store partial results when computing the boolean expression.</p>
26662682
<div class="admonition note">
26672683
<p class="admonition-title">Note</p>
2684+
<p>The support for guard code snippets to be <em>either</em> boolean expressions <em>or</em> return statements that return boolean expressions rely on that it's possible for the code generator to syntactically conclude if a guard code is an expression or a statement. In some situations this may not be possible, for example if guard code uses macros. In that case you can disable the support for guard expressions by means of the TC property <a href="../building/transformation-configurations/#guardexpressions"><code>guardExpressions</code></a> and specify all guards with return statements.</p>
2685+
</div>
2686+
<div class="admonition note">
2687+
<p class="admonition-title">Note</p>
26682688
<p>Guard code snippets should execute fast and have no side-effects. They are called frequently to decide which transition to execute when a message has arrived.</p>
26692689
</div>
26702690
<p>Both effects and guards are translated to C++ functions in the generated code. These functions have two arguments that can be used in the effect and guard code snippets:</p>

docs/building/art-compiler/index.html

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1290,12 +1290,14 @@
12901290

12911291

12921292

1293+
1294+
12931295

12941296

12951297

12961298

12971299
<div class="md-nav__link md-nav__link--index ">
1298-
<a href="../../migration-modelrt/">Migration from Model RT</a>
1300+
<a href="../../migration-modelrt/">Migration from Model RealTime</a>
12991301

13001302
<label for="__nav_2_11">
13011303
<span class="md-nav__icon md-icon"></span>
@@ -1306,7 +1308,7 @@
13061308
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_11_label" aria-expanded="false">
13071309
<label class="md-nav__title" for="__nav_2_11">
13081310
<span class="md-nav__icon md-icon"></span>
1309-
Migration from Model RT
1311+
Migration from Model RealTime
13101312
</label>
13111313
<ul class="md-nav__list" data-md-scrollfix>
13121314

@@ -1326,6 +1328,20 @@
13261328

13271329

13281330

1331+
1332+
1333+
1334+
1335+
1336+
<li class="md-nav__item">
1337+
<a href="../../migration-modelrt/best-practices/" class="md-nav__link">
1338+
Best Practices
1339+
</a>
1340+
</li>
1341+
1342+
1343+
1344+
13291345
</ul>
13301346
</nav>
13311347
</li>

docs/building/build-cpp-files/index.html

Lines changed: 26 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@
9292
<div data-md-component="skip">
9393

9494

95-
<a href="#excluding-source-files" class="md-skip">
95+
<a href="#including-and-excluding-source-files" class="md-skip">
9696
Skip to content
9797
</a>
9898

@@ -931,8 +931,8 @@
931931
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
932932

933933
<li class="md-nav__item">
934-
<a href="#excluding-source-files" class="md-nav__link">
935-
Excluding Source Files
934+
<a href="#including-and-excluding-source-files" class="md-nav__link">
935+
Including and Excluding Source Files
936936
</a>
937937

938938
</li>
@@ -1193,12 +1193,14 @@
11931193

11941194

11951195

1196+
1197+
11961198

11971199

11981200

11991201

12001202
<div class="md-nav__link md-nav__link--index ">
1201-
<a href="../../migration-modelrt/">Migration from Model RT</a>
1203+
<a href="../../migration-modelrt/">Migration from Model RealTime</a>
12021204

12031205
<label for="__nav_2_11">
12041206
<span class="md-nav__icon md-icon"></span>
@@ -1209,7 +1211,7 @@
12091211
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_11_label" aria-expanded="false">
12101212
<label class="md-nav__title" for="__nav_2_11">
12111213
<span class="md-nav__icon md-icon"></span>
1212-
Migration from Model RT
1214+
Migration from Model RealTime
12131215
</label>
12141216
<ul class="md-nav__list" data-md-scrollfix>
12151217

@@ -1229,6 +1231,20 @@
12291231

12301232

12311233

1234+
1235+
1236+
1237+
1238+
1239+
<li class="md-nav__item">
1240+
<a href="../../migration-modelrt/best-practices/" class="md-nav__link">
1241+
Best Practices
1242+
</a>
1243+
</li>
1244+
1245+
1246+
1247+
12321248
</ul>
12331249
</nav>
12341250
</li>
@@ -1404,8 +1420,8 @@
14041420
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
14051421

14061422
<li class="md-nav__item">
1407-
<a href="#excluding-source-files" class="md-nav__link">
1408-
Excluding Source Files
1423+
<a href="#including-and-excluding-source-files" class="md-nav__link">
1424+
Including and Excluding Source Files
14091425
</a>
14101426

14111427
</li>
@@ -1462,15 +1478,15 @@ <h1>C++ Source Files</h1>
14621478
};
14631479
</code></pre>
14641480
<p>It's recommended to place C++ source files in subfolders as in the example above. If you place them directly in the workspace folder you need to ensure they don't have the same name as any of the Art elements that are built. This is to ensure there are no name clashes between the object files that are produced when building.</p>
1465-
<h2 id="excluding-source-files">Excluding Source Files</h2>
1481+
<h2 id="including-and-excluding-source-files">Including and Excluding Source Files</h2>
14661482
<p>By default all <code>.cpp</code> and <code>.h</code> files that are found in a workspace folder, or in a folder that is directly or indirectly contained in the workspace folder, will be included in the build. If you want to exclude some of these files from the build you can use the <a href="../transformation-configurations/#sources"><code>sources</code></a> TC property, just as for Art files. All <code>.cpp</code> and <code>.h</code> files that match at least one pattern in the <a href="../transformation-configurations/#sources"><code>sources</code></a> property, and doesn't match an anti-pattern (starting with the character <code>!</code>) will be included into the build. </p>
14671483
<div class="admonition note">
14681484
<p class="admonition-title">Note</p>
14691485
<p>If you set the <a href="../transformation-configurations/#sources"><code>sources</code></a> property to explicitly include some specific <code>.cpp</code> and <code>.h</code> files you also need to specify which <code>.art</code> files to include. That is, make sure the specified patterns match all files that should be included in the build (both <code>.cpp</code>, <code>.h</code> and <code>.art</code> files). If you only specify anti-patterns (i.e. files to exclude from the build) you don't need to do this, since by default all files are included except the ones that are excluded.</p>
14701486
</div>
14711487
<p>Here are some examples:</p>
1472-
<pre><code class="language-js">tc.sources = [&quot;**/*.cpp&quot;, &quot;**/*.h&quot;, &quot;*.art&quot;]; // Include all .cpp and .h files from the workspace folder and all its subfolders, and all .art files from the workspace folder. This is the default behavior if the &quot;sources&quot; property is not set.
1473-
tc.sources = [&quot;src/utils.cpp&quot;, &quot;include/utils.h&quot;, &quot;*.art&quot;]; // Include a specific .cpp and .h file into the build
1488+
<pre><code class="language-js">tc.sources = [&quot;**/*.art&quot;, &quot;**/*.h&quot;, &quot;**/*.cpp&quot;]; // Include all .art, .cpp and .h files from the workspace folder and all its subfolders. This is the default behavior if the &quot;sources&quot; property is not set.
1489+
tc.sources = [&quot;src/utils.cpp&quot;, &quot;include/utils.h&quot;, &quot;**/*.art&quot;]; // Include a specific .cpp and .h file into the build
14741490
tc.sources = [&quot;!src/utils.cpp&quot;, &quot;!include/utils.h&quot;]; // Include all .cpp and .h files except two specific ones (all .art files will be built)
14751491
</code></pre>
14761492
<p>If you have set-up the TC to place generated C++ files in a subfolder of the workspace folder, you don't have to exclude them by means of the <a href="../transformation-configurations/#sources"><code>sources</code></a> TC property. Generated files will always be included in the build exactly once, no matter where they are located. </p>

docs/building/build-tasks/index.html

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1193,12 +1193,14 @@
11931193

11941194

11951195

1196+
1197+
11961198

11971199

11981200

11991201

12001202
<div class="md-nav__link md-nav__link--index ">
1201-
<a href="../../migration-modelrt/">Migration from Model RT</a>
1203+
<a href="../../migration-modelrt/">Migration from Model RealTime</a>
12021204

12031205
<label for="__nav_2_11">
12041206
<span class="md-nav__icon md-icon"></span>
@@ -1209,7 +1211,7 @@
12091211
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_11_label" aria-expanded="false">
12101212
<label class="md-nav__title" for="__nav_2_11">
12111213
<span class="md-nav__icon md-icon"></span>
1212-
Migration from Model RT
1214+
Migration from Model RealTime
12131215
</label>
12141216
<ul class="md-nav__list" data-md-scrollfix>
12151217

@@ -1229,6 +1231,20 @@
12291231

12301232

12311233

1234+
1235+
1236+
1237+
1238+
1239+
<li class="md-nav__item">
1240+
<a href="../../migration-modelrt/best-practices/" class="md-nav__link">
1241+
Best Practices
1242+
</a>
1243+
</li>
1244+
1245+
1246+
1247+
12321248
</ul>
12331249
</nav>
12341250
</li>

docs/building/build-variants/index.html

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1377,12 +1377,14 @@
13771377

13781378

13791379

1380+
1381+
13801382

13811383

13821384

13831385

13841386
<div class="md-nav__link md-nav__link--index ">
1385-
<a href="../../migration-modelrt/">Migration from Model RT</a>
1387+
<a href="../../migration-modelrt/">Migration from Model RealTime</a>
13861388

13871389
<label for="__nav_2_11">
13881390
<span class="md-nav__icon md-icon"></span>
@@ -1393,7 +1395,7 @@
13931395
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_11_label" aria-expanded="false">
13941396
<label class="md-nav__title" for="__nav_2_11">
13951397
<span class="md-nav__icon md-icon"></span>
1396-
Migration from Model RT
1398+
Migration from Model RealTime
13971399
</label>
13981400
<ul class="md-nav__list" data-md-scrollfix>
13991401

@@ -1413,6 +1415,20 @@
14131415

14141416

14151417

1418+
1419+
1420+
1421+
1422+
1423+
<li class="md-nav__item">
1424+
<a href="../../migration-modelrt/best-practices/" class="md-nav__link">
1425+
Best Practices
1426+
</a>
1427+
</li>
1428+
1429+
1430+
1431+
14161432
</ul>
14171433
</nav>
14181434
</li>

docs/building/images/tc-editor.png

-5.42 KB
Loading

0 commit comments

Comments
 (0)