Skip to content
Snippets Groups Projects
Commit bfe98b58 authored by Asad Mansoor's avatar Asad Mansoor
Browse files

Module Guide - Updated section 4

parent d4b00a5d
No related branches found
No related tags found
No related merge requests found
No preview for this file type
...@@ -162,10 +162,13 @@ actually be implemented. ...@@ -162,10 +162,13 @@ actually be implemented.
Since Blaze-Brigade consists of purely software, M1 does not apply to the system. The software never interfaces with the hardware itself. The lowest level of interfacing with the software is the OS. Since Blaze-Brigade consists of purely software, M1 does not apply to the system. The software never interfaces with the hardware itself. The lowest level of interfacing with the software is the OS.
%Section 4
\section{Connection Between Requirements and Design} \label{SecConnection} \section{Connection Between Requirements and Design} \label{SecConnection}
The design of the system is intended to satisfy the requirements developed in The design of the system is intended to satisfy the requirements developed in
the SRS. In this stage, the system is decomposed into modules. The connection the SRS. In this stage, the system is decomposed into modules. The connection
between requirements and modules is listed in Table \ref{TblRT}. between requirements and modules is listed in Table \ref{TblRT} and Table \ref{TblNFRT}.
%Section 5
\section{Module Decomposition} \label{SecMD} \section{Module Decomposition} \label{SecMD}
Modules are decomposed according to the principle of ``information hiding'' proposed by \citet{ParnasEtAl1984}. The \emph{Secrets} field in a module decomposition is a brief statement of the design decision hidden by the module. The \emph{Services} field specifies \emph{what} the module will do Modules are decomposed according to the principle of ``information hiding'' proposed by \citet{ParnasEtAl1984}. The \emph{Secrets} field in a module decomposition is a brief statement of the design decision hidden by the module. The \emph{Services} field specifies \emph{what} the module will do
without documenting \emph{how} to do it. For each module, a suggestion for the implementing software is given under the \emph{Implemented By} title. If the without documenting \emph{how} to do it. For each module, a suggestion for the implementing software is given under the \emph{Implemented By} title. If the
...@@ -225,6 +228,8 @@ selected. ...@@ -225,6 +228,8 @@ selected.
\item[Services:]Retrieves user input and updates the current state of the software. From here, the module sends the current state to the output formatting module. \item[Services:]Retrieves user input and updates the current state of the software. From here, the module sends the current state to the output formatting module.
\item[Implemented By:]GameState.cs \item[Implemented By:]GameState.cs
\end{description} \end{description}
%Section 6
\section{Traceability Matrix} \label{SecTM} \section{Traceability Matrix} \label{SecTM}
This section shows two traceability matrices: between the modules and the This section shows two traceability matrices: between the modules and the
requirements and between the modules and the anticipated changes. requirements and between the modules and the anticipated changes.
...@@ -236,22 +241,37 @@ requirements and between the modules and the anticipated changes. ...@@ -236,22 +241,37 @@ requirements and between the modules and the anticipated changes.
\toprule \toprule
\textbf{Req.} & \textbf{Modules}\\ \textbf{Req.} & \textbf{Modules}\\
\midrule \midrule
R1 & \mref{mHH}, \mref{mInput}, \mref{mParams}, \mref{mControl}\\ FR1 & \mref{mHH}, \mref{mIF}, \mref{mOF}\\
R2 & \mref{mInput}, \mref{mParams}\\ FR2 & \mref{mM}, \mref{mGS}\\
R3 & \mref{mVerify}\\ FR3 & \mref{mIF}, \mref{mOF}\\
R4 & \mref{mOutput}, \mref{mControl}\\ FR4 & \mref{mIF}, \mref{mOF}, \mref{mM}\\
R5 & \mref{mOutput}, \mref{mODEs}, \mref{mControl}, \mref{mSeqDS}, \mref{mSolver}, \mref{mPlot}\\ FR5 & \mref{mM}\\
R6 & \mref{mOutput}, \mref{mODEs}, \mref{mControl}, \mref{mSeqDS}, \mref{mSolver}, \mref{mPlot}\\
R7 & \mref{mOutput}, \mref{mEnergy}, \mref{mControl}, \mref{mSeqDS}, \mref{mPlot}\\
R8 & \mref{mOutput}, \mref{mEnergy}, \mref{mControl}, \mref{mSeqDS}, \mref{mPlot}\\
R9 & \mref{mVerifyOut}\\
R10 & \mref{mOutput}, \mref{mODEs}, \mref{mControl}\\
R11 & \mref{mOutput}, \mref{mODEs}, \mref{mEnergy}, \mref{mControl}\\
\bottomrule \bottomrule
\end{tabular} \end{tabular}
\caption{Trace Between Requirements and Modules} \caption{Trace Between Functional Requirements and Modules}
\label{TblRT} \label{TblRT}
\end{table} \end{table}
\begin{table}[H]
\centering
\begin{tabular}{p{0.2\textwidth} p{0.6\textwidth}}
\toprule
\textbf{Req.} & \textbf{Modules}\\
\midrule
NFR1 & \mref{mHH}, \mref{mBH}, \mref{mOF}\\
NFR2 & \mref{mSD}, \mref{mIF}\\
NFR3 & \mref{mSD}, \mref{mM}\\
NFR4 & \mref{mSD}, \mref{mM}\\
NFR5 & \mref{mSD}, \mref{mM}, \mref{mGS}\\
NFR6 & \mref{mHH}, \mref{mBH}\\
NFR7 & \mref{mOF}\\
NFR8 & \mref{mHH}, \mref{mSD}\\
\bottomrule
\end{tabular}
\caption{Trace Between Non-Functional Requirements and Modules}
\label{TblNFRT}
\end{table}
\begin{table}[H] \begin{table}[H]
\centering \centering
\begin{tabular}{p{0.2\textwidth} p{0.6\textwidth}} \begin{tabular}{p{0.2\textwidth} p{0.6\textwidth}}
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment