Index: DamClients/DamUI/trunk/doc/DAM UI - Functional Design/ResultsDisplay.tex =================================================================== diff -u --- DamClients/DamUI/trunk/doc/DAM UI - Functional Design/ResultsDisplay.tex (revision 0) +++ DamClients/DamUI/trunk/doc/DAM UI - Functional Design/ResultsDisplay.tex (revision 3564) @@ -0,0 +1,92 @@ +\chapter{Display results}\label{sec:USDisplayResults} + +The user must be able to view the results of the calculations within \ProgramName. + +The overall results at main level must be presented in a table so these can be exported and/or copy pasted in an excel sheet. + +Next to that, the individual results of a single calculation must be presented in a property view. +This view must show the relevant information about the calculation +(i.e. what location, profile, scenario etc. it represents) as well as the main results. +An optional graphic presentation of the results must be offered when applicable (e.g. the picture of the final slip circle for a bishop stability calculation). +It must also be possible to open/recalculate the individual result in the original program from within \ProgramName when applicable. + +\section{Stabilty results} +The results presented in the table for the stability calculations must be: +\begin{itemize} + \item name of the location + \item name of the scenario + \item calculation result (succeeded, failed, not calculated) + \item location coordinates (in RD) + \item type of analysis (no adaption/adapt geometry) + \item uplift (yes/no) + \item profile name + \item profile probability + \item the safety factor + \item etc.etc. +\end{itemize} + +\section{Piping results} +Unless stated otherwise, all results are read only. +The results per individual calculation presented using a table for the piping calculations must be (at least but not limited to): +\begin{itemize} + \item name of the location + \item name of the scenario + \item calculation result (succeeded, failed, not calculated) + \item location coordinates (in RD) + \item type of analysis (no adaption/adapt geometry) + \item uplift (yes/no) + \item profile name + \item profile probability + \item safety factor (= piping factor) + \item required safety factor + \item River level + \item River level low + \item Dike table height + \item Piping Model + \item Entry point piping X (local) + \item Exit point piping X (local) + \item Seepage length piping + \item Hcritical + \item Uplift safety factor + \item Backward erosion safety factor + \item Backward erosion safety factor (WBI*) + \item Backward erosion CCreep (WBI*) + \item Backward erosion hc (WBI*) + \item Backward erosion delta hc (WBI*) + \item Backward erosion reduced delta hc (WBI*) + \item Uplift safety factor (WBI*) + \item Uplift hc (WBI*) + \item Uplift delta hc (WBI*) + \item Heave safety factor (WBI*) + \item Heave hc (WBI*) + \item Heave gradient (WBI*) + \item Piping hc (WBI*) + \item Effective stress exit point (WBI*) + \item Result messages (e.g. error messages from calculation/validation) + \item Number of iterations (important for Desing with adapt geometry) + \item Notes (free remarks by user, editable) + \item Evaluation (Not evaluated/Accepted/Rejected, editable) +\end{itemize} +\Note{*: Should only be visibile when the WBI model is used.} + +In the property view (per result) the next items must be displayed and for a part be editable: +\begin{itemize} + \item name of the location + \item profile name + \item Piping Model + \item name of the scenario + \item safety factor (= piping factor) + \item calculation result (succeeded, failed, not calculated) + \item Number of iterations (important for Desing with adapt geometry) + \item Evaluation (Not evaluated/Accepted/Rejected, editable) + \item Notes (free remarks by user, editable) +\end{itemize} + +In order to be able to (re-)display the results mentioned above when loading a project file that already calculated them, +these results must be part of the damx project file itself. + +Finally, some extra information that can be useful to examine the results further +(such as the profile and surface line used in the analysis) +are written to an external file per location, scenario, profile. +Note that the name of the file must be added to the individual results per calculation as part of the damx project file. +The data in this file could be used to display the adapted surfaceline graphically when this is available. For this purpose, the file should be read upon selection of the result. Index: DamClients/DamUI/trunk/doc/DAM UI - Functional Design/DAM_UI_FO.tex =================================================================== diff -u -r3430 -r3564 --- DamClients/DamUI/trunk/doc/DAM UI - Functional Design/DAM_UI_FO.tex (.../DAM_UI_FO.tex) (revision 3430) +++ DamClients/DamUI/trunk/doc/DAM UI - Functional Design/DAM_UI_FO.tex (.../DAM_UI_FO.tex) (revision 3564) @@ -82,8 +82,8 @@ The design of this functionality is described in \autoref{sec:USCalcSettings}. \section{User story Display results} -As a geotechnical engineer I want to see the results of the calculations of the DAM Engine, so I can evaluate the calculations. -%The design of this functionality is described in \autoref{sec:USResultsDisplay}. +As a geotechnical engineer I want to see the results of the calculations of the DAM Engine, so I can evaluate the calculations. +The design of this functionality is described in \autoref{sec:USDisplayResults}. \section{User story Export data} As a geotechnical engineer I want to export data as tables (CSV-format) and/or shapes, so I can use the data for other purposes. Index: DamClients/DamUI/trunk/doc/DAM UI - Functional Design/DAM UI - Functional Design.pdf =================================================================== diff -u -r2696 -r3564 Binary files differ Index: DamClients/DamUI/trunk/doc/DAM UI - Functional Design/DAM UI - Functional Design.tex =================================================================== diff -u -r3430 -r3564 --- DamClients/DamUI/trunk/doc/DAM UI - Functional Design/DAM UI - Functional Design.tex (.../DAM UI - Functional Design.tex) (revision 3430) +++ DamClients/DamUI/trunk/doc/DAM UI - Functional Design/DAM UI - Functional Design.tex (.../DAM UI - Functional Design.tex) (revision 3564) @@ -25,7 +25,7 @@ \keywords{Dike, safety assessment, design, software, macro stability, piping} -\references{Refer to \autoref{chapterLiterature}.} +\reference{Refer to \autoref{chapterLiterature}.} \summary{This document contains the functional design for \ProgramName, a software module that computes the strength of a complete dikering with respect to several failure mechanisms, such as macro stability and piping\newline \newline @@ -52,6 +52,7 @@ \include{DataDisplay} \include{DataEdit} \include{CalcSettings} +\include{ResultsDisplay} \include{DataExport} \include{DSoilmodel} \include{Literature} Index: DamClients/DamUI/trunk/doc/DAM UI - Functional Design/DataExport.tex =================================================================== diff -u -r2208 -r3564 --- DamClients/DamUI/trunk/doc/DAM UI - Functional Design/DataExport.tex (.../DataExport.tex) (revision 2208) +++ DamClients/DamUI/trunk/doc/DAM UI - Functional Design/DataExport.tex (.../DataExport.tex) (revision 3564) @@ -2,11 +2,14 @@ The user must be able to export the following data from \ProgramName: -Surfacelines with characteristic points -The surface lines and the corresponding characteristic points must be exported in the same format as the import files. Its is a complete set of all locations of the project. - -Scenarios file - -Calculation file - -Calculation image +\begin{itemize} + \item The calculation log + (the log that is produced during the calculations with all errors and warnings provided by kernel validation and calculation) + must be saved as text file. + \item Surfacelines with characteristic points. + The surface lines and the corresponding characteristic points must be exported in the same format as the import files. + It is a complete set of all locations in the project. + \item Scenarios file + \item Calculation file + \item Calculation image +\end{itemize}