Index: dam engine/trunk/doc/Dam Engine - Technical Design/pictures/DAMMainDataflow.pdf =================================================================== diff -u Binary files differ Index: dam engine/trunk/doc/Dam Engine - Technical Design/pictures/DAMEngineSequenceAssessmentRegional.pdf =================================================================== diff -u -r172 -r176 Binary files differ Index: dam engine/trunk/doc/Dam Engine - Technical Design/pictures/DAMEngineSequenceAssessment.pdf =================================================================== diff -u -r172 -r176 Binary files differ Fisheye: Tag 176 refers to a dead (removed) revision in file `dam engine/trunk/doc/UML Diagrams/DAM Main Dataflow Original.uxf'. Fisheye: No comparison available. Pass `N' to diff? Index: dam engine/trunk/doc/Dam Engine - Technical Design/DAM Engine - Technical Design.pdf =================================================================== diff -u -r173 -r176 Binary files differ Fisheye: Tag 176 refers to a dead (removed) revision in file `dam engine/trunk/doc/UML Diagrams/DAM Main Dataflow.uxf'. Fisheye: No comparison available. Pass `N' to diff? Index: dam engine/trunk/doc/Dam Engine - Technical Design/pictures/DAMKEngineComponents.pdf =================================================================== diff -u -r172 -r176 Binary files differ Index: dam engine/trunk/doc/Dam Engine - Technical Design/pictures/DAMComponents.pdf =================================================================== diff -u -r172 -r176 Binary files differ 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. Index: dam engine/trunk/doc/UML Diagrams/DAM Engine Components.uxf =================================================================== diff -u -r172 -r176 --- dam engine/trunk/doc/UML Diagrams/DAM Engine Components.uxf (.../DAM Engine Components.uxf) (revision 172) +++ dam engine/trunk/doc/UML Diagrams/DAM Engine Components.uxf (.../DAM Engine Components.uxf) (revision 176) @@ -18,7 +18,7 @@ UMLGeneric - 144 + 160 448 208 64 @@ -178,9 +178,9 @@ UMLDeployment - 128 + 144 408 - 248 + 240 352 Design Dikes Index: dam engine/trunk/doc/Dam Engine - Technical Design/pictures/DAMKEngineComponents.pdf =================================================================== diff -u -r172 -r176 Binary files differ Index: dam engine/trunk/doc/UML Diagrams/DAM Engine Sequence Assessment Regional.uxf =================================================================== diff -u -r172 -r176 --- dam engine/trunk/doc/UML Diagrams/DAM Engine Sequence Assessment Regional.uxf (.../DAM Engine Sequence Assessment Regional.uxf) (revision 172) +++ dam engine/trunk/doc/UML Diagrams/DAM Engine Sequence Assessment Regional.uxf (.../DAM Engine Sequence Assessment Regional.uxf) (revision 176) @@ -4,8 +4,8 @@ UMLGeneric - 420 - 260 + 520 + 200 20 690 @@ -16,8 +16,8 @@ UMLGeneric - 540 - 140 + 640 + 80 140 50 @@ -29,8 +29,8 @@ UMLGeneric - 360 - 140 + 460 + 80 140 30 @@ -41,8 +41,8 @@ UMLGeneric - 200 - 140 + 300 + 80 140 50 @@ -53,8 +53,8 @@ UMLGeneric - 710 - 140 + 810 + 80 140 50 @@ -65,8 +65,8 @@ UMLGeneric - 870 - 140 + 970 + 80 140 50 @@ -77,8 +77,8 @@ UMLGeneric - 590 - 260 + 690 + 200 20 690 @@ -89,8 +89,8 @@ Relation - 590 - 180 + 690 + 120 30 100 @@ -100,8 +100,8 @@ Relation - 430 - 330 + 530 + 270 180 30 @@ -111,8 +111,8 @@ Relation - 430 - 370 + 530 + 310 180 30 @@ -122,8 +122,8 @@ UMLGeneric - 250 - 260 + 350 + 200 20 130 @@ -134,8 +134,8 @@ UMLGeneric - 760 - 390 + 860 + 330 20 130 @@ -146,8 +146,8 @@ UMLGeneric - 920 - 530 + 1020 + 470 20 130 @@ -158,8 +158,8 @@ Relation - 260 - 270 + 360 + 210 180 30 @@ -169,8 +169,8 @@ Relation - 260 - 300 + 360 + 240 180 30 @@ -180,8 +180,8 @@ Relation - 600 - 420 + 700 + 360 180 30 @@ -191,8 +191,8 @@ Relation - 600 - 480 + 700 + 420 180 30 @@ -202,8 +202,8 @@ Relation - 600 - 560 + 700 + 500 340 30 @@ -213,8 +213,8 @@ Relation - 600 - 630 + 700 + 570 340 30 @@ -224,8 +224,8 @@ Relation - 250 - 180 + 350 + 120 30 100 @@ -235,8 +235,8 @@ Relation - 760 - 180 + 860 + 120 30 230 @@ -246,8 +246,8 @@ Relation - 420 - 160 + 520 + 100 30 120 @@ -257,8 +257,8 @@ Relation - 920 - 180 + 1020 + 120 30 370 @@ -268,8 +268,8 @@ UMLGeneric - 1030 - 140 + 1130 + 80 140 50 @@ -281,8 +281,8 @@ UMLGeneric - 0 - 140 + 100 + 80 160 50 @@ -294,8 +294,8 @@ UMLGeneric - 1090 - 670 + 1190 + 610 20 130 @@ -306,8 +306,8 @@ UMLGeneric - 70 - 820 + 170 + 760 20 130 @@ -318,8 +318,8 @@ Relation - 1090 - 180 + 1190 + 120 30 510 @@ -329,8 +329,8 @@ Relation - 70 - 180 + 170 + 120 30 660 @@ -340,8 +340,8 @@ Relation - 600 - 690 + 700 + 630 510 30 @@ -351,8 +351,8 @@ Relation - 80 - 840 + 180 + 780 360 30 @@ -362,8 +362,8 @@ Relation - 600 - 750 + 700 + 690 510 30 @@ -373,8 +373,8 @@ Relation - 80 - 910 + 180 + 850 360 30