-
Notifications
You must be signed in to change notification settings - Fork 0
/
classFilament__sensor.html
245 lines (240 loc) · 17 KB
/
classFilament__sensor.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
239
240
241
242
243
244
245
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Prusa3d Marlin fork: Filament_sensor Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Prusa3d Marlin fork
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-static-methods">Static Public Member Functions</a> |
<a href="#pro-methods">Protected Member Functions</a> |
<a href="#pro-static-methods">Static Protected Member Functions</a> |
<a href="#pro-attribs">Protected Attributes</a> |
<a href="classFilament__sensor-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Filament_sensor Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include <<a class="el" href="Filament__sensor_8h_source.html">Filament_sensor.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for Filament_sensor:</div>
<div class="dyncontent">
<div class="center"><img src="classFilament__sensor__inherit__graph.png" border="0" usemap="#aFilament__sensor_inherit__map" alt="Inheritance graph"/></div>
<map name="aFilament__sensor_inherit__map" id="aFilament__sensor_inherit__map">
<area shape="rect" title=" " alt="" coords="75,5,203,32"/>
<area shape="rect" href="classIR__sensor.html" title=" " alt="" coords="31,80,116,107"/>
<area shape="rect" href="classPAT9125__sensor.html" title=" " alt="" coords="140,80,268,107"/>
<area shape="rect" href="classIR__sensor__analog.html" title=" " alt="" coords="5,155,141,181"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for Filament_sensor:</div>
<div class="dyncontent">
<div class="center"><img src="classFilament__sensor__coll__graph.png" border="0" usemap="#aFilament__sensor_coll__map" alt="Collaboration graph"/></div>
<map name="aFilament__sensor_coll__map" id="aFilament__sensor_coll__map">
<area shape="rect" title=" " alt="" coords="34,95,162,121"/>
<area shape="rect" href="classTimer.html" title=" " alt="" coords="5,5,191,32"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:aa4ad1fc64545fa6262bc9d85759e921f"><td class="memItemLeft" align="right" valign="top"><a id="aa4ad1fc64545fa6262bc9d85759e921f"></a>enum class  </td><td class="memItemRight" valign="bottom"><b>State</b> : uint8_t { <b>disabled</b> = 0
, <b>initializing</b>
, <b>ready</b>
, <b>error</b>
}</td></tr>
<tr class="separator:aa4ad1fc64545fa6262bc9d85759e921f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abe511a157d58fabe7fc6efa3f46e0178"><td class="memItemLeft" align="right" valign="top"><a id="abe511a157d58fabe7fc6efa3f46e0178"></a>enum class  </td><td class="memItemRight" valign="bottom"><b>SensorActionOnError</b> : uint8_t { <b>_Continue</b> = 0
, <b>_Pause</b> = 1
, <b>_Undef</b> = EEPROM_EMPTY_VALUE
}</td></tr>
<tr class="separator:abe511a157d58fabe7fc6efa3f46e0178"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a7de76540bba5475514a50d4ad13a2d52"><td class="memItemLeft" align="right" valign="top"><a id="a7de76540bba5475514a50d4ad13a2d52"></a>
void </td><td class="memItemRight" valign="bottom"><b>setAutoLoadEnabled</b> (bool state, bool updateEEPROM=false)</td></tr>
<tr class="separator:a7de76540bba5475514a50d4ad13a2d52"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7e65e1cc228f4cc359d6e0d281c36684"><td class="memItemLeft" align="right" valign="top"><a id="a7e65e1cc228f4cc359d6e0d281c36684"></a>
bool </td><td class="memItemRight" valign="bottom"><b>getAutoLoadEnabled</b> () const</td></tr>
<tr class="separator:a7e65e1cc228f4cc359d6e0d281c36684"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abba355756d468999587d0b8ab99a8919"><td class="memItemLeft" align="right" valign="top"><a id="abba355756d468999587d0b8ab99a8919"></a>
void </td><td class="memItemRight" valign="bottom"><b>setRunoutEnabled</b> (bool state, bool updateEEPROM=false)</td></tr>
<tr class="separator:abba355756d468999587d0b8ab99a8919"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a35c43952790525929fc964b84919c294"><td class="memItemLeft" align="right" valign="top"><a id="a35c43952790525929fc964b84919c294"></a>
bool </td><td class="memItemRight" valign="bottom"><b>getRunoutEnabled</b> () const</td></tr>
<tr class="separator:a35c43952790525929fc964b84919c294"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a07863efe3adaf81d37ba5bd83846fc95"><td class="memItemLeft" align="right" valign="top"><a id="a07863efe3adaf81d37ba5bd83846fc95"></a>
void </td><td class="memItemRight" valign="bottom"><b>setActionOnError</b> (SensorActionOnError state, bool updateEEPROM=false)</td></tr>
<tr class="separator:a07863efe3adaf81d37ba5bd83846fc95"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6638444bfba18d771a760f9e46660253"><td class="memItemLeft" align="right" valign="top"><a id="a6638444bfba18d771a760f9e46660253"></a>
SensorActionOnError </td><td class="memItemRight" valign="bottom"><b>getActionOnError</b> () const</td></tr>
<tr class="separator:a6638444bfba18d771a760f9e46660253"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a922ecd67cfed10fc95113570ed9fb708"><td class="memItemLeft" align="right" valign="top"><a id="a922ecd67cfed10fc95113570ed9fb708"></a>
bool </td><td class="memItemRight" valign="bottom"><b>getFilamentLoadEvent</b> () const</td></tr>
<tr class="separator:a922ecd67cfed10fc95113570ed9fb708"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa96a835c865726f8da66dd2f2858ab0f"><td class="memItemLeft" align="right" valign="top"><a id="aa96a835c865726f8da66dd2f2858ab0f"></a>
bool </td><td class="memItemRight" valign="bottom"><b>isError</b> () const</td></tr>
<tr class="separator:aa96a835c865726f8da66dd2f2858ab0f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae0c6234d1a99976a261bca22138102aa"><td class="memItemLeft" align="right" valign="top"><a id="ae0c6234d1a99976a261bca22138102aa"></a>
bool </td><td class="memItemRight" valign="bottom"><b>isReady</b> () const</td></tr>
<tr class="separator:ae0c6234d1a99976a261bca22138102aa"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0e4adef66f454993ad993a5413565262"><td class="memItemLeft" align="right" valign="top"><a id="a0e4adef66f454993ad993a5413565262"></a>
bool </td><td class="memItemRight" valign="bottom"><b>isEnabled</b> () const</td></tr>
<tr class="separator:a0e4adef66f454993ad993a5413565262"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:a9acacbfb8fddfff62e01be9abdf7dad6"><td class="memItemLeft" align="right" valign="top"><a id="a9acacbfb8fddfff62e01be9abdf7dad6"></a>
static void </td><td class="memItemRight" valign="bottom"><b>setEnabled</b> (bool enabled)</td></tr>
<tr class="separator:a9acacbfb8fddfff62e01be9abdf7dad6"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:abfe1c70c231a92745d384b96a0fe7d00"><td class="memItemLeft" align="right" valign="top"><a id="abfe1c70c231a92745d384b96a0fe7d00"></a>
void </td><td class="memItemRight" valign="bottom"><b>settings_init_common</b> ()</td></tr>
<tr class="separator:abfe1c70c231a92745d384b96a0fe7d00"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af269e5f8d1bcbdd543eebd36412bc432"><td class="memItemLeft" align="right" valign="top"><a id="af269e5f8d1bcbdd543eebd36412bc432"></a>
bool </td><td class="memItemRight" valign="bottom"><b>checkFilamentEvents</b> ()</td></tr>
<tr class="separator:af269e5f8d1bcbdd543eebd36412bc432"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3e841028ff5067f146188cbd5e4a34aa"><td class="memItemLeft" align="right" valign="top"><a id="a3e841028ff5067f146188cbd5e4a34aa"></a>
void </td><td class="memItemRight" valign="bottom"><b>triggerFilamentInserted</b> ()</td></tr>
<tr class="separator:a3e841028ff5067f146188cbd5e4a34aa"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aaf622f24fc76ad280c1ea5b936bdf4ea"><td class="memItemLeft" align="right" valign="top"><a id="aaf622f24fc76ad280c1ea5b936bdf4ea"></a>
void </td><td class="memItemRight" valign="bottom"><b>triggerFilamentRemoved</b> ()</td></tr>
<tr class="separator:aaf622f24fc76ad280c1ea5b936bdf4ea"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab3b06ddba74a90d66b4197c37b5553ef"><td class="memItemLeft" align="right" valign="top"><a id="ab3b06ddba74a90d66b4197c37b5553ef"></a>
void </td><td class="memItemRight" valign="bottom"><b>filRunout</b> ()</td></tr>
<tr class="separator:ab3b06ddba74a90d66b4197c37b5553ef"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa691ec8ff0268321cbe2322ab59fa695"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classFilament__sensor.html#aa691ec8ff0268321cbe2322ab59fa695">triggerError</a> ()</td></tr>
<tr class="separator:aa691ec8ff0268321cbe2322ab59fa695"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-static-methods"></a>
Static Protected Member Functions</h2></td></tr>
<tr class="memitem:a35566f2aa5a379dc08aa37a20b42173a"><td class="memItemLeft" align="right" valign="top"><a id="a35566f2aa5a379dc08aa37a20b42173a"></a>
static void </td><td class="memItemRight" valign="bottom"><b>filAutoLoad</b> ()</td></tr>
<tr class="separator:a35566f2aa5a379dc08aa37a20b42173a"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:a6d84d4b015c8c1f465c30798104b65cc"><td class="memItemLeft" align="right" valign="top"><a id="a6d84d4b015c8c1f465c30798104b65cc"></a>
State </td><td class="memItemRight" valign="bottom"><b>state</b></td></tr>
<tr class="separator:a6d84d4b015c8c1f465c30798104b65cc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af1f0289c1563911847c301c88d2bd068"><td class="memItemLeft" align="right" valign="top"><a id="af1f0289c1563911847c301c88d2bd068"></a>
bool </td><td class="memItemRight" valign="bottom"><b>autoLoadEnabled</b></td></tr>
<tr class="separator:af1f0289c1563911847c301c88d2bd068"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a72807dead9b548f414e1ced85d04d450"><td class="memItemLeft" align="right" valign="top"><a id="a72807dead9b548f414e1ced85d04d450"></a>
bool </td><td class="memItemRight" valign="bottom"><b>runoutEnabled</b></td></tr>
<tr class="separator:a72807dead9b548f414e1ced85d04d450"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6b8d4d8f847a1b632722193c089ce4f4"><td class="memItemLeft" align="right" valign="top"><a id="a6b8d4d8f847a1b632722193c089ce4f4"></a>
bool </td><td class="memItemRight" valign="bottom"><b>oldFilamentPresent</b></td></tr>
<tr class="separator:a6b8d4d8f847a1b632722193c089ce4f4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aae233abe129813331cf4d2cd57aea586"><td class="memItemLeft" align="right" valign="top"><a id="aae233abe129813331cf4d2cd57aea586"></a>
bool </td><td class="memItemRight" valign="bottom"><b>postponedLoadEvent</b></td></tr>
<tr class="separator:aae233abe129813331cf4d2cd57aea586"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac4e20e3ec69be55094623501bae9bcc9"><td class="memItemLeft" align="right" valign="top"><a id="ac4e20e3ec69be55094623501bae9bcc9"></a>
<a class="el" href="Timer_8h.html#a41ba10bd5180e91fa2248d0d56166621">ShortTimer</a> </td><td class="memItemRight" valign="bottom"><b>eventBlankingTimer</b></td></tr>
<tr class="separator:ac4e20e3ec69be55094623501bae9bcc9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abe364c6395ddcd1b74fe583bc1037b51"><td class="memItemLeft" align="right" valign="top"><a id="abe364c6395ddcd1b74fe583bc1037b51"></a>
SensorActionOnError </td><td class="memItemRight" valign="bottom"><b>sensorActionOnError</b></td></tr>
<tr class="separator:abe364c6395ddcd1b74fe583bc1037b51"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Base class Filament sensor</p>
<p>Ideally, there could have been a nice class hierarchy of filament sensor types with common functionality extracted into this base class. But:</p><ul>
<li>virtual methods take more space</li>
<li>we don't need to switch among different filament sensors at runtime Therefore the class hierarchy carefully avoids using virtual methods and doesn't look too fancy. </li>
</ul>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="aa691ec8ff0268321cbe2322ab59fa695"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa691ec8ff0268321cbe2322ab59fa695">◆ </a></span>triggerError()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void Filament_sensor::triggerError </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>some message, idk</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="Filament__sensor_8h_source.html">Filament_sensor.h</a></li>
<li>Filament_sensor.cpp</li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
</small></address>
</body>
</html>