Documentation for system schedule

Issue-Ref: 3834 Issue-Url: https://af3-developer.fortiss.org/issues/3834 Signed-off-by: Simon Barner <barner@fortiss.org>

Documentation for system schedule
16b8f9b6 · Simon Barner · 62bc4f37 · 16b8f9b6 · 16b8f9b6 · 16b8f9b6
Commit 16b8f9b6 authored 5 years ago by Simon Barner
--- a/org.fortiss.af3.rcp.help/html/ta/.ratings
+++ b/org.fortiss.af3.rcp.help/html/ta/.ratings
 allocations.html 91f2636b00d59253f7007864d4e0ebdd0b713dad RED
-beagle_java_deployment.html 8ba70c9b06c3313f3d732bcdb43e8cc15fe193a1 RED
-code_generation.html 8d3b9847eed8693bbc0c23a0dc5f8be2f118714b RED
+beagle_java_deployment.html 71722ccb21d588da69256307988ff9567c0d93a0 RED
+code_generation.html d05bdb6fb049422d08a450324f0563391e5e48e9 RED
 partition_architecture.html a92e71ac333c972cba98660c43b9cb13528074f2 RED
 platform_architecture.html 89df3aa2fa49faad25aaa52264d89393ce6bd18f RED
 platform_architecture_generic.html cb91689226e3ed5168b11ba2d008601dc2661637 RED
 platform_architecture_hierarchical.html 3c410b1c8ee284b2080d03eb5d022cdee531257a RED
+system_schedule.html 58dccc62eb8fe2a731a12d118638f932510a82e6 RED
 task_architecture.html fbce88173c788b20b1a7d97195f935f685c1d7e6 RED
-technical_viewpoint.html c528f8f14632305a2977029fff75f8c364d6ab5a RED
+technical_viewpoint.html b74101aeb2ffd34b21cd53cad2116c694b5424de RED
--- a/org.fortiss.af3.rcp.help/html/ta/pictures/System.Schedule.Edit.Manually.png
+++ b/org.fortiss.af3.rcp.help/html/ta/pictures/System.Schedule.Edit.Manually.png
--- a/org.fortiss.af3.rcp.help/html/ta/pictures/System.Schedule.Example.png
+++ b/org.fortiss.af3.rcp.help/html/ta/pictures/System.Schedule.Example.png
--- a/org.fortiss.af3.rcp.help/html/ta/pictures/System.Schedule.Show.View.png
+++ b/org.fortiss.af3.rcp.help/html/ta/pictures/System.Schedule.Show.View.png
--- a/org.fortiss.af3.rcp.help/html/ta/system_schedule.html
+++ b/org.fortiss.af3.rcp.help/html/ta/system_schedule.html
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
+
+<html>
+<head>
+	<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
+	<title>System Schedules</title>
+</head>
+<body>
+
+<h2><u><font color="#336699">System Schedule</font></u></h2>
+
+<p>A <i>System Schedule</i> collects the schedules for all involved resources in the associated
+<i><a href="allocations.html">Allocation</a></i> that defines the mapping of the elements
+of a <i><a href="task_architecture.html">Task Architecture</a></i>
+to the underlying hardware <i><a href="platform_architecture.html">Platform Architecture</a></i>).
+An important attribute of a system schedule is its Major Frame (MAF) that is defined as the period of time to be
+considered when computing the task allocation and scheduling. The MAF of a <i>System Schedule</i>
+is normally equal to the least-common multiple (LCM) of the periods of all
+<i>ResourceSchedule</i>s, but can be less than this value under certain conditions such
+as harmonicity or geometricity of periods.</p>
+
+<p>The schedule of each individual resource is described using a <i>Resource Schedule</i>.
+The allocation of a share of the resource referenced by a <i>Resource Schedule</i> is
+expressed using a <i>Resource Allocation</i>.</p>
+
+<p>The AutoFOCUS3 schedule model enables to describe hierarchical schedules. The share of a resource
+described by a <i>Resource Allocation</i> allocated in a <i>Resource Schedule</i> can be
+further sub-divided by declaring a <i>Sub Schedule</i> for it. <i>Sub Schedule</i>s apply the
+concept recursively, i.e., they also contain <i>Resource Allocation</i>s that reference a
+<i>SchedulableEntity</i> and a <i>Trigger</i>. A <i>Sub-Schedule</i> does however not
+reference a platform resource, since it refines another <i>Resource Allocation</i>. <i>Trigger</i>s
+ specify the temporal activation pattern of <i>Resource Allocation</i>s.</p>
+
+<p>The figure below shows the Gantt chart of an exemplary schedule.</p>
+
+<img src="pictures/System.Schedule.Example.png" />
+
+<p>Due to the inherent complexity of the problem, (real-time) schedules are typically not defined manually,
+but are <a href="../dse/schedule_synthesis.html">synthesized automatically</a>. To enable comfortable
+testing, the modeling perspective of AutoFOCUS3 provides a minimal schedule editor that is based on
+the model navigator and the properties section. This means that <i>system schedules</i> can be created using
+the context menu of the project, <i>resource schedules</i> can be added in the context
+menu of a <i>system schedule</i>, etc.</p>
+
+<img src="pictures/System.Schedule.Edit.Manually.png" />
+
+<p>To view a Gantt chart of a system schedule in the modeling perspective, the </i>Schedule View</i>
+needs to be activated from the dialog that is shown by hitting <tt>ALT+SHIFT+Q</tt> followed by <tt>Q</tt>.
+The view will render the system schedule that has been selected last in the model navigator.</p>
+
+<img src="pictures/System.Schedule.Show.View.png" />
+  
+</body>
+</html>
\ No newline at end of file
--- a/org.fortiss.af3.rcp.help/html/ta/technical_viewpoint.html
+++ b/org.fortiss.af3.rcp.help/html/ta/technical_viewpoint.html
@@ -37,7 +37,8 @@ mappings between the following following viewpoints:</li>
 <li><a href="partition_architecture.html">Partition Architecture</a></li>
 <li><a href="platform_architecture.html">Platform Architecture</a></li>
 </ul>
-<li><i><a href="system_schedule">System schedule</a></i>: </li>
+<li><i><a href="system_schedule.html">System schedule</a></i>: A System Schedule is a container for
+the schedules for all resources referenced by the given allocation.</li>
 </ul>

 </body>