Change TOC-Style in PRD

doc/lastenheft/lastenheft.tex

@@ -37,6 +37,11 @@
 }
 \newacronym{IPD}{IPD}{\gls{Inner-Platoon-Distance}}
 
+\newacronym{UC}{UC}{Use-Case}
+\newacronym{RQ}{RQ}{Requirement}
+\newacronym{ES}{ES}{Evolution-State}
+\newacronym{MS}{MS}{Milestone}
+
 \makeglossaries % needs to be set after the inclusion of hyperref!
 \glsunsetall % this will suppress expanding the first occurrence of acronyms
 %%% BIBTEX %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
@@ -66,7 +71,7 @@
 \section{Projektbeschreibung}
 Das Projekt soll automatisches Kolonnenfahren für Modellautos realisieren
 
-\subsection*{Organisation}
+\subsection{Organisation}
 Wird in drei Gruppen umgesetzt, welche hauptsächlich in 
 paralleler, kooperativer Arbeit agieren. Die Gruppen werden mit
 \textit{Gruppe A}, \textit{Gruppe B} und \textit{Gruppe C} bezeichnet.
@@ -80,16 +85,17 @@ und beschriebenen Use-Cases.
 Während der Entwicklung sollte auf größtmögliche Konformität mit dem
 bestehenden Projekt der Assystem geachtet werden.
 
-\subsection*{Stakeholder}
+\subsection{Stakeholder}
 wichtige Personen hier aufführen.
 Verantworliche von Assystem u.a.
 
-\section{Zielvorstellungen}
+\section{Zielvorstellungen / Ausbaustufen}
 In diesem Abschnitt sollen Beispielszenarien beschrieben werden,
 welche durch das fertige System durchlaufen werden können soll.
 Dabei werden drei verschiedenen Ausbaustufen definiert.
 
 \subsection*{Minimale Zielvorstellung}\label{AB:min}
+\addcontentsline{toc}{subsection}{\nameref{AB:min}}
 \underline{Required Use-Cases:}
 \begin{itemize}
   \item 
@@ -107,12 +113,14 @@ Upon reaching the obstacle the whole platoon stops while still maintaining the c
 %bei schweren Störungen immer Emergency-Stop
 
 \subsection*{Ausbaustufe - Setup-Distance}\label{AB:setupDist}
+\addcontentsline{toc}{subsection}{\nameref{AB:setupDist}}
 \underline{Required Use-Cases:}
 \begin{itemize}
   \item 
 \end{itemize}
 Anfangsabstand and Kolonnenabstand sind unterschiedlich
 \subsection*{Ausbaustufe - Stop-Last-Car}\label{AB:stopCar}
+\addcontentsline{toc}{subsection}{\nameref{AB:stopCar}}
 \underline{Required Use-Cases:}
 \begin{itemize}
   \item \nameref{UC:leavePlatoon}
@@ -125,6 +133,7 @@ The last car will then brake.
 The other two cars keep driving as a platoon until they reach the obstacle.
 
 \subsection*{Ausbaustufe - Asynchronous-Start }\label{AB:asynStart}
+\addcontentsline{toc}{subsection}{\nameref{AB:asynStart}}
 \underline{Required Use-Cases:}
 \begin{itemize}
   \item 
@@ -140,6 +149,7 @@ Therefore it drives in the same lane, the same direction and the same speed as t
 Eventually the platoon consisting of now three members will reach the obstacle and stop.
 
 \subsection*{Ausbaustufe - Circle-Path}\label{AB:circle}
+\addcontentsline{toc}{subsection}{\nameref{AB:circle}}
 \underline{Required Use-Cases:}
 \begin{itemize}
   \item 
@@ -153,18 +163,21 @@ The same as scenario 1 however the route is not a straight line but a circle.
 %keine Feste Konfiguration, d.h. \gls{LV} abhängig von der Situation fesetgelegt
 
 \subsection*{Ausbaustufe - Change-\gls{IPD}}\label{AB:changeDist}
+\addcontentsline{toc}{subsection}{\nameref{AB:changeDist}}
 \underline{Required Use-Cases:}
 \begin{itemize}
   \item 
 \end{itemize}
 Kunde kann den Kolonnenabstand während der Fahrt ändern
 \subsection*{Ausbaustufe - Turn-On-After-Start}\label{AB:asynStart-2}
+\addcontentsline{toc}{subsection}{\nameref{AB:asynStart-2}}
 \underline{Required Use-Cases:}
 \begin{itemize}
   \item 
 \end{itemize}
 2 Fahrzeuge fahren in Kolonne. Kunde bootet und startet 3. Fahrzeug, 3. Fahrzeug schließt sich der Kolonne an
 \subsection*{Ausbaustufe - Manual-Speed}\label{AB:changeSpeed}
+\addcontentsline{toc}{subsection}{\nameref{AB:changeSpeed}}
 \underline{Required Use-Cases:}
 \begin{itemize}
   \item 
@@ -174,6 +187,7 @@ so lange sie nicht in Kolonne fahren.
 Der Kunde kann Fahrzeug x in die Kolonne bringen.
 Wenn es in der Kolonne ist, reagiert es nicht mehr auf Geschwindigkeitsänderungswünsche…
 \subsection*{Ausbaustufe - RC-Control}\label{AB:RCcontrol}
+\addcontentsline{toc}{subsection}{\nameref{AB:RCcontrol}}
 \underline{Required Use-Cases:}
 \begin{itemize}
   \item 
@@ -186,7 +200,8 @@ Wenn es in der Kolonne ist, reagiert es nicht mehr auf Geschwindigkeitsänderung
 
 \section{Use-Cases}
 %TODO Reihenfolge ändern
-\subsection*{Fahrbahn folgen}\label{UC:laneKeeping}
+\subsection*{\texorpdfstring{\gls{UC}}{UC} - Fahrbahn folgen}\label{UC:laneKeeping}
+\addcontentsline{toc}{subsection}{\nameref{UC:laneKeeping}}
 \underline{Notwendig für Ausbaustufen:}
 \begin{itemize}
   \item \nameref{AB:circle}
@@ -196,7 +211,8 @@ Wenn es in der Kolonne ist, reagiert es nicht mehr auf Geschwindigkeitsänderung
   \item 
 \end{itemize}
 
-\subsection*{Kolonne erstellen}\label{UC:createPlatoon}
+\subsection*{\texorpdfstring{\gls{UC}}{UC} - Kolonne erstellen}\label{UC:createPlatoon}
+\addcontentsline{toc}{subsection}{\nameref{UC:createPlatoon}}
 \underline{Notwendig für Ausbaustufen:}
 \begin{itemize}
   \item 
@@ -210,7 +226,8 @@ Wenn es in der Kolonne ist, reagiert es nicht mehr auf Geschwindigkeitsänderung
 % \subsubsection*{Als \gls{FV} Kolonne bilden}\label{UC:FVcreatePlatoon}
 % \subsubsection*{Verifikation der Erstellung}\label{UC:PPcreatePlatoon} % TODO ich (Franz) bin dafür dieses Use-Case zu löschen
 
-\subsection*{Kolonne beitreten}\label{UC:joinPlatoon}
+\subsection*{\texorpdfstring{\gls{UC}}{UC} - Kolonne beitreten}\label{UC:joinPlatoon}
+\addcontentsline{toc}{subsection}{\nameref{UC:joinPlatoon}}
 \underline{Notwendig für Ausbaustufen:}
 \begin{itemize}
   \item 
@@ -220,17 +237,19 @@ Wenn es in der Kolonne ist, reagiert es nicht mehr auf Geschwindigkeitsänderung
   \item 
 \end{itemize}
 
-\subsection*{Kolonne verlassen}\label{UC:leavePlatoon}
+\subsection*{\texorpdfstring{\gls{UC}}{UC} - Kolonne verlassen}\label{UC:leavePlatoon}
+\addcontentsline{toc}{subsection}{\nameref{UC:leavePlatoon}}
 \underline{Notwendig für Ausbaustufen:}
 \begin{itemize}
   \item \nameref{AB:stopCar}
 \end{itemize}
 \underline{Verwendete Anforderung:}
 \begin{itemize}
-  \item \nameref{RQ:PP-leaveMsg}
+  \item \nameref{RQ:leaveMsg}
 \end{itemize}
 
-\subsection*{Kolonne auflösen}\label{UC:deltePlatoon}
+\subsection*{\texorpdfstring{\gls{UC}}{UC} - Kolonne auflösen}\label{UC:deltePlatoon}
+\addcontentsline{toc}{subsection}{\nameref{UC:deltePlatoon}}
 \underline{Notwendig für Ausbaustufen:}
 \begin{itemize}
   \item 
@@ -240,7 +259,8 @@ Wenn es in der Kolonne ist, reagiert es nicht mehr auf Geschwindigkeitsänderung
   \item 
 \end{itemize}
 
-\subsection*{Anzeigen/Ausgaben des aktuellen Status}\label{UC:showStatus}
+\subsection*{\texorpdfstring{\gls{UC}}{UC} - Anzeigen/Ausgaben des aktuellen Status}\label{UC:showStatus}
+\addcontentsline{toc}{subsection}{\nameref{UC:showStatus}}
 \underline{Notwendig für Ausbaustufen:}
 \begin{itemize}
   \item 
@@ -250,7 +270,8 @@ Wenn es in der Kolonne ist, reagiert es nicht mehr auf Geschwindigkeitsänderung
   \item 
 \end{itemize}
 
-\subsection*{Kollonnenfahren}\label{UC:runPlatoon}
+\subsection*{\texorpdfstring{\gls{UC}}{UC} - Kollonnenfahren}\label{UC:runPlatoon}
+\addcontentsline{toc}{subsection}{\nameref{UC:runPlatoon}}
 \underline{Notwendig für Ausbaustufen:}
 \begin{itemize}
   \item \nameref{AB:min}
@@ -261,8 +282,9 @@ Wenn es in der Kolonne ist, reagiert es nicht mehr auf Geschwindigkeitsänderung
 \end{itemize}
 
 \section{Funktionale Anforderungen}
-\subsection*{Anforderungen an das allgemeine Fahrzeugverhalten (RQ-V-XX)}
-\subsubsection*{RQ-V-10 Emergency-Stop}
+\subsection{Anforderungen an das allgemeine Fahrzeugverhalten (RQ - GVXX)}
+\subsubsection*{RQ - GV10 Emergency-Stop}\label{RQ:emergencyStop}
+\addcontentsline{toc}{subsubsection}{\nameref{RQ:emergencyStop}}
 \underline{Notwendig für Use-Cases:}
 \begin{itemize}
   \item 
@@ -278,7 +300,8 @@ ignoriert.
 Ein Emergency-Stop muss sofort als Broadcast an alle Fahrzeuge
 kommuniziert werden.
 
-\subsubsection*{RQ-V-20 Hindernis Erkennung}
+\subsubsection*{RQ - GV20 Hindernis Erkennung}\label{RQ:obstacleDetect}
+\addcontentsline{toc}{subsubsection}{\nameref{RQ:obstacleDetect}}
 \underline{Notwendig für Use-Cases:}
 \begin{itemize}
   \item 
@@ -286,26 +309,28 @@ kommuniziert werden.
 Ein Fahrzeug muss vor sich befindliche Hindernisse (evtl. auch andere Fahrzeuge)
 erkennen und deren relative Position und Geschwindigkeit bestimmen können.
 
-\subsubsection*{RQ-V-30 W-LAN Kommunikation}
-
-\paragraph{RQ-V-31 Aufbau der Verbindung zu einem Steuercomputer}
-Die Fahrzeuge müssen mit einem Steuercomputer verbunden werden können.
-Der Steuercomputer dient dazu durch Auslesen von log-Dateien,
-die Funktion der Fahrzeuge zu überwachen
-und Nachrichten des Platooning-Protokolls in seinem Namen, oder
-stellvertretend für jedes andere Fahrzeug zu verschicken.
-
-\paragraph{RQ-V-32 Aufbau der Verbindung zu anderen Fahrzeugen}
-Die Fahrzeuge müssen ihre Intention eine Kolonne zu bilden
-umliegenden Fahrzeugen per W-LAN mitteilen können.
-
-\subsubsection*{RQ-V-30 RC-Steuerung}
-
-\subsection*{Anforderungen an das \texorpdfstring{\gls{LV}}{LV} (RQ-LV-XX)}
-\subsubsection*{RQ-LV-10 Ermittlung/Festlegung des \gls{PS}}
+%\subsubsection*{RQ - GV30 W-LAN Kommunikation}
+%
+%\paragraph{RQ - GV31 Aufbau der Verbindung zu einem Steuercomputer}
+%Die Fahrzeuge müssen mit einem Steuercomputer verbunden werden können.
+%Der Steuercomputer dient dazu durch Auslesen von log-Dateien,
+%die Funktion der Fahrzeuge zu überwachen
+%und Nachrichten des Platooning-Protokolls in seinem Namen, oder
+%stellvertretend für jedes andere Fahrzeug zu verschicken.
+%
+%\paragraph{RQ - GV32 Aufbau der Verbindung zu anderen Fahrzeugen}
+%Die Fahrzeuge müssen ihre Intention eine Kolonne zu bilden
+%umliegenden Fahrzeugen per W-LAN mitteilen können.
+
+\subsubsection*{RQ - GV30 RC-Steuerung}\label{RQ:RCcontrol}
+\addcontentsline{toc}{subsubsection}{\nameref{RQ:RCcontrol}}
+
+\subsection{Anforderungen an das \texorpdfstring{\gls{LV}}{LV} (RQ - LVXX)}
+\subsubsection*{RQ - LV10 Ermittlung/Festlegung des \gls{PS}}\label{RQ:setPS}
+\addcontentsline{toc}{subsubsection}{\nameref{RQ:setPS}}
 \underline{Notwendig für Use-Cases:}
 \begin{itemize}
-  \item \nameref{UC:leavePlatoon}
+  \item 
 \end{itemize}
 Das \gls{LV} muss aus den Abständen zu Hindernissen, oder voran fahrenden
 Fahrzeugen ein \gls{PS} ermitteln und diese allen \gls{FV}
@@ -315,10 +340,11 @@ Wird ein festzulegender kritischer Grenzwert für die Geschwindigkeitsänderung
 
 Eine Übertragung von Beschleuningungsinformationen ist nicht vorgesehen.
 
-\subsubsection*{RQ-LV-20 Ermittlung/Festlegung des \gls{IPD}}
+\subsubsection*{RQ - LV20 Ermittlung/Festlegung des \gls{IPD}}\label{RQ:setIPD}
+\addcontentsline{toc}{subsubsection}{\nameref{RQ:setIPD}}
 \underline{Notwendig für Use-Cases:}
 \begin{itemize}
-  \item \nameref{UC:leavePlatoon}
+  \item 
 \end{itemize}
 Das \gls{LV} muss aus dem \gls{PS},
 den Abständen zu Hindernissen, oder voran fahrenden
@@ -327,22 +353,19 @@ mitteilen.
 Wird ein festzulegender kritischer Grenzwert für die Abstände unterschritten,
 so wird das Emergency-Stop-Signal gebroadcasted.
 
-\subsection*{RQ-LV-30 Erkennen und Kommunizieren schwerer Störungen}
+\subsubsection*{RQ - LV30 Erkennen und Kommunizieren schwerer Störungen}\label{RQ:seeCritErr}
+\addcontentsline{toc}{subsubsection}{\nameref{RQ:seeCritErr}}
 \underline{Notwendig für Use-Cases:}
 \begin{itemize}
-  \item \nameref{UC:leavePlatoon}
-\end{itemize}
-
-\subsection*{Anforderungen an die \texorpdfstring{\gls{FV}}{FV} (RQ-FV-XX)}
-\underline{Notwendig für Use-Cases:}
-\begin{itemize}
-  \item \nameref{UC:leavePlatoon}
+  \item 
 \end{itemize}
 
-\subsubsection*{RQ-FV-10 Halten des \gls{PS}}
+\subsection{Anforderungen an die \texorpdfstring{\gls{FV}}{FV} (RQ - FVXX)}
+\subsubsection*{RQ - FV10 Halten des \gls{PS}}\label{RQ:keepPS}
+\addcontentsline{toc}{subsubsection}{\nameref{RQ:keepPS}}
 \underline{Notwendig für Use-Cases:}
 \begin{itemize}
-  \item \nameref{UC:leavePlatoon}
+  \item 
 \end{itemize}
 Ein \gls{FV} muss in der Lage sein eine vom \gls{LV} vorgegebene
 Geschwindigkeit zu halten.
@@ -357,10 +380,11 @@ diese (innerhalb einer Toleranz) erstmalig für einen gewissen (kurzen)
 Kontrollzeitruam gehalten, so wird die erfolgreiche
 Umsetzung der Geschwindigkeitsänderung dem \gls{LV} mitgeteilt.
 
-\subsubsection*{RQ-FV-20 Halten der \gls{IPD}}
+\subsubsection*{RQ - FV20 Halten der \gls{IPD}}\label{RQ:keepIPD}
+\addcontentsline{toc}{subsubsection}{\nameref{RQ:keepIPD}}
 \underline{Notwendig für Use-Cases:}
 \begin{itemize}
-  \item \nameref{UC:leavePlatoon}
+  \item 
 \end{itemize}
 Ein \gls{FV} muss in der Lage sein ein vom \gls{LV} vorgegebenen
 Abstand zu seinem voran fahrenden Fahrzeug einzurichten und zu halten.
@@ -380,82 +404,92 @@ dieser (innerhalb einer Toleranz) erstmalig für einen gewissen (kurzen)
 Kontrollzeitruam gehalten, so wird die erfolgreiche
 Umsetzung der Abstandsänderung dem \gls{LV} mitgeteilt.
 
-\subsubsection*{Erkennung von Drehungen des voran fahrenden Fahrzeugs}
+\subsubsection*{RQ- FV30 Erkennung von Drehungen des voran fahrenden Fahrzeugs}\label{RQ:seeTurn}
+\addcontentsline{toc}{subsubsection}{\nameref{RQ:seeTurn}}
 \underline{Notwendig für Use-Cases:}
 \begin{itemize}
-  \item \nameref{UC:leavePlatoon}
+  \item 
 \end{itemize}
 
-\subsection*{Anforderungen an das Platooning-Protokoll (RQ-PP-XX)}
-
-\subsubsection*{RQ-PP-10 Mitteilung: Emergency-Stop}
+\subsection{Anforderungen an das Platooning-Protokoll (RQ - PPXX)}
+\subsubsection*{RQ - PP10 Mitteilung: Emergency-Stop}\label{RQ:emergencyStopMsg}
+\addcontentsline{toc}{subsubsection}{\nameref{RQ:emergencyStopMsg}}
 \underline{Notwendig für Use-Cases:}
 \begin{itemize}
-  \item \nameref{UC:leavePlatoon}
+  \item 
 \end{itemize}
 
-\subsubsection*{RQ-PP-20 Auswahl der Kolonnenführung (\texorpdfstring{\gls{LV}}{LV}) }
+\subsubsection*{RQ - PP20 Auswahl der Kolonnenführung (\texorpdfstring{\gls{LV}}{LV}) }\label{RQ:voteLeader}
+\addcontentsline{toc}{subsubsection}{\nameref{RQ:voteLeader}}
 \underline{Notwendig für Use-Cases:}
 \begin{itemize}
-  \item \nameref{UC:leavePlatoon}
+  \item 
 \end{itemize}
 
-\subsubsection*{RQ-PP-30 Mitteilung zur Bereitschaft am Kolonnenfahren}
+\subsubsection*{RQ - PP30 Mitteilung zur Bereitschaft am Kolonnenfahren}\label{RQ:wantPlatoonMsg}
+\addcontentsline{toc}{subsubsection}{\nameref{RQ:wantPlatoonMsg}}
 \underline{Notwendig für Use-Cases:}
 \begin{itemize}
-  \item \nameref{UC:leavePlatoon}
+  \item 
 \end{itemize}
 
-\subsubsection*{RQ-PP-40 Mitteilung bei Austritt aus der Kolonne} \label{RQ:PP-leaveMsg}
+\subsubsection*{RQ - PP40 Mitteilung bei Austritt aus der Kolonne} \label{RQ:leaveMsg}
+\addcontentsline{toc}{subsubsection}{\nameref{RQ:leaveMsg}}
 \underline{Notwendig für Use-Cases:}
 \begin{itemize}
-  \item \nameref{UC:leavePlatoon}
+  \item 
 \end{itemize}
 
-\subsubsection*{RQ-PP-50 Mitteilung bei erfolgreicher Geschwindigkeitsänderung}
+\subsubsection*{RQ - PP50 Mitteilung bei erfolgreicher Geschwindigkeitsänderung}\label{RQ:changedPSMsg}
+\addcontentsline{toc}{subsubsection}{\nameref{RQ:changedPSMsg}}
 \underline{Notwendig für Use-Cases:}
 \begin{itemize}
-  \item \nameref{UC:leavePlatoon}
+  \item 
 \end{itemize}
 
-\subsubsection*{RQ-PP-60 Mitteilung bei erfolgreicher Abstandsänderung}
+\subsubsection*{RQ - PP60 Mitteilung bei erfolgreicher Abstandsänderung}\label{RQ:changedIPDMsg}
+\addcontentsline{toc}{subsubsection}{\nameref{RQ:changedIPDMsg}}
 \underline{Notwendig für Use-Cases:}
 \begin{itemize}
-  \item \nameref{UC:leavePlatoon}
+  \item 
 \end{itemize}
 
-\subsubsection*{RQ-PP-70 Ermittlung des Verbindungsstatus und Timeouts}
+\subsubsection*{RQ - PP70 Ermittlung des Verbindungsstatus und Timeouts}\label{RQ:checkConnection}
+\addcontentsline{toc}{subsubsection}{\nameref{RQ:checkConnection}}
 \underline{Notwendig für Use-Cases:}
 \begin{itemize}
-  \item \nameref{UC:leavePlatoon}
+  \item 
 \end{itemize}
 
 \section{Meilensteinplanung}
-Das Projekt sieht die folgenden grobe Meilensteine vor.
-
-\begin{enumerate}
-  \item Anfang Dezember
-    \begin{itemize}
-      \item Fertigstellung der Modellautos
-      \item Fertigstellung des Platooning-Protokolls-Designs
-    \end{itemize}
-  \item vor Weihnachten 
-    \begin{itemize}
-      \item Fertigstellung der Software-Systemarchitektur
-    \end{itemize}
-  \item Anfang Januar
-    \begin{itemize}
-      \item Fertigstellung der Platooning-Protokolls-Implementation
-    \end{itemize}
-\end{enumerate}
-
 
+\subsection*{MS - Anfang Dezember}\label{MS:beginDez}
+\addcontentsline{toc}{subsection}{\nameref{MS:beginDez}}
 Nach dem erreichen eines Meilensteins durch alle
 Gruppen, findet eine vergleichende Bewertung der Umsetzungen
 zwischen den Gruppen statt. Im Sinne des Projektes können an Hand
 dieser Vergleiche einzelne Komponenten, zwischen den Gruppen
 ausgetauscht werden, bevor diese mit der Entwicklung fortfahren.
 
+\begin{itemize}
+  \item Fertigstellung der Modellautos
+  \item Fertigstellung des Platooning-Protokolls-Designs
+\end{itemize}
+
+\subsection*{MS - vor Weihnachten}\label{MS:prevChrist}
+\addcontentsline{toc}{subsection}{\nameref{MS:prevChrist}}
+\begin{itemize}
+  \item Fertigstellung der Software-Systemarchitektur
+\end{itemize}
+
+\subsection*{MS - Anfang Januar}\label{MS:beginJan}
+\addcontentsline{toc}{subsection}{\nameref{MS:beginJan}}
+\begin{itemize}
+  \item Fertigstellung der Platooning-Protokolls-Implementation
+\end{itemize}
+
+
+
 % Glossary
 \glsaddall
 \printglossaries