smyalygames/checklist-tester
1
0
Fork 0
mirror of https://github.com/smyalygames/checklist-tester.git synced 2025-11-04 04:49:49 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity

refactor(dissertation): move tech stack talk to background

Browse Source
This commit is contained in:
Anthony Berg 2024-05-05 18:07:32 +01:00
parent 89566935ce
commit 7673e90706
4 changed files with 66 additions and 59 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

65
pub/dissertation/chapters/background.tex Normal file
View File

@ -0,0 +1,65 @@
\documentclass[../dissertation.tex]{subfiles}
\begin{document}
\section{Solution Stack}
\begin{itemize}
\item There would be around 3 main components to this tester
\begin{itemize}
\item Formal Model
\item Flight Simulator plugin
\item Checklist Tester (to connect the formal model and flight simulator)
\end{itemize}
\item As VDM-SL is being used, it uses VDMJ to parse the model~\cite{vdmj}. This was a starting
point for the tech stack, as VDMJ is also open source.
\item VDMJ uses Java, therefore my language of choice was a language related to Java.
\end{itemize}
\subsection{Formal Model}
\begin{itemize}
\item There were a few ways of implementing the formal model into another application
\item Some of these methods were provided by Overture~\cite{overture-remote}
\begin{itemize}
\item RemoteControl interface
\item VDMTools API~\cite{vdmtoolbox-api}
\end{itemize}
\item However, both of these methods did not suit what was required as most of the
documentation for RemoteControl was designed for the Overture Tool IDE. VDMTools
may have handled the formal model differently
\item The choice was to create a VDMJ wrapper, as the modules are available on Maven
\end{itemize}
\subsection{Checklist Tester}
\begin{itemize}
\item VDMJ uses Java, meaning the logical choice would be to use something with Java
\item As the tester is going to include a UI, the language choice was still important
\item Kotlin~\cite{kotlin} was the choice in the end as Google has been putting Kotlin first
compared to Java, it includes less boilerplate code (e.g. getters and setters)~\cite{android-kotlin}
\item There are a variety of GUI libraries to consider using
\begin{itemize}
\item JavaFX~\cite{javafx}
\item Swing~\cite{flatlaf}
\item Compose Multiplatform~\cite{compose}
\end{itemize}
\item The decision was to use Compose Multiplatform in the end, due to time limitations and
having prior experience in using Flutter~\cite{flutter}
\item Compose Multiplatform has the ability to create a desktop application and a server,
which would allow for leeway if a server would be needed
\end{itemize}
\subsection{Flight Simulator Plugin}
\begin{itemize}
\item There are two main choices for flight simulators that can be used
for professional simulation
\begin{itemize}
\item X-Plane~\cite{x-plane}
\item Prepar3D~\cite{p3d}
\end{itemize}
\item X-Plane was the choice due to having better documentation for the SDK, and a variety
of development libraries for the simulator itself
\item For the plugin itself, there was already a solution developed by NASA, X-Plane Connect~\cite{xpc}
that is more appropriate due to the time limitations and would be more likely to be reliable
as it has been developed since 2015
\end{itemize}
\end{document}

59
pub/dissertation/chapters/design.tex
View File

@ -50,63 +50,4 @@
\end{itemize}
\section{Decisions}
\begin{itemize}
\item There would be around 3 main components to this tester
\begin{itemize}
\item Formal Model
\item Flight Simulator plugin
\item Checklist Tester (to connect the formal model and flight simulator)
\end{itemize}
\item As VDM-SL is being used, it uses VDMJ to parse the model~\cite{vdmj}. This was a starting
point for the tech stack, as VDMJ is also open source.
\item VDMJ uses Java, therefore my language of choice was a language related to Java.
\end{itemize}
\subsection{Formal Model}
\begin{itemize}
\item There were a few ways of implementing the formal model into another application
\item Some of these methods were provided by Overture~\cite{overture-remote}
\begin{itemize}
\item RemoteControl interface
\item VDMTools API~\cite{vdmtoolbox-api}
\end{itemize}
\item However, both of these methods did not suit what was required as most of the
documentation for RemoteControl was designed for the Overture Tool IDE. VDMTools
may have handled the formal model differently
\item The choice was to create a VDMJ wrapper, as the modules are available on Maven
\end{itemize}
\subsection{Checklist Tester}
\begin{itemize}
\item VDMJ uses Java, meaning the logical choice would be to use something with Java
\item As the tester is going to include a UI, the language choice was still important
\item Kotlin~\cite{kotlin} was the choice in the end as Google has been putting Kotlin first
compared to Java, it includes less boilerplate code (e.g. getters and setters)~\cite{android-kotlin}
\item There are a variety of GUI libraries to consider using
\begin{itemize}
\item JavaFX~\cite{javafx}
\item Swing~\cite{flatlaf}
\item Compose Multiplatform~\cite{compose}
\end{itemize}
\item The decision was to use Compose Multiplatform in the end, due to time limitations and
having prior experience in using Flutter~\cite{flutter}
\item Compose Multiplatform has the ability to create a desktop application and a server,
which would allow for leeway if a server would be needed
\end{itemize}
\subsection{Flight Simulator Plugin}
\begin{itemize}
\item There are two main choices for flight simulators that can be used
for professional simulation
\begin{itemize}
\item X-Plane~\cite{x-plane}
\item Prepar3D~\cite{p3d}
\end{itemize}
\item X-Plane was the choice due to having better documentation for the SDK, and a variety
of development libraries for the simulator itself
\item For the plugin itself, there was already a solution developed by NASA, X-Plane Connect~\cite{xpc}
that is more appropriate due to the time limitations and would be more likely to be reliable
as it has been developed since 2015
\end{itemize}
\end{document}

BIN
pub/dissertation/dissertation.pdf
View File

Binary file not shown.

1
pub/dissertation/dissertation.tex
View File

@ -71,6 +71,7 @@ This is the acknowledgements.
\subfile{chapters/introduction.tex}
\chapter{Background}
\subfile{chapters/background.tex}
\chapter{Design/Implementation}
\subfile{chapters/design.tex}