Index: doc/trunk/DAM - Architecture Overall/pictures/DamSVNClientLibraryLayout.png =================================================================== diff -u -r94 -r186 Binary files differ Index: doc/trunk/DAM - Architecture Overall/DAM - Architecture Overall.pdf =================================================================== diff -u -r151 -r186 Binary files differ Index: doc/trunk/DAM - Architecture Overall/pictures/DamSVNMainLayout.png =================================================================== diff -u -r94 -r186 Binary files differ Index: doc/trunk/DAM - Architecture Overall/DAM - Architecture Overall.tex =================================================================== diff -u -r108 -r186 --- doc/trunk/DAM - Architecture Overall/DAM - Architecture Overall.tex (.../DAM - Architecture Overall.tex) (revision 108) +++ doc/trunk/DAM - Architecture Overall/DAM - Architecture Overall.tex (.../DAM - Architecture Overall.tex) (revision 186) @@ -61,15 +61,15 @@ \begin{tabular}{|p{60mm}|p{80mm}|} \hline \textbf{Title} & \textbf{Content} \\ \hline \ProgramNamePlusSpace - Architecture Overall \newline \citep{DAM_ArchitectureOverall} & Description of overall architecture of \ProgramNamePlusSpace and its components. \\ \hline -\ProgramNamePlusSpace Kernel - Technical Design \newline \citep{DAMKernel_TechnicalDesign} & Description of the implementation of the technical design of \ProgramName. \\ \hline -\ProgramNamePlusSpace Kernel - Technical documentation \newline \citep{DAMKernel_TechnicalDocumentation} & Description of the arguments and usage of different software components, generated from in-line comment with Doxygen. \\ \hline -\ProgramNamePlusSpace Kernel - Test Plan \newline \citep{DAMKernel_TestPlan} & Description of the different regression and acceptation tests, including target values. \\ \hline -\ProgramNamePlusSpace Kernel - Test Report \newline \citep{DAMKernel_TestReport} & Description of the test results (benchmarks and test scripts). \\ \hline -\ProgramNamePlusSpace UI - Functional Design \newline \citep{DAMUI_FunctionalDesign} & Description of the requirements and functional design. \\ \hline -\ProgramNamePlusSpace UI - Technical Design \newline \citep{DAMUI_TechnicalDesign} & Description of the requirements and functional design. \\ \hline -\ProgramNamePlusSpace UI - Technical documentation \newline \citep{DAMUI_TechnicalDocumentation} & Description of the arguments and usage of different software components, generated from in-line comment with Doxygen. \\ \hline -\ProgramNamePlusSpace UI - Test Plan \newline \citep{DAMUI_TestPlan} & Description of the different regression and acceptation tests, including target values. \\ \hline -\ProgramNamePlusSpace UI - Test Report \newline \citep{DAMUI_TestReport} & Description of the test results (benchmarks and test scripts). \\ \hline +\ProgramNamePlusSpace Engine - Technical Design \newline \citep{DAMEngine_TechnicalDesign} & Description of the implementation of the architecture and technical design of \ProgramName. \\ \hline +\ProgramNamePlusSpace Engine - Technical documentation \newline \citep{DAMEngine_TechnicalDocumentation} & Description of the arguments and usage of different software components, generated from in-line comment with Doxygen. \\ \hline +\ProgramNamePlusSpace Engine - Test Plan \newline \citep{DAMEngine_TestPlan} & Description of the different regression and acceptation tests, including target values. \\ \hline +\ProgramNamePlusSpace Engine - Test Report \newline \citep{DAMEngine_TestReport} & Description of the test results (benchmarks and test scripts). \\ \hline +\ProgramNamePlusSpace UI - Functional Design \newline \citep{DAMUI_FO} & Description of the requirements and functional design of the DAM User Interface. \\ \hline +\ProgramNamePlusSpace UI - Technical Design \newline \citep{DAMUI_TechnicalDesign} & Description of the implementation of the architecture and technical design of the DAM User Interface. \\ \hline +\ProgramNamePlusSpace UI - Technical documentation \newline \citep{DAMUI_TechnicalDocumentation} & Description of the arguments and usage of different software components of the DAM User Interface, generated from in-line comment with Doxygen. \\ \hline +\ProgramNamePlusSpace UI - Test Plan \newline \citep{DAMUI_TestPlan} & Description of the different regression and acceptation tests, including target values for the DAM User Interface. \\ \hline +\ProgramNamePlusSpace UI - Test Report \newline \citep{DAMUI_TestReport} & Description of the test results (benchmarks and test scripts) of the DAM User Interface. \\ \hline \ProgramNamePlusSpace UI - User Manual \newline \citep{DAMUI_Manual} & Description of the different functionalites available in the \textit{User Interface} and background information. \\ \hline \end{tabular} \caption{\small \ProgramNamePlusSpace system documents.} @@ -124,29 +124,29 @@ \end{figure} -These clients interact directly with the \ProgramNamePlusSpace kernel (see next section). +These clients interact directly with the \ProgramNamePlusSpace Engine (see next section). -\section{\ProgramNamePlusSpace kernel} \label{sec:2.2} +\section{\ProgramNamePlusSpace Engine} \label{sec:2.2} -The \ProgramNamePlusSpace kernel is the engine for the \ProgramNamePlusSpace computation. It contains several submodules, depending on which computation has to be made. +The \ProgramNamePlusSpace Engine is the engine for the \ProgramNamePlusSpace computation. It contains several submodules, depending on which computation has to be made. As can be seen in \autoref{fig-DamComponents} the submodules are \begin{itemize} \item Assessment regional dikes \item Design primary dikes \item Operational module (for realtime calculations) \end{itemize} Depending on the client, 1 or more of these submodules can be addressed by the client. -The \ProgramNamePlusSpace kernel has no knowledge of the clients that use the kernel and there will be no code dependencies from the kernel to the clients. +The \ProgramNamePlusSpace Engine has no knowledge of the clients that use the Engine and there will be no code dependencies from the Engine to the clients. \section{Failure mechanisms} \label{sec:2.3} -The \ProgramNamePlusSpace kernel uses the failure mechanisms. These are completely independent and have no knowledge of the \ProgramNamePlusSpace kernel. So there will be no code dependencies from the failure mechanisms to the \ProgramNamePlusSpace kernel. +The \ProgramNamePlusSpace Engine uses the failure mechanisms. These are completely independent and have no knowledge of the \ProgramNamePlusSpace Engine. So there will be no code dependencies from the failure mechanisms to the \ProgramNamePlusSpace Engine. %------------------------------------------------------------------------------ \chapter{Architectural Choices} \label{chapter3} \section{Module dependencies} \label{sec:3.1} -As can be seen in \autoref{fig-DamComponents} the arrows pointing between the main parts of the system are only 1 way. This means that e.g. the \ProgramNamePlusSpace clients may address the \ProgramNamePlusSpace kernel, but the \ProgramNamePlusSpace kernel may not address the \ProgramNamePlusSpace clients. +As can be seen in \autoref{fig-DamComponents} the arrows pointing between the main parts of the system are only 1 way. This means that e.g. the \ProgramNamePlusSpace clients may address the \ProgramNamePlusSpace Engine, but the \ProgramNamePlusSpace Engine may not address the \ProgramNamePlusSpace clients. \section{External libraries and components} \label{sec:3.2} \ProgramNamePlusSpace uses third-party libraries and components. Only open sources and free components, that are free to redistribute, are allowed to be used. @@ -181,8 +181,8 @@ \item Firebird: Firebird database access library \end{itemize} -\section{\ProgramNamePlusSpace kernel} \label{sec:3.4} -The \ProgramNamePlusSpace kernel only uses part (the non-UI modules) of the DSL library +\section{\ProgramNamePlusSpace Engine} \label{sec:3.4} +The \ProgramNamePlusSpace Engine only uses part (the non-UI modules) of the DSL library \begin{itemize} \item DSL-Core \item DSL-Probabilistic @@ -218,9 +218,9 @@ The 4 main parts are \begin{itemize} - \item dam clients - the client applications that use the \ProgramNamePlusSpace kernel. + \item dam clients - the client applications that use the \ProgramNamePlusSpace Engine. \item dam clients library - shared libraries by the \ProgramNamePlusSpace clients. - \item dam kernel - the computational kernel of \ProgramName. + \item dam engine - the computational engine of \ProgramName. \item doc - general documentation for \ProgramNamePlusSpace (like this document). \end{itemize} With the excpetion of "`dam clients"' Each of these parts has its own trunk/branches/tags layout. @@ -259,7 +259,7 @@ \begin{flushleft} \includegraphics{pictures/DamSVNClientLibraryLayout.png} \end{flushleft} - \caption{\small \ProgramNamePlusSpace SVN clients layout.} + \caption{\small \ProgramNamePlusSpace SVN clients library layout.} \label{fig-SVNClientLibraryLayout} \end{figure} @@ -276,7 +276,7 @@ \includegraphics{pictures/DamSVNLayout.png} \end{flushleft} - \caption{\small \ProgramNamePlusSpace SVN layout.} + \caption{\small \ProgramNamePlusSpace SVN full layout.} \label{fig-SVNLayout} \end{figure} Index: doc/trunk/DAM - Architecture Overall/pictures/DamSVNLayout.png =================================================================== diff -u -r94 -r186 Binary files differ Index: doc/trunk/DAM - Architecture Overall/pictures/DamSVNClientLayout.png =================================================================== diff -u -r94 -r186 Binary files differ