Index: DamClients/DamLive/trunk/doc/DAMLive - Functional Design/DAMLive_Intro.tex =================================================================== diff -u -r2667 -r2676 --- DamClients/DamLive/trunk/doc/DAMLive - Functional Design/DAMLive_Intro.tex (.../DAMLive_Intro.tex) (revision 2667) +++ DamClients/DamLive/trunk/doc/DAMLive - Functional Design/DAMLive_Intro.tex (.../DAMLive_Intro.tex) (revision 2676) @@ -31,12 +31,10 @@ %\label{xxx} \begin{tabular}{|p{40mm}|p{\textwidth-40mm-24pt}|} \hline \textbf{Title} & \textbf{Content} \\ \hline -\ProgramName Architecture Overall \newline \citep{DAM_ArchitectureOverall} & Description of overall architecture of DAM and its components. \\ \hline -\ProgramName - Functional Design\newline \citep{DAMEngine_FunctionalDesign} & Description of the requirements and functional design. \\ \hline -\ProgramName - Technical Design\newline \citep{DAMEngine_TechnicalDesign}& Description of the implementation of the technical design of DAM Engine. \\ \hline -\ProgramName - Technical documentation \newline \citep{DAMEngine_TechnicalDocumentation} & Description of the arguments and usage of different software components, generated from in-line comment with Doxygen. \\ \hline -\ProgramName - Test Plan \newline \citep{DAMEngine_TestPlan} & Description of the different regression and acceptation tests, including target values. \\ \hline -\ProgramName - Test Report \newline \citep{DAMEngine_TestReport} & Description of the test results (benchmarks and test scripts). \\ \hline +DAM Architecture Overall \newline \citep{DAM_ArchitectureOverall} & Description of overall architecture of DAM and its components. \\ \hline +\ProgramName - Technical Design\newline \citep{DAMEngine_TechnicalDesign}& Description of the implementation of the technical design of DAM Engine. \\ \hline +DAM 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 +DAM UI - Functional Design\newline \citep{DAMUI_FunctionalDesign} & Description of the requirements and functional design. \\ \hline Architecture Guidelines \newline \citep{ArchitectureGuidelines} & Architecture guidelines that are used by DSC-Deltares. \\ \hline \end{tabular} \caption{\small \ProgramName system documents.} @@ -52,26 +50,22 @@ \chapter{Functional requirements} Main purpose of \ProgramName -DAMLive is the name for two functioncan combine a dam project with sensor data to calculation input for the DAM Engine. After calculations made by DAM Engine DAMLive can produce an output files with results. +DAMLive can combine a dam project with sensor data to calculation input for the DAM Engine. After calculations made by DAM Engine DAMLive can produce an output files with results. -\section{REQ Import.Project}\label{sec:REQImportProject} -\ProgramName can import an excisting project. The functionality of DAM UI for making this project is described in \autoref{sec:ImportProject}. +\section{REQ Data.Input}\label{sec:REQDataInput} +\ProgramName needs a DAM project file (*.damx) and sensordata. +The generation of the DAM project file is described in the Functional Design of DAM UI, see \citep{DAMUI_FunctionalDesign}. +In this DAM project information about the sensors is present; where are the sensors placed and for which PL-line is the data used. -\section{REQ Data.Format}\label{sec:REQInputData} -\ProgramName has a defined format for the data input, so DAMLive users know how to arrange the sensor data. -The design of this functionality is described in \autoref{sec:DataFormat}. +The sensordata itself must be provided in xml format. +This is described in the FEWS Public Wiki -\section{REQ Data.Content}\label{sec:REQDataContent} -\ProgramName has a defined content for the data input, so DAMLive users know which input data to provide.\\ -The design of this functionality is described in \autoref{sec:DataContent}. - -\section{REQ Data.Combination}\label{sec:REQDataCombi} -\ProgramName combines sensor data per location with a dam project. The design of this functionality is described in \autoref{sec:DataCombination}. - \section{REQ Calc.Settings}\label{sec:REQCalcSettings} -\ProgramName ables the user to change calculations settings such as failure mechanisms and models. - -\section{REQ Output.data}\label{sec:REQOutputData} +\ProgramName can use the kernels which are used by DAM Engine. Via a xml file ables \ProgramName the user to change calculations settings such as failure mechanisms (kernel) and models. +The available failure mechanisms and models are described in the Functional Design of DAM Engine \citep{ +DAMEngine_FunctionalDesign}. + +\section{REQ Data.Output}\label{sec:REQDataOutput} \ProgramName can produce output files. \section{REQ Save.Project}\label{sec:REQSaveProject} Index: DamClients/DamLive/trunk/doc/DAMLive - Functional Design/DAMLive - Functional Design.tex =================================================================== diff -u -r2626 -r2676 --- DamClients/DamLive/trunk/doc/DAMLive - Functional Design/DAMLive - Functional Design.tex (.../DAMLive - Functional Design.tex) (revision 2626) +++ DamClients/DamLive/trunk/doc/DAMLive - Functional Design/DAMLive - Functional Design.tex (.../DAMLive - Functional Design.tex) (revision 2676) @@ -23,7 +23,7 @@ \reference{1210702-000-GEO-0003} \classification{-} -\date{Sep. 2018} +\date{Sep. 2019} \version{0.1} \keywords{Dike, safety assessment, monitoring, software, macro stability, piping} @@ -47,9 +47,7 @@ \deltarestitle \include{DAMLive_Intro} - \include{DAMLive_CalculationParameters} - \include{Literature} %------------------------------------------------------------------------------