Introduce the example and describe the setup steps for each tool

Issue-Ref: 4031 Issue-Url: https://af3-developer.fortiss.org/issues/4031 Signed-off-by: Tiziano Munaro <munaro@fortiss.org>

Introduce the example and describe the setup steps for each tool
3534b4cb · Tiziano Munaro · e1cb2546 · 3534b4cb · 3534b4cb
Commit 3534b4cb authored 4 years ago by Tiziano Munaro
--- a/org.fortiss.af3.rcp.help/html/.ratings
+++ b/org.fortiss.af3.rcp.help/html/.ratings
 af3_faq.html 851f9881df0a7d2093c05bd73aa4e0e404e592db GREEN
+example_co-simulation.html 5f53ae41deec804c786c782a819a0ec39057d887 RED
 furtherResources.MainPage.html 1d38b2ed28f00c8abed17a5c3aca6316341163f1 GREEN
 getting_started.html d2cec69b06162d9b63687b4b8e9cadedabe168a7 GREEN
 managing_projects.html f112b5b7db98bd373b870c343ba708e7b9c90aee GREEN

--- a/org.fortiss.af3.rcp.help/html/example_co-simulation.html
+++ b/org.fortiss.af3.rcp.help/html/example_co-simulation.html
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
+
+<!--  Documentation to Create, Import, Export and Load AF3-Projects. -->
+
+<html>
+	<head>
+		<link rel="stylesheet" type="text/css" href="./layout/stylesheet.css"/>
+		<title>FMI-based Co-Simulation with OpenModelica and Overture</title>
+	</head>
+	
+	<body>
+		<div class="box">
+			<button onclick="topFunction()" id="upBtn" title="Go to top">Top</button>
+			
+			<h1>FMI-based Co-Simulation with OpenModelica and Overture</h1>
+			
+				The following example illustrates the co-simulation capabilities of AutoFOCUS 3 and shows how this feature can be leveraged for tool-interoperability.
+				To highlight the potential of the Functional Mock-up Interface (FMI) standard, the following example considers a controlled inverted pendulum.
+				On the one hand, both the pendulum's dynamics and the PID controller are modeled using OpenModelica - a tool dedicated to the development of continuous systems.
+				The input and environment models, on the other hand, have been developed in AutoFOCUS 3 and Overture respectively - both representing models with a discrete notion of time.
+			
+				<h2>Setup</h2>
+				
+					<h3>AutoFOCUS 3</h3>
+
+						<ol>
+							<li>Download the following AutoFOCUS 3 model: <a href="./gettingStarted/dat/af3_pulse-generator.af3_23">Input Model</a></li>
+							<li>Import the project: <b>'File &rarr; Import AF3-Project'</b></li>
+						</ol>
+				
+					<h3>Overture</h3>
+
+						<ol>
+							<li><a href="http://overturetool.org/download/">Download</a>, unzip and launch Overture</li>
+							<li>Download the following Overture project: <a href="./gettingStarted/dat/overture_noise-generator.zip">Environment Model</a></li>
+							<li>Unzip the archive.</li>
+							<li>Import the project: <b>'File &rarr; Import... &rarr; General &rarr; Existing Projects into Workspace'</b></li>
+						</ol>
+				
+					<h3>OpenModelica</h3>
+
+						<ol>
+							<li><a href="https://openmodelica.org/">Download</a></td> and install OpenModelica</li>
+							<li>Install the FMI exporter for Overture following these instructions: <a href="https://into-cps-association.github.io/constituent-model-development/overture/fmi-support.html">FMI support for Overture</a></li>
+							<li>Download the following OpenModelica model: <a href="./gettingStarted/dat/openmodelica_inverted-pendulum.mo">System &amp; Controller Models</a></li>
+							<li>Import the project: <b>'File &rarr; Open Model/Library Files(s)'</b></li>
+						</ol>
+						
+				<h2>FMU Export</h2>
+				
+					<h3>AutoFOCUS 3</h3>
+
+						<ol>
+							<li>Export the <b>Input</b> component as FMU: <b>'[Right click on component] &rarr; Export to FMU 2.0'</b></li>
+							<li>Set the component to be executed at a frequency of <b>100 Hz</b> and store it in the root folder of your workspace.</li>
+						</ol>
+				
+					<h3>Overture</h3>
+
+						<ol>
+							<li>Export the <b>NoiseGenerator</b> project as FMU: <b>'[Right click on project] &rarr; Overture FMU &rarr; Export Tool Wrapper FMU'</b></li>
+							<li>The FMU will be stored in <b>'./generated'</b> within the project directory.</li>
+						</ol>
+				
+					<h3>OpenModelica</h3>
+
+						<ol>
+							<li>Export the model as FMU: <b>'File &rarr; Export &rarr; FMU'</b></li>
+							<li>The location of the newly generated FMU will be displayed in the console.</li>
+						</ol>
+						
+				<h2>FMI-based Co-Simulation</h2>
+				
+					<h3>AutoFOCUS 3</h3>
+					
+						<ol>
+							<li></li>
+						</ol>
+					
+					<h3>OpenModelica</h3>
+					
+						<ol>
+							<li></li>
+						</ol>
+
+		</div>
+		<script src="../layout/jsscript/topBtn.js"></script>
+		<script src="./layout/jsscript/submenuScript.js"></script>
+		<div class="footer">
+			<p>
+					&copy; 2020 <a href="https://www.fortiss.org/">fortiss GmbH</a> &nbsp;&nbsp;&bull;&nbsp;&nbsp;
+				<a href="https://www.fortiss.org/en/publications/software/autofocus-3#c2007">Contact</a>&nbsp;&nbsp;&bull;&nbsp;&nbsp;
+				<a href="https://www.fortiss.org/en/imprint">Imprint</a>
+			</p>
+		</div>
+	</body>
+</html>
\ No newline at end of file