Index: DamClients/DamUI/trunk/doc/DAM UI - Functional Design/DataFormat.tex =================================================================== diff -u -r2425 -r2561 --- DamClients/DamUI/trunk/doc/DAM UI - Functional Design/DataFormat.tex (.../DataFormat.tex) (revision 2425) +++ DamClients/DamUI/trunk/doc/DAM UI - Functional Design/DataFormat.tex (.../DataFormat.tex) (revision 2561) @@ -1,6 +1,6 @@ \chapter{Data format}\label{sec:USDataFormat} -All required and optional import data is placed in table OverviewDataUIAndEngine.xls, tab DAM\_input +All required and optional import data is placed in table OverviewDataUIAndEngine.xlsx, tab DAM\_input \ProgramName can import data from csv files and shape files The sequence of import is @@ -9,14 +9,36 @@ 3. scenario.csv \section{Presence} -If data is not present in the import, though required, \ProgramName uses the default value from OverviewDataUIAndEngine.xls, tab DAM\_input. +If data is not present during import the default value is used, when a default is available. Default values are mentioned in OverviewDataUIAndEngine.xlsx -\section{Validation} -In OverviewDataUIAndEngine.xls, tab DAM\_input the required data is listed. If not present, an error must be given. -In OverviewDataUIAndEngine.xls, tab DAM\_input the optional data is listed. If not present, no error or warning is given. +Required data +Data can be required when importing and/or required when calculating. +In OverviewDataUIAndEngine.xlsx is described what data is required and when. Example: crosssection and dikering$\_$ are only required when using shapefiles (see column remark).\newline +If data is required for import and is missing, the exception handling is dependent of the kind of data, see \autoref{table:ExceptionHandlingReqData}. +\begin{table}[H] +\begin{tabular}{|p{40mm}|p{\textwidth-40mm-24pt}|} \hline +\textbf{Parameter} & \textbf{Exception handling} \\ \hline +location$\_$id & All locations with missing location$\_$id are not imported and message is given. \\ \hline +surfaceline$\_$id & All locations with missing surfaceline$\_$id are not imported and message is given. \\ \hline +dikering$\_$id & Project is not imported and message is given. \\ \hline +segment$\_$id & Project is not imported and message is given. \\ \hline +calculation$\_$type & Project is not imported and message is given. \\ \hline +soilprofile$\_$id & Project is not imported and message is given. \\ \hline +top$\_$level & Project is not imported and message is given. \\ \hline +location$\_$scenario$\_$id & All locations with missing location$\_$scenario$\_$id are not imported and message is given. \\ \hline +crosssection & All locations with missing cross section are not imported and message is given. \\ \hline +\end{tabular} +\caption{Exception handling required data during import} +\label{table:ExceptionHandlingReqData} +\end{table} -The data is validated by the used kernels when calculations are started. DAM validates during the import of the data and during editing by user in the User interface. +In OverviewDataUIAndEngine.xls, tab DAM\_input also the optional data is listed. If these parameters are not present, no error or warning is given. When a default is available, this value is used, otherwise the parameters is NULL. +If the parameter is required for calculation and the value is NULL and the kernel does not provide a default, an error message is given. +\section{Validation} +\ProgramName validates during the import of the data and during editing by user in the User interface. Minimal and maximum values are given in OverviewDataUIAndEngine.xlsx. +The data is also validated by the used kernels when calculations are started. + \subsection{Editing characteristic points}\label{sec:ValCharPoints} When the characteristic points are edited by the user in the UI, they must be validated by rules in following table. Blue text validations are not implemented yet. Index: DamClients/DamUI/trunk/doc/DAM UI - Functional Design/DAM UI - Functional Design.pdf =================================================================== diff -u -r2425 -r2561 Binary files differ