Skip to content
GitLab
An error occurred while loading the file. Please try again.
Switch branch/tag
Find file BlameHistoryPermalink
ParameterCatalogs.html 127.06 KiB
Open in Web IDE
1 
<!DOCTYPE html>
2 
<html lang="en">
3 
<head>
4 
<meta charset="UTF-8">
5 
<meta http-equiv="X-UA-Compatible" content="IE=edge">
6 
<meta name="viewport" content="width=device-width, initial-scale=1.0">
7 
<meta name="generator" content="Asciidoctor 2.0.8.dev">
8 
<meta name="author" content="Kai-Holger Brassel, Hamburg, &lt;mail@khbrassel.de&gt;">
9 
<title>Parameter Catalogs for Simulation</title>
10 
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400,700">
11 
<style>
12 
/* Asciidoctor default stylesheet | MIT License | https://asciidoctor.org */
13 
/* Uncomment @import statement to use as custom stylesheet */
14 
/*@import "https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400,700";*/
15 
article,aside,details,figcaption,figure,footer,header,hgroup,main,nav,section{display:block}
16 
audio,video{display:inline-block}
17 
audio:not([controls]){display:none;height:0}
18 
html{font-family:sans-serif;-ms-text-size-adjust:100%;-webkit-text-size-adjust:100%}
19 
a{background:none}
20 
a:focus{outline:thin dotted}
21 
a:active,a:hover{outline:0}
22 
h1{font-size:2em;margin:.67em 0}
23 
abbr[title]{border-bottom:1px dotted}
24 
b,strong{font-weight:bold}
25 
dfn{font-style:italic}
26 
hr{-moz-box-sizing:content-box;box-sizing:content-box;height:0}
27 
mark{background:#ff0;color:#000}
28 
code,kbd,pre,samp{font-family:monospace;font-size:1em}
29 
pre{white-space:pre-wrap}
30 
q{quotes:"\201C" "\201D" "\2018" "\2019"}
31 
small{font-size:80%}
32 
sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}
33 
sup{top:-.5em}
34 
sub{bottom:-.25em}
35 
img{border:0}
36 
svg:not(:root){overflow:hidden}
37 
figure{margin:0}
38 
fieldset{border:1px solid silver;margin:0 2px;padding:.35em .625em .75em}
39 
legend{border:0;padding:0}
40 
button,input,select,textarea{font-family:inherit;font-size:100%;margin:0}
41 
button,input{line-height:normal}
42 
button,select{text-transform:none}
43 
button,html input[type="button"],input[type="reset"],input[type="submit"]{-webkit-appearance:button;cursor:pointer}
44 
button[disabled],html input[disabled]{cursor:default}
45 
input[type="checkbox"],input[type="radio"]{box-sizing:border-box;padding:0}
46 
button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0}
47 
textarea{overflow:auto;vertical-align:top}
48 
table{border-collapse:collapse;border-spacing:0}
49 
*,*::before,*::after{-moz-box-sizing:border-box;-webkit-box-sizing:border-box;box-sizing:border-box}
50 
html,body{font-size:100%}
51 
body{background:#fff;color:rgba(0,0,0,.8);padding:0;margin:0;font-family:"Noto Serif","DejaVu Serif",serif;font-weight:400;font-style:normal;line-height:1;position:relative;cursor:auto;tab-size:4;-moz-osx-font-smoothing:grayscale;-webkit-font-smoothing:antialiased}
52 
a:hover{cursor:pointer}
53 
img,object,embed{max-width:100%;height:auto}
54 
object,embed{height:100%}
55 
img{-ms-interpolation-mode:bicubic}
56 
.left{float:left!important}
57 
.right{float:right!important}
58 
.text-left{text-align:left!important}
59 
.text-right{text-align:right!important}
60 
.text-center{text-align:center!important}
61 
.text-justify{text-align:justify!important}
62 
.hide{display:none}
63 
img,object,svg{display:inline-block;vertical-align:middle}
64 
textarea{height:auto;min-height:50px}
65 
select{width:100%}
66 
.center{margin-left:auto;margin-right:auto}
67 
.stretch{width:100%}
68 
.subheader,.admonitionblock td.content>.title,.audioblock>.title,.exampleblock>.title,.imageblock>.title,.listingblock>.title,.literalblock>.title,.stemblock>.title,.openblock>.title,.paragraph>.title,.quoteblock>.title,table.tableblock>.title,.verseblock>.title,.videoblock>.title,.dlist>.title,.olist>.title,.ulist>.title,.qlist>.title,.hdlist>.title{line-height:1.45;color:#7a2518;font-weight:400;margin-top:0;margin-bottom:.25em}
69 
div,dl,dt,dd,ul,ol,li,h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6,pre,form,p,blockquote,th,td{margin:0;padding:0;direction:ltr}
70 
a{color:#2156a5;text-decoration:underline;line-height:inherit}
71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140
a:hover,a:focus{color:#1d4b8f} a img{border:0} p{font-family:inherit;font-weight:400;font-size:1em;line-height:1.6;margin-bottom:1.25em;text-rendering:optimizeLegibility} p aside{font-size:.875em;line-height:1.35;font-style:italic} h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{font-family:"Open Sans","DejaVu Sans",sans-serif;font-weight:300;font-style:normal;color:#ba3925;text-rendering:optimizeLegibility;margin-top:1em;margin-bottom:.5em;line-height:1.0125em} h1 small,h2 small,h3 small,#toctitle small,.sidebarblock>.content>.title small,h4 small,h5 small,h6 small{font-size:60%;color:#e99b8f;line-height:0} h1{font-size:2.125em} h2{font-size:1.6875em} h3,#toctitle,.sidebarblock>.content>.title{font-size:1.375em} h4,h5{font-size:1.125em} h6{font-size:1em} hr{border:solid #dddddf;border-width:1px 0 0;clear:both;margin:1.25em 0 1.1875em;height:0} em,i{font-style:italic;line-height:inherit} strong,b{font-weight:bold;line-height:inherit} small{font-size:60%;line-height:inherit} code{font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;font-weight:400;color:rgba(0,0,0,.9)} ul,ol,dl{font-size:1em;line-height:1.6;margin-bottom:1.25em;list-style-position:outside;font-family:inherit} ul,ol{margin-left:1.5em} ul li ul,ul li ol{margin-left:1.25em;margin-bottom:0;font-size:1em} ul.square li ul,ul.circle li ul,ul.disc li ul{list-style:inherit} ul.square{list-style-type:square} ul.circle{list-style-type:circle} ul.disc{list-style-type:disc} ol li ul,ol li ol{margin-left:1.25em;margin-bottom:0} dl dt{margin-bottom:.3125em;font-weight:bold} dl dd{margin-bottom:1.25em} abbr,acronym{text-transform:uppercase;font-size:90%;color:rgba(0,0,0,.8);border-bottom:1px dotted #ddd;cursor:help} abbr{text-transform:none} blockquote{margin:0 0 1.25em;padding:.5625em 1.25em 0 1.1875em;border-left:1px solid #ddd} blockquote cite{display:block;font-size:.9375em;color:rgba(0,0,0,.6)} blockquote cite::before{content:"\2014 \0020"} blockquote cite a,blockquote cite a:visited{color:rgba(0,0,0,.6)} blockquote,blockquote p{line-height:1.6;color:rgba(0,0,0,.85)} @media screen and (min-width:768px){h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2} h1{font-size:2.75em} h2{font-size:2.3125em} h3,#toctitle,.sidebarblock>.content>.title{font-size:1.6875em} h4{font-size:1.4375em}} table{background:#fff;margin-bottom:1.25em;border:solid 1px #dedede} table thead,table tfoot{background:#f7f8f7} table thead tr th,table thead tr td,table tfoot tr th,table tfoot tr td{padding:.5em .625em .625em;font-size:inherit;color:rgba(0,0,0,.8);text-align:left} table tr th,table tr td{padding:.5625em .625em;font-size:inherit;color:rgba(0,0,0,.8)} table tr.even,table tr.alt{background:#f8f8f7} table thead tr th,table tfoot tr th,table tbody tr td,table tr td,table tfoot tr td{display:table-cell;line-height:1.6} h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2;word-spacing:-.05em} h1 strong,h2 strong,h3 strong,#toctitle strong,.sidebarblock>.content>.title strong,h4 strong,h5 strong,h6 strong{font-weight:400} .clearfix::before,.clearfix::after,.float-group::before,.float-group::after{content:" ";display:table} .clearfix::after,.float-group::after{clear:both} :not(pre):not([class^=L])>code{font-size:.9375em;font-style:normal!important;letter-spacing:0;padding:.1em .5ex;word-spacing:-.15em;background:#f7f7f8;-webkit-border-radius:4px;border-radius:4px;line-height:1.45;text-rendering:optimizeSpeed;word-wrap:break-word} :not(pre)>code.nobreak{word-wrap:normal} :not(pre)>code.nowrap{white-space:nowrap} pre{color:rgba(0,0,0,.9);font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;line-height:1.45;text-rendering:optimizeSpeed} pre code,pre pre{color:inherit;font-size:inherit;line-height:inherit} pre>code{display:block} pre.nowrap,pre.nowrap pre{white-space:pre;word-wrap:normal} em em{font-style:normal} strong strong{font-weight:400} .keyseq{color:rgba(51,51,51,.8)} kbd{font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;display:inline-block;color:rgba(0,0,0,.8);font-size:.65em;line-height:1.45;background:#f7f7f7;border:1px solid #ccc;-webkit-border-radius:3px;border-radius:3px;-webkit-box-shadow:0 1px 0 rgba(0,0,0,.2),0 0 0 .1em white inset;box-shadow:0 1px 0 rgba(0,0,0,.2),0 0 0 .1em #fff inset;margin:0 .15em;padding:.2em .5em;vertical-align:middle;position:relative;top:-.1em;white-space:nowrap} .keyseq kbd:first-child{margin-left:0} .keyseq kbd:last-child{margin-right:0} .menuseq,.menuref{color:#000} .menuseq b:not(.caret),.menuref{font-weight:inherit} .menuseq{word-spacing:-.02em} .menuseq b.caret{font-size:1.25em;line-height:.8} .menuseq i.caret{font-weight:bold;text-align:center;width:.45em} b.button::before,b.button::after{position:relative;top:-1px;font-weight:400} b.button::before{content:"[";padding:0 3px 0 2px} b.button::after{content:"]";padding:0 2px 0 3px} p a>code:hover{color:rgba(0,0,0,.9)}
141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210
#header,#content,#footnotes,#footer{width:100%;margin-left:auto;margin-right:auto;margin-top:0;margin-bottom:0;max-width:62.5em;*zoom:1;position:relative;padding-left:.9375em;padding-right:.9375em} #header::before,#header::after,#content::before,#content::after,#footnotes::before,#footnotes::after,#footer::before,#footer::after{content:" ";display:table} #header::after,#content::after,#footnotes::after,#footer::after{clear:both} #content{margin-top:1.25em} #content::before{content:none} #header>h1:first-child{color:rgba(0,0,0,.85);margin-top:2.25rem;margin-bottom:0} #header>h1:first-child+#toc{margin-top:8px;border-top:1px solid #dddddf} #header>h1:only-child,body.toc2 #header>h1:nth-last-child(2){border-bottom:1px solid #dddddf;padding-bottom:8px} #header .details{border-bottom:1px solid #dddddf;line-height:1.45;padding-top:.25em;padding-bottom:.25em;padding-left:.25em;color:rgba(0,0,0,.6);display:-ms-flexbox;display:-webkit-flex;display:flex;-ms-flex-flow:row wrap;-webkit-flex-flow:row wrap;flex-flow:row wrap} #header .details span:first-child{margin-left:-.125em} #header .details span.email a{color:rgba(0,0,0,.85)} #header .details br{display:none} #header .details br+span::before{content:"\00a0\2013\00a0"} #header .details br+span.author::before{content:"\00a0\22c5\00a0";color:rgba(0,0,0,.85)} #header .details br+span#revremark::before{content:"\00a0|\00a0"} #header #revnumber{text-transform:capitalize} #header #revnumber::after{content:"\00a0"} #content>h1:first-child:not([class]){color:rgba(0,0,0,.85);border-bottom:1px solid #dddddf;padding-bottom:8px;margin-top:0;padding-top:1rem;margin-bottom:1.25rem} #toc{border-bottom:1px solid #e7e7e9;padding-bottom:.5em} #toc>ul{margin-left:.125em} #toc ul.sectlevel0>li>a{font-style:italic} #toc ul.sectlevel0 ul.sectlevel1{margin:.5em 0} #toc ul{font-family:"Open Sans","DejaVu Sans",sans-serif;list-style-type:none} #toc li{line-height:1.3334;margin-top:.3334em} #toc a{text-decoration:none} #toc a:active{text-decoration:underline} #toctitle{color:#7a2518;font-size:1.2em} @media screen and (min-width:768px){#toctitle{font-size:1.375em} body.toc2{padding-left:15em;padding-right:0} #toc.toc2{margin-top:0!important;background:#f8f8f7;position:fixed;width:15em;left:0;top:0;border-right:1px solid #e7e7e9;border-top-width:0!important;border-bottom-width:0!important;z-index:1000;padding:1.25em 1em;height:100%;overflow:auto} #toc.toc2 #toctitle{margin-top:0;margin-bottom:.8rem;font-size:1.2em} #toc.toc2>ul{font-size:.9em;margin-bottom:0} #toc.toc2 ul ul{margin-left:0;padding-left:1em} #toc.toc2 ul.sectlevel0 ul.sectlevel1{padding-left:0;margin-top:.5em;margin-bottom:.5em} body.toc2.toc-right{padding-left:0;padding-right:15em} body.toc2.toc-right #toc.toc2{border-right-width:0;border-left:1px solid #e7e7e9;left:auto;right:0}} @media screen and (min-width:1280px){body.toc2{padding-left:20em;padding-right:0} #toc.toc2{width:20em} #toc.toc2 #toctitle{font-size:1.375em} #toc.toc2>ul{font-size:.95em} #toc.toc2 ul ul{padding-left:1.25em} body.toc2.toc-right{padding-left:0;padding-right:20em}} #content #toc{border-style:solid;border-width:1px;border-color:#e0e0dc;margin-bottom:1.25em;padding:1.25em;background:#f8f8f7;-webkit-border-radius:4px;border-radius:4px} #content #toc>:first-child{margin-top:0} #content #toc>:last-child{margin-bottom:0} #footer{max-width:100%;background:rgba(0,0,0,.8);padding:1.25em} #footer-text{color:rgba(255,255,255,.8);line-height:1.44} #content{margin-bottom:.625em} .sect1{padding-bottom:.625em} @media screen and (min-width:768px){#content{margin-bottom:1.25em} .sect1{padding-bottom:1.25em}} .sect1:last-child{padding-bottom:0} .sect1+.sect1{border-top:1px solid #e7e7e9} #content h1>a.anchor,h2>a.anchor,h3>a.anchor,#toctitle>a.anchor,.sidebarblock>.content>.title>a.anchor,h4>a.anchor,h5>a.anchor,h6>a.anchor{position:absolute;z-index:1001;width:1.5ex;margin-left:-1.5ex;display:block;text-decoration:none!important;visibility:hidden;text-align:center;font-weight:400} #content h1>a.anchor::before,h2>a.anchor::before,h3>a.anchor::before,#toctitle>a.anchor::before,.sidebarblock>.content>.title>a.anchor::before,h4>a.anchor::before,h5>a.anchor::before,h6>a.anchor::before{content:"\00A7";font-size:.85em;display:block;padding-top:.1em} #content h1:hover>a.anchor,#content h1>a.anchor:hover,h2:hover>a.anchor,h2>a.anchor:hover,h3:hover>a.anchor,#toctitle:hover>a.anchor,.sidebarblock>.content>.title:hover>a.anchor,h3>a.anchor:hover,#toctitle>a.anchor:hover,.sidebarblock>.content>.title>a.anchor:hover,h4:hover>a.anchor,h4>a.anchor:hover,h5:hover>a.anchor,h5>a.anchor:hover,h6:hover>a.anchor,h6>a.anchor:hover{visibility:visible} #content h1>a.link,h2>a.link,h3>a.link,#toctitle>a.link,.sidebarblock>.content>.title>a.link,h4>a.link,h5>a.link,h6>a.link{color:#ba3925;text-decoration:none} #content h1>a.link:hover,h2>a.link:hover,h3>a.link:hover,#toctitle>a.link:hover,.sidebarblock>.content>.title>a.link:hover,h4>a.link:hover,h5>a.link:hover,h6>a.link:hover{color:#a53221} details,.audioblock,.imageblock,.literalblock,.listingblock,.stemblock,.videoblock{margin-bottom:1.25em} details>summary:first-of-type{cursor:pointer;display:list-item;outline:none;margin-bottom:.75em} .admonitionblock td.content>.title,.audioblock>.title,.exampleblock>.title,.imageblock>.title,.listingblock>.title,.literalblock>.title,.stemblock>.title,.openblock>.title,.paragraph>.title,.quoteblock>.title,table.tableblock>.title,.verseblock>.title,.videoblock>.title,.dlist>.title,.olist>.title,.ulist>.title,.qlist>.title,.hdlist>.title{text-rendering:optimizeLegibility;text-align:left;font-family:"Noto Serif","DejaVu Serif",serif;font-size:1rem;font-style:italic} table.tableblock.fit-content>caption.title{white-space:nowrap;width:0} .paragraph.lead>p,#preamble>.sectionbody>[class="paragraph"]:first-of-type p{font-size:1.21875em;line-height:1.6;color:rgba(0,0,0,.85)} table.tableblock #preamble>.sectionbody>[class="paragraph"]:first-of-type p{font-size:inherit} .admonitionblock>table{border-collapse:separate;border:0;background:none;width:100%} .admonitionblock>table td.icon{text-align:center;width:80px} .admonitionblock>table td.icon img{max-width:none} .admonitionblock>table td.icon .title{font-weight:bold;font-family:"Open Sans","DejaVu Sans",sans-serif;text-transform:uppercase} .admonitionblock>table td.content{padding-left:1.125em;padding-right:1.25em;border-left:1px solid #dddddf;color:rgba(0,0,0,.6)} .admonitionblock>table td.content>:last-child>:last-child{margin-bottom:0}
211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280
.exampleblock>.content{border-style:solid;border-width:1px;border-color:#e6e6e6;margin-bottom:1.25em;padding:1.25em;background:#fff;-webkit-border-radius:4px;border-radius:4px} .exampleblock>.content>:first-child{margin-top:0} .exampleblock>.content>:last-child{margin-bottom:0} .sidebarblock{border-style:solid;border-width:1px;border-color:#dbdbd6;margin-bottom:1.25em;padding:1.25em;background:#f3f3f2;-webkit-border-radius:4px;border-radius:4px} .sidebarblock>:first-child{margin-top:0} .sidebarblock>:last-child{margin-bottom:0} .sidebarblock>.content>.title{color:#7a2518;margin-top:0;text-align:center} .exampleblock>.content>:last-child>:last-child,.exampleblock>.content .olist>ol>li:last-child>:last-child,.exampleblock>.content .ulist>ul>li:last-child>:last-child,.exampleblock>.content .qlist>ol>li:last-child>:last-child,.sidebarblock>.content>:last-child>:last-child,.sidebarblock>.content .olist>ol>li:last-child>:last-child,.sidebarblock>.content .ulist>ul>li:last-child>:last-child,.sidebarblock>.content .qlist>ol>li:last-child>:last-child{margin-bottom:0} .literalblock pre,.listingblock>.content>pre{-webkit-border-radius:4px;border-radius:4px;word-wrap:break-word;overflow-x:auto;padding:1em;font-size:.8125em} @media screen and (min-width:768px){.literalblock pre,.listingblock>.content>pre{font-size:.90625em}} @media screen and (min-width:1280px){.literalblock pre,.listingblock>.content>pre{font-size:1em}} .literalblock pre,.listingblock>.content>pre:not(.highlight),.listingblock>.content>pre[class="highlight"],.listingblock>.content>pre[class^="highlight "]{background:#f7f7f8} .literalblock.output pre{color:#f7f7f8;background:rgba(0,0,0,.9)} .listingblock>.content{position:relative} .listingblock code[data-lang]::before{display:none;content:attr(data-lang);position:absolute;font-size:.75em;top:.425rem;right:.5rem;line-height:1;text-transform:uppercase;color:inherit;opacity:.5} .listingblock:hover code[data-lang]::before{display:block} .listingblock.terminal pre .command::before{content:attr(data-prompt);padding-right:.5em;color:inherit;opacity:.5} .listingblock.terminal pre .command:not([data-prompt])::before{content:"$"} .listingblock pre.highlightjs{padding:0} .listingblock pre.highlightjs>code{padding:1em;-webkit-border-radius:4px;border-radius:4px} .listingblock pre.prettyprint{border-width:0} .prettyprint{background:#f7f7f8} pre.prettyprint .linenums{line-height:1.45;margin-left:2em} pre.prettyprint li{background:none;list-style-type:inherit;padding-left:0} pre.prettyprint li code[data-lang]::before{opacity:1} pre.prettyprint li:not(:first-child) code[data-lang]::before{display:none} table.linenotable{border-collapse:separate;border:0;margin-bottom:0;background:none} table.linenotable td[class]{color:inherit;vertical-align:top;padding:0;line-height:inherit;white-space:normal} table.linenotable td.code{padding-left:.75em} table.linenotable td.linenos{border-right:1px solid currentColor;opacity:.35;padding-right:.5em} pre.pygments .lineno{border-right:1px solid currentColor;opacity:.35;display:inline-block;margin-right:.75em} pre.pygments .lineno::before{content:"";margin-right:-.125em} .quoteblock{margin:0 1em 1.25em 1.5em;display:table} .quoteblock>.title{margin-left:-1.5em;margin-bottom:.75em} .quoteblock blockquote,.quoteblock p{color:rgba(0,0,0,.85);font-size:1.15rem;line-height:1.75;word-spacing:.1em;letter-spacing:0;font-style:italic;text-align:justify} .quoteblock blockquote{margin:0;padding:0;border:0} .quoteblock blockquote::before{content:"\201c";float:left;font-size:2.75em;font-weight:bold;line-height:.6em;margin-left:-.6em;color:#7a2518;text-shadow:0 1px 2px rgba(0,0,0,.1)} .quoteblock blockquote>.paragraph:last-child p{margin-bottom:0} .quoteblock .attribution{margin-top:.75em;margin-right:.5ex;text-align:right} .verseblock{margin:0 1em 1.25em} .verseblock pre{font-family:"Open Sans","DejaVu Sans",sans;font-size:1.15rem;color:rgba(0,0,0,.85);font-weight:300;text-rendering:optimizeLegibility} .verseblock pre strong{font-weight:400} .verseblock .attribution{margin-top:1.25rem;margin-left:.5ex} .quoteblock .attribution,.verseblock .attribution{font-size:.9375em;line-height:1.45;font-style:italic} .quoteblock .attribution br,.verseblock .attribution br{display:none} .quoteblock .attribution cite,.verseblock .attribution cite{display:block;letter-spacing:-.025em;color:rgba(0,0,0,.6)} .quoteblock.abstract blockquote::before,.quoteblock.excerpt blockquote::before,.quoteblock .quoteblock blockquote::before{display:none} .quoteblock.abstract blockquote,.quoteblock.abstract p,.quoteblock.excerpt blockquote,.quoteblock.excerpt p,.quoteblock .quoteblock blockquote,.quoteblock .quoteblock p{line-height:1.6;word-spacing:0} .quoteblock.abstract{margin:0 1em 1.25em;display:block} .quoteblock.abstract>.title{margin:0 0 .375em;font-size:1.15em;text-align:center} .quoteblock.excerpt,.quoteblock .quoteblock{margin:0 0 1.25em;padding:0 0 .25em 1em;border-left:.25em solid #dddddf} .quoteblock.excerpt blockquote,.quoteblock.excerpt p,.quoteblock .quoteblock blockquote,.quoteblock .quoteblock p{color:inherit;font-size:1.0625rem} .quoteblock.excerpt .attribution,.quoteblock .quoteblock .attribution{color:inherit;text-align:left;margin-right:0} table.tableblock{max-width:100%;border-collapse:separate} p.tableblock:last-child{margin-bottom:0} td.tableblock>.content>:last-child{margin-bottom:-1.25em} td.tableblock>.content>:last-child.sidebarblock{margin-bottom:0} table.tableblock,th.tableblock,td.tableblock{border:0 solid #dedede} table.grid-all>thead>tr>.tableblock,table.grid-all>tbody>tr>.tableblock{border-width:0 1px 1px 0} table.grid-all>tfoot>tr>.tableblock{border-width:1px 1px 0 0} table.grid-cols>*>tr>.tableblock{border-width:0 1px 0 0} table.grid-rows>thead>tr>.tableblock,table.grid-rows>tbody>tr>.tableblock{border-width:0 0 1px} table.grid-rows>tfoot>tr>.tableblock{border-width:1px 0 0} table.grid-all>*>tr>.tableblock:last-child,table.grid-cols>*>tr>.tableblock:last-child{border-right-width:0} table.grid-all>tbody>tr:last-child>.tableblock,table.grid-all>thead:last-child>tr>.tableblock,table.grid-rows>tbody>tr:last-child>.tableblock,table.grid-rows>thead:last-child>tr>.tableblock{border-bottom-width:0} table.frame-all{border-width:1px} table.frame-sides{border-width:0 1px} table.frame-topbot,table.frame-ends{border-width:1px 0} table.stripes-all tr,table.stripes-odd tr:nth-of-type(odd),table.stripes-even tr:nth-of-type(even),table.stripes-hover tr:hover{background:#f8f8f7} th.halign-left,td.halign-left{text-align:left}
281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350
th.halign-right,td.halign-right{text-align:right} th.halign-center,td.halign-center{text-align:center} th.valign-top,td.valign-top{vertical-align:top} th.valign-bottom,td.valign-bottom{vertical-align:bottom} th.valign-middle,td.valign-middle{vertical-align:middle} table thead th,table tfoot th{font-weight:bold} tbody tr th{display:table-cell;line-height:1.6;background:#f7f8f7} tbody tr th,tbody tr th p,tfoot tr th,tfoot tr th p{color:rgba(0,0,0,.8);font-weight:bold} p.tableblock>code:only-child{background:none;padding:0} p.tableblock{font-size:1em} ol{margin-left:1.75em} ul li ol{margin-left:1.5em} dl dd{margin-left:1.125em} dl dd:last-child,dl dd:last-child>:last-child{margin-bottom:0} ol>li p,ul>li p,ul dd,ol dd,.olist .olist,.ulist .ulist,.ulist .olist,.olist .ulist{margin-bottom:.625em} ul.checklist,ul.none,ol.none,ul.no-bullet,ol.no-bullet,ol.unnumbered,ul.unstyled,ol.unstyled{list-style-type:none} ul.no-bullet,ol.no-bullet,ol.unnumbered{margin-left:.625em} ul.unstyled,ol.unstyled{margin-left:0} ul.checklist{margin-left:.625em} ul.checklist li>p:first-child>.fa-square-o:first-child,ul.checklist li>p:first-child>.fa-check-square-o:first-child{width:1.25em;font-size:.8em;position:relative;bottom:.125em} ul.checklist li>p:first-child>input[type="checkbox"]:first-child{margin-right:.25em} ul.inline{display:-ms-flexbox;display:-webkit-box;display:flex;-ms-flex-flow:row wrap;-webkit-flex-flow:row wrap;flex-flow:row wrap;list-style:none;margin:0 0 .625em -1.25em} ul.inline>li{margin-left:1.25em} .unstyled dl dt{font-weight:400;font-style:normal} ol.arabic{list-style-type:decimal} ol.decimal{list-style-type:decimal-leading-zero} ol.loweralpha{list-style-type:lower-alpha} ol.upperalpha{list-style-type:upper-alpha} ol.lowerroman{list-style-type:lower-roman} ol.upperroman{list-style-type:upper-roman} ol.lowergreek{list-style-type:lower-greek} .hdlist>table,.colist>table{border:0;background:none} .hdlist>table>tbody>tr,.colist>table>tbody>tr{background:none} td.hdlist1,td.hdlist2{vertical-align:top;padding:0 .625em} td.hdlist1{font-weight:bold;padding-bottom:1.25em} .literalblock+.colist,.listingblock+.colist{margin-top:-.5em} .colist td:not([class]):first-child{padding:.4em .75em 0;line-height:1;vertical-align:top} .colist td:not([class]):first-child img{max-width:none} .colist td:not([class]):last-child{padding:.25em 0} .thumb,.th{line-height:0;display:inline-block;border:solid 4px #fff;-webkit-box-shadow:0 0 0 1px #ddd;box-shadow:0 0 0 1px #ddd} .imageblock.left{margin:.25em .625em 1.25em 0} .imageblock.right{margin:.25em 0 1.25em .625em} .imageblock>.title{margin-bottom:0} .imageblock.thumb,.imageblock.th{border-width:6px} .imageblock.thumb>.title,.imageblock.th>.title{padding:0 .125em} .image.left,.image.right{margin-top:.25em;margin-bottom:.25em;display:inline-block;line-height:0} .image.left{margin-right:.625em} .image.right{margin-left:.625em} a.image{text-decoration:none;display:inline-block} a.image object{pointer-events:none} sup.footnote,sup.footnoteref{font-size:.875em;position:static;vertical-align:super} sup.footnote a,sup.footnoteref a{text-decoration:none} sup.footnote a:active,sup.footnoteref a:active{text-decoration:underline} #footnotes{padding-top:.75em;padding-bottom:.75em;margin-bottom:.625em} #footnotes hr{width:20%;min-width:6.25em;margin:-.25em 0 .75em;border-width:1px 0 0} #footnotes .footnote{padding:0 .375em 0 .225em;line-height:1.3334;font-size:.875em;margin-left:1.2em;margin-bottom:.2em} #footnotes .footnote a:first-of-type{font-weight:bold;text-decoration:none;margin-left:-1.05em} #footnotes .footnote:last-of-type{margin-bottom:0} #content #footnotes{margin-top:-.625em;margin-bottom:0;padding:.75em 0} .gist .file-data>table{border:0;background:#fff;width:100%;margin-bottom:0} .gist .file-data>table td.line-data{width:99%} div.unbreakable{page-break-inside:avoid} .big{font-size:larger} .small{font-size:smaller} .underline{text-decoration:underline} .overline{text-decoration:overline} .line-through{text-decoration:line-through} .aqua{color:#00bfbf} .aqua-background{background:#00fafa} .black{color:#000}
351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420
.black-background{background:#000} .blue{color:#0000bf} .blue-background{background:#0000fa} .fuchsia{color:#bf00bf} .fuchsia-background{background:#fa00fa} .gray{color:#606060} .gray-background{background:#7d7d7d} .green{color:#006000} .green-background{background:#007d00} .lime{color:#00bf00} .lime-background{background:#00fa00} .maroon{color:#600000} .maroon-background{background:#7d0000} .navy{color:#000060} .navy-background{background:#00007d} .olive{color:#606000} .olive-background{background:#7d7d00} .purple{color:#600060} .purple-background{background:#7d007d} .red{color:#bf0000} .red-background{background:#fa0000} .silver{color:#909090} .silver-background{background:#bcbcbc} .teal{color:#006060} .teal-background{background:#007d7d} .white{color:#bfbfbf} .white-background{background:#fafafa} .yellow{color:#bfbf00} .yellow-background{background:#fafa00} span.icon>.fa{cursor:default} a span.icon>.fa{cursor:inherit} .admonitionblock td.icon [class^="fa icon-"]{font-size:2.5em;text-shadow:1px 1px 2px rgba(0,0,0,.5);cursor:default} .admonitionblock td.icon .icon-note::before{content:"\f05a";color:#19407c} .admonitionblock td.icon .icon-tip::before{content:"\f0eb";text-shadow:1px 1px 2px rgba(155,155,0,.8);color:#111} .admonitionblock td.icon .icon-warning::before{content:"\f071";color:#bf6900} .admonitionblock td.icon .icon-caution::before{content:"\f06d";color:#bf3400} .admonitionblock td.icon .icon-important::before{content:"\f06a";color:#bf0000} .conum[data-value]{display:inline-block;color:#fff!important;background:rgba(0,0,0,.8);-webkit-border-radius:100px;border-radius:100px;text-align:center;font-size:.75em;width:1.67em;height:1.67em;line-height:1.67em;font-family:"Open Sans","DejaVu Sans",sans-serif;font-style:normal;font-weight:bold} .conum[data-value] *{color:#fff!important} .conum[data-value]+b{display:none} .conum[data-value]::after{content:attr(data-value)} pre .conum[data-value]{position:relative;top:-.125em} b.conum *{color:inherit!important} .conum:not([data-value]):empty{display:none} dt,th.tableblock,td.content,div.footnote{text-rendering:optimizeLegibility} h1,h2,p,td.content,span.alt{letter-spacing:-.01em} p strong,td.content strong,div.footnote strong{letter-spacing:-.005em} p,blockquote,dt,td.content,span.alt{font-size:1.0625rem} p{margin-bottom:1.25rem} .sidebarblock p,.sidebarblock dt,.sidebarblock td.content,p.tableblock{font-size:1em} .exampleblock>.content{background:#fffef7;border-color:#e0e0dc;-webkit-box-shadow:0 1px 4px #e0e0dc;box-shadow:0 1px 4px #e0e0dc} .print-only{display:none!important} @page{margin:1.25cm .75cm} @media print{*{-webkit-box-shadow:none!important;box-shadow:none!important;text-shadow:none!important} html{font-size:80%} a{color:inherit!important;text-decoration:underline!important} a.bare,a[href^="#"],a[href^="mailto:"]{text-decoration:none!important} a[href^="http:"]:not(.bare)::after,a[href^="https:"]:not(.bare)::after{content:"(" attr(href) ")";display:inline-block;font-size:.875em;padding-left:.25em} abbr[title]::after{content:" (" attr(title) ")"} pre,blockquote,tr,img,object,svg{page-break-inside:avoid} thead{display:table-header-group} svg{max-width:100%} p,blockquote,dt,td.content{font-size:1em;orphans:3;widows:3} h2,h3,#toctitle,.sidebarblock>.content>.title{page-break-after:avoid} #toc,.sidebarblock,.exampleblock>.content{background:none!important} #toc{border-bottom:1px solid #dddddf!important;padding-bottom:0!important} body.book #header{text-align:center} body.book #header>h1:first-child{border:0!important;margin:2.5em 0 1em} body.book #header .details{border:0!important;display:block;padding:0!important} body.book #header .details span:first-child{margin-left:0!important}
421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490
body.book #header .details br{display:block} body.book #header .details br+span::before{content:none!important} body.book #toc{border:0!important;text-align:left!important;padding:0!important;margin:0!important} body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-break-before:always} .listingblock code[data-lang]::before{display:block} #footer{padding:0 .9375em} .hide-on-print{display:none!important} .print-only{display:block!important} .hide-for-print{display:none!important} .show-for-print{display:inherit!important}} @media print,amzn-kf8{#header>h1:first-child{margin-top:1.25rem} .sect1{padding:0!important} .sect1+.sect1{border:0} #footer{background:none} #footer-text{color:rgba(0,0,0,.6);font-size:.9em}} @media amzn-kf8{#header,#content,#footnotes,#footer{padding:0}} </style> <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.7.0/css/font-awesome.min.css"> </head> <body class="article"> <div id="header"> <h1>Parameter Catalogs for Simulation</h1> <div class="details"> <span id="author" class="author">Kai-Holger Brassel, Hamburg, &lt;mail@khbrassel.de&gt;</span><br> </div> <div id="toc" class="toc"> <div id="toctitle">Table of Contents</div> <ul class="sectlevel1"> <li><a href="#trueintroduction">Introduction</a> <ul class="sectlevel2"> <li><a href="#truethe-bigger-picture">The Bigger Picture</a></li> <li><a href="#truelessons-learned">Lessons Learned</a></li> <li><a href="#low-code-development">Low-Code-Development of Parameter Catalogs</a></li> </ul> </li> <li><a href="#truehow-to-implement-parameter-catalogs-with-eclipse">How to Implement Parameter Catalogs with Eclipse</a> <ul class="sectlevel2"> <li><a href="#trueeclipse-basics">Eclipse Basics</a></li> <li><a href="#truesetup-eclipse-modeling-tools">Setup Eclipse Modeling Tools</a></li> <li><a href="#truemodeling-parameter-catalogs-for-simulation-with-ecore">Modeling Parameter Catalogs for Simulation with Ecore</a></li> <li><a href="#truegeneration-of-java-code-from-data-model">Generation of Java Code from Data Model</a></li> <li><a href="#truegeneration-and-tweaking-of-user-interface">Generation and Tweaking of User Interface</a></li> <li><a href="#trueadd-units-to-the-mix">Add Units to the Mix</a></li> <li><a href="#truesummary">Summary</a></li> </ul> </li> <li><a href="#using-parameter-catalogs">TBD: Accessing and Using Parameter Catalogs</a> <ul class="sectlevel2"> <li><a href="#trueaccessing-xml-catalogs-from-java">Accessing XML-Catalogs from Java</a></li> <li><a href="#truecreate-insel-models-with-handlebars-templates">Create Insel Models with Handlebars Templates</a></li> <li><a href="#trueaccessing-xml-catalogs-from-python">Accessing XML-Catalogs from Python</a></li> </ul> </li> <li><a href="#truetbd-distribution-of-parameter-catalogs">TBD: Distribution of Parameter Catalogs</a> <ul class="sectlevel2"> <li><a href="#truecreate-an-eclipse-application">Create an Eclipse Application</a></li> <li><a href="#trueuse-maven-and-tycho-as-build-system">Use Maven and Tycho as Build System</a></li> <li><a href="#truedeploy-to-p2-repository">Deploy to P2 Repository</a></li> <li><a href="#trueversioning-and-collaboration">Versioning and Collaboration</a></li> </ul> </li> </ul> </div> </div> <div id="content"> <div id="preamble"> <div class="sectionbody"> <div class="paragraph"> <p>This work by Kai-Holger Brassel, Hamburg, is licensed under <a href="https://creativecommons.org/licenses/by-nc-nd/4.0">CC BY-NC-ND 4.0</a> <span class="image"><img src="https://mirrors.creativecommons.org/presskit/icons/cc.svg" alt="cc" width="20"></span>
491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560
<span class="image"><img src="https://mirrors.creativecommons.org/presskit/icons/by.svg" alt="by" width="20"></span> <span class="image"><img src="https://mirrors.creativecommons.org/presskit/icons/nc.svg" alt="nc" width="20"></span> <span class="image"><img src="https://mirrors.creativecommons.org/presskit/icons/nd.svg" alt="nd" width="20"></span></p> </div> <div class="paragraph"> <p>Non-final version: April 20<sup>th</sup>, 2021.</p> </div> <div class="paragraph"> <p>Go to <a href="ParameterCatalogs.pdf">PDF-Version</a></p> </div> </div> </div> <div class="sect1"> <h2 id="trueintroduction"><a class="anchor" href="#trueintroduction"></a>Introduction</h2> <div class="sectionbody"> <div class="admonitionblock important"> <table> <tr> <td class="icon"> <i class="fa icon-important" title="Important"></i> </td> <td class="content"> <div class="paragraph"> <p>This introduction talks about the work of the author and others, but without bibliographic references. Currently, it is just meant as background to better understand the technical documentation in the sections to follow. Maybe it could be developed into a more serious paper later.</p> </div> </td> </tr> </table> </div> <div class="paragraph"> <p>Simulation of energy supply and consumption of buildings at the level of districts or even cities not only requires elaborated algorithms but also careful design of model structure and parameters. Structural aspects include building geometry as well as arrangement of buildings, e.g. to take shadowing and heat transfer into account. Assigning usage patterns or energy components like heat pumps, PV, boilers, etc. to specific buildings also count as structural aspects of a simulation model. Moreover, this multitude of model entities has to be defined in more detail by lots of numeric, ordinal or nominal parameters. Our experience with developing simulation systems like INSEL and SimStadt showed that manual parametrization based on informal data collections, typologies, spreadsheet tables, etc. from different sources is tedious and often hard to reproduce. Instead, parametrization of complex models should be supported by software providing formally defined <strong>parameter catalogs</strong>, that are systematically created and updated by domain experts.</p> </div> <div class="paragraph"> <p>Parameter catalogs and the software to create, maintain and deploy them should be independent of any specific simulation software to enhance software modularity (separation of concerns). Ideally, modelers can enhance their simulation environment by adding suited parameter catalogs as software plug-ins and use them to parametrize model entities easily, e.g. via drag and drop.</p> </div> <div class="paragraph"> <p>Automatic parametrization of components in simulation models requires a formal data model which fits the simulation models in terms of content and structure and can pass information to them. Self-contained parameter catalogs fulfill this requirement by providing an application programmers interface (API) that can be queried for automatic, rule-based parametrization of simulation models.</p> </div> <div class="paragraph"> <p>To get good results fast, close collaboration with domain experts and short development cycles are desirable. We achieved this by exploiting techniques of so called <strong>low code development</strong>. Basically this means that domain experts encode their knowledge into a graphical diagram defining types of components, their relations, and attributes. From this diagram, program code for storing and manipulating data sets in main memory as well as code to write and read that data to and from XML files (or data bases) are automatically generated. A modern graphical user interface to create, read, update, and delete data (CRUD operations) can also be provided with no or very few lines of manually written code.</p> </div> <div class="paragraph"> <p>The overall motivation for the work on parameter catalogs for simulation is to make easier to develop and perform computer simulations in complex and <em>data rich</em> domains like building physics, transportation, and all kinds of urban infrastructure.</p> </div> <div class="sect2"> <h3 id="truethe-bigger-picture"><a class="anchor" href="#truethe-bigger-picture"></a>The Bigger Picture</h3> <div class="paragraph"> <p>A good part of computer science was and is driven by the motivation to make it easier to develop computer programs of all sorts. "Higher" programming languages were invented to make programs human readable and soon special constructs for <em>functional programming</em> (computation without side effects) and <em>structured programming</em> (computation without go to statements) were introduced to help programmers writing and understanding ever growing programs. Then, between 1962 and 1967, program language Simula was developed especially to deal with the challenges of simulating systems comprising of many different types of objects. This opened the door to more direct computer representations of real world objects, their attributes, relationships and behavior, ultimately leading to <em>object-oriented</em> software development that today is embodied in programming languages like Java, C++, Python, and graphical notations like the Unified Modeling Language (UML).</p> </div> <div class="paragraph"> <p>While these achievements had boosted the productivity of software developers, still the creation of correct, efficient and maintainable programs&#8201;&#8212;&#8201;including simulations&#8201;&#8212;&#8201;required a big deal of expert knowledge and experience. To overcome this bottleneck, starting in the 70s, so called 4th generation languages entered the stage. These languages were tailored to specific tasks like statistics ("S" 1976, "R" being its successor), database programming (SQL 1979), or simulation (MATLAB around 1979, Mathematica 1988, Modellica 1999) to name a few. By sacrificing generality, these special languages become more accessible to domain experts, not just trained software developers. To flatten the learning curve even more, formal <em>graphical</em> languages for special purposes were invented, e.g. Simulink for block diagram simulation models in 1984, Entity-Relationship-Diagrams for data modeling in 1976, UML for object-oriented systems design in the 1990s, or graphical languages to specify business and also scientific workflows around 2000.</p> </div>
561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630
<div class="paragraph"> <p>This very short history of technologies for development of software in general, and simulations in particular, shall illuminate the tools at our disposal:</p> </div> <div class="ulist"> <ul> <li> <p>general purpose programming languages that combine structured, functional and object-oriented approaches to enable the creation of big, modular software systems, often called "programming in the large"</p> </li> <li> <p>formal textual domain specific languages (DSLs) dedicated to solve specific tasks with ease</p> </li> <li> <p>formal graphical DSLs.</p> </li> </ul> </div> <div class="exampleblock"> <div class="content"> <div class="paragraph"> <p>Note that DSLs more tend to describe <em>what</em> shall be achieved by a computation instead of describing in detail, <em>how</em> to achieve it. Therefore, DSLs usually look more like a model than like an algorithm.</p> </div> </div> </div> <div class="paragraph"> <p>Now back to the task at hand.</p> </div> <div class="paragraph"> <p>Some domains deal with a few types of simple objects to be simulated. Take the building blocks of an electric circuit as an example. The algorithms to simulate these correctly and efficiently may be quite complex&#8201;&#8212;&#8201;the model elements usually can be described by very few parameters like resistance or capacity. More complex domains like (regenerative) energy systems or building physics deal with more complex objects to be simulated, e.g. PV modules or layered walls of buildings, often coming in different types and configurations, and dozens of possibly interdependent parameters.</p> </div> </div> <div class="sect2"> <h3 id="truelessons-learned"><a class="anchor" href="#truelessons-learned"></a>Lessons Learned</h3> <div class="paragraph"> <p>First a note on terminology: Instead of <em>parameter catalogs</em> in SimStadt we used term <em>library</em> like in <em>building physics library</em>. Obviously this was not a good choice, since <em>library</em> is used a lot in IT and programming with all sorts of meaning. Instead we started to talk about <em>data catalogs</em>, but in data science this term has specific meaning, namely: catalogs of data and data sources. Since our catalogs, first of all, shall grant structured access to parameters for simulated entities <em>parameter catalog</em> sounds more appropriate to me.</p> </div> <div class="paragraph"> <p>The problem of navigating huge parameter spaces and assembling complex simulation models popped up as the author worked on a diagram editor for <strong>INSEL</strong>, a simulation language and runtime environment developed for renewable energy systems simulation. To make existing catalogs on weather data, solar panels and inverter modules accessible to the modeler, special dialogs were added to the INSEL user interface that allowed browsing through the catalogs. Using this browsers, the modeler would choose a weather station, panel or inverter to parameterize a corresponding INSEL function-block. However, there are some severe disadvantages with this approach:</p> </div> <div class="olist arabic"> <ol class="arabic"> <li> <p>Parameter catalogs were stored in a proprietary data format on disk within the INSEL application distribution, meaning they could not used independently from INSEL by other interested parties (systems or users).</p> </li> <li> <p>The catalogs have to be maintained by editing text files manually.</p> </li> <li> <p>While INSEL modeler could browse the catalogs, searching and sorting were not supported.</p> </li> <li> <p>Development of Java Swing UIs for the different kind of catalogs is time consuming as is their maintenance, e.g. if a catalog data format were to change.</p> </li> <li> <p>Putting UIs to handle big amounts of data into a diagram editor is not very user friendly.</p> </li> </ol> </div> <div class="paragraph"> <p>From 2013 to 2016, the simulation platform <strong>SimStadt</strong> was developed to make specific modeling and simulation workflows accessible to experts in urban planning and energy systems. Using INSEL and other simulators under the hood, the usage of 3D city data, provided as CityGML files, was a core requirement of this project.</p> </div> <div class="paragraph">
631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700
<p>To enable simulation of, say, the heating demand of a district, geometric building data had to be enriched with data on building physics and usage. To do so, existing informations about building physics and usage&#8201;&#8212;&#8201;often only available as informal typologies or tables&#8201;&#8212;&#8201;had to be provided to the SimStadt user on an abstract level, e.g. to choose between refurbishment scenarios. At the same time, specific building configurations and parameter sets had to be injected into the simulation models to obtain the desired results.</p> </div> <div class="paragraph"> <p>Again, we implemented parameter catalogs to fulfill these requirements, but compared to the quite simple catalogs used in INSEL, the data for building materials, window, wall and roof types as well as the typologies of buildings, households, usage patterns, and so on were more intricate. They had to be created iteratively in collaboration with domain experts. In this situation, manual coding data formats and access with a general programming language would have led to relatively long iteration cycles and high communication effort between programmer and domain expert. Instead, we decided to use a DSL for data modeling and use code generation whenever possible. Since SimStadt was developed within the Java eco-system we followed this standard approach:<sup class="footnote">[<a id="_footnoteref_1" class="footnote" href="#_footnotedef_1" title="View footnote.">1</a>]</sup></p> </div> <div class="olist arabic"> <ol class="arabic"> <li> <p>Developer and domain expert create a first version of the data model as XML Schema Definition (our DSL).</p> </li> <li> <p>For plausibility checks one would use any standard XML editor to create example data conforming to the XSD.</p> </li> <li> <p>With JAXB (Java Architecture for XML Binding) Java code is generated to read our XML catalogs into Java objects that, in turn, can be accessed by SimStadt workflows to generate and parameterize simulations.</p> </li> <li> <p>If required, developer and domain expert go back to step one to refine data model and catalog data.</p> </li> </ol> </div> <div class="paragraph"> <p>After the data model for building physics catalogs had matured, we developed a desktop application for convenient creation and maintenance of building physics data catalogs separate from SimStadt. It was developed in Java with a user interface written in JavaFX and was well received by domain experts.</p> </div> <div class="paragraph"> <p>However, as a different catalog&#8201;&#8212;&#8201;this time for building usages&#8201;&#8212;&#8201;had to be created, it was quite difficult to reuse the XML schema and application code from the building physics catalog: The usage catalog data model was "pressed" into a form similar to the building physics catalog data model, and the UI code was "over-engineered" to accommodate both catalog&#8217;s requirements.</p> </div> </div> <div class="sect2"> <h3 id="low-code-development"><a class="anchor" href="#low-code-development"></a>Low-Code-Development of Parameter Catalogs</h3> <div class="paragraph"> <p>From INSEL and SimStadt we learned, that manual and automatic construction and parameterization of complex simulation models with many types of interrelated objects should be supported be the means of domain specific parameter catalogs.</p> </div> <div class="paragraph"> <p>Close collaboration with domain experts in designing and implementing these catalogs in short development cycles is desirable.</p> </div> <div class="paragraph"> <p>Parameter catalogs and the software for their creation, maintenance and deployment should be independent of any specific simulation software, (a) to be reusable and (b) not to overload simulation applications.</p> </div> <div class="paragraph"> <p>In SimStadt, catalog development was partly facilitated by a textual DSL for data modeling (XML schema language) and automatic generation of Java code from it. On the other hand, user interfaces and generation and parameterization of simulations from templates within SimStadt workflows had still to be coded manually hindering the routinely creation of new catalogs.</p> </div> <div class="paragraph"> <p>Now, in 2020, several developments in different projects provide an opportunity to re-think the topic of parameter catalogs for simulations, namely:</p> </div> <div class="olist arabic"> <ol class="arabic"> <li> <p>Plans for a new Urban Simulation Platform at Concordia University, Montreal.</p> </li> <li> <p>New implementation of INSEL user interface based on the Eclipse application framework and Eclipse-Sirius diagram editors.</p> </li> <li> <p>Enhancement of existing building physics and usage catalogs from SimStadt and their adaptation to new regions.</p> </li> <li> <p>Development of a new comprehensive catalog of electric systems components to be used in SimStadt as well as in Concordia&#8217;s Urban Simulation Platform.</p> </li> </ol> </div> <div class="exampleblock">
701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770
<div class="content"> <div class="paragraph"> <p>In what follows, the new technology stack used to implement (4) is documented in detail. It uses four technologies to replace manual coding by code generation from models:</p> </div> <div class="ulist"> <ul> <li> <p><em>Ecore</em> to model the catalog&#8217;s data and generate Java classes and persistence layer from it.</p> </li> <li> <p><em>EMF Forms</em> for modeling and generating tables, forms and buttons to <strong>c</strong>reate, <strong>r</strong>ead, <strong>u</strong>pdate, and <strong>d</strong>elete data (CRUD).</p> </li> <li> <p><em>E4</em>, the Eclipse way of modeling the application user interface itself, e.g. the placement and behavior of views, editors, toolbars, menus, and more.</p> </li> <li> <p>A template engine called <em>Handlebars</em> to generate fully parameterized simulation models from textual templates without programming.</p> </li> </ul> </div> <div class="paragraph"> <p>The new technology stack is rooted in the Eclipse application framework and eco-system.<sup class="footnote">[<a id="_footnoteref_2" class="footnote" href="#_footnotedef_2" title="View footnote.">2</a>]</sup> Its main advantage is the possibility to implement CRUD applications like parameter catalogs and their underlying data models with no or very view lines of handwritten code (<em>low-code-development</em>).</p> </div> </div> </div> <div class="paragraph"> <p>Plans are to use the same approach also for implementation of (3). Since task (2) and maybe (1) will use Eclipse, too, close integration of parameter catalogs and simulation environments seems feasible. E.g., a user could drag an electric system component from a catalog onto an INSEL block for parametrization.</p> </div> <div class="paragraph"> <p>The Eclipse application framework offers:</p> </div> <div class="ulist"> <ul> <li> <p>OSGI plug-in mechanism and UI framework for integrating applications and services</p> </li> <li> <p><em>E4</em> application model to declaratively describe user interface&#8217;s structure</p> </li> <li> <p>General notion of <em>project</em> with specific file types, help system, preferences etc.</p> </li> <li> <p>IDE support for important general purpose languages like Java, <a href="https://marketplace.eclipse.org/content/pydev-python-ide-eclipse">Python</a>, Ruby, C, Fortran, C++</p> </li> <li> <p>Support for creating textual and graphical DSLs (<a href="https://www.eclipse.org/Xtext">XText</a>, <a href="https://www.eclipse.org/sirius">Sirius</a>)</p> </li> <li> <p>Industry proven DSLs and code generators for data models and form based UIs via the <a href="https://www.eclipse.org/modeling/emf"><em>Eclipse Modeling Framework</em></a> (EMF) providing:</p> <div class="ulist"> <ul> <li> <p><a href="https://www.eclipse.org/ecoretools"><em>Ecore</em></a> for model driven generation of Java classes and persistence layers for XML or data bases</p> </li> <li> <p><a href="https://eclipsesource.com/blogs/tutorials/emf-forms-view-model-elements"><em>EMF Forms</em></a> for describing and generating form based UIs</p> </li> <li> <p>Mechanisms to adapt or extend data models and forms to special needs (e.g., we added quantities&#8201;&#8212;&#8201;that is numbers <em>with units</em>&#8201;&#8212;&#8201;to Ecore and EMF Forms, a feature very important for parameter catalogs)</p> </li> </ul> </div> </li> <li> <p>Rich open source eco-system with lots of plugins and projects important for an urban simulation platform:</p>
771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840
<div class="ulist"> <ul> <li> <p>model server for distributed access and work on Ecore models, including model comparison and migration (<a href="https://projects.eclipse.org/projects/modeling.emf.cdo">CDO</a>, <a href="https://www.eclipse.org/emf/compare">EMFCompare</a>)</p> </li> <li> <p>a <a href="https://pyecore.readthedocs.io/en/latest">Python implementation of Ecore</a></p> </li> <li> <p>GIS: storage, processing, and visualization of geographical data (list of projects under the umbrella <a href="https://projects.eclipse.org/projects/locationtech">LocationTech</a>, e.g. user-friendly desktop internet GIS <a href="http://udig.refractions.net">uDig</a>)</p> </li> <li> <p>workbench for traffic simulation (<a href="https://www.eclipse.org/sumo">SUMO</a>)</p> </li> <li> <p>spatial multi-agent-simulation (<a href="https://gama-platform.github.io/wiki/Home">GAMA-Platform</a>)</p> </li> <li> <p>scientific workflows (<a href="https://projects.eclipse.org/projects/science.triquetrum">Triquetrum</a>)</p> </li> <li> <p>visualizations (<a href="https://www.eclipse.org/nebula/widgets/visualization/visualization.php">Nebula</a>)</p> </li> <li> <p>machine learning (<a href="https://deeplearning4j.org">deeplearning4j</a>)</p> </li> <li> <p>45+ projects in the area of <a href="https://iot.eclipse.org">IoT</a></p> </li> <li> <p>&#8230;&#8203;</p> </li> </ul> </div> </li> </ul> </div> <div class="paragraph"> <p>As always, all that glitters is not gold. When we go through the details below, some bugs and inconsistencies, typical for open source projects of this age and size, have to be addressed.</p> </div> <div style="page-break-after: always;"></div> </div> </div> </div> <div class="sect1"> <h2 id="truehow-to-implement-parameter-catalogs-with-eclipse"><a class="anchor" href="#truehow-to-implement-parameter-catalogs-with-eclipse"></a>How to Implement Parameter Catalogs with Eclipse</h2> <div class="sectionbody"> <div class="paragraph"> <p>At the end of this chapter, you should be able to build a running software prototype for creating and maintaining parameter catalogs based on a graphical data model of the domain you are an expert in.</p> </div> <div class="paragraph"> <p>To build data models and parameter catalogs from scratch, we first have to understand some basics about Eclipse, and then install the correct Eclipse package. Thereafter, we can model our data with <em>Ecore</em> considering some best practices, followed by the generation of Java classes and user interface (UI). Finally, we will install some plug-ins to "pimp" our Eclipse installation in order to add units and quantities to the mix.</p> </div> <div class="sect2"> <h3 id="trueeclipse-basics"><a class="anchor" href="#trueeclipse-basics"></a>Eclipse Basics</h3> <div class="paragraph"> <p><a href="https://en.wikipedia.org/wiki/Eclipse_(software)">Eclipse</a> was originally developed by IBM and became Open Source in 2001. It is best known for its Integrated Development Environments (<em>Eclipse IDEs</em>), not only for Java, but also for C++, Python and many other programming languages. These IDEs are created on top of the Eclipse Rich Client Platform (Eclipse RCP), an application framework and plug-in system based on Java and OSGi. Eclipse RCP is foundation of a plethora of general-purpose applications, too.</p> </div> <div class="paragraph"> <p>First time users of Eclipse better understand the following concepts.</p> </div> <div class="paragraph"> <div class="title">Eclipse Packages</div> <p>An Eclipse package is an Eclipse distribution dedicated to a specific type of task.<sup class="footnote">[<a id="_footnoteref_3" class="footnote" href="#_footnotedef_3" title="View footnote.">3</a>]</sup> A list of packages is available at <a href="https://www.eclipse.org/downloads/packages/">eclipse.org</a>.
841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910
Beside others it contains <em>Eclipse IDE for Java Developers</em>, <em>Eclipse IDE for Scientific Computing</em>, and the package we will use: <em>Eclipse Modeling Tools</em>. Note that third parties offer many other packages, e.g. <em>GAMA</em> for multi-agent-simulation or <em>Obeo Designer Community</em> for creating Sirius diagram editors.</p> </div> <div class="admonitionblock note"> <table> <tr> <td class="icon"> <i class="fa icon-note" title="Note"></i> </td> <td class="content"> <div class="paragraph"> <p>Several Eclipse packages can be installed side by side, even different releases of the same package. Multiple Eclipse installations can run at the same time, each on its own <em>workspace</em> (see below).</p> </div> </td> </tr> </table> </div> <div class="paragraph"> <div class="title">Plug-ins / Features</div> <p>An installed Eclipse package consists of a runtime core and a bunch of additional plug-ins. Technically, a plug-in is just a special kind of Java archive (JAR file) that uses and can be used by other plug-ins with regard to OSGi specifications. Groups of plug-ins that belong together are called a <em>feature</em>.</p> </div> <div class="paragraph"> <p>Sometimes, a user will add plug-ins or features to an Eclipse installation to add new capabilities. E.g. writing this documentation within my Eclipse IDE is facilitated by the plug-in <a href="https://marketplace.eclipse.org/content/asciidoctor-editor">Asciidoctor Editor</a>. Plug-ins can easily be installed via main menu command <code>Help → Eclipse Marketplace&#8230;&#8203;</code> or <code>Help → Install New Software&#8230;&#8203;</code>. Some plug-ins may be self-made like our <em>City Units</em> plug-in that enables Ecore to deal with physical quantities.</p> </div> <div class="paragraph"> <div class="title">Git</div> <p><a href="https://git-scm.com">Git</a> is the industry standard for collaborative work on, and versioning of, source code and other textual data. Collaborative development of parameter catalogs benefits massively from using Git. Git support is built into <em>Eclipse Modeling Tools</em>, the Eclipse package we will use. However, if Eclipse needs to connect to a Git server that uses SSH protocol (not HTTPS with credentials), access configuration is more involved and may be dependent on your operating system.</p> </div> <div class="paragraph"> <p>Some users, anyway, prefer to use Git from the command line or with one of the client application listed <a href="https://git-scm.com/downloads/guis">here</a>, e.g. <a href="https://tortoisegit.org">TortoiseGit</a> for Windows.</p> </div> <div class="paragraph"> <p>While it is required to get Git working at some point, we won&#8217;t refer to it in this document and, for now, do not cover the installation of Git on your machine or configuration of Git in Eclipse.</p> </div> <div class="paragraph"> <div class="title">Workspaces</div> <p>When you start a new Eclipse installation for the first time, you are asked to designate a new directory in your file system to store an <em>Eclipse workspace</em>. Eclipse is always running with exact one workspace open. As the name implies, a workspace stores everything needed in a given context of work, namely a set of related projects the user is working on as well as meta-data like preference settings, the current status of projects, to do lists, and more. In case a user wants to work in different contexts, e.g. on different tasks, command <code>File &#8594; Switch Workspace</code> allows to create additional workspaces and to switch between them.</p> </div> <div class="admonitionblock note"> <table> <tr> <td class="icon"> <i class="fa icon-note" title="Note"></i> </td> <td class="content"> <div class="paragraph"> <p>Any plug-in from the original Eclipse package or installed by the user later will be copied into the Eclipse installation directory, <strong>not</strong> in any workspace. Configuration and current state of plug-ins, on the other hand, are stored in workspaces.</p> </div> </td> </tr> </table> </div> <div class="paragraph"> <div class="title">Projects</div> <p>An Eclipse project is a technical term for a directory that often contains:</p> </div> <div class="ulist"> <ul>
911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980
<li> <p>files of specific types for source code, scripts, XML files or other data</p> </li> <li> <p>build settings, configurations</p> </li> <li> <p>dependency definitions (remember the dependencies between plug-ins above?)</p> </li> <li> <p>other Eclipse projects.</p> </li> </ul> </div> <div class="paragraph"> <p><code>File &#8594; New &#8594; Project&#8230;&#8203;</code> offers many different types of projects that the user can choose from, e.g. Java projects to create Java programs, Ecore modeling projects, or general projects, that simple hold some arbitrary files.<sup class="footnote">[<a id="_footnoteref_4" class="footnote" href="#_footnotedef_4" title="View footnote.">4</a>]</sup></p> </div> <div class="admonitionblock warning"> <table> <tr> <td class="icon"> <i class="fa icon-warning" title="Warning"></i> </td> <td class="content"> <div class="paragraph"> <p>Files that do not belong to a project are invisible for Eclipse!</p> </div> </td> </tr> </table> </div> <div class="paragraph"> <p>The projects belonging to a workspace can either be directly stored within the workspace as sub-directories (the default offered to the user when creating a new project), or linked from it, that is the workspace just holds a link to the project directory that lives somewhere in the file system outside of the workspace. Linking allows to work with the same projects in different workspaces.</p> </div> <div class="paragraph"> <p>While it sometimes makes sense to share or exchange workspaces between users,<sup class="footnote">[<a id="_footnoteref_5" class="footnote" href="#_footnotedef_5" title="View footnote.">5</a>]</sup>, I do not recommend this for now. Projects, in contrast, are shared between users most of the time, usually via Git. In general, I would suggest to store Eclipse projects outside workspaces at dedicated locations in the user&#8217;s file system. That way, we can follow the convention that local Git repositories should all be located under <code>&lt;userhome&gt;/git</code>.</p> </div> </div> <div class="sect2"> <h3 id="truesetup-eclipse-modeling-tools"><a class="anchor" href="#truesetup-eclipse-modeling-tools"></a>Setup Eclipse Modeling Tools</h3> <div class="paragraph"> <div class="title">Install Java</div> <p>Eclipse runs on 64-bit versions of Windows, Linux, and macOS and requires an according Java Development Kit (JDK), version 11 or higher, to be installed on your machine. Even if such JDK already exists, please download OpenJDK, version <strong>16</strong> or newer for your operating system from <a href="https://adoptopenjdk.net">AdoptOpenJDK</a>. <sup class="footnote">[<a id="_footnoteref_6" class="footnote" href="#_footnotedef_6" title="View footnote.">6</a>]</sup> Choose <code>HotSpot</code> as Java Virtual Machine. Installation process is straight forward, but you can also find links to exhaustive instructions for your operating system.</p> </div> <div class="paragraph"> <p>New Java versions appear every six months, so one could tend to stick with older version 11 that comes with long time support (LTE) until next LTE version 17 arrives in autumn 2021. However, actual version 16 conforms to the latest security measures built into macOS Catalina, so it is a must if software we build here shall be deployed to these systems, too.</p> </div> <div class="paragraph"> <p>Note that different versions of Java coexist peacefully.</p> </div> <div class="paragraph"> <div class="title">Install Eclipse Modeling Tools</div> <p>Now its time to download and install the correct Eclipse package <em>Eclipse Modeling Tools</em>, version 2021-03 or newer. Please go to <a href="https://www.eclipse.org/downloads/packages">Eclipse download page for packages</a>. On this page you may see <em>"Try the Eclipse Installer"</em> or similar. Do <strong>not</strong> follow this advice, since we want more control over what versions of Java and Eclipse shall be installed. Instead, look for package <em>Eclipse Modeling Tools</em> and follow the link for your operating system on the right:</p> </div> <div class="imageblock thumb"> <div class="content">
981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050
<img src="ParameterCatalogs2Images/EclipseDownload.gif" alt="EclipseDownload"> </div> <div class="title">Figure 1. Download links for Eclipse Modeling Tools package</div> </div> <div class="paragraph"> <p>Finally, you can click on <code>Download</code> and wait for the 400 something MB package to arrive.</p> </div> <div class="admonitionblock note"> <table> <tr> <td class="icon"> <i class="fa icon-note" title="Note"></i> </td> <td class="content"> <div class="paragraph"> <p>Depending on the operating system, several security dialogs have to be acknowledged during installation and first launch of Eclipse.</p> </div> </td> </tr> </table> </div> <div class="paragraph"> <p>The downloaded installation file contains the application simply named <code>Eclipse</code> ready to be copied into <code>Applications</code> on macOS or be installed in <code>Programs</code> on Windows. Since later you may add other Eclipse packages&#8201;&#8212;&#8201;or different versions of the same package&#8201;&#8212;&#8201;I suggest to rename the application more significantly to <code>EclipseModeling2103</code> or similar.</p> </div> <div class="paragraph"> <p>After installation has finished launch Eclipse for the first time and you will see a dialog for choosing a new empty directory as its workspace.</p> </div> <div class="imageblock thumb"> <div class="content"> <img src="ParameterCatalogs2Images/SelectWorkspaceDirectory.gif" alt="SelectWorkspaceDirectory" width="500"> </div> <div class="title">Figure 2. Initial Dialog to Choose a Workspace Directory</div> </div> <div class="paragraph"> <p>Again, more workspaces might come into existence later, so replace the proposed generic directory path and name with a more specific one, e.g.<code>EclipseModelingWS</code>. The Eclipse main window appears with a Welcome Screen open. It contains links to exhaustive documentation on concept, features and usage of Eclipse that might be of interest later, especially:</p> </div> <div class="ulist"> <ul> <li> <p>Overview</p> <div class="ulist"> <ul> <li> <p>Workbench basics</p> <div class="ulist"> <ul> <li> <p>Concepts: features, resources, perspectives, views, editors</p> </li> <li> <p>Opening perspectives and views</p> </li> <li> <p>Installing new software manually</p> </li> </ul> </div> </li> <li> <p>Team support with Git</p> </li> </ul> </div> </li> <li> <p>Learn how to use the Ecore diagram editor</p> </li>
1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120
<li> <p>Launch the Eclipse Marketplace</p> </li> </ul> </div> <div class="paragraph"> <p>For now, you can dismiss the welcome screen. It can be opened anytime by executing <code>Help &#8594; Welcome</code>. Now you should see the initial layout of Eclipse with <em>Model Explorer</em> and <em>Outline</em> on the left and a big empty editing area to the right with a <em>Properties</em> view below.</p> </div> </div> <div class="sect2"> <h3 id="truemodeling-parameter-catalogs-for-simulation-with-ecore"><a class="anchor" href="#truemodeling-parameter-catalogs-for-simulation-with-ecore"></a>Modeling Parameter Catalogs for Simulation with Ecore</h3> <div class="quoteblock"> <blockquote> <div class="paragraph"> <p>There are two hard problems in computer science: cache invalidation, naming things, and off-by-1 errors.</p> </div> </blockquote> <div class="attribution"> &#8212; Phil Karlton / N.N. </div> </div> <div class="paragraph"> <p>It takes time and effort to come along with good names for model entities, projects, files, and so on. Also, specific naming conventions are in place to enhance readability of models and program code. Since it is not always clear where names provided during modeling are used later, I compiled a list of names important in Ecore projects and added examples and comments to elucidate their meaning and naming conventions.</p> </div> <table class="tableblock frame-all grid-all stretch"> <caption class="title">Table 1. Naming</caption> <colgroup> <col style="width: 33.3333%;"> <col style="width: 33.3333%;"> <col style="width: 33.3334%;"> </colgroup> <thead> <tr> <th class="tableblock halign-left valign-top">Name</th> <th class="tableblock halign-left valign-top">Demo Catalog Example</th> <th class="tableblock halign-left valign-top">Real World Expample</th> </tr> </thead> <tbody> <tr> <td class="tableblock halign-left valign-top"><p class="tableblock">Namespace URI</p></td> <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="http://example.org/democatalog" class="bare">http://example.org/democatalog</a></p></td> <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="http://hft-stuttgart.de/buildingphysics" class="bare">http://hft-stuttgart.de/buildingphysics</a></p></td> </tr> <tr> <td class="tableblock halign-left valign-top"><p class="tableblock">Namespace Prefix</p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">democat</p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">buildphys</p></td> </tr> <tr> <td class="tableblock halign-left valign-top"><p class="tableblock">Base Package (reverse domain)<sup class="footnote">[<a id="_footnoteref_7" class="footnote" href="#_footnotedef_7" title="View footnote.">7</a>]</sup></p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">org.example</p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">de.hftstuttgart</p></td> </tr> <tr> <td class="tableblock halign-left valign-top"><p class="tableblock">Main Package</p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">democatalog</p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">buildingphysics</p></td> </tr> <tr> <td class="tableblock halign-left valign-top"><p class="tableblock">Eclipse Project<sup class="footnote">[<a id="_footnoteref_8" class="footnote" href="#_footnotedef_8" title="View footnote.">8</a>]</sup></p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">org.example.democatalog.model</p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">de.hftstuttgart.buildingphysics</p></td> </tr> <tr> <td class="tableblock halign-left valign-top"><p class="tableblock">Class Prefix</p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">Democatalog</p></td>
1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190
<td class="tableblock halign-left valign-top"><p class="tableblock">Buildingphysics</p></td> </tr> <tr> <td class="tableblock halign-left valign-top"><p class="tableblock">XML File Suffix</p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">democatalog</p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">buildingphysics</p></td> </tr> <tr> <td class="tableblock halign-left valign-top"><p class="tableblock">Classes</p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">e.g. SolarPanel</p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">e.g. WindowType</p></td> </tr> <tr> <td class="tableblock halign-left valign-top"><p class="tableblock">Attributes</p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">e.g. nominalPower</p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">e.g. id</p></td> </tr> <tr> <td class="tableblock halign-left valign-top"><p class="tableblock">Associations</p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">e.g. solarPanels</p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">e.g. windowTypes</p></td> </tr> </tbody> </table> <div class="paragraph"> <p>Classes are written in <a href="https://en.wikipedia.org/wiki/Camel_case">Camel case notation</a> starting with an upper case letter. Associations and attributes are written the same way, but starting with a lower case letter.</p> </div> <div class="paragraph"> <p>All other names should be derived from the globally unique <em>name space</em> of the project, in our example: <code>example.org/democatalog</code>. It consists of a global unique domain name and a path to the project, unique within that domain.</p> </div> <div class="paragraph"> <p>Use the names of example <em>Demo Catalog</em> to create your first Ecore modeling project:</p> </div> <div class="olist arabic"> <ol class="arabic"> <li> <p>Execute <code>File &#8594; New &#8594; Ecore Modeling Project</code> from main menu&#8201;&#8212;&#8201;not <code>Modeling Project</code>!</p> </li> <li> <p>Name the project <code>org.example.democatalog.model</code> and uncheck <code>Use default location</code> so that the new project is <strong>not</strong> stored in workspace but a different directory you create/choose, then click <code>Next &gt;</code></p> </li> <li> <p>Provide <code>democatalog</code> as main Java package name, uncheck <code>Use default namespace parameter</code> and provide <code><a href="http://example.org/democatalog" class="bare">http://example.org/democatalog</a></code> as <em>Ns URI</em> and <code>democat</code> as <em>Ns prefix</em></p> </li> <li> <p>Click <code>Finish</code>.</p> </li> </ol> </div> <div class="paragraph"> <p>Eclipse should look like below with an new empty graphical Ecore diagram editor opened. The diagram is automatically named <code>democatalog</code> after the package name for the Java classes that will be generated from it (provided above). The <em>Model Explorer</em> shows the contents of the new Ecore modeling project.</p> </div> <div class="imageblock thumb"> <div class="content"> <img src="ParameterCatalogs2Images/DemoCatalogEmpty.png" alt="DemoCatalogEmpty"> </div> <div class="title">Figure 3. New Ecore Modeling Project</div> </div> <div class="paragraph"> <p>To get your feet wet, do this:</p> </div> <div class="olist arabic"> <ol class="arabic"> <li> <p>Drag a <em>Class</em> from the palette on the right onto the editor&#8217;s canvas: it will materialize as a rectangle labeled <code>NewEClass1</code>.</p> </li> <li>
1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260
<p>The class symbol should be selected initially, so you can see its attributes in the <em>Properties</em> view.</p> </li> <li> <p>In there replace <code>NewEClass1</code> by <code>EnergyComponentsCatalog</code> to rename the class.</p> </li> <li> <p>Click anywhere on the canvas and notice that the class symbol is deselected and the toolbar at the top adapts accordingly.</p> </li> <li> <p>In the toolbar change <code>100%</code> to <code>75%</code> to scale diagram.</p> </li> <li> <p>Execute <code>File &#8594; Save</code> to save model and diagram on disk.</p> </li> <li> <p>Close diagram editor <code>democatalog</code> by closing its tab.</p> </li> <li> <p>Reopen saved diagram by double click on entry <code>democatalog</code> in <em>Model Explorer</em>.</p> </li> </ol> </div> <div class="paragraph"> <p>Technically, everything is in place now to begin modeling the data that the projected catalog shall contain. Except &#8230;&#8203; understanding the basics of object-oriented modeling would be helpful. This is why developers should support domain experts at this stage.</p> </div> <div class="paragraph"> <div class="title">Model Data with Class Diagrams</div> <p>Ecore diagrams are simplified UML class diagrams. Here some resources on what this is all about:</p> </div> <div class="ulist"> <ul> <li> <p><a href="http://www.cs.toronto.edu/~sme/CSC340F/slides/11-objects.pdf">Toronto Lecture on Object Oriented Modeling</a></p> </li> <li> <p><a href="http://agilemodeling.com/artifacts/classDiagram.htm">UML 2 Class Diagrams: An Agile Introduction</a></p> </li> <li> <p><a href="https://www.amazon.de/UML-Classroom-Einführung-objektorientierte-Modellierung-ebook/dp/B00AIBE1QA/ref=sr_1_2?__mk_de_DE=ÅMÅŽÕÑ&amp;dchild=1&amp;keywords=UML&amp;qid=1585854599&amp;sr=8-2">UML @ Classroom: Eine Einführung in die objektorientierte Modellierung (German Book)</a></p> </li> </ul> </div> <div class="admonitionblock tip"> <table> <tr> <td class="icon"> <i class="fa icon-tip" title="Tip"></i> </td> <td class="content"> <div class="paragraph"> <p>Beginners are strongly encouraged to read the first two resources. The first one contains a gentle introduction, especially suited for domain experts. The second one can also serve as reference.</p> </div> </td> </tr> </table> </div> <div class="paragraph"> <p>We will touch central object-oriented concepts <em>Class</em>, <em>Object</em>, <em>Attribute</em>, <em>Association</em>, <em>Composition</em>, and <em>Multiplicity</em> in an example below, but work through above sources to get a deeper understanding and to enhance your modeling skills.</p> </div> <div class="paragraph"> <p>Note that above sources differentiate between <em>conceptual</em> and <em>detailed</em> models. We go for detailed models, since only these contain enough information to generate code. Having said this, it is usually a good idea to have two or three conceptual iterations at a white board to agree on the broad approach before going too much into detail. But even if one starts with Ecore models right away, these also can be adapted any time to follow a new train of thought.</p> </div>
1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330
<div class="paragraph"> <p>See here the essential and typical structure of a parameter catalog in a class diagram. Instead of artificial example classes like <em>Foo</em> and <em>Bar</em> it shows classes from an existing catalog, albeit in very condensed form.</p> </div> <div class="imageblock thumb"> <div class="content"> <img src="http://localhost:57513/afx/cache/28c119036261e39473751e5cb111acc9.png" alt="28c119036261e39473751e5cb111acc9"> </div> <div class="title">Figure 4. Principle Structure of a Parameter Catalog</div> </div> <div class="paragraph"> <p>The diagram models four types of technical components whose data shall be stored in the catalog, e.g. for parameterization of simulation models later: <em>Boiler</em>, <em>CombinedHeatPower</em>, <em>SolarPanel</em>, and <em>Inverter</em>.</p> </div> <div class="paragraph"> <p>The catalog itself is represented by class <em>EnergyComponentsCatalog</em>. Unlike dozens, hundreds, or even thousands of objects to be cataloged&#8201;&#8212;&#8201;Boilers, Inverters etc.&#8201;&#8212;&#8201;there will be just exactly <strong>one</strong> catalog object in the data representing the catalog itself. Its "singularity" is not visible in the class diagram, but an <em>Ecore</em> convention requires that all objects must form a composition hierarchy with only one root object.</p> </div> <div class="paragraph"> <div class="title">Composition</div> <p>If, in the domain, one object is composed of others, this is expressed by a special kind of association called <em>composition</em>. Compositions are depicted as a link with a diamond shape attached to the containing object. In the <em>Boiler</em> case said link translates to: The <em>EnergyComponentsCatalog</em> contains&#8201;&#8212;&#8201;or is composed of&#8201;&#8212;&#8201;zero or more (<code>0..*</code>) boiler objects stored in a list named <code>boilers</code>.</p> </div> <div class="admonitionblock important"> <table> <tr> <td class="icon"> <i class="fa icon-important" title="Important"></i> </td> <td class="content"> <div class="paragraph"> <p>Note that class names&#8201;&#8212;&#8201;despite the fact that they model a set of similar objects&#8201;&#8212;&#8201;are always written in <em>singular</em>! Names for list-like associations and attributes usually are written in plural form.</p> </div> </td> </tr> </table> </div> <div class="paragraph"> <div class="title">Inheritance</div> <p>Besides composition of <strong>objects</strong>, the model above shows another, completely different, kind of hierarchy: the inheritance hierarchy between <strong>classes</strong>. Whenever classes of objects share the same attributes or associations, we don&#8217;t like to repeat ourselves by adding that attribute or relation to all classes again and again. Instead, we add a <em>super class</em> to define common attributes and associations and connect it to <em>sub classes</em> that will automatically <em>inherit</em> all the features of their super class.</p> </div> <div class="paragraph"> <p>In our example above, common to all four energy components are attributes <code>modelName</code> and <code>revisionYear</code>, thus these are modeled by class <code>EnergyComponent</code> that is directly or indirectly a super class of <em>Boiler</em>, <em>CombinedHeatPower</em>, <em>SolarPanel</em>, and <em>Inverter</em>. Similar, <em>Boiler</em> and <em>CombinedHeatPower</em> share attribute <code>installedThermalPower</code> factored out by class <em>ChemicalDevice</em>. <em>SolarPanel</em> and <em>Inverter</em> share attribute <code>nominalPower</code> modeled in abstract class <em>ElectricalDevice</em>.</p> </div> <div class="paragraph"> <div class="title">Associations</div> <p>You probably noticed a fifth type of objects contained in the catalog, namely <code>Manufacturer</code> objects stored in list <code>manufactureres</code>. How come? Ok, here is the story:</p> </div> <div class="sidebarblock"> <div class="content"> <div class="title">Domain Expert Meets Developer</div> <div class="paragraph"> <p><em>Exp</em>: &#8220;I&#8217;d like to store a component&#8217;s manufacturer. Shall I add a String attribute <code>manufacturerName</code> to all classes like <em>Boiler</em>, <em>Inverter</em> and so on to store the manufacturer&#8217;s name?&#8221;</p> </div> <div class="paragraph"> <p><em>Dev</em> shudders: &#8220;Well, what do you mean by "&#8230;&#8203; and so on"?&#8221;</p> </div> <div class="paragraph"> <p><em>Exp</em>: &#8220;Basically, I mean all energy components.&#8221;</p> </div> <div class="paragraph"> <p><em>Dev</em>: &#8220;Fine. We already have a class representing all those energy components, brilliantly named <em>EnergyComponent</em>. Thus, we can define <code>manfacturerName</code> there, following one of Developer&#8217;s holy principles: "<em>DRY</em>&#8201;&#8212;&#8201;Don&#8217;t repeat yourself!" By the way: Is the name all you want to know about manufacturers?&#8221;</p> </div>
1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400
<div class="paragraph"> <p><em>Exp</em>: &#8220;Mhm, maybe we need to know if they are still in business &#8230;&#8203;&#8221;</p> </div> <div class="paragraph"> <p><em>Dev</em>: &#8220;&#8230;&#8203; or even since when they were out of business, if at all &#8230;&#8203;&#8221;</p> </div> <div class="paragraph"> <p><em>Exp</em>: &#8220;&#8230;&#8203; and the country or region they are active.&#8221;</p> </div> <div class="paragraph"> <p><em>Dev</em>: &#8220;Ok, so it&#8217;s not just the name&#8201;&#8212;&#8201;we need a class <code>Manufacturer</code> to model all these information.&#8221;</p> </div> <div class="paragraph"> <p><em>Exp</em> sighs.</p> </div> <div class="paragraph"> <p><em>Dev</em>: &#8220;Come on, its not that hard to add a class to our data model, isn&#8217;t it?&#8221;</p> </div> <div class="paragraph"> <p><em>Exp</em>: &#8220;Ok, but how can we express what components a manufacturer produces?&#8221;</p> </div> <div class="paragraph"> <p><em>Dev</em>: &#8220;Wasn&#8217;t it the other way around? I thought, you just wanted to know the manufacturer of a component?&#8221;</p> </div> <div class="paragraph"> <p><em>Exp</em>: &#8220;What is the difference?&#8221;</p> </div> <div class="paragraph"> <p><em>Dev</em>: &#8220;In data modeling, it is the difference between a uni-directional and a bi-directional association.&#8221;</p> </div> <div class="paragraph"> <p><em>Exp</em>: &#8220;&#8230;&#8203;?&#8221;</p> </div> <div class="paragraph"> <p><em>Dev</em>: &#8220;Let&#8217;s put it that way: The difference between a link with an arrow on one side or on both sides.&#8221;</p> </div> <div class="paragraph"> <p><em>Exp</em>: &#8220;Ok. We don&#8217;t need a list of components per manufacturer, but simply a reference from the component to its manufacturer.&#8221;</p> </div> <div class="paragraph"> <p><em>Dev</em>: &#8220;Fine, then in Ecore please create a simple reference from class <code>EnergyComponent</code> to class <code>Manufacturer</code>, maybe named <code>producedBy</code>.&#8221;</p> </div> <div class="paragraph"> <p><em>Exp</em>: &#8220;I will try this and get back to you.&#8221;</p> </div> <div class="paragraph"> <p><em>Dev</em>: &#8220;Fine &#8230;&#8203; good meeting.&#8221;</p> </div> </div> </div> <div class="paragraph"> <p>Observe in our data model, reference <code>producedBy</code> points <em>from</em> <code>EnergyComponent</code> <em>to</em> <code>Manufacturer</code> making it uni-directional reference. One can simply query the manufacturer of a product, but not the other way around. With a bi-directional reference both queries would be available.</p> </div> <div class="paragraph"> <p>Observe also the annotations <code>0..*</code> and <code>1..1</code> near class <code>Manufacturer</code>. These are <em>multiplicities</em> of associations: An <code>EnergyComponentsCatalog</code> contains zero, one, or many objects of class <code>Manufacturer</code> and an <code>EnergyComponent</code> must reference exactly one manufacturer&#8201;&#8212;&#8201;not less, not more.</p> </div> <div class="openblock float-group"> <div class="content"> <div class="imageblock right thumb"> <div class="content"> <img src="ParameterCatalogs2Images/EcoreRelations.gif" alt="EcoreRelations" width="200"> </div> <div class="title">Figure 5. Ecore Relations</div> </div> <div class="paragraph"> <p>To recapitulate: Our example parameter catalog already exhibits all four types of relations provided by Ecore. You find these in the Ecore editor&#8217;s palette shown here.
1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470
To create a relation between a sub class and a super class use tool <code>SuperType</code>. Use the other tools to create an association between classes, may it be a simple (uni-directional) reference, a bi-directional reference, or a composition.</p> </div> </div> </div> <div class="paragraph"> <div class="title">Attributes and Enumerations</div> <p>Obviously, attributes are central in data modeling. Create one by dragging it from the palette onto our one and only class so far: <code>EnergyComponentsCatalog</code>. The class symbol will turn red to indicate an error. Hover with the mouse pointer over the new attribute and a tooltip with a more or less helpful error message will appear. Current error is caused by that no data type was set for the new attribute. Data types for attributes can be integer or floating point numbers, strings, dates, booleans, and more. To get rid of the error:</p> </div> <div class="olist arabic"> <ol class="arabic"> <li> <p>If not already selected, select new attribute by clicking at it in the editor.</p> </li> <li> <p>In view <em>Properties</em> find <code>EType</code> and click button <code>&#8230;&#8203;</code> to see a quite long list of available data types.</p> </li> <li> <p>Choose <code>EString [java.lang:String]</code> from the list and the error is gone.</p> </li> </ol> </div> <div class="openblock float-group"> <div class="content"> <div class="imageblock right thumb"> <div class="content"> <img src="ParameterCatalogs2Images/EcoreClassWithAttribute.png" alt="EcoreClassWithAttribute" width="200"> </div> <div class="title">Figure 6. Class with Attribute</div> </div> <div class="paragraph"> <p>Change the attribute&#8217;s name to <code>author</code> and the class should look like shown here.</p> </div> <div class="paragraph"> <p>Most data types to choose from begin with letter <strong>E</strong> like in <strong>E</strong>core. These are just Ecore enabled variants of the respective Java types, thus, choose EInt for an int, EFloat for a 32 bit floating point number, EDouble for a 64 bit one, and so on.</p> </div> <div class="paragraph"> <p>Ecore allows to introduce new data types. We employ this feature later to enable data models with physical units and quantities.</p> </div> </div> </div> <div class="paragraph"> <p>There exists one other means to define the values an attribute can take, namely enumerations of distinct literals. Take <em>Monday</em>, <em>Tuesday</em>, <em>Wednesday</em>, &#8230;&#8203; as a typical example for representing weekdays. In our example data model you&#8217;ll find one <em>Enumeration</em> named <code>BoilerType</code> with values <code>LowTemperature</code> and <code>Condensing</code>.</p> </div> <div class="paragraph"> <div class="title">Homework</div> <p>The next section deals with generation of Java code from data models. To have more to play with, please implement our example model in Ecore now.</p> </div> <div class="openblock float-group"> <div class="content"> <div class="imageblock right thumb"> <div class="content"> <img src="ParameterCatalogs2Images/EcoreClassifier.png" alt="EcoreClassifier" width="200"> </div> <div class="title">Figure 7. Abstract Class</div> </div> <div class="paragraph"> <p>To do this, there is one more thing to know about classes: the difference between ordinary classes and abstract classes. 'Ordinary class' doesn&#8217;t sound nice, therefore, classes that are not abstract are called <em>concrete</em> classes. Our example diagram depicts abstract classes with letter <strong>A</strong> while concrete classes are labeled with <strong>C</strong>. You add abstract classes to a model with a special palette tool shown here.</p> </div>
1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540
<div class="paragraph"> <p>The thing is: Objects can be created for concrete classes only!</p> </div> <div class="paragraph"> <p>In our example, it makes no sense to create an object from class <em>EnergyComponent</em>, because there is not such a thing like an energy component <em>per se</em>. Therefore, this class is <em>abstract</em>. It is true that an inverter <em>is</em> an energy component, thus inheriting all its features, but it was <em>created</em> as <em>Inverter</em>, not as <em>EnergyComponent</em>.</p> </div> <div class="paragraph"> <p>Super classes will be abstract most of the time. So my advice is: Model a super class as abstract class unless you convince yourself that there exist real objects in the domain that belong to the super class but, at the same time, do not belong to any of its sub classes. In the Ecore editor properties view, you can specify if a class is abstract or not, simply by toggling check box <code>Abstract</code>.</p> </div> </div> </div> <div class="paragraph"> <p>Two more tips and you are ready to rock and roll!&#8201;&#8212;&#8201;At least with your homework.</p> </div> <div class="admonitionblock tip"> <table> <tr> <td class="icon"> <i class="fa icon-tip" title="Tip"></i> </td> <td class="content"> <div class="paragraph"> <p>An exhaustive user manual for Ecore diagram editor is available. Execute <code>Help &#8594; Welcome</code> and follow link <code>Learn how to use the diagram editor</code>.</p> </div> </td> </tr> </table> </div> <div class="admonitionblock tip"> <table> <tr> <td class="icon"> <i class="fa icon-tip" title="Tip"></i> </td> <td class="content"> <div class="paragraph"> <p>If Ecore models get bigger, you may find it more convenient to work with a form based UI instead of, or in addition to, the diagram editor. Open this kind of editor via command <code>Open With &#8594; Ecore Editor</code> from the context menu over entry <code>democatalog.ecore</code> in the <em>Model Explorer</em> view. Note that Eclipse synchronizes different editors of the same content automatically.</p> </div> </td> </tr> </table> </div> </div> <div class="sect2"> <h3 id="truegeneration-of-java-code-from-data-model"><a class="anchor" href="#truegeneration-of-java-code-from-data-model"></a>Generation of Java Code from Data Model</h3> <div class="paragraph"> <p>By now, your Ecore model should look like this:</p> </div> <div id="fig-example-model" class="imageblock thumb"> <div class="content"> <img src="ParameterCatalogs2Images/Homework.png" alt="Homework"> </div> <div class="title">Figure 8. Example Model (Homework)</div> </div> <div class="paragraph"> <p>Let us bring the model to life, that is, generate code from it that creates, reads, updates, and deletes concrete data objects of modeled classes in computers. I would like to tell you that this is done with just one click but, actually, you need two or three:</p> </div> <div class="olist arabic"> <ol class="arabic"> <li> <p>Make sure all files are saved (<code>File &#8594; Save All</code>)</p> </li> <li>
1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610
<p>Execute <code>Generate &#8594; Model Code</code> from the context menu of Ecore editor <code>democatalog</code></p> </li> <li> <p>Execute <code>Generate &#8594; Edit Code</code> from the same context menu</p> </li> </ol> </div> <div class="admonitionblock warning"> <table> <tr> <td class="icon"> <i class="fa icon-warning" title="Warning"></i> </td> <td class="content"> <div class="paragraph"> <p>Please do <strong>not</strong> execute <code>Generate &#8594; All</code> or <code>Generate &#8594; Editor Code</code>.</p> </div> <div class="imageblock thumb"> <div class="content"> <img src="ParameterCatalogs2Images/GenerateMenu.png" alt="GeneratedClasses" width="260"> </div> </div> <div class="paragraph"> <p>This would create code for a simple user interface, but we use more advanced EMF Forms for that later. If, by mistake, project <code>org.example.democatalog.editor</code> was created, just delete it from <em>Model Explorer</em> and do not forget to check <code>Delete project contents on disk</code> in confirmation dialog.</p> </div> </td> </tr> </table> </div> <div class="openblock float-group"> <div class="content"> <div class="imageblock right thumb"> <div class="content"> <img src="ParameterCatalogs2Images/GeneratedClasses.png" alt="GeneratedClasses" width="260"> </div> <div class="title">Figure 9. Generated Classes</div> </div> <div class="paragraph"> <p><code>Generate &#8594; Model Code</code> creates classes that represent the modeled data in code. These classes are located in three packages under directory <code>src-gen</code> in <code>org.example.democatalog.model</code>.</p> </div> <div class="paragraph"> <p><code>Generate &#8594; Edit Code</code> creates a whole new Eclipse project named <code>org.example.democatalog.edit</code>, again with generated classes under directory <code>src-gen</code>.</p> </div> <div class="paragraph"> <p>You may have a look at some Java classes for curiosity by double clicking at them in <em>Model Explorer</em>. There is no point in trying to understand the code in detail, but observe token <code>@generated</code> present in the comments of all classes, fields and methods. Classes, fields and methods marked with this token are (re)generated whenever above commands are executed.</p> </div> <div class="paragraph"> <p>Sometimes it maybe required to manually adapt generated code&#8201;&#8212;&#8201;after all our concern is "low code", not "no code" development. In that case, we will replace <code>@generated</code> by <code>@generated NOT</code> to prevent code regeneration.</p> </div> <div class="paragraph"> <p>After code generation, you may have noticed some warnings showed up in view <em>Problems</em>.</p> </div> <div class="imageblock thumb"> <div class="content"> <img src="ParameterCatalogs2Images/Warnings.gif" alt="Warnings" width="500"> </div> <div class="title">Figure 10. Warnings</div> </div> <div class="paragraph"> <p>In general, it is highly recommended to resolve warnings, and errors of course, but we will make an exception from the rule, since the warnings are uncritical and would reappear each time code is regenerated.</p> </div> </div> </div> </div> <div class="sect2"> <h3 id="truegeneration-and-tweaking-of-user-interface"><a class="anchor" href="#truegeneration-and-tweaking-of-user-interface"></a>Generation and Tweaking of User Interface</h3> <div class="paragraph"> <p>In this section you will learn how to generate and tweak a CRUD user interface based on Ecore data model and Java classes created for our demo parameters catalog above. Topics described here are discussed in more detail in tutorial <a href="https://eclipsesource.com/blogs/tutorials/getting-started-with-EMF-Forms/">Getting started with EMF Forms</a>. To find out what user interface controls and layouts are provided by this framework have a look at <a href="https://eclipsesource.com/blogs/tutorials/emf-forms-view-model-elements/">EMF Forms – View Model Elements</a>. <em>EMF Forms</em> is already part of package <em>Eclipse Modeling Tools</em>, so we can create a third Eclipse project/plugin that implements a user interface for editing catalog data without further ado:</p>
1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680
</div> <div class="olist arabic"> <ol class="arabic"> <li> <p>In the <em>Model Explorer</em> execute <code>EMF Forms &#8594; Create View Model Project</code> from context menu over <code>democatalog.ecore</code></p> </li> <li> <p>Leave project name <code>org.example.democatalog.viewmodel</code> as is but uncheck <code>Use default location</code>&#8201;&#8212;&#8201;as we always do&#8201;&#8212;&#8201;and browse to the directory containing <code>org.example.democatalog.model</code></p> </li> <li> <p>Click <code>Next &gt;</code> and select <code>EnergyComponentsCatalog</code> as data element we want to create a user interface for</p> </li> <li> <p>Leave <code>Fill view model with default layout</code> checked and click <code>Finish</code>.</p> </li> </ol> </div> <div class="paragraph"> <p>According to these inputs a new project is created with file <code>EnergyComponentsCatalog.view</code> under directory <code>viewmodels</code>. This file opens automatically in a special <em>View Editor</em>.</p> </div> <div class="imageblock thumb"> <div class="content"> <img src="ParameterCatalogs2Images/ViewModel.png" alt="ViewModel1"> </div> <div class="title">Figure 11. New View Model</div> </div> <div class="paragraph"> <p>Like the <strong>data</strong> of our catalog are modeled as Ecore file using a dedicated graphical editor, so will our catalog’s <strong>user interface</strong> be modeled in <code>.view</code> files, again using a special editor.</p> </div> <div class="paragraph"> <p>Since we opted for <code>Fill view model with default layout</code> the catalog&#8217;s UI is filled initially with default controls for all data items assigned to Ecore type <code>EnergyComponentsCatalog</code> like a string control for <code>author</code> or list controls for <code>boilers</code>, <code>chps</code>, and so on.</p> </div> <div class="paragraph"> <p>See red arrow in the above screen-shot? It points to a button that opens a functional preview of the modeled user interface.</p> </div> <div class="imageblock thumb"> <div class="content"> <img src="ParameterCatalogs2Images/ViewEditorPreview.png" alt="ViewModel1" width="500"> </div> <div class="title">Figure 12. User Interface Preview</div> </div> <div class="admonitionblock tip"> <table> <tr> <td class="icon"> <i class="fa icon-tip" title="Tip"></i> </td> <td class="content"> <div class="paragraph"> <p>Double click on tab <em>EMF Forms Preview</em> to enlarge view for better handling&#8201;&#8212;&#8201;double click again to get back.</p> </div> <div class="paragraph"> <p>Enable auto refresh mode <span class="image"><img src="ParameterCatalogs2Images/ViewModelAutomaticRefresh.gif" alt="ViewModelAutomaticRefresh" width="40"></span> to let each change in the view model instantly be reflected in the preview.</p> </div> <div class="paragraph"> <p>Given your screen is big enough, you may want to dock-out the preview by dragging tab <em>EMF Forms Preview</em> out of Eclipse&#8217;s main window. Seeing editor and preview side by side is a great way to explore the possibilities of view models.</p> </div> </td> </tr> </table> </div> <div class="paragraph"> <p>Red input field and exclamation mark in the preview signal missing or inconsistent data. Ecore data model specifies attribute <code>author</code> with a lower bound of one, meaning it is a mandatory attribute. As soon as an author&#8217;s name is provided, the error indication disappears. This is what <em>functional</em> preview means. You can even create new boilers or other objects in lists provided, with all forms created "automagically" with respect to our underlying Ecore data model.</p>
1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750
</div> <div class="paragraph"> <p>Of course, such automatic approach has its limits. In our case, a long list of lists is not very user-friendly, because one has to scroll up and down to find a specific list. Also, no specific object data are shown in the list and data can only be edited in a pop-up form (no inline editing).</p> </div> <div class="paragraph"> <p>How should a better UI look and feel like?</p> </div> <div class="paragraph"> <p>If there are many lists (types) of entities&#8201;&#8212;&#8201;the normal case for parameter catalogs&#8201;&#8212;&#8201;users should select what list they want to work with by selecting it from a list or tree view that is always visible, the <em>master view</em>. Once a type is selected in the master view, a table with all objects of this list/type shall appear sidelong in a <em>detail view</em>, ready for editing.</p> </div> <div class="paragraph"> <p>In <em>EMF Forms</em> master-detail-views can be modeled either with <em>Categorization</em> or <em>Tree Master Detail</em> UI components. The latter not only allows to edit information displayed in the detail view, but also the tree of elements in the master view. Opposed to that, a <em>Categorization</em> presents a fixed hierarchy of elements to choose from. This is exactly what we need as there are only a fixed number of types of objects to be edited in a parameters catalog.</p> </div> <div class="sect3"> <h4 id="trueadding-tables-to-the-ui"><a class="anchor" href="#trueadding-tables-to-the-ui"></a>Adding Tables to the UI</h4> <div class="openblock float-group"> <div class="content"> <div class="imageblock right thumb"> <div class="content"> <img src="ParameterCatalogs2Images/ViewModelDeleteControls.gif" alt="ViewModelDeleteControls" width="300"> </div> <div class="title">Figure 13. Delete default list controls</div> </div> <div class="paragraph"> <p>But first, we replace the default controls for lists of boilers, chps, and so on by tables. As shown here, select all list controls in the view model and execute <code>Delete</code> from context menu. Refresh <em>View Editor Preview</em> to verify that only field <code>Author*</code> is left.</p> </div> </div> </div> <div class="openblock float-group"> <div class="content"> <div class="imageblock right thumb"> <div class="content"> <img src="ParameterCatalogs2Images/ViewModelCreateTable.gif" alt="ViewModelCreateTable" width="300"> </div> <div class="title">Figure 14. Create Table Control</div> </div> <div class="paragraph"> <p>Next, create a table that shall display all boilers in a catalog: Select <code>EnergyComponentsCatalog</code>, activate context menu and choose <code>TableControl</code> from the list of available UI elements. (EnergyComponentsCatalog represents the root view of the UI and, as such, accepts quite a lot of different UI components as child components.)</p> </div> <div class="paragraph"> <p>Entry <code>TableControl</code> was inserted into the list of interface elements below <code>Control author</code>. Checking updated preview reveals no table but a message basically saying that a reference to the domain model is missing, in other words: <em>EMF Forms</em> does not know yet what data to present in table. Click on entry <code>TableControl</code> to see its details. A red exclamation mark indicates the missing <code>Domain Model Reference*</code>. Click on <span class="image"><img src="ParameterCatalogs2Images/ButtonLinkPlus.gif" alt="ButtonLinkPlus" width="40"></span> and be ready to chase a sequence of dialogs:</p> </div> </div> </div> <div class="olist arabic"> <ol class="arabic"> <li> <p>Click on another <span class="image"><img src="ParameterCatalogs2Images/ButtonLinkPlus.gif" alt="ButtonLinkPlus" width="40"></span> in dialog <code>Configure TableDomainModelReference</code></p> </li> <li> <p>In wizard <code>New Reference Element</code> select <code>model &#8594; FeaturePathDomainModelReference</code> and click <code>Next &gt;</code></p> </li> <li> <p>Click <code>Link Domain Model EFeature</code> and in appearing pop-up list choose reference to list of objects you want to edit in the table, e.g. <code>boilers</code>; confirm with <code>OK</code> safely ignoring warning about missing <code>PropertyDescriptor</code>.</p> </li> <li> <p><code>Finish</code> wizard <code>New Reference Element</code></p> </li>
1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820
<li> <p><code>Finish</code> dialog <code>Configure TableDomainModelReference</code>.</p> </li> </ol> </div> <div class="paragraph"> <p>This was some work, but as reward we get a fully specified table control in <em>View Editor</em> that "translates" into a preview where we can create, read, update, and delete boilers.</p> </div> <div class="imageblock thumb"> <div class="content"> <img src="ParameterCatalogs2Images/ViewModelWithTable.gif" alt="ViewModelWithTable.gif"> </div> <div class="title">Figure 15. Table for Boilers</div> </div> <div class="paragraph"> <p>Moreover, clicking at a table header sorts all objects in it (rows) according to the values in this column. Column widths can adapted, too.</p> </div> <div class="openblock float-group"> <div class="content"> <div class="imageblock right thumb"> <div class="content"> <img src="ParameterCatalogs2Images/ViewModelTweakTable.gif" alt="ViewModelTweakTable" width="300"> </div> <div class="title">Figure 16. Modify Table Control</div> </div> <div class="paragraph"> <p>Table UIs can be tweaked in many ways, e.g. selection and sequence of columns can be declared via list <code>Column Domain Model References</code>. To fill this list with defaults, execute <code>Generate Columns</code> from table control&#8217;s context menu. Reorder them as you like or delete columns that are not important to the user.</p> </div> <div class="paragraph"> <p>Notice here an important overall feature of <em>EMF Forms</em>: If something is left unspecified, be it the view model for an Ecore object type or the specification of table columns, <em>EMF Forms</em> will always find a default solution! Applied to columns specification this means we get default columns automatically back in the moment the last column is removed from list <code>Column Domain Model References</code>.</p> </div> <div class="paragraph"> <p>If explicit column specifications are present further configurations can be added to a table control from its context menu, e.g. initial column widths or read-only status of columns. See <a href="https://eclipsesource.com/de/blogs/2018/01/31/emf-forms-1-15-0-feature-enhanced-table-renderer/">here</a> for details.</p> </div> </div> </div> <div class="paragraph"> <p>By default only attributes are displayed and directly editable in tables while references to other objects&#8201;&#8212;&#8201;in our case the reference to a manufacturer&#8201;&#8212;&#8201;are not.</p> </div> <div class="openblock float-group"> <div class="content"> <div class="imageblock right thumb"> <div class="content"> <img src="ParameterCatalogs2Images/ViewModelWithPanel.gif" alt="ViewModelWithPanel" width="300"> </div> <div class="title">Figure 17. Default Panel for Boilers</div> </div> <div class="paragraph"> <p>To get the default (<em>sic!</em>) editing panel for an selected table row, in <em>View Editor</em> just set <code>Detail Editing*</code> from <code>None</code> to <code>WithPanel</code>, <strong>press <em>Tab</em></strong>, and save. For boilers, <em>EMF Forms</em> will create the editing panel shown here. Regardless wether users edit data in the panel or directly in the table&#8201;&#8212;&#8201;both will stay in sync any time.</p> </div> </div> </div> <div class="admonitionblock warning"> <table> <tr> <td class="icon"> <i class="fa icon-warning" title="Warning"></i> </td> <td class="content"> <div class="paragraph"> <p><em>View editor</em> exhibits an irritating behavior: With preview auto-refresh turned on, any change in the details view is reflected instantly in the preview, even without saving the form or leaving the edited field.</p> </div> <div class="paragraph"> <p>On the other hand, <strong>saving</strong> an updated view editor only takes into account edited fields after they have lost focus, e.g. by pressing <em>Tab</em> key or clicking with the mouse into another field. So, saving a form before the focus has shifted from the last edited field won&#8217;t honor this edit, that is you won&#8217;t necessarily get what you see.</p> </div> </td> </tr> </table>
1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890
</div> <div class="paragraph"> <p>One last thing: Enter <code>boilers</code> as name for the table control so we can distinguish it from the other four table controls to come.</p> </div> <div class="paragraph"> <p>Yes! &#8230;&#8203; Please repeat above procedure to create table controls for chps, solar panels, inverters and manufacturers, too. I did this in about 3 minutes. ;-)</p> </div> </div> <div class="sect3"> <h4 id="truemaster-detail-view-with-categories"><a class="anchor" href="#truemaster-detail-view-with-categories"></a>Master-Detail View with Categories</h4> <div class="paragraph"> <p>In last section we improved our catalog&#8217;s UI by replacing simple object lists by tables that can be sorted, customized and edited inline as well as in an associated panel. Alas, instead a list of lists we have got an even bigger list of tables.</p> </div> <div class="paragraph"> <p>High time to introduce a master-detail view that presents categories of object types in a master view and, after one is selected, the according object table in the detail view.</p> </div> <div class="openblock float-group"> <div class="content"> <div class="imageblock right thumb"> <div class="content"> <img src="ParameterCatalogs2Images/ViewModelCatgorization1.gif" alt="ViewModelCatgorization1" width="180"> </div> <div class="title">Figure 18. Category Tree</div> </div> <div class="paragraph"> <p>Add a <em>Categorization</em> view to the list of UI elements in <em>View Editor</em> by selecting <code>EnergyComponentsCatalog</code> and choose <code>Categorization</code> from its contect menu.</p> </div> <div class="paragraph"> <p>Now add two <code>Composite Category</code> elements and one <code>Leaf Category</code> to <code>Categorization</code> from according context menu. This gives us three top level entries in the hierarchy.</p> </div> <div class="paragraph"> <p>In the same way add two <code>Leaf Category</code> elements to each <code>Composite Category</code> resulting in the hierarchy depicted here.</p> </div> </div> </div> <div class="openblock float-group"> <div class="content"> <div class="imageblock right thumb"> <div class="content"> <img src="ParameterCatalogs2Images/ViewModelCatgorization2.gif" alt="ViewModelCatgorization2" width="260"> </div> <div class="title">Figure 19. Completed View Model</div> </div> <div class="paragraph"> <p>This screen shot shows the view model of our UI when finished. To get there:</p> </div> <div class="olist arabic"> <ol class="arabic"> <li> <p>Select UI element <code>Categorization</code> and rename it to <code>Categories</code></p> </li> <li> <p>Rename composite and leaf categories as depicted here</p> </li> <li> <p>Drag all table controls one by one into the suited leaf category</p> </li> <li> <p>Confirm master-detail view works as expected in the preview.</p> </li> </ol> </div> </div> </div> <div class="admonitionblock important"> <table> <tr> <td class="icon"> <i class="fa icon-important" title="Important"></i>
1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960
</td> <td class="content"> <div class="paragraph"> <p>The UI hierarchy to access tables for entity types is independent, and usually will differ, from aggregation and inheritance hierarchies present in Ecore data model (compare fig. <a href="#fig-example-model">Example Model</a>).</p> </div> </td> </tr> </table> </div> <div class="paragraph"> <p>Note that <em>EMF Forms Preview</em> provides these buttons <span class="image"><img src="ParameterCatalogs2Images/ViewModelPersistence.gif" alt="PreviewPersistanceButtons" width="68"></span> to clear, load and store edited data. In fact, this feature gives us a fully functional prototype. At least during refinement of model and UI, data sets can be created, edited, and tested for usability without the need to built a full blown, deployable application&#8201;&#8212;&#8201;see parts <em>Accessing and Using Parameter Catalogs</em> and <em>Build (Parameter Catalog) Applications with Eclipse Tycho</em> below.</p> </div> <div class="paragraph"> <p>Be aware that in some cases the view model must adapt to changes in data model, e.g. a new leaf category and table component must be created for a new catalog object type. Other changes are automatically reflected in the generated UI, at least for default forms and default table columns. To our convenience, view model specifications incompatible with data model are indicated by error badges in the <em>View Editor</em>.</p> </div> <div class="paragraph"> <p>Changes in data model also can make existing XML data incompatible. There are tools for data migration, but for now, recreation of test data or manual editing of XML file is the way to go.</p> </div> </div> </div> <div class="sect2"> <h3 id="trueadd-units-to-the-mix"><a class="anchor" href="#trueadd-units-to-the-mix"></a>Add Units to the Mix</h3> <div class="paragraph"> <p>As mentioned earlier, parameter catalogs should be able to represent quantities, not just bare numbers. See <a href="https://onlinelibrary.wiley.com/doi/full/10.1002/spe.2926">Unit of measurement libraries, their popularity and suitability</a> for a systematic account of open source solutions in the this area.</p> </div> <div class="paragraph"> <p>Java provides an extensive framework to deal with quantities and their units defined in <a href="https://docs.google.com/document/d/12KhosAFriGCczBs6gwtJJDfg_QlANT92_lhxUWO2gCY/edit#heading=h.6698n7erex5o">Java Specification Request (JSR) 385</a>. The reference implementation for this framework is <a href="https://unitsofmeasurement.github.io/indriya/">Indriya</a>. Demos of its usage can be found at <a href="https://unitsofmeasurement.github.io/uom-demos/" class="bare">https://unitsofmeasurement.github.io/uom-demos/</a>.</p> </div> <div class="paragraph"> <p>To make Indriya available Ecore data models and EMF Forms, the author has created two plug-ins that can easily be added to Eclipse. To do so, open dialog <code>Help &#8594; Install New Software&#8230;&#8203;</code> and enter site <code><a href="https://transfer.hft-stuttgart.de/pages/neqmodplus/indriya-p2/release_target_211/" class="bare">https://transfer.hft-stuttgart.de/pages/neqmodplus/indriya-p2/release_target_211/</a></code> like depicted below.</p> </div> <div class="imageblock thumb"> <div class="content"> <img src="ParameterCatalogs2Images/AddUpdateSite.png" alt="Install Plug-in" width="500"> </div> <div class="title">Figure 20. Install Plug-in from Specific Update Site</div> </div> <div class="paragraph"> <p>Select Indriya plug-in, press <code>Next &gt;</code> and acknowledge all following dialogs, including security warnings.</p> </div> <div class="paragraph"> <p>Do the same for the City Units plug-in available at site <code><a href="https://transfer.hft-stuttgart.de/pages/neqmodplus/de.hft-stuttgart.cityunits/release_target_101/" class="bare">https://transfer.hft-stuttgart.de/pages/neqmodplus/de.hft-stuttgart.cityunits/release_target_101/</a></code> Finally, restart Eclipse to complete plug-in installation.</p> </div> <div class="paragraph"> <p>While the first plug-in installs Indriya, the second plug-in adds some specific units for urban simulation, EMF Forms editor fields for quantities, and Ecore types used for modeling quantities as attributes of classes.</p> </div> <div class="paragraph"> <p>Make the new Ecore types <code>QuantityLong</code> and <code>QuantityDouble</code> available like so:</p> </div> <div class="olist arabic"> <ol class="arabic"> <li> <p>Open <code>Sample Ecore Model Editor</code> from the context menu over your Ecore model</p> </li> <li> <p>From the context menu in this editor, execute <code>Load Resource&#8230;&#8203;</code> and then <code>Browse Target Platform Packages&#8230;&#8203;</code></p> </li> <li> <p>Select package <code><a href="https://www.hftstuttgart.de/quantities" class="bare">https://www.hftstuttgart.de/quantities</a></code> and confirm the addition of <code>platform:/resource/de.hftstuttgart.cityunits.model/model/Quantities.ecore</code>.</p> </li> </ol> </div>
1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030
<div class="imageblock right thumb"> <div class="content"> <img src="ParameterCatalogs2Images/QuantityDoubleAttributeType.png" alt="Install Plug-in" width="300"> </div> <div class="title">Figure 21. Set QuantityDouble Type</div> </div> <div class="paragraph"> <p>From now on, the new attribute types are available to model quantities with integer or floating point values as can be seen on the screenshot to the right.</p> </div> <div class="paragraph"> <p>Note here, that I also changed the default value from <code>0.0</code> to <code>0.0 V</code> to indicate that <code>maxDCVoltage</code> of inverters is given in <strong>Volt</strong>.</p> </div> <div class="paragraph"> <p>The symbols for defining units follow SI and other standards, including decimal prefixes like <code>m</code> for Milli or <code>G</code> for Giga as well as derived units, that is: <code>mV</code>, <code>GV</code> or <code>kW·h/m³</code> are all valid unit definitions. This is all documented well in the resources mentioned at the top of this section, but for convenience, a table with valid units, including some specific units for urban simulation, is compiled in <a href="UnitsExamples.md" class="bare">UnitsExamples.md</a>.</p> </div> <div class="paragraph"> <p>If a unit symbol cannot be interpreted, this error is not already detected while generating and compiling code from model, but not before run time when the application tries to create the default value. In that case, you will see an error message like this:</p> </div> <div class="imageblock thumb"> <div class="content"> <img src="ParameterCatalogs2Images/ErrorInUnitDefinition.png" alt="Install Plug-in" width="400"> </div> <div class="title">Figure 22. Error Message for Wrong Unit Definition</div> </div> <div class="admonitionblock warning"> <table> <tr> <td class="icon"> <i class="fa icon-warning" title="Warning"></i> </td> <td class="content"> <div class="paragraph"> <p>Be told that each attribute of type <code>QuantityLong</code> or <code>QuantityDouble</code> has to have a unit defined in its <code>Default Value Literal</code>, even optional attributes that do not require a numerical value to be set. For these, too, the Ecore model must specify the unit to use.</p> </div> <div class="paragraph"> <p>In other words: If you do not want to preset an attribute with a numerical default, you can omit the numerical part, but still must provide the unit symbol as <code>Default Value Literal</code>, e.g. <code>V</code> will work as well as <code>1.0 V</code> but leaving the numeric value initially undefined.</p> </div> </td> </tr> </table> </div> <div class="paragraph"> <p>One last technicality. <strong>Before</strong> code from an Ecore model with attributes of type <code>QuantityLong</code> or <code>QuantityDouble</code> can be generated correctly, we must tell Eclipse to reuse the corresponding generator model from the City Units plug-in:</p> </div> <div class="olist arabic"> <ol class="arabic"> <li> <p>In package or project explorer find your generator model, e.g. <code>democatalog.genmodel</code> and execute <code>Reload&#8230;&#8203;</code> from its context menu</p> </li> <li> <p>Choose <code>Ecore model</code>, press <code>Next &gt;</code> and <code>Load</code> the model (again)</p> </li> <li> <p><code>Next &gt;</code> will open the page below. In section <em>Referenced Generator Models</em> select the Quantities generator model as depicted and click on <code>Finish</code>.</p> </li> </ol> </div> <div class="imageblock thumb"> <div class="content"> <img src="ParameterCatalogs2Images/ReferenceGeneratorModel.png" alt="Install Plug-in" width="500"> </div> <div class="title">Figure 23. Add Reference to Imported Generator Model</div> </div> <div class="paragraph"> <p>If no generator model is available for selection, press button <code>Add&#8230;&#8203;</code> to add it first (this only works if <code>QuantityLong</code> or <code>QuantityDouble</code> were used at least once in the Ecore model).</p> </div> </div> <div class="sect2"> <h3 id="truesummary"><a class="anchor" href="#truesummary"></a>Summary</h3> <div class="paragraph">
2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100
<p>Congratulations on making it this far. What have we achieved?</p> </div> <div class="paragraph"> <p>We get to know the <em>Eclipse Modeling Tools</em> IDE and created a graphical Ecore data model with one catalog class and five classes/types of domain objects therein. Classes have been defined by name, attributes, and relationships between them, often with cardinalities. Whenever classes shared some attributes or relationships we factored these out into super classes. An enumeration introduced a new attribute type as a set of named values.</p> </div> <div class="paragraph"> <p>From this data model, we issued commands to create Java code for representing the data in memory as well as to store and retrieve them on and from disk. Methods to create, read, update and delete data objects (CRUD) were generated, too.</p> </div> <div class="paragraph"> <p>We reflected on a good user interface for this data and used <em>EMF Forms</em> to model such an interface resulting in a full functional prototype.</p> </div> <div class="paragraph"> <p>Lastly, we enhanced Eclipse, Ecore and <em>EMF Forms</em> with two plug-ins for modeling, editing and persisting physical quantities as numerical values with defined units.</p> </div> <div style="page-break-after: always;"></div> </div> </div> </div> <div class="sect1"> <h2 id="using-parameter-catalogs"><a class="anchor" href="#using-parameter-catalogs"></a>TBD: Accessing and Using Parameter Catalogs</h2> <div class="sectionbody"> <div class="sect2"> <h3 id="trueaccessing-xml-catalogs-from-java"><a class="anchor" href="#trueaccessing-xml-catalogs-from-java"></a>Accessing XML-Catalogs from Java</h3> </div> <div class="sect2"> <h3 id="truecreate-insel-models-with-handlebars-templates"><a class="anchor" href="#truecreate-insel-models-with-handlebars-templates"></a>Create Insel Models with Handlebars Templates</h3> </div> <div class="sect2"> <h3 id="trueaccessing-xml-catalogs-from-python"><a class="anchor" href="#trueaccessing-xml-catalogs-from-python"></a>Accessing XML-Catalogs from Python</h3> <div style="page-break-after: always;"></div> </div> </div> </div> <div class="sect1"> <h2 id="truetbd-distribution-of-parameter-catalogs"><a class="anchor" href="#truetbd-distribution-of-parameter-catalogs"></a>TBD: Distribution of Parameter Catalogs</h2> <div class="sectionbody"> <div class="paragraph"> <p>Three plugins so for for the content and UI.</p> </div> <div class="paragraph"> <p>Missing: Deployable application and inclusion to third party libraries.</p> </div> <div class="paragraph"> <p>Building an application "around" the three plugins for Ecore data model and UI specification model.</p> </div> <div class="sect2"> <h3 id="truecreate-an-eclipse-application"><a class="anchor" href="#truecreate-an-eclipse-application"></a>Create an Eclipse Application</h3> </div> <div class="sect2"> <h3 id="trueuse-maven-and-tycho-as-build-system"><a class="anchor" href="#trueuse-maven-and-tycho-as-build-system"></a>Use Maven and Tycho as Build System</h3> <div class="paragraph"> <div class="title">Install Maven Support</div> <p>We are going to create a complete Eclipse desktop application from generated code. We also want to deploy this application for Linux, macOS and Windows operating systems. Eclipse offers several approaches for compiling and deploying such an application, traditionally with <em>Ant</em> scripts.</p> </div> <div class="paragraph"> <p>Creation and maintenance of these scripts turned out to be tedious and error prone. For quite some years now, the proposed&#8201;&#8212;&#8201;and mostly supported&#8201;&#8212;&#8201;method for building Eclipse applications is to use <em>Maven</em> build system, more specifically, a couple of Maven plug-ins, subsumed under the name <em>Tycho</em>.</p> </div> <div class="paragraph"> <p>Many Eclipse platforms have Maven support <a href="https://www.eclipse.org/m2e/"><em>M2Eclipse</em></a> already built in, not so our <em>Eclipse Modeling Tools</em>. But don&#8217;t worry: Installation of required Eclipse feature is easy and straight forward. And, by the way, you will acquire the indispensable skill of how to install new plug-ins/features to Eclipse.</p>
2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170
</div> <div class="paragraph"> <p>First, tell your Eclipse installation where to look for the new software. Execute <code>Help &#8594; Install new Software&#8230;&#8203;</code> to invoke dialog <em>Available Software</em> and press <code>Add&#8230;&#8203;</code>. Sub-dialog <code>Add Repository</code> pops up.</p> </div> <div class="imageblock thumb"> <div class="content"> <img src="ParameterCatalogs2Images/InstallMaven1.gif" alt="InstallMaven1"> </div> <div class="title">Figure 24. Add update site m2e</div> </div> <div class="paragraph"> <p>In there provide <code>m2e</code> as name and</p> </div> <div class="literalblock"> <div class="content"> <pre>http://download.eclipse.org/technology/m2e/releases</pre> </div> </div> <div class="paragraph"> <p>as location. After confirmation with <code>Add</code>, choose the new site to <code>Work with:</code> Eclipse now looks up the site for available software.</p> </div> <div class="imageblock thumb"> <div class="content"> <img src="ParameterCatalogs2Images/InstallMaven2.gif" alt="InstallMaven2"> </div> <div class="title">Figure 25. Choose features to install</div> </div> <div class="paragraph"> <p>Provided <code>Group items by category</code> is checked, above features are displayed. Check all features and confirm all following questions about licenses and security concerns. After download is complete&#8201;&#8212;&#8201;it can take a few minutes&#8201;&#8212;&#8201;restart Eclipse. Verify that Maven version 3.6.3 or above is now installed in <code>Window &#8594; Preferences&#8230;&#8203;</code> (or <code>Eclipse &#8594; Preferences&#8230;&#8203;</code> on macOS) under <code>Maven &#8594; Installations</code>.</p> </div> <div class="imageblock thumb"> <div class="content"> <img src="ParameterCatalogs2Images/InstallMaven3.gif" alt="InstallMaven3" width="400"> </div> <div class="title">Figure 26. Check Maven installation</div> </div> <div class="paragraph"> <div class="title">Add third party Java libraries</div> <p>"Correct" way to add third party Java libraries as plugins</p> </div> <div class="paragraph"> <p>Example Indriya</p> </div> </div> <div class="sect2"> <h3 id="truedeploy-to-p2-repository"><a class="anchor" href="#truedeploy-to-p2-repository"></a>Deploy to P2 Repository</h3> </div> <div class="sect2"> <h3 id="trueversioning-and-collaboration"><a class="anchor" href="#trueversioning-and-collaboration"></a>Versioning and Collaboration</h3> </div> </div> </div> </div> <div id="footnotes"> <hr> <div class="footnote" id="_footnotedef_1"> <a href="#_footnoteref_1">1</a>. A similar approach is in use to standardize extensions to CityGML via so called application domain extensions (ADE) like the energy ADE for exchanging energy related data. </div> <div class="footnote" id="_footnotedef_2"> <a href="#_footnoteref_2">2</a>. A comparable, but completely different approach would be to combine several web applications and services via portal software in web browsers. </div> <div class="footnote" id="_footnotedef_3"> <a href="#_footnoteref_3">3</a>. The notion of an Eclipse package has nothing to do with Java packages.
2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197
</div> <div class="footnote" id="_footnotedef_4"> <a href="#_footnoteref_4">4</a>. Projects possess one or more <em>natures</em> used to define a project&#8217;s principal type. </div> <div class="footnote" id="_footnotedef_5"> <a href="#_footnoteref_5">5</a>. Or even work on the same workspace provided in the cloud, see <a href="https://www.eclipse.org/che/technology/">Eclipse Che</a>. </div> <div class="footnote" id="_footnotedef_6"> <a href="#_footnoteref_6">6</a>. AdoptOpenJDK recently joined the Eclipse foundation and soon will change its name to <em>Adoptium</em> for legal reasons. </div> <div class="footnote" id="_footnotedef_7"> <a href="#_footnoteref_7">7</a>. <a href="https://en.wikipedia.org/wiki/Reverse_domain_name_notation" class="bare">https://en.wikipedia.org/wiki/Reverse_domain_name_notation</a> </div> <div class="footnote" id="_footnotedef_8"> <a href="#_footnoteref_8">8</a>. <a href="https://wiki.eclipse.org/Naming_Conventions#Eclipse_Workspace_Projects" class="bare">https://wiki.eclipse.org/Naming_Conventions#Eclipse_Workspace_Projects</a> </div> </div> <div id="footer"> <div id="footer-text"> Last updated 2021-04-20 12:48:52 +0200 </div> </div> <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.15.6/styles/github.min.css"> <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.15.6/highlight.min.js"></script> <script>hljs.initHighlighting()</script> </body> </html>

Dies ist die Gitlab-Instanz des Transferportals der Hochschule für Technik Stuttgart. Hier geht es zurück zum Portal