Index: dam engine/trunk/doc/Dam Engine - Technical Design/DAM Engine - Technical Design.tex =================================================================== diff -u -r173 -r176 --- dam engine/trunk/doc/Dam Engine - Technical Design/DAM Engine - Technical Design.tex (.../DAM Engine - Technical Design.tex) (revision 173) +++ dam engine/trunk/doc/Dam Engine - Technical Design/DAM Engine - Technical Design.tex (.../DAM Engine - Technical Design.tex) (revision 176) @@ -9,6 +9,7 @@ % \newcommand{\ProgramName}{DAM Engine\xspace} +\newcommand{\kernel}{failuremechanism kernel\xspace} \title{\ProgramName} \subtitle{Technical Design} @@ -106,8 +107,25 @@ \end{figure} The arrows illustrate the dependencies of the components. + +\section{\ProgramName data flow} +\label{sec:ProgramNameDataFlow} +Please see \autoref{fig-DAMMainDataflow} for an overview of the data flow within the DAM system. + +\begin{figure}[H] + \begin{center} + \includegraphics[width=15cm]{pictures/DAMMainDataflow.pdf} + \end{center} + + \caption{\small \ProgramName and its components.} + \label{fig-DAMMainDataflow} +\end{figure} -\section{\ProgramName components} \label{sec:DAMEngineComponents} +The red arrows illustrate the dataflow between the main DAM components. \newline +As can be seen the data exchange between the \ProgramName and the \kernel (bottom of the picture) is done through the API that is defined by the \kernel. +The data exchange between the \ProgramName and the DAM client (top of the picture) is done through XML files (one for input and one for output), which are well defined by XML schemas (XSD's). +\section{\ProgramName components} +\label{sec:DAMEngineComponents} The \ProgramName itself also consists of several modules. These can be seen in see \autoref{fig-DAMEngineComponents} @@ -119,7 +137,7 @@ \begin{figure}[H] \begin{center} - \includegraphics[width=18cm]{pictures/DAMComponents.pdf} + \includegraphics[width=16cm]{pictures/DAMEngineComponents.pdf} \end{center} \caption{\small \ProgramName and its components.} @@ -134,7 +152,6 @@ \begin{center} \includegraphics[width=15cm]{pictures/DAMEngineSequenceAssessment.pdf} \end{center} - \caption{\small \ProgramName Assessment sequence diagram.} \label{fig-DAMEngineSequenceAssessment} \end{figure} @@ -179,7 +196,11 @@ The \ProgramName will be developed in C\# with the .NET 4.5 framework. The development environment will be Visual Studio 2015. \section{Error handling} \label{sec:ErrorHandling} -Errors are handled through the standard exception handling of the .NET framework. Error messages must contain as much information as possible, so a user can trace back the error to the input data. +Errors within the \ProgramName are handled through the standard exception handling of the .NET framework. Error messages must contain as much information as possible, so a user can trace back the error to the input data. \newline +Errorhandling with a \kernel is done through the mechanism that is supplied by the API of the specific kernel. \newline +Errorhandling with DAM Client is done by passing the error messages as part of the ouput XML file. \newline +In fact it is the same mechanism that is used for exchanging the regular data (input and output), as shown in \autoref{fig-DAMMainDataflow}. + \section{External libraries and components} \label{sec:ExternalLibrariesAndComponents} \ProgramName uses third-party libraries and components. Only open sources and free components, that are free to redistribute are allowed to be used.