-
Notifications
You must be signed in to change notification settings - Fork 0
/
package-summary.html
238 lines (238 loc) · 7.91 KB
/
package-summary.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
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
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
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
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="ro">
<head>
<!-- Generated by javadoc (11) on Thu Nov 22 11:39:43 GMT 2018 -->
<title><Unnamed></title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2018-11-22">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="script.js"></script>
<script type="text/javascript" src="jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="jquery/jquery-3.3.1.js"></script>
<script type="text/javascript" src="jquery/jquery-migrate-3.0.1.js"></script>
<script type="text/javascript" src="jquery/jquery-ui.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="<Unnamed>";
}
}
catch(err) {
}
//-->
var pathtoroot = "./";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="deprecated-list.html">Deprecated</a></li>
<li><a href="index-files/index-1.html">Index</a></li>
<li><a href="help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_top">
<li><a href="allclasses.html">All Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<a id="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding"> </div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<main role="main">
<div class="header">
<h1 title="Package" class="title">Package <Unnamed></h1>
</div>
<div class="contentContainer">
<ul class="blockList">
<li class="blockList">
<table class="typeSummary">
<caption><span>Class Summary</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="Appliance.html" title="class in <Unnamed>">Appliance</a></th>
<td class="colLast">
<div class="block">This class works as a super class for all types of appliances</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="ApplianceFactory.html" title="class in <Unnamed>">ApplianceFactory</a></th>
<td class="colLast">
<div class="block">Used to created different types of appliances from properites hash map</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="Battery.html" title="class in <Unnamed>">Battery</a></th>
<td class="colLast">
<div class="block">A battery can hold [capacity] amount of units for later use</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="BatteryMeter.html" title="class in <Unnamed>">BatteryMeter</a></th>
<td class="colLast">
<div class="block">A meter that stores extra units in a battery</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="ConfigLoader.html" title="class in <Unnamed>">ConfigLoader</a></th>
<td class="colLast">
<div class="block">Used to load the read configuration file in the House to be simulated</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="CyclicFixed.html" title="class in <Unnamed>">CyclicFixed</a></th>
<td class="colLast">
<div class="block">An appliance switched on for a set cycle every day from hour 1 to opHours
and consumes unitsPerHr every hour.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="CyclicVaries.html" title="class in <Unnamed>">CyclicVaries</a></th>
<td class="colLast"> </td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="House.html" title="class in <Unnamed>">House</a></th>
<td class="colLast"> </td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="Main.html" title="class in <Unnamed>">Main</a></th>
<td class="colLast"> </td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="Meter.html" title="class in <Unnamed>">Meter</a></th>
<td class="colLast">
<div class="block">A meter keeps track of how many units of [utilityName] are consumed</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="Parser.html" title="class in <Unnamed>">Parser</a></th>
<td class="colLast">
<div class="block">Used to parse a config file formatted as field:value
Each appliance needs 8 lines in the config file
The properties can be in any order as long as a block of 8 lines configures the same appliance
Only needed fields are checked for errors</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="RandomFixed.html" title="class in <Unnamed>">RandomFixed</a></th>
<td class="colLast"> </td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="RandomVaries.html" title="class in <Unnamed>">RandomVaries</a></th>
<td class="colLast"> </td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="Simulator.html" title="class in <Unnamed>">Simulator</a></th>
<td class="colLast">
<div class="block">Simulates a smart house configured from the config file for a number of steps
Creates BatteryMeters, Batteries and the House objects to be used in the simulation</div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
</div>
</main>
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="deprecated-list.html">Deprecated</a></li>
<li><a href="index-files/index-1.html">Index</a></li>
<li><a href="help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="allclasses.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<a id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
</footer>
</body>
</html>