From 5d7407aded9c6dace130a510f5e785318c0f0006 Mon Sep 17 00:00:00 2001 From: Tristan Krause Date: Wed, 22 May 2019 10:32:51 +0200 Subject: [PATCH] doc update --- control/examples/pegel/main.cpp | 8 +- control/src/drv/b15f.h | 13 +- docs/README.md | 3 + docs/doxygen-cfg | 6 +- docs/html/b15f_8cpp_source.html | 5 +- docs/html/b15f_8h_source.html | 5 +- docs/html/classB15F-members.html | 23 +- docs/html/classB15F.html | 33 +- docs/html/functions.html | 7 - docs/html/functions_func.html | 7 - docs/html/index.html | 9 +- docs/html/menudata.js | 2 - docs/html/search/all_4.js | 3 +- docs/html/search/all_7.js | 2 +- docs/html/search/all_8.js | 3 +- docs/html/search/all_9.js | 6 +- docs/html/search/all_a.js | 7 +- docs/html/search/all_b.js | 6 +- docs/html/search/all_c.js | 5 +- docs/html/search/all_d.js | 7 +- docs/html/search/all_e.js | 7 +- docs/html/search/functions_6.js | 2 +- docs/html/search/functions_7.js | 2 +- docs/html/search/functions_8.js | 5 +- docs/html/search/functions_9.js | 7 +- docs/html/search/functions_a.js | 5 +- docs/html/search/functions_b.js | 4 +- docs/html/search/pages_0.html | 30 ++ docs/html/search/pages_0.js | 4 + docs/html/search/searchdata.js | 11 +- docs/index.html | 15 + docs/latex/Makefile | 23 -- docs/latex/annotated.tex | 15 - docs/latex/classB15F.tex | 501 ----------------------- docs/latex/classDot.tex | 30 -- docs/latex/classDriverException.eps | 197 --------- docs/latex/classDriverException.tex | 38 -- docs/latex/classPlottyFile.tex | 102 ----- docs/latex/classTimeoutException.eps | 197 --------- docs/latex/classTimeoutException.tex | 41 -- docs/latex/classUSART.tex | 273 ------------- docs/latex/classUSARTException.eps | 197 --------- docs/latex/classUSARTException.tex | 38 -- docs/latex/classView.eps | 213 ---------- docs/latex/classView.tex | 78 ---- docs/latex/classViewInfo.eps | 203 ---------- docs/latex/classViewInfo.tex | 64 --- docs/latex/classViewMonitor.eps | 203 ---------- docs/latex/classViewMonitor.tex | 43 -- docs/latex/classViewPromt.eps | 197 --------- docs/latex/classViewPromt.tex | 85 ---- docs/latex/classViewSelection.eps | 197 --------- docs/latex/classViewSelection.tex | 52 --- docs/latex/doxygen.sty | 571 --------------------------- docs/latex/hierarchy.tex | 21 - docs/latex/refman.tex | 189 --------- 56 files changed, 131 insertions(+), 3889 deletions(-) create mode 100644 docs/README.md create mode 100644 docs/html/search/pages_0.html create mode 100644 docs/html/search/pages_0.js create mode 100644 docs/index.html delete mode 100644 docs/latex/Makefile delete mode 100644 docs/latex/annotated.tex delete mode 100644 docs/latex/classB15F.tex delete mode 100644 docs/latex/classDot.tex delete mode 100644 docs/latex/classDriverException.eps delete mode 100644 docs/latex/classDriverException.tex delete mode 100644 docs/latex/classPlottyFile.tex delete mode 100644 docs/latex/classTimeoutException.eps delete mode 100644 docs/latex/classTimeoutException.tex delete mode 100644 docs/latex/classUSART.tex delete mode 100644 docs/latex/classUSARTException.eps delete mode 100644 docs/latex/classUSARTException.tex delete mode 100644 docs/latex/classView.eps delete mode 100644 docs/latex/classView.tex delete mode 100644 docs/latex/classViewInfo.eps delete mode 100644 docs/latex/classViewInfo.tex delete mode 100644 docs/latex/classViewMonitor.eps delete mode 100644 docs/latex/classViewMonitor.tex delete mode 100644 docs/latex/classViewPromt.eps delete mode 100644 docs/latex/classViewPromt.tex delete mode 100644 docs/latex/classViewSelection.eps delete mode 100644 docs/latex/classViewSelection.tex delete mode 100644 docs/latex/doxygen.sty delete mode 100644 docs/latex/hierarchy.tex delete mode 100644 docs/latex/refman.tex diff --git a/control/examples/pegel/main.cpp b/control/examples/pegel/main.cpp index 960b8ad..2487217 100644 --- a/control/examples/pegel/main.cpp +++ b/control/examples/pegel/main.cpp @@ -11,7 +11,7 @@ int main() B15F& drv = B15F::getInstance(); PlottyFile pf; - uint16_t ba[1024]; + uint16_t buf[1024]; const uint16_t sample_count = 1024; const uint16_t delta = 1; @@ -30,12 +30,12 @@ int main() uint8_t curve = 0; - drv.analogSequence(0, &ba[0], 0, 1, nullptr, 0, 0, delta, sample_count); + drv.analogSequence(0, &buf[0], 0, 1, nullptr, 0, 0, delta, sample_count); for(uint16_t x = 0; x < sample_count * delta; x += delta) { - std::cout << x << " - " << ba[x] << std::endl; - pf.addDot(Dot(x, ba[x], curve)); + std::cout << x << " - " << buf[x] << std::endl; + pf.addDot(Dot(x, buf[x], curve)); } // speichern und plotty starten diff --git a/control/src/drv/b15f.h b/control/src/drv/b15f.h index d183644..dc06e43 100644 --- a/control/src/drv/b15f.h +++ b/control/src/drv/b15f.h @@ -32,12 +32,6 @@ public: * Grundfunktionen des B15F Treibers * *************************************/ - /** - * Initialisiert und testet die Verbindung zum B15 - * \throws DriverException - */ - void init(void); - /** * Versucht die Verbindung zum B15 wiederherzustellen * \throws DriverException @@ -182,7 +176,6 @@ public: uint16_t analogRead(uint8_t channel); /** - * \brief Komplexe Analoge Sequenz * DAC 0 wird auf den Startwert gesetzt und dann schrittweise um Delta inkrementiert. * Für jeden eingestelleten DAC-Wert werden zwei ADCs (channel_a und channel_b) angesprochen und die Werte übermittelt. * Die Werte werden in buffer_a für Kanal a und buffer_b für Kanal b gespeichert. @@ -212,6 +205,12 @@ public: constexpr static uint32_t BAUDRATE = 57600; private: + + /** + * Initialisiert und testet die Verbindung zum B15 + * \throws DriverException + */ + void init(void); USART usart; static B15F* instance; diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 0000000..99a8a8d --- /dev/null +++ b/docs/README.md @@ -0,0 +1,3 @@ +# Einführung +Die wichtigste Klasse für die Steuerung des Board 15 ist [B15F](classB15F.html). +Dort befindet sich auch eine Übersicht der verfügbaren Befehle. diff --git a/docs/doxygen-cfg b/docs/doxygen-cfg index edfca4d..629c77c 100644 --- a/docs/doxygen-cfg +++ b/docs/doxygen-cfg @@ -827,7 +827,7 @@ WARN_LOGFILE = # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING # Note: If this tag is empty the current directory is searched. -INPUT = "../control/src" +INPUT = ../control/src README.md # This tag can be used to specify the character encoding of the source files # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses @@ -1020,7 +1020,7 @@ FILTER_SOURCE_PATTERNS = # (index.html). This can be useful if you have a project on for instance GitHub # and want to reuse the introduction page also for the doxygen output. -USE_MDFILE_AS_MAINPAGE = +USE_MDFILE_AS_MAINPAGE = README.md #--------------------------------------------------------------------------- # Configuration options related to source browsing @@ -1696,7 +1696,7 @@ EXTRA_SEARCH_MAPPINGS = # If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output. # The default value is: YES. -GENERATE_LATEX = YES +GENERATE_LATEX = NO # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of diff --git a/docs/html/b15f_8cpp_source.html b/docs/html/b15f_8cpp_source.html index f7fbaa7..bf5bcd1 100644 --- a/docs/html/b15f_8cpp_source.html +++ b/docs/html/b15f_8cpp_source.html @@ -70,12 +70,12 @@ $(function() {
b15f.cpp
-
1 #include "b15f.h"
2 
3 B15F* B15F::instance = nullptr;
4 errorhandler_t B15F::errorhandler = nullptr;
5 
6 B15F::B15F()
7 {
8  init();
9 }
10 
11 void B15F::init()
12 {
13 
14  std::string device = exec("bash -c 'ls /dev/ttyUSB*'");
15  while(device.find(' ') != std::string::npos || device.find('\n') != std::string::npos || device.find('\t') != std::string::npos)
16  device.pop_back();
17 
18  if(device.length() == 0)
19  abort("Adapter nicht gefunden");
20 
21  std::cout << PRE << "Verwende Adapter: " << device << std::endl;
22 
23 
24 
25  std::cout << PRE << "Stelle Verbindung mit Adapter her... " << std::flush;
26  usart.setBaudrate(BAUDRATE);
27  usart.openDevice(device);
28  std::cout << "OK" << std::endl;
29 
30 
31 
32  std::cout << PRE << "Teste Verbindung... " << std::flush;
33  uint8_t tries = 3;
34  while(tries--)
35  {
36  // verwerfe Daten, die µC noch hat
37  //discard();
38 
39  if(!testConnection())
40  continue;
41 
42  if(!testIntConv())
43  continue;
44 
45  break;
46  }
47  if(tries == 0)
48  abort("Verbindungstest fehlgeschlagen. Neueste Version im Einsatz?");
49  std::cout << "OK" << std::endl;
50 
51 
52  // Gib board info aus
53  std::vector<std::string> info = getBoardInfo();
54  std::cout << PRE << "AVR Firmware Version: " << info[0] << " um " << info[1] << " Uhr (" << info[2] << ")" << std::endl;
55 }
56 
57 void B15F::reconnect()
58 {
59  uint8_t tries = RECONNECT_TRIES;
60  while(tries--)
61  {
62  delay_ms(RECONNECT_TIMEOUT);
63  discard();
64 
65  if(testConnection())
66  return;
67  }
68 
69  abort("Verbindung kann nicht repariert werden");
70 }
71 
72 void B15F::discard(void)
73 {
74  try
75  {
76  usart.clearOutputBuffer();
77  for(uint8_t i = 0; i < 16; i++)
78  {
79  usart.writeByte(RQ_DISC); // sende discard Befehl (verwerfe input)
80  delay_ms(4);
81  }
82  usart.clearInputBuffer();
83  }
84  catch(std::exception& ex)
85  {
86  abort(ex);
87  }
88 }
89 
90 bool B15F::testConnection()
91 {
92  // erzeuge zufälliges Byte
93  srand(time(NULL));
94  uint8_t dummy = rand() % 256;
95 
96  usart.writeByte(RQ_TEST);
97  usart.writeByte(dummy);
98 
99  uint8_t aw = usart.readByte();
100  uint8_t mirror = usart.readByte();
101 
102  return aw == MSG_OK && mirror == dummy;
103 }
104 
105 bool B15F::testIntConv()
106 {
107  srand(time(NULL));
108  uint16_t dummy = rand() % (0xFFFF / 3);
109 
110  usart.writeByte(RQ_INT);
111  usart.writeInt(dummy);
112 
113  uint16_t aw = usart.readInt();
114  return aw == dummy * 3;
115 }
116 
117 
118 std::vector<std::string> B15F::getBoardInfo(void)
119 {
120  std::vector<std::string> info;
121 
122  usart.writeByte(RQ_INFO);
123 
124  uint8_t n = usart.readByte();
125  while(n--)
126  {
127  uint8_t len = usart.readByte();
128  std::string str;
129 
130  while(len--) {
131  str += static_cast<char>(usart.readByte());
132  }
133 
134  info.push_back(str);
135  }
136 
137  uint8_t aw = usart.readByte();
138  if(aw != MSG_OK)
139  abort("Board Info fehlerhalft: code " + std::to_string((int) aw));
140 
141  return info;
142 }
143 
144 bool B15F::activateSelfTestMode()
145 {
146  usart.writeByte(RQ_ST);
147 
148  uint8_t aw = usart.readByte();
149  return aw == MSG_OK;
150 }
151 
152 bool B15F::digitalWrite0(uint8_t port)
153 {
154  usart.writeByte(RQ_BA0);
155  usart.writeByte(port);
156 
157  uint8_t aw = usart.readByte();
158  delay_us(10);
159  return aw == MSG_OK;
160 }
161 
162 bool B15F::digitalWrite1(uint8_t port)
163 {
164  usart.writeByte(RQ_BA1);
165  usart.writeByte(port);
166 
167  uint8_t aw = usart.readByte();
168  delay_us(10);
169  return aw == MSG_OK;
170 }
171 
172 uint8_t B15F::digitalRead0()
173 {
174  usart.clearInputBuffer();
175  usart.writeByte(RQ_BE0);
176  uint8_t byte = usart.readByte();
177  delay_us(10);
178  return byte;
179 }
180 
181 uint8_t B15F::digitalRead1()
182 {
183  usart.clearInputBuffer();
184  usart.writeByte(RQ_BE1);
185  uint8_t byte = usart.readByte();
186  delay_us(10);
187  return byte;
188 }
189 
190 uint8_t B15F::readDipSwitch()
191 {
192  usart.clearInputBuffer();
193  usart.writeByte(RQ_DSW);
194  uint8_t byte = usart.readByte();
195  delay_us(10);
196  return byte;
197 }
198 
199 bool B15F::analogWrite0(uint16_t value)
200 {
201  usart.writeByte(RQ_AA0);
202  usart.writeInt(value);
203 
204  uint8_t aw = usart.readByte();
205  delay_us(10);
206  return aw == MSG_OK;
207 }
208 
209 bool B15F::analogWrite1(uint16_t value)
210 {
211  usart.writeByte(RQ_AA1);
212  usart.writeInt(value);
213 
214  uint8_t aw = usart.readByte();
215  delay_us(10);
216  return aw == MSG_OK;
217 }
218 
219 uint16_t B15F::analogRead(uint8_t channel)
220 {
221  usart.clearInputBuffer();
222  if(channel > 7)
223  abort("Bad ADC channel: " + std::to_string(channel));
224 
225  uint8_t rq[] = {
226  RQ_ADC,
227  channel
228  };
229 
230  int n_sent = usart.write_timeout(&rq[0], 0, sizeof(rq), 1000);
231  if(n_sent != sizeof(rq))
232  abort("Sent failed");
233 
234  uint16_t adc = usart.readInt();
235 
236  if(adc > 1023)
237  abort("Bad ADC data detected (1)");
238  return adc;
239 }
240 
241 void B15F::analogSequence(uint8_t channel_a, uint16_t* buffer_a, uint32_t offset_a, uint8_t channel_b, uint16_t* buffer_b, uint32_t offset_b, uint16_t start, int16_t delta, uint16_t count)
242 {
243  // check pointers
244  buffer_a += offset_a;
245  buffer_b += offset_b;
246 
247 
248  usart.clearInputBuffer();
249  usart.writeByte(RQ_ADC_DAC_STROKE);
250  usart.writeByte(channel_a);
251  usart.writeByte(channel_b);
252  usart.writeInt(start);
253  usart.writeInt(static_cast<uint16_t>(delta));
254  usart.writeInt(count);
255 
256  for(uint16_t i = 0; i < count; i++)
257  {
258  if(buffer_a)
259  {
260  buffer_a[i] = usart.readInt();
261 
262  if(buffer_a[i] > 1023) // check for broken usart connection
263  abort("Bad ADC data detected (2)");
264  }
265  else
266  {
267  usart.readInt();
268  }
269 
270  if(buffer_b)
271  {
272  buffer_b[i] = usart.readInt();
273 
274  if(buffer_b[i] > 1023) // check for broken usart connection
275  abort("Bad ADC data detected (3)");
276  }
277  else
278  {
279  usart.readInt();
280  }
281  }
282 
283  uint8_t aw = usart.readByte();
284  if(aw != MSG_OK)
285  abort("Sequenz unterbrochen");
286 
287  delay_us(10);
288 }
289 
290 void B15F::delay_ms(uint16_t ms)
291 {
292  std::this_thread::sleep_for(std::chrono::milliseconds(ms));
293 }
294 
295 void B15F::delay_us(uint16_t us)
296 {
297  std::this_thread::sleep_for(std::chrono::microseconds(us));
298 }
299 
300 B15F& B15F::getInstance(void)
301 {
302  if(!instance)
303  instance = new B15F();
304 
305  return *instance;
306 }
307 
308 // https://stackoverflow.com/a/478960
309 std::string B15F::exec(std::string cmd) {
310  std::array<char, 128> buffer;
311  std::string result;
312  std::unique_ptr<FILE, decltype(&pclose)> pipe(popen(cmd.c_str(), "r"), pclose);
313  if (!pipe) {
314  throw std::runtime_error("popen() failed!");
315  }
316  while (fgets(buffer.data(), buffer.size(), pipe.get()) != nullptr) {
317  result += buffer.data();
318  }
319  return result;
320 }
321 
322 void B15F::abort(std::string msg)
323 {
324  DriverException ex(msg);
325  abort(ex);
326 }
327 void B15F::abort(std::exception& ex)
328 {
329  if(errorhandler)
330  errorhandler(ex);
331  else
332  {
333  std::cerr << "NOTICE: B15F::errorhandler not set" << std::endl;
334  std::cout << ex.what() << std::endl;
335  throw DriverException(ex.what());
336  }
337 }
338 
339 void B15F::setAbortHandler(errorhandler_t func)
340 {
341  errorhandler = func;
342 }
+
1 #include "b15f.h"
2 
3 B15F* B15F::instance = nullptr;
4 errorhandler_t B15F::errorhandler = nullptr;
5 
6 B15F::B15F()
7 {
8  init();
9 }
10 
11 void B15F::init()
12 {
13 
14  std::string device = exec("bash -c 'ls /dev/ttyUSB*'");
15  while(device.find(' ') != std::string::npos || device.find('\n') != std::string::npos || device.find('\t') != std::string::npos)
16  device.pop_back();
17 
18  if(device.length() == 0)
19  abort("Adapter nicht gefunden");
20 
21  std::cout << PRE << "Verwende Adapter: " << device << std::endl;
22 
23 
24 
25  std::cout << PRE << "Stelle Verbindung mit Adapter her... " << std::flush;
26  usart.setBaudrate(BAUDRATE);
27  usart.openDevice(device);
28  std::cout << "OK" << std::endl;
29 
30 
31 
32  std::cout << PRE << "Teste Verbindung... " << std::flush;
33  uint8_t tries = 3;
34  while(tries--)
35  {
36  // verwerfe Daten, die µC noch hat
37  //discard();
38 
39  if(!testConnection())
40  continue;
41 
42  if(!testIntConv())
43  continue;
44 
45  break;
46  }
47  if(tries == 0)
48  abort("Verbindungstest fehlgeschlagen. Neueste Version im Einsatz?");
49  std::cout << "OK" << std::endl;
50 
51 
52  // Gib board info aus
53  std::vector<std::string> info = getBoardInfo();
54  std::cout << PRE << "AVR Firmware Version: " << info[0] << " um " << info[1] << " Uhr (" << info[2] << ")" << std::endl;
55 }
56 
57 void B15F::reconnect()
58 {
59  uint8_t tries = RECONNECT_TRIES;
60  while(tries--)
61  {
62  delay_ms(RECONNECT_TIMEOUT);
63  discard();
64 
65  if(testConnection())
66  return;
67  }
68 
69  abort("Verbindung kann nicht repariert werden");
70 }
71 
72 void B15F::discard(void)
73 {
74  try
75  {
76  usart.clearOutputBuffer();
77  for(uint8_t i = 0; i < 16; i++)
78  {
79  usart.writeByte(RQ_DISC); // sende discard Befehl (verwerfe input)
80  delay_ms(4);
81  }
82  usart.clearInputBuffer();
83  }
84  catch(std::exception& ex)
85  {
86  abort(ex);
87  }
88 }
89 
90 bool B15F::testConnection()
91 {
92  // erzeuge zufälliges Byte
93  srand(time(NULL));
94  uint8_t dummy = rand() % 256;
95 
96  usart.writeByte(RQ_TEST);
97  usart.writeByte(dummy);
98 
99  uint8_t aw = usart.readByte();
100  uint8_t mirror = usart.readByte();
101 
102  return aw == MSG_OK && mirror == dummy;
103 }
104 
105 bool B15F::testIntConv()
106 {
107  srand(time(NULL));
108  uint16_t dummy = rand() % (0xFFFF / 3);
109 
110  usart.writeByte(RQ_INT);
111  usart.writeInt(dummy);
112 
113  uint16_t aw = usart.readInt();
114  return aw == dummy * 3;
115 }
116 
117 
118 std::vector<std::string> B15F::getBoardInfo(void)
119 {
120  std::vector<std::string> info;
121 
122  usart.writeByte(RQ_INFO);
123 
124  uint8_t n = usart.readByte();
125  while(n--)
126  {
127  uint8_t len = usart.readByte();
128  std::string str;
129 
130  while(len--) {
131  str += static_cast<char>(usart.readByte());
132  }
133 
134  info.push_back(str);
135  }
136 
137  uint8_t aw = usart.readByte();
138  if(aw != MSG_OK)
139  abort("Board Info fehlerhalft: code " + std::to_string((int) aw));
140 
141  return info;
142 }
143 
144 bool B15F::activateSelfTestMode()
145 {
146  usart.writeByte(RQ_ST);
147 
148  uint8_t aw = usart.readByte();
149  return aw == MSG_OK;
150 }
151 
152 bool B15F::digitalWrite0(uint8_t port)
153 {
154  usart.writeByte(RQ_BA0);
155  usart.writeByte(port);
156 
157  uint8_t aw = usart.readByte();
158  delay_us(10);
159  return aw == MSG_OK;
160 }
161 
162 bool B15F::digitalWrite1(uint8_t port)
163 {
164  usart.writeByte(RQ_BA1);
165  usart.writeByte(port);
166 
167  uint8_t aw = usart.readByte();
168  delay_us(10);
169  return aw == MSG_OK;
170 }
171 
172 uint8_t B15F::digitalRead0()
173 {
174  usart.clearInputBuffer();
175  usart.writeByte(RQ_BE0);
176  uint8_t byte = usart.readByte();
177  delay_us(10);
178  return byte;
179 }
180 
181 uint8_t B15F::digitalRead1()
182 {
183  usart.clearInputBuffer();
184  usart.writeByte(RQ_BE1);
185  uint8_t byte = usart.readByte();
186  delay_us(10);
187  return byte;
188 }
189 
190 uint8_t B15F::readDipSwitch()
191 {
192  usart.clearInputBuffer();
193  usart.writeByte(RQ_DSW);
194  uint8_t byte = usart.readByte();
195  delay_us(10);
196  return byte;
197 }
198 
199 bool B15F::analogWrite0(uint16_t value)
200 {
201  usart.writeByte(RQ_AA0);
202  usart.writeInt(value);
203 
204  uint8_t aw = usart.readByte();
205  delay_us(10);
206  return aw == MSG_OK;
207 }
208 
209 bool B15F::analogWrite1(uint16_t value)
210 {
211  usart.writeByte(RQ_AA1);
212  usart.writeInt(value);
213 
214  uint8_t aw = usart.readByte();
215  delay_us(10);
216  return aw == MSG_OK;
217 }
218 
219 uint16_t B15F::analogRead(uint8_t channel)
220 {
221  usart.clearInputBuffer();
222  if(channel > 7)
223  abort("Bad ADC channel: " + std::to_string(channel));
224 
225  uint8_t rq[] = {
226  RQ_ADC,
227  channel
228  };
229 
230  int n_sent = usart.write_timeout(&rq[0], 0, sizeof(rq), 1000);
231  if(n_sent != sizeof(rq))
232  abort("Sent failed");
233 
234  uint16_t adc = usart.readInt();
235 
236  if(adc > 1023)
237  abort("Bad ADC data detected (1)");
238  return adc;
239 }
240 
241 void B15F::analogSequence(uint8_t channel_a, uint16_t* buffer_a, uint32_t offset_a, uint8_t channel_b, uint16_t* buffer_b, uint32_t offset_b, uint16_t start, int16_t delta, uint16_t count)
242 {
243  // check pointers
244  buffer_a += offset_a;
245  buffer_b += offset_b;
246 
247 
248  usart.clearInputBuffer();
249  usart.writeByte(RQ_ADC_DAC_STROKE);
250  usart.writeByte(channel_a);
251  usart.writeByte(channel_b);
252  usart.writeInt(start);
253  usart.writeInt(static_cast<uint16_t>(delta));
254  usart.writeInt(count);
255 
256  for(uint16_t i = 0; i < count; i++)
257  {
258  if(buffer_a)
259  {
260  buffer_a[i] = usart.readInt();
261 
262  if(buffer_a[i] > 1023) // check for broken usart connection
263  abort("Bad ADC data detected (2)");
264  }
265  else
266  {
267  usart.readInt();
268  }
269 
270  if(buffer_b)
271  {
272  buffer_b[i] = usart.readInt();
273 
274  if(buffer_b[i] > 1023) // check for broken usart connection
275  abort("Bad ADC data detected (3)");
276  }
277  else
278  {
279  usart.readInt();
280  }
281  }
282 
283  uint8_t aw = usart.readByte();
284  if(aw != MSG_OK)
285  abort("Sequenz unterbrochen");
286 
287  delay_us(10);
288 }
289 
290 void B15F::delay_ms(uint16_t ms)
291 {
292  std::this_thread::sleep_for(std::chrono::milliseconds(ms));
293 }
294 
295 void B15F::delay_us(uint16_t us)
296 {
297  std::this_thread::sleep_for(std::chrono::microseconds(us));
298 }
299 
300 B15F& B15F::getInstance(void)
301 {
302  if(!instance)
303  instance = new B15F();
304 
305  return *instance;
306 }
307 
308 // https://stackoverflow.com/a/478960
309 std::string B15F::exec(std::string cmd) {
310  std::array<char, 128> buffer;
311  std::string result;
312  std::unique_ptr<FILE, decltype(&pclose)> pipe(popen(cmd.c_str(), "r"), pclose);
313  if (!pipe) {
314  throw std::runtime_error("popen() failed!");
315  }
316  while (fgets(buffer.data(), buffer.size(), pipe.get()) != nullptr) {
317  result += buffer.data();
318  }
319  return result;
320 }
321 
322 void B15F::abort(std::string msg)
323 {
324  DriverException ex(msg);
325  abort(ex);
326 }
327 void B15F::abort(std::exception& ex)
328 {
329  if(errorhandler)
330  errorhandler(ex);
331  else
332  {
333  std::cerr << "NOTICE: B15F::errorhandler not set" << std::endl;
334  std::cout << ex.what() << std::endl;
335  throw DriverException(ex.what());
336  }
337 }
338 
339 void B15F::setAbortHandler(errorhandler_t func)
340 {
341  errorhandler = func;
342 }
B15F::exec
static std::string exec(std::string cmd)
Definition: b15f.cpp:309
USART::readByte
uint8_t readByte(void)
Definition: usart.cpp:210
B15F::delay_us
void delay_us(uint16_t us)
Definition: b15f.cpp:295
B15F::digitalRead0
uint8_t digitalRead0(void)
Definition: b15f.cpp:172
-
B15F::analogSequence
void analogSequence(uint8_t channel_a, uint16_t *buffer_a, uint32_t offset_a, uint8_t channel_b, uint16_t *buffer_b, uint32_t offset_b, uint16_t start, int16_t delta, uint16_t count)
Komplexe Analoge Sequenz DAC 0 wird auf den Startwert gesetzt und dann schrittweise um Delta inkremen...
Definition: b15f.cpp:241
+
B15F::analogSequence
void analogSequence(uint8_t channel_a, uint16_t *buffer_a, uint32_t offset_a, uint8_t channel_b, uint16_t *buffer_b, uint32_t offset_b, uint16_t start, int16_t delta, uint16_t count)
Definition: b15f.cpp:241
B15F::testConnection
bool testConnection(void)
Definition: b15f.cpp:90
B15F::readDipSwitch
uint8_t readDipSwitch(void)
Definition: b15f.cpp:190
B15F::delay_ms
void delay_ms(uint16_t ms)
Definition: b15f.cpp:290
@@ -92,7 +92,6 @@ $(function() {
B15F::getBoardInfo
std::vector< std::string > getBoardInfo(void)
Definition: b15f.cpp:118
USART::writeByte
void writeByte(uint8_t b)
Definition: usart.cpp:67
B15F::digitalWrite1
bool digitalWrite1(uint8_t)
Definition: b15f.cpp:162
-
B15F::init
void init(void)
Definition: b15f.cpp:11
B15F::discard
void discard(void)
Definition: b15f.cpp:72
B15F::analogWrite0
bool analogWrite0(uint16_t)
Definition: b15f.cpp:199
USART::openDevice
void openDevice(std::string device)
Definition: usart.cpp:3
diff --git a/docs/html/b15f_8h_source.html b/docs/html/b15f_8h_source.html index 33242e7..4dffe52 100644 --- a/docs/html/b15f_8h_source.html +++ b/docs/html/b15f_8h_source.html @@ -70,11 +70,11 @@ $(function() {
b15f.h
-
1 #ifndef B15F_H
2 #define B15F_H
3 
4 #include <iostream>
5 #include <bits/stdc++.h>
6 #include <string>
7 #include <fstream>
8 #include <cstdlib>
9 #include <chrono>
10 #include <cstdint>
11 #include <vector>
12 
13 #include <unistd.h>
14 #include <fcntl.h>
15 #include <sys/ioctl.h>
16 #include <termios.h>
17 #include "usart.h"
18 #include "driverexception.h"
19 #include "timeoutexception.h"
20 
21 typedef std::function<void(std::exception&)> errorhandler_t;
22 
23 
24 class B15F
25 {
26 private:
27  // privater Konstruktor
28  B15F(void);
29 public:
30 
31  /*************************************
32  * Grundfunktionen des B15F Treibers *
33  *************************************/
34 
39  void init(void);
40 
45  void reconnect(void);
46 
51  void discard(void);
52 
57  bool testConnection(void);
58 
63  bool testIntConv(void);
64 
69  std::vector<std::string> getBoardInfo(void);
70 
75  void delay_ms(uint16_t ms);
76 
81  void delay_us(uint16_t us);
82 
87  static B15F& getInstance(void);
88 
93  static std::string exec(std::string cmd);
94 
99  static void abort(std::string msg);
100 
105  static void abort(std::exception& ex);
106 
111  static void setAbortHandler(errorhandler_t func);
112 
113  /*************************************/
114 
115 
116 
117  /*************************
118  * Steuerbefehle für B15 *
119  *************************/
120 
126  bool activateSelfTestMode(void);
127 
133  bool digitalWrite0(uint8_t);
134 
140  bool digitalWrite1(uint8_t);
141 
147  uint8_t digitalRead0(void);
148 
154  uint8_t digitalRead1(void);
155 
161  uint8_t readDipSwitch(void);
162 
168  bool analogWrite0(uint16_t);
169 
175  bool analogWrite1(uint16_t);
176 
182  uint16_t analogRead(uint8_t channel);
183 
200  void analogSequence(uint8_t channel_a, uint16_t* buffer_a, uint32_t offset_a, uint8_t channel_b, uint16_t* buffer_b, uint32_t offset_b, uint16_t start, int16_t delta, uint16_t count);
201 
202  /*************************/
203 
204 
205  // CONSTANTS
206  const std::string PRE = "[B15F] ";
207  constexpr static uint8_t MSG_OK = 0xFF;
208  constexpr static uint8_t MSG_FAIL = 0xFE;
209  constexpr static uint16_t RECONNECT_TIMEOUT = 64; // ms
210  constexpr static uint16_t WDT_TIMEOUT = 15; // ms
211  constexpr static uint8_t RECONNECT_TRIES = 3;
212  constexpr static uint32_t BAUDRATE = 57600;
213 
214 private:
215 
216  USART usart;
217  static B15F* instance;
218  static errorhandler_t errorhandler;
219 
220  // REQUESTS
221  constexpr static uint8_t RQ_DISC = 0;
222  constexpr static uint8_t RQ_TEST = 1;
223  constexpr static uint8_t RQ_INFO = 2;
224  constexpr static uint8_t RQ_INT = 3;
225  constexpr static uint8_t RQ_ST = 4;
226  constexpr static uint8_t RQ_BA0 = 5;
227  constexpr static uint8_t RQ_BA1 = 6;
228  constexpr static uint8_t RQ_BE0 = 7;
229  constexpr static uint8_t RQ_BE1 = 8;
230  constexpr static uint8_t RQ_DSW = 9;
231  constexpr static uint8_t RQ_AA0 = 10;
232  constexpr static uint8_t RQ_AA1 = 11;
233  constexpr static uint8_t RQ_ADC = 12;
234  constexpr static uint8_t RQ_ADC_DAC_STROKE = 13;
235 };
236 
237 #endif // B15F_H
+
1 #ifndef B15F_H
2 #define B15F_H
3 
4 #include <iostream>
5 #include <bits/stdc++.h>
6 #include <string>
7 #include <fstream>
8 #include <cstdlib>
9 #include <chrono>
10 #include <cstdint>
11 #include <vector>
12 
13 #include <unistd.h>
14 #include <fcntl.h>
15 #include <sys/ioctl.h>
16 #include <termios.h>
17 #include "usart.h"
18 #include "driverexception.h"
19 #include "timeoutexception.h"
20 
21 typedef std::function<void(std::exception&)> errorhandler_t;
22 
23 
24 class B15F
25 {
26 private:
27  // privater Konstruktor
28  B15F(void);
29 public:
30 
31  /*************************************
32  * Grundfunktionen des B15F Treibers *
33  *************************************/
34 
39  void reconnect(void);
40 
45  void discard(void);
46 
51  bool testConnection(void);
52 
57  bool testIntConv(void);
58 
63  std::vector<std::string> getBoardInfo(void);
64 
69  void delay_ms(uint16_t ms);
70 
75  void delay_us(uint16_t us);
76 
81  static B15F& getInstance(void);
82 
87  static std::string exec(std::string cmd);
88 
93  static void abort(std::string msg);
94 
99  static void abort(std::exception& ex);
100 
105  static void setAbortHandler(errorhandler_t func);
106 
107  /*************************************/
108 
109 
110 
111  /*************************
112  * Steuerbefehle für B15 *
113  *************************/
114 
120  bool activateSelfTestMode(void);
121 
127  bool digitalWrite0(uint8_t);
128 
134  bool digitalWrite1(uint8_t);
135 
141  uint8_t digitalRead0(void);
142 
148  uint8_t digitalRead1(void);
149 
155  uint8_t readDipSwitch(void);
156 
162  bool analogWrite0(uint16_t);
163 
169  bool analogWrite1(uint16_t);
170 
176  uint16_t analogRead(uint8_t channel);
177 
193  void analogSequence(uint8_t channel_a, uint16_t* buffer_a, uint32_t offset_a, uint8_t channel_b, uint16_t* buffer_b, uint32_t offset_b, uint16_t start, int16_t delta, uint16_t count);
194 
195  /*************************/
196 
197 
198  // CONSTANTS
199  const std::string PRE = "[B15F] ";
200  constexpr static uint8_t MSG_OK = 0xFF;
201  constexpr static uint8_t MSG_FAIL = 0xFE;
202  constexpr static uint16_t RECONNECT_TIMEOUT = 64; // ms
203  constexpr static uint16_t WDT_TIMEOUT = 15; // ms
204  constexpr static uint8_t RECONNECT_TRIES = 3;
205  constexpr static uint32_t BAUDRATE = 57600;
206 
207 private:
208 
213  void init(void);
214 
215  USART usart;
216  static B15F* instance;
217  static errorhandler_t errorhandler;
218 
219  // REQUESTS
220  constexpr static uint8_t RQ_DISC = 0;
221  constexpr static uint8_t RQ_TEST = 1;
222  constexpr static uint8_t RQ_INFO = 2;
223  constexpr static uint8_t RQ_INT = 3;
224  constexpr static uint8_t RQ_ST = 4;
225  constexpr static uint8_t RQ_BA0 = 5;
226  constexpr static uint8_t RQ_BA1 = 6;
227  constexpr static uint8_t RQ_BE0 = 7;
228  constexpr static uint8_t RQ_BE1 = 8;
229  constexpr static uint8_t RQ_DSW = 9;
230  constexpr static uint8_t RQ_AA0 = 10;
231  constexpr static uint8_t RQ_AA1 = 11;
232  constexpr static uint8_t RQ_ADC = 12;
233  constexpr static uint8_t RQ_ADC_DAC_STROKE = 13;
234 };
235 
236 #endif // B15F_H
B15F::exec
static std::string exec(std::string cmd)
Definition: b15f.cpp:309
B15F::delay_us
void delay_us(uint16_t us)
Definition: b15f.cpp:295
B15F::digitalRead0
uint8_t digitalRead0(void)
Definition: b15f.cpp:172
-
B15F::analogSequence
void analogSequence(uint8_t channel_a, uint16_t *buffer_a, uint32_t offset_a, uint8_t channel_b, uint16_t *buffer_b, uint32_t offset_b, uint16_t start, int16_t delta, uint16_t count)
Komplexe Analoge Sequenz DAC 0 wird auf den Startwert gesetzt und dann schrittweise um Delta inkremen...
Definition: b15f.cpp:241
+
B15F::analogSequence
void analogSequence(uint8_t channel_a, uint16_t *buffer_a, uint32_t offset_a, uint8_t channel_b, uint16_t *buffer_b, uint32_t offset_b, uint16_t start, int16_t delta, uint16_t count)
Definition: b15f.cpp:241
B15F::testConnection
bool testConnection(void)
Definition: b15f.cpp:90
B15F::readDipSwitch
uint8_t readDipSwitch(void)
Definition: b15f.cpp:190
B15F::delay_ms
void delay_ms(uint16_t ms)
Definition: b15f.cpp:290
@@ -88,7 +88,6 @@ $(function() {
B15F::activateSelfTestMode
bool activateSelfTestMode(void)
Definition: b15f.cpp:144
B15F::getBoardInfo
std::vector< std::string > getBoardInfo(void)
Definition: b15f.cpp:118
B15F::digitalWrite1
bool digitalWrite1(uint8_t)
Definition: b15f.cpp:162
-
B15F::init
void init(void)
Definition: b15f.cpp:11
B15F::discard
void discard(void)
Definition: b15f.cpp:72
B15F::analogWrite0
bool analogWrite0(uint16_t)
Definition: b15f.cpp:199
B15F::digitalRead1
uint8_t digitalRead1(void)
Definition: b15f.cpp:181
diff --git a/docs/html/classB15F-members.html b/docs/html/classB15F-members.html index cd747d3..6ad79a3 100644 --- a/docs/html/classB15F-members.html +++ b/docs/html/classB15F-members.html @@ -87,18 +87,17 @@ $(function() { exec(std::string cmd)B15Fstatic getBoardInfo(void)B15F getInstance(void)B15Fstatic - init(void)B15F - MSG_FAIL (defined in B15F)B15Fstatic - MSG_OK (defined in B15F)B15Fstatic - PRE (defined in B15F)B15F - readDipSwitch(void)B15F - reconnect(void)B15F - RECONNECT_TIMEOUT (defined in B15F)B15Fstatic - RECONNECT_TRIES (defined in B15F)B15Fstatic - setAbortHandler(errorhandler_t func)B15Fstatic - testConnection(void)B15F - testIntConv(void)B15F - WDT_TIMEOUT (defined in B15F)B15Fstatic + MSG_FAIL (defined in B15F)B15Fstatic + MSG_OK (defined in B15F)B15Fstatic + PRE (defined in B15F)B15F + readDipSwitch(void)B15F + reconnect(void)B15F + RECONNECT_TIMEOUT (defined in B15F)B15Fstatic + RECONNECT_TRIES (defined in B15F)B15Fstatic + setAbortHandler(errorhandler_t func)B15Fstatic + testConnection(void)B15F + testIntConv(void)B15F + WDT_TIMEOUT (defined in B15F)B15Fstatic
diff --git a/docs/html/classB15F.html b/docs/html/classB15F.html index 98d62ce..34fbd28 100644 --- a/docs/html/classB15F.html +++ b/docs/html/classB15F.html @@ -75,8 +75,6 @@ $(function() { - - @@ -110,7 +108,6 @@ Public Member Functions -

Public Member Functions

void init (void)
 
void reconnect (void)
 
void discard (void)
uint16_t analogRead (uint8_t channel)
 
void analogSequence (uint8_t channel_a, uint16_t *buffer_a, uint32_t offset_a, uint8_t channel_b, uint16_t *buffer_b, uint32_t offset_b, uint16_t start, int16_t delta, uint16_t count)
 Komplexe Analoge Sequenz DAC 0 wird auf den Startwert gesetzt und dann schrittweise um Delta inkrementiert. Für jeden eingestelleten DAC-Wert werden zwei ADCs (channel_a und channel_b) angesprochen und die Werte übermittelt. Die Werte werden in buffer_a für Kanal a und buffer_b für Kanal b gespeichert. More...
 

@@ -350,9 +347,7 @@ constexpr static uint32_t 
- -

Komplexe Analoge Sequenz DAC 0 wird auf den Startwert gesetzt und dann schrittweise um Delta inkrementiert. Für jeden eingestelleten DAC-Wert werden zwei ADCs (channel_a und channel_b) angesprochen und die Werte übermittelt. Die Werte werden in buffer_a für Kanal a und buffer_b für Kanal b gespeichert.

-
Parameters
+

DAC 0 wird auf den Startwert gesetzt und dann schrittweise um Delta inkrementiert. Für jeden eingestelleten DAC-Wert werden zwei ADCs (channel_a und channel_b) angesprochen und die Werte übermittelt. Die Werte werden in buffer_a für Kanal a und buffer_b für Kanal b gespeichert.

Parameters
@@ -729,32 +724,6 @@ constexpr static uint32_t 
channel_aAuswahl des ADC a, von 0 - 7
buffer_aSpeichertort für Werte des Kanals a

Definition at line 300 of file b15f.cpp.

- - - -

◆ init()

- -
-
- - - - - - - - -
void B15F::init (void )
-
-

Initialisiert und testet die Verbindung zum B15

Exceptions
- - -
DriverException
-
-
- -

Definition at line 11 of file b15f.cpp.

-
diff --git a/docs/html/functions.html b/docs/html/functions.html index 0480d53..1c5c177 100644 --- a/docs/html/functions.html +++ b/docs/html/functions.html @@ -154,13 +154,6 @@ $(function() { -

- i -

    -
  • init() -: B15F -
    • -
- -

- o -

  • openDevice() : USART diff --git a/docs/html/functions_func.html b/docs/html/functions_func.html index 891a1d2..0a45dfa 100644 --- a/docs/html/functions_func.html +++ b/docs/html/functions_func.html @@ -154,13 +154,6 @@ $(function() {
-

- i -

    -
  • init() -: B15F -
    • -
- -

- o -

  • openDevice() : USART diff --git a/docs/html/index.html b/docs/html/index.html index a232af3..39eaa17 100644 --- a/docs/html/index.html +++ b/docs/html/index.html @@ -5,7 +5,7 @@ -B15F: Main Page +B15F: Einführung @@ -61,11 +61,14 @@ $(function() { -
    +
    -
    B15F Documentation
    +
    Einführung
    +

    Die wichtigste Klasse für die Steuerung des Board 15 ist B15F.
    +Dort befindet sich auch eine Übersicht der verfügbaren Befehle.

    +
    diff --git a/docs/html/menudata.js b/docs/html/menudata.js index 92681bb..3c52b9d 100644 --- a/docs/html/menudata.js +++ b/docs/html/menudata.js @@ -34,7 +34,6 @@ var menudata={children:[ {text:"e",url:"functions.html#index_e"}, {text:"f",url:"functions.html#index_f"}, {text:"g",url:"functions.html#index_g"}, -{text:"i",url:"functions.html#index_i"}, {text:"o",url:"functions.html#index_o"}, {text:"p",url:"functions.html#index_p"}, {text:"r",url:"functions.html#index_r"}, @@ -48,7 +47,6 @@ var menudata={children:[ {text:"e",url:"functions_func.html#index_e"}, {text:"f",url:"functions_func.html#index_f"}, {text:"g",url:"functions_func.html#index_g"}, -{text:"i",url:"functions_func.html#index_i"}, {text:"o",url:"functions_func.html#index_o"}, {text:"p",url:"functions_func.html#index_p"}, {text:"r",url:"functions_func.html#index_r"}, diff --git a/docs/html/search/all_4.js b/docs/html/search/all_4.js index fb3f662..4acd298 100644 --- a/docs/html/search/all_4.js +++ b/docs/html/search/all_4.js @@ -1,4 +1,5 @@ var searchData= [ - ['exec',['exec',['../classB15F.html#a1a7ac52984ed7ecac008a3e4060eee3a',1,'B15F']]] + ['exec',['exec',['../classB15F.html#a1a7ac52984ed7ecac008a3e4060eee3a',1,'B15F']]], + ['einführung',['Einführung',['../index.html',1,'']]] ]; diff --git a/docs/html/search/all_7.js b/docs/html/search/all_7.js index c1170e9..bd75d34 100644 --- a/docs/html/search/all_7.js +++ b/docs/html/search/all_7.js @@ -1,4 +1,4 @@ var searchData= [ - ['init',['init',['../classB15F.html#a74d8cca6edbb4e24a2f760829b3742a5',1,'B15F']]] + ['opendevice',['openDevice',['../classUSART.html#a5f7e2abda2ec4a68a5fdb8ee2f8a940a',1,'USART']]] ]; diff --git a/docs/html/search/all_8.js b/docs/html/search/all_8.js index bd75d34..8232ab7 100644 --- a/docs/html/search/all_8.js +++ b/docs/html/search/all_8.js @@ -1,4 +1,5 @@ var searchData= [ - ['opendevice',['openDevice',['../classUSART.html#a5f7e2abda2ec4a68a5fdb8ee2f8a940a',1,'USART']]] + ['plottyfile',['PlottyFile',['../classPlottyFile.html',1,'']]], + ['printstatistics',['printStatistics',['../classUSART.html#a33559bb8f0eda33a489d47b9c9227b59',1,'USART']]] ]; diff --git a/docs/html/search/all_9.js b/docs/html/search/all_9.js index 8232ab7..5d35f1d 100644 --- a/docs/html/search/all_9.js +++ b/docs/html/search/all_9.js @@ -1,5 +1,7 @@ var searchData= [ - ['plottyfile',['PlottyFile',['../classPlottyFile.html',1,'']]], - ['printstatistics',['printStatistics',['../classUSART.html#a33559bb8f0eda33a489d47b9c9227b59',1,'USART']]] + ['readbyte',['readByte',['../classUSART.html#a8f54b98b26bfe084359a5604bda82562',1,'USART']]], + ['readdipswitch',['readDipSwitch',['../classB15F.html#a6f858f21ea81d491b5031b3644a2239a',1,'B15F']]], + ['readint',['readInt',['../classUSART.html#a1534c229db71a375e556cf1e7d0b8119',1,'USART']]], + ['reconnect',['reconnect',['../classB15F.html#a52557b375443c180a044e7d4e80a1ae7',1,'B15F']]] ]; diff --git a/docs/html/search/all_a.js b/docs/html/search/all_a.js index 5d35f1d..4f4d28c 100644 --- a/docs/html/search/all_a.js +++ b/docs/html/search/all_a.js @@ -1,7 +1,6 @@ var searchData= [ - ['readbyte',['readByte',['../classUSART.html#a8f54b98b26bfe084359a5604bda82562',1,'USART']]], - ['readdipswitch',['readDipSwitch',['../classB15F.html#a6f858f21ea81d491b5031b3644a2239a',1,'B15F']]], - ['readint',['readInt',['../classUSART.html#a1534c229db71a375e556cf1e7d0b8119',1,'USART']]], - ['reconnect',['reconnect',['../classB15F.html#a52557b375443c180a044e7d4e80a1ae7',1,'B15F']]] + ['setaborthandler',['setAbortHandler',['../classB15F.html#a55b0cd1ea582bda53d6979442640f8e9',1,'B15F']]], + ['setbaudrate',['setBaudrate',['../classUSART.html#aac63918a8b97ae63ee607cfa39e6d88d',1,'USART']]], + ['settimeout',['setTimeout',['../classUSART.html#ad7fe866cebe920784d2b17602824c7ff',1,'USART']]] ]; diff --git a/docs/html/search/all_b.js b/docs/html/search/all_b.js index 4f4d28c..57a58a5 100644 --- a/docs/html/search/all_b.js +++ b/docs/html/search/all_b.js @@ -1,6 +1,6 @@ var searchData= [ - ['setaborthandler',['setAbortHandler',['../classB15F.html#a55b0cd1ea582bda53d6979442640f8e9',1,'B15F']]], - ['setbaudrate',['setBaudrate',['../classUSART.html#aac63918a8b97ae63ee607cfa39e6d88d',1,'USART']]], - ['settimeout',['setTimeout',['../classUSART.html#ad7fe866cebe920784d2b17602824c7ff',1,'USART']]] + ['testconnection',['testConnection',['../classB15F.html#af01983594f2af98ab2b1e514aa036a5d',1,'B15F']]], + ['testintconv',['testIntConv',['../classB15F.html#a7b8a0e2a9156f7dcb05d097f23666a78',1,'B15F']]], + ['timeoutexception',['TimeoutException',['../classTimeoutException.html',1,'']]] ]; diff --git a/docs/html/search/all_c.js b/docs/html/search/all_c.js index 57a58a5..c030e1b 100644 --- a/docs/html/search/all_c.js +++ b/docs/html/search/all_c.js @@ -1,6 +1,5 @@ var searchData= [ - ['testconnection',['testConnection',['../classB15F.html#af01983594f2af98ab2b1e514aa036a5d',1,'B15F']]], - ['testintconv',['testIntConv',['../classB15F.html#a7b8a0e2a9156f7dcb05d097f23666a78',1,'B15F']]], - ['timeoutexception',['TimeoutException',['../classTimeoutException.html',1,'']]] + ['usart',['USART',['../classUSART.html',1,'']]], + ['usartexception',['USARTException',['../classUSARTException.html',1,'']]] ]; diff --git a/docs/html/search/all_d.js b/docs/html/search/all_d.js index c030e1b..27f785f 100644 --- a/docs/html/search/all_d.js +++ b/docs/html/search/all_d.js @@ -1,5 +1,8 @@ var searchData= [ - ['usart',['USART',['../classUSART.html',1,'']]], - ['usartexception',['USARTException',['../classUSARTException.html',1,'']]] + ['view',['View',['../classView.html',1,'']]], + ['viewinfo',['ViewInfo',['../classViewInfo.html',1,'']]], + ['viewmonitor',['ViewMonitor',['../classViewMonitor.html',1,'']]], + ['viewpromt',['ViewPromt',['../classViewPromt.html',1,'']]], + ['viewselection',['ViewSelection',['../classViewSelection.html',1,'']]] ]; diff --git a/docs/html/search/all_e.js b/docs/html/search/all_e.js index 27f785f..88b07d9 100644 --- a/docs/html/search/all_e.js +++ b/docs/html/search/all_e.js @@ -1,8 +1,5 @@ var searchData= [ - ['view',['View',['../classView.html',1,'']]], - ['viewinfo',['ViewInfo',['../classViewInfo.html',1,'']]], - ['viewmonitor',['ViewMonitor',['../classViewMonitor.html',1,'']]], - ['viewpromt',['ViewPromt',['../classViewPromt.html',1,'']]], - ['viewselection',['ViewSelection',['../classViewSelection.html',1,'']]] + ['writebyte',['writeByte',['../classUSART.html#a60eadbe9956bab8144ee96d89eacd9f5',1,'USART']]], + ['writeint',['writeInt',['../classUSART.html#a78b30d9aa863f38745e982860392599a',1,'USART']]] ]; diff --git a/docs/html/search/functions_6.js b/docs/html/search/functions_6.js index c1170e9..bd75d34 100644 --- a/docs/html/search/functions_6.js +++ b/docs/html/search/functions_6.js @@ -1,4 +1,4 @@ var searchData= [ - ['init',['init',['../classB15F.html#a74d8cca6edbb4e24a2f760829b3742a5',1,'B15F']]] + ['opendevice',['openDevice',['../classUSART.html#a5f7e2abda2ec4a68a5fdb8ee2f8a940a',1,'USART']]] ]; diff --git a/docs/html/search/functions_7.js b/docs/html/search/functions_7.js index bd75d34..cfb7a36 100644 --- a/docs/html/search/functions_7.js +++ b/docs/html/search/functions_7.js @@ -1,4 +1,4 @@ var searchData= [ - ['opendevice',['openDevice',['../classUSART.html#a5f7e2abda2ec4a68a5fdb8ee2f8a940a',1,'USART']]] + ['printstatistics',['printStatistics',['../classUSART.html#a33559bb8f0eda33a489d47b9c9227b59',1,'USART']]] ]; diff --git a/docs/html/search/functions_8.js b/docs/html/search/functions_8.js index cfb7a36..5d35f1d 100644 --- a/docs/html/search/functions_8.js +++ b/docs/html/search/functions_8.js @@ -1,4 +1,7 @@ var searchData= [ - ['printstatistics',['printStatistics',['../classUSART.html#a33559bb8f0eda33a489d47b9c9227b59',1,'USART']]] + ['readbyte',['readByte',['../classUSART.html#a8f54b98b26bfe084359a5604bda82562',1,'USART']]], + ['readdipswitch',['readDipSwitch',['../classB15F.html#a6f858f21ea81d491b5031b3644a2239a',1,'B15F']]], + ['readint',['readInt',['../classUSART.html#a1534c229db71a375e556cf1e7d0b8119',1,'USART']]], + ['reconnect',['reconnect',['../classB15F.html#a52557b375443c180a044e7d4e80a1ae7',1,'B15F']]] ]; diff --git a/docs/html/search/functions_9.js b/docs/html/search/functions_9.js index 5d35f1d..4f4d28c 100644 --- a/docs/html/search/functions_9.js +++ b/docs/html/search/functions_9.js @@ -1,7 +1,6 @@ var searchData= [ - ['readbyte',['readByte',['../classUSART.html#a8f54b98b26bfe084359a5604bda82562',1,'USART']]], - ['readdipswitch',['readDipSwitch',['../classB15F.html#a6f858f21ea81d491b5031b3644a2239a',1,'B15F']]], - ['readint',['readInt',['../classUSART.html#a1534c229db71a375e556cf1e7d0b8119',1,'USART']]], - ['reconnect',['reconnect',['../classB15F.html#a52557b375443c180a044e7d4e80a1ae7',1,'B15F']]] + ['setaborthandler',['setAbortHandler',['../classB15F.html#a55b0cd1ea582bda53d6979442640f8e9',1,'B15F']]], + ['setbaudrate',['setBaudrate',['../classUSART.html#aac63918a8b97ae63ee607cfa39e6d88d',1,'USART']]], + ['settimeout',['setTimeout',['../classUSART.html#ad7fe866cebe920784d2b17602824c7ff',1,'USART']]] ]; diff --git a/docs/html/search/functions_a.js b/docs/html/search/functions_a.js index 4f4d28c..4b801c0 100644 --- a/docs/html/search/functions_a.js +++ b/docs/html/search/functions_a.js @@ -1,6 +1,5 @@ var searchData= [ - ['setaborthandler',['setAbortHandler',['../classB15F.html#a55b0cd1ea582bda53d6979442640f8e9',1,'B15F']]], - ['setbaudrate',['setBaudrate',['../classUSART.html#aac63918a8b97ae63ee607cfa39e6d88d',1,'USART']]], - ['settimeout',['setTimeout',['../classUSART.html#ad7fe866cebe920784d2b17602824c7ff',1,'USART']]] + ['testconnection',['testConnection',['../classB15F.html#af01983594f2af98ab2b1e514aa036a5d',1,'B15F']]], + ['testintconv',['testIntConv',['../classB15F.html#a7b8a0e2a9156f7dcb05d097f23666a78',1,'B15F']]] ]; diff --git a/docs/html/search/functions_b.js b/docs/html/search/functions_b.js index 4b801c0..88b07d9 100644 --- a/docs/html/search/functions_b.js +++ b/docs/html/search/functions_b.js @@ -1,5 +1,5 @@ var searchData= [ - ['testconnection',['testConnection',['../classB15F.html#af01983594f2af98ab2b1e514aa036a5d',1,'B15F']]], - ['testintconv',['testIntConv',['../classB15F.html#a7b8a0e2a9156f7dcb05d097f23666a78',1,'B15F']]] + ['writebyte',['writeByte',['../classUSART.html#a60eadbe9956bab8144ee96d89eacd9f5',1,'USART']]], + ['writeint',['writeInt',['../classUSART.html#a78b30d9aa863f38745e982860392599a',1,'USART']]] ]; diff --git a/docs/html/search/pages_0.html b/docs/html/search/pages_0.html new file mode 100644 index 0000000..32cbf49 --- /dev/null +++ b/docs/html/search/pages_0.html @@ -0,0 +1,30 @@ + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/docs/html/search/pages_0.js b/docs/html/search/pages_0.js new file mode 100644 index 0000000..abe03ca --- /dev/null +++ b/docs/html/search/pages_0.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['einführung',['Einführung',['../index.html',1,'']]] +]; diff --git a/docs/html/search/searchdata.js b/docs/html/search/searchdata.js index 6cddf59..522aa5c 100644 --- a/docs/html/search/searchdata.js +++ b/docs/html/search/searchdata.js @@ -1,21 +1,24 @@ var indexSectionsWithContent = { - 0: "abcdefgioprstuvw", + 0: "abcdefgoprstuvw", 1: "bdptuv", - 2: "acdefgioprstw" + 2: "acdefgoprstw", + 3: "e" }; var indexSectionNames = { 0: "all", 1: "classes", - 2: "functions" + 2: "functions", + 3: "pages" }; var indexSectionLabels = { 0: "All", 1: "Classes", - 2: "Functions" + 2: "Functions", + 3: "Pages" }; diff --git a/docs/index.html b/docs/index.html new file mode 100644 index 0000000..1324b98 --- /dev/null +++ b/docs/index.html @@ -0,0 +1,15 @@ + + + + + + + Page Redirection + + + + If you are not redirected automatically, follow this link to example. + + diff --git a/docs/latex/Makefile b/docs/latex/Makefile deleted file mode 100644 index 877c9cc..0000000 --- a/docs/latex/Makefile +++ /dev/null @@ -1,23 +0,0 @@ -LATEX_CMD=pdflatex - -all: refman.pdf - -pdf: refman.pdf - -refman.pdf: clean refman.tex - $(LATEX_CMD) refman - makeindex refman.idx - $(LATEX_CMD) refman - latex_count=8 ; \ - while egrep -s 'Rerun (LaTeX|to get cross-references right)' refman.log && [ $$latex_count -gt 0 ] ;\ - do \ - echo "Rerunning latex...." ;\ - $(LATEX_CMD) refman ;\ - latex_count=`expr $$latex_count - 1` ;\ - done - makeindex refman.idx - $(LATEX_CMD) refman - - -clean: - rm -f *.ps *.dvi *.aux *.toc *.idx *.ind *.ilg *.log *.out *.brf *.blg *.bbl refman.pdf diff --git a/docs/latex/annotated.tex b/docs/latex/annotated.tex deleted file mode 100644 index 305f68e..0000000 --- a/docs/latex/annotated.tex +++ /dev/null @@ -1,15 +0,0 @@ -\doxysection{Class List} -Here are the classes, structs, unions and interfaces with brief descriptions\+:\begin{DoxyCompactList} -\item\contentsline{section}{\mbox{\hyperlink{classB15F}{B15F}} }{\pageref{classB15F}}{} -\item\contentsline{section}{\mbox{\hyperlink{classDot}{Dot}} }{\pageref{classDot}}{} -\item\contentsline{section}{\mbox{\hyperlink{classDriverException}{Driver\+Exception}} }{\pageref{classDriverException}}{} -\item\contentsline{section}{\mbox{\hyperlink{classPlottyFile}{Plotty\+File}} }{\pageref{classPlottyFile}}{} -\item\contentsline{section}{\mbox{\hyperlink{classTimeoutException}{Timeout\+Exception}} }{\pageref{classTimeoutException}}{} -\item\contentsline{section}{\mbox{\hyperlink{classUSART}{U\+S\+A\+RT}} }{\pageref{classUSART}}{} -\item\contentsline{section}{\mbox{\hyperlink{classUSARTException}{U\+S\+A\+R\+T\+Exception}} }{\pageref{classUSARTException}}{} -\item\contentsline{section}{\mbox{\hyperlink{classView}{View}} }{\pageref{classView}}{} -\item\contentsline{section}{\mbox{\hyperlink{classViewInfo}{View\+Info}} }{\pageref{classViewInfo}}{} -\item\contentsline{section}{\mbox{\hyperlink{classViewMonitor}{View\+Monitor}} }{\pageref{classViewMonitor}}{} -\item\contentsline{section}{\mbox{\hyperlink{classViewPromt}{View\+Promt}} }{\pageref{classViewPromt}}{} -\item\contentsline{section}{\mbox{\hyperlink{classViewSelection}{View\+Selection}} }{\pageref{classViewSelection}}{} -\end{DoxyCompactList} diff --git a/docs/latex/classB15F.tex b/docs/latex/classB15F.tex deleted file mode 100644 index c576f8e..0000000 --- a/docs/latex/classB15F.tex +++ /dev/null @@ -1,501 +0,0 @@ -\hypertarget{classB15F}{}\doxysection{B15F Class Reference} -\label{classB15F}\index{B15F@{B15F}} -\doxysubsection*{Public Member Functions} -\begin{DoxyCompactItemize} -\item -void \mbox{\hyperlink{classB15F_a74d8cca6edbb4e24a2f760829b3742a5}{init}} (void) -\item -void \mbox{\hyperlink{classB15F_a52557b375443c180a044e7d4e80a1ae7}{reconnect}} (void) -\item -void \mbox{\hyperlink{classB15F_ae4740cd473f40a1a4121dfa66b25e1d5}{discard}} (void) -\item -bool \mbox{\hyperlink{classB15F_af01983594f2af98ab2b1e514aa036a5d}{test\+Connection}} (void) -\item -bool \mbox{\hyperlink{classB15F_a7b8a0e2a9156f7dcb05d097f23666a78}{test\+Int\+Conv}} (void) -\item -std\+::vector$<$ std\+::string $>$ \mbox{\hyperlink{classB15F_a4f01677e73d6d172a2c1cae9427a591b}{get\+Board\+Info}} (void) -\item -void \mbox{\hyperlink{classB15F_aaffce20afb9f06bc4b7556c70ce76416}{delay\+\_\+ms}} (uint16\+\_\+t ms) -\item -void \mbox{\hyperlink{classB15F_adcaac8ae8db3c28eccb499fbd720361f}{delay\+\_\+us}} (uint16\+\_\+t us) -\item -bool \mbox{\hyperlink{classB15F_ad9bf80ee2485fb5aac9926c6ef0731f1}{activate\+Self\+Test\+Mode}} (void) -\item -bool \mbox{\hyperlink{classB15F_a13797edea1c50278988373acbd110064}{digital\+Write0}} (uint8\+\_\+t) -\item -bool \mbox{\hyperlink{classB15F_aa225e7fc813849634063e071ef25db1b}{digital\+Write1}} (uint8\+\_\+t) -\item -uint8\+\_\+t \mbox{\hyperlink{classB15F_ae0df6d423deeb2fd610968bd1c72060e}{digital\+Read0}} (void) -\item -uint8\+\_\+t \mbox{\hyperlink{classB15F_afc76b612dd4faeee0ac02a66b65af5f2}{digital\+Read1}} (void) -\item -uint8\+\_\+t \mbox{\hyperlink{classB15F_a6f858f21ea81d491b5031b3644a2239a}{read\+Dip\+Switch}} (void) -\item -bool \mbox{\hyperlink{classB15F_a5c5583d591afdd3f9501856c6b0ba3e3}{analog\+Write0}} (uint16\+\_\+t) -\item -bool \mbox{\hyperlink{classB15F_a63d67795879cdc0b035c9c970e7d6fc3}{analog\+Write1}} (uint16\+\_\+t) -\item -uint16\+\_\+t \mbox{\hyperlink{classB15F_ae0bd1f69751e2dc3c462db9213fc4627}{analog\+Read}} (uint8\+\_\+t channel) -\item -void \mbox{\hyperlink{classB15F_ab82a324426c3063318c6cafb3089ae02}{analog\+Sequence}} (uint8\+\_\+t channel\+\_\+a, uint16\+\_\+t $\ast$buffer\+\_\+a, uint32\+\_\+t offset\+\_\+a, uint8\+\_\+t channel\+\_\+b, uint16\+\_\+t $\ast$buffer\+\_\+b, uint32\+\_\+t offset\+\_\+b, uint16\+\_\+t start, int16\+\_\+t delta, uint16\+\_\+t count) -\begin{DoxyCompactList}\small\item\em Komplexe Analoge Sequenz D\+AC 0 wird auf den Startwert gesetzt und dann schrittweise um Delta inkrementiert. Für jeden eingestelleten D\+A\+C-\/\+Wert werden zwei A\+D\+Cs (channel\+\_\+a und channel\+\_\+b) angesprochen und die Werte übermittelt. Die Werte werden in buffer\+\_\+a für Kanal a und buffer\+\_\+b für Kanal b gespeichert. \end{DoxyCompactList}\end{DoxyCompactItemize} -\doxysubsection*{Static Public Member Functions} -\begin{DoxyCompactItemize} -\item -static \mbox{\hyperlink{classB15F}{B15F}} \& \mbox{\hyperlink{classB15F_a8b4533d232c55ef2aa967e39e2d23380}{get\+Instance}} (void) -\item -static std\+::string \mbox{\hyperlink{classB15F_a1a7ac52984ed7ecac008a3e4060eee3a}{exec}} (std\+::string cmd) -\item -static void \mbox{\hyperlink{classB15F_a3f09a418f9e3be5d1d750e4515c96f1e}{abort}} (std\+::string msg) -\item -static void \mbox{\hyperlink{classB15F_ac962a6a49bddd0e261a8c7d3aded23f8}{abort}} (std\+::exception \&ex) -\item -static void \mbox{\hyperlink{classB15F_a55b0cd1ea582bda53d6979442640f8e9}{set\+Abort\+Handler}} (errorhandler\+\_\+t func) -\end{DoxyCompactItemize} -\doxysubsection*{Public Attributes} -\begin{DoxyCompactItemize} -\item -\mbox{\Hypertarget{classB15F_a3b0fc1f85954b2d9c145af4a3af5b1ec}\label{classB15F_a3b0fc1f85954b2d9c145af4a3af5b1ec}} -const std\+::string {\bfseries P\+RE} = \char`\"{}\mbox{[}B15F\mbox{]} \char`\"{} -\end{DoxyCompactItemize} -\doxysubsection*{Static Public Attributes} -\begin{DoxyCompactItemize} -\item -\mbox{\Hypertarget{classB15F_ab01299858f74a6cec598688562e0ad02}\label{classB15F_ab01299858f74a6cec598688562e0ad02}} -constexpr static uint8\+\_\+t {\bfseries M\+S\+G\+\_\+\+OK} = 0x\+FF -\item -\mbox{\Hypertarget{classB15F_a77d1ecf24b406c9204665d3b09c36f1e}\label{classB15F_a77d1ecf24b406c9204665d3b09c36f1e}} -constexpr static uint8\+\_\+t {\bfseries M\+S\+G\+\_\+\+F\+A\+IL} = 0x\+FE -\item -\mbox{\Hypertarget{classB15F_a040951746fbfd632e12bd1ad14578816}\label{classB15F_a040951746fbfd632e12bd1ad14578816}} -constexpr static uint16\+\_\+t {\bfseries R\+E\+C\+O\+N\+N\+E\+C\+T\+\_\+\+T\+I\+M\+E\+O\+UT} = 64 -\item -\mbox{\Hypertarget{classB15F_a158d13bc84aed6430cdede1396384e06}\label{classB15F_a158d13bc84aed6430cdede1396384e06}} -constexpr static uint16\+\_\+t {\bfseries W\+D\+T\+\_\+\+T\+I\+M\+E\+O\+UT} = 15 -\item -\mbox{\Hypertarget{classB15F_a6c4895bdbcd71ff6743becf97985c2dc}\label{classB15F_a6c4895bdbcd71ff6743becf97985c2dc}} -constexpr static uint8\+\_\+t {\bfseries R\+E\+C\+O\+N\+N\+E\+C\+T\+\_\+\+T\+R\+I\+ES} = 3 -\item -\mbox{\Hypertarget{classB15F_a7d548d6861cfc69753161bf9cda14f87}\label{classB15F_a7d548d6861cfc69753161bf9cda14f87}} -constexpr static uint32\+\_\+t {\bfseries B\+A\+U\+D\+R\+A\+TE} = 57600 -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} - - -Definition at line 24 of file b15f.\+h. - - - -\doxysubsection{Member Function Documentation} -\mbox{\Hypertarget{classB15F_ac962a6a49bddd0e261a8c7d3aded23f8}\label{classB15F_ac962a6a49bddd0e261a8c7d3aded23f8}} -\index{B15F@{B15F}!abort@{abort}} -\index{abort@{abort}!B15F@{B15F}} -\doxysubsubsection{\texorpdfstring{abort()}{abort()}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}} -{\footnotesize\ttfamily void B15\+F\+::abort (\begin{DoxyParamCaption}\item[{std\+::exception \&}]{ex }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [static]}} - -Multithread sicherer Abbruch des B15\+F-\/\+Treibers -\begin{DoxyParams}{Parameters} -{\em ex} & Exception als Abbruchursache \\ -\hline -\end{DoxyParams} - - -Definition at line 327 of file b15f.\+cpp. - -\mbox{\Hypertarget{classB15F_a3f09a418f9e3be5d1d750e4515c96f1e}\label{classB15F_a3f09a418f9e3be5d1d750e4515c96f1e}} -\index{B15F@{B15F}!abort@{abort}} -\index{abort@{abort}!B15F@{B15F}} -\doxysubsubsection{\texorpdfstring{abort()}{abort()}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}} -{\footnotesize\ttfamily void B15\+F\+::abort (\begin{DoxyParamCaption}\item[{std\+::string}]{msg }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [static]}} - -Multithread sicherer Abbruch des B15\+F-\/\+Treibers -\begin{DoxyParams}{Parameters} -{\em msg} & Beschreibung der Abbruchursache \\ -\hline -\end{DoxyParams} - - -Definition at line 322 of file b15f.\+cpp. - -\mbox{\Hypertarget{classB15F_ad9bf80ee2485fb5aac9926c6ef0731f1}\label{classB15F_ad9bf80ee2485fb5aac9926c6ef0731f1}} -\index{B15F@{B15F}!activateSelfTestMode@{activateSelfTestMode}} -\index{activateSelfTestMode@{activateSelfTestMode}!B15F@{B15F}} -\doxysubsubsection{\texorpdfstring{activateSelfTestMode()}{activateSelfTestMode()}} -{\footnotesize\ttfamily bool B15\+F\+::activate\+Self\+Test\+Mode (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption})} - -Versetzt das Board in den Selbsttest-\/\+Modus W\+I\+C\+H\+T\+IG\+: Es darf dabei nichts an den Klemmen angeschlossen sein! -\begin{DoxyExceptions}{Exceptions} -{\em \mbox{\hyperlink{classDriverException}{Driver\+Exception}}} & \\ -\hline -\end{DoxyExceptions} - - -Definition at line 144 of file b15f.\+cpp. - -\mbox{\Hypertarget{classB15F_ae0bd1f69751e2dc3c462db9213fc4627}\label{classB15F_ae0bd1f69751e2dc3c462db9213fc4627}} -\index{B15F@{B15F}!analogRead@{analogRead}} -\index{analogRead@{analogRead}!B15F@{B15F}} -\doxysubsubsection{\texorpdfstring{analogRead()}{analogRead()}} -{\footnotesize\ttfamily uint16\+\_\+t B15\+F\+::analog\+Read (\begin{DoxyParamCaption}\item[{uint8\+\_\+t}]{channel }\end{DoxyParamCaption})} - -Liest den Wert des Analog-\/\+Digital-\/\+Converters (A\+DC / A\+DU) -\begin{DoxyParams}{Parameters} -{\em channel} & Kanalwahl von 0 -\/ 7 \\ -\hline -\end{DoxyParams} - -\begin{DoxyExceptions}{Exceptions} -{\em \mbox{\hyperlink{classDriverException}{Driver\+Exception}}} & \\ -\hline -\end{DoxyExceptions} - - -Definition at line 219 of file b15f.\+cpp. - -\mbox{\Hypertarget{classB15F_ab82a324426c3063318c6cafb3089ae02}\label{classB15F_ab82a324426c3063318c6cafb3089ae02}} -\index{B15F@{B15F}!analogSequence@{analogSequence}} -\index{analogSequence@{analogSequence}!B15F@{B15F}} -\doxysubsubsection{\texorpdfstring{analogSequence()}{analogSequence()}} -{\footnotesize\ttfamily void B15\+F\+::analog\+Sequence (\begin{DoxyParamCaption}\item[{uint8\+\_\+t}]{channel\+\_\+a, }\item[{uint16\+\_\+t $\ast$}]{buffer\+\_\+a, }\item[{uint32\+\_\+t}]{offset\+\_\+a, }\item[{uint8\+\_\+t}]{channel\+\_\+b, }\item[{uint16\+\_\+t $\ast$}]{buffer\+\_\+b, }\item[{uint32\+\_\+t}]{offset\+\_\+b, }\item[{uint16\+\_\+t}]{start, }\item[{int16\+\_\+t}]{delta, }\item[{uint16\+\_\+t}]{count }\end{DoxyParamCaption})} - - - -Komplexe Analoge Sequenz D\+AC 0 wird auf den Startwert gesetzt und dann schrittweise um Delta inkrementiert. Für jeden eingestelleten D\+A\+C-\/\+Wert werden zwei A\+D\+Cs (channel\+\_\+a und channel\+\_\+b) angesprochen und die Werte übermittelt. Die Werte werden in buffer\+\_\+a für Kanal a und buffer\+\_\+b für Kanal b gespeichert. - - -\begin{DoxyParams}{Parameters} -{\em channel\+\_\+a} & Auswahl des A\+DC a, von 0 -\/ 7 \\ -\hline -{\em buffer\+\_\+a} & Speichertort für Werte des Kanals a \\ -\hline -{\em offset\+\_\+a} & Anzahl an Werten des Kanals a, die im Speicher übersprungen werden sollen \\ -\hline -{\em channel\+\_\+b} & Auswahl des A\+DC b, von 0 -\/ 7 \\ -\hline -{\em buffer\+\_\+b} & Speichertort für Werte des Kanals b \\ -\hline -{\em offset\+\_\+b} & Anzahl an Werten des Kanals b, die im Speicher übersprungen werden \\ -\hline -{\em start} & Startwert des D\+A\+Cs \\ -\hline -{\em delta} & Schrittweite, mit welcher der D\+AC inkrementiert wird \\ -\hline -{\em count} & Anzahl an Inkrementierungen \\ -\hline -\end{DoxyParams} - -\begin{DoxyExceptions}{Exceptions} -{\em \mbox{\hyperlink{classDriverException}{Driver\+Exception}}} & \\ -\hline -\end{DoxyExceptions} - - -Definition at line 241 of file b15f.\+cpp. - -\mbox{\Hypertarget{classB15F_a5c5583d591afdd3f9501856c6b0ba3e3}\label{classB15F_a5c5583d591afdd3f9501856c6b0ba3e3}} -\index{B15F@{B15F}!analogWrite0@{analogWrite0}} -\index{analogWrite0@{analogWrite0}!B15F@{B15F}} -\doxysubsubsection{\texorpdfstring{analogWrite0()}{analogWrite0()}} -{\footnotesize\ttfamily bool B15\+F\+::analog\+Write0 (\begin{DoxyParamCaption}\item[{uint16\+\_\+t}]{value }\end{DoxyParamCaption})} - -Setzt den Wert des Digital-\/\+Analog-\/\+Converters (D\+AC / D\+AU) 0 -\begin{DoxyParams}{Parameters} -{\em port} & 10-\/Bit Wert \\ -\hline -\end{DoxyParams} - -\begin{DoxyExceptions}{Exceptions} -{\em \mbox{\hyperlink{classDriverException}{Driver\+Exception}}} & \\ -\hline -\end{DoxyExceptions} - - -Definition at line 199 of file b15f.\+cpp. - -\mbox{\Hypertarget{classB15F_a63d67795879cdc0b035c9c970e7d6fc3}\label{classB15F_a63d67795879cdc0b035c9c970e7d6fc3}} -\index{B15F@{B15F}!analogWrite1@{analogWrite1}} -\index{analogWrite1@{analogWrite1}!B15F@{B15F}} -\doxysubsubsection{\texorpdfstring{analogWrite1()}{analogWrite1()}} -{\footnotesize\ttfamily bool B15\+F\+::analog\+Write1 (\begin{DoxyParamCaption}\item[{uint16\+\_\+t}]{value }\end{DoxyParamCaption})} - -Setzt den Wert des Digital-\/\+Analog-\/\+Converters (D\+AC / D\+AU) 1 -\begin{DoxyParams}{Parameters} -{\em port} & 10-\/Bit Wert \\ -\hline -\end{DoxyParams} - -\begin{DoxyExceptions}{Exceptions} -{\em \mbox{\hyperlink{classDriverException}{Driver\+Exception}}} & \\ -\hline -\end{DoxyExceptions} - - -Definition at line 209 of file b15f.\+cpp. - -\mbox{\Hypertarget{classB15F_aaffce20afb9f06bc4b7556c70ce76416}\label{classB15F_aaffce20afb9f06bc4b7556c70ce76416}} -\index{B15F@{B15F}!delay\_ms@{delay\_ms}} -\index{delay\_ms@{delay\_ms}!B15F@{B15F}} -\doxysubsubsection{\texorpdfstring{delay\_ms()}{delay\_ms()}} -{\footnotesize\ttfamily void B15\+F\+::delay\+\_\+ms (\begin{DoxyParamCaption}\item[{uint16\+\_\+t}]{ms }\end{DoxyParamCaption})} - -Lässt den Treiber für eine angegebene Zeit pausieren -\begin{DoxyParams}{Parameters} -{\em ms} & Verzögerung in Millisekunden \\ -\hline -\end{DoxyParams} - - -Definition at line 290 of file b15f.\+cpp. - -\mbox{\Hypertarget{classB15F_adcaac8ae8db3c28eccb499fbd720361f}\label{classB15F_adcaac8ae8db3c28eccb499fbd720361f}} -\index{B15F@{B15F}!delay\_us@{delay\_us}} -\index{delay\_us@{delay\_us}!B15F@{B15F}} -\doxysubsubsection{\texorpdfstring{delay\_us()}{delay\_us()}} -{\footnotesize\ttfamily void B15\+F\+::delay\+\_\+us (\begin{DoxyParamCaption}\item[{uint16\+\_\+t}]{us }\end{DoxyParamCaption})} - -Lässt den Treiber für eine angegebene Zeit pausieren -\begin{DoxyParams}{Parameters} -{\em us} & Verzögerung in Microsekunden \\ -\hline -\end{DoxyParams} - - -Definition at line 295 of file b15f.\+cpp. - -\mbox{\Hypertarget{classB15F_ae0df6d423deeb2fd610968bd1c72060e}\label{classB15F_ae0df6d423deeb2fd610968bd1c72060e}} -\index{B15F@{B15F}!digitalRead0@{digitalRead0}} -\index{digitalRead0@{digitalRead0}!B15F@{B15F}} -\doxysubsubsection{\texorpdfstring{digitalRead0()}{digitalRead0()}} -{\footnotesize\ttfamily uint8\+\_\+t B15\+F\+::digital\+Read0 (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption})} - -Liest den Wert des digitalen Eingabeports 0 \begin{DoxyReturn}{Returns} -Wert für gesamten Port -\end{DoxyReturn} - -\begin{DoxyExceptions}{Exceptions} -{\em \mbox{\hyperlink{classDriverException}{Driver\+Exception}}} & \\ -\hline -\end{DoxyExceptions} - - -Definition at line 172 of file b15f.\+cpp. - -\mbox{\Hypertarget{classB15F_afc76b612dd4faeee0ac02a66b65af5f2}\label{classB15F_afc76b612dd4faeee0ac02a66b65af5f2}} -\index{B15F@{B15F}!digitalRead1@{digitalRead1}} -\index{digitalRead1@{digitalRead1}!B15F@{B15F}} -\doxysubsubsection{\texorpdfstring{digitalRead1()}{digitalRead1()}} -{\footnotesize\ttfamily uint8\+\_\+t B15\+F\+::digital\+Read1 (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption})} - -Liest den Wert des digitalen Eingabeports 1 \begin{DoxyReturn}{Returns} -Wert für gesamten Port -\end{DoxyReturn} - -\begin{DoxyExceptions}{Exceptions} -{\em \mbox{\hyperlink{classDriverException}{Driver\+Exception}}} & \\ -\hline -\end{DoxyExceptions} - - -Definition at line 181 of file b15f.\+cpp. - -\mbox{\Hypertarget{classB15F_a13797edea1c50278988373acbd110064}\label{classB15F_a13797edea1c50278988373acbd110064}} -\index{B15F@{B15F}!digitalWrite0@{digitalWrite0}} -\index{digitalWrite0@{digitalWrite0}!B15F@{B15F}} -\doxysubsubsection{\texorpdfstring{digitalWrite0()}{digitalWrite0()}} -{\footnotesize\ttfamily bool B15\+F\+::digital\+Write0 (\begin{DoxyParamCaption}\item[{uint8\+\_\+t}]{port }\end{DoxyParamCaption})} - -Setzt den Wert des digitalen Ausgabeports 0 -\begin{DoxyParams}{Parameters} -{\em port} & Wert für gesamten Port \\ -\hline -\end{DoxyParams} - -\begin{DoxyExceptions}{Exceptions} -{\em \mbox{\hyperlink{classDriverException}{Driver\+Exception}}} & \\ -\hline -\end{DoxyExceptions} - - -Definition at line 152 of file b15f.\+cpp. - -\mbox{\Hypertarget{classB15F_aa225e7fc813849634063e071ef25db1b}\label{classB15F_aa225e7fc813849634063e071ef25db1b}} -\index{B15F@{B15F}!digitalWrite1@{digitalWrite1}} -\index{digitalWrite1@{digitalWrite1}!B15F@{B15F}} -\doxysubsubsection{\texorpdfstring{digitalWrite1()}{digitalWrite1()}} -{\footnotesize\ttfamily bool B15\+F\+::digital\+Write1 (\begin{DoxyParamCaption}\item[{uint8\+\_\+t}]{port }\end{DoxyParamCaption})} - -Setzt den Wert des digitalen Ausgabeports 1 -\begin{DoxyParams}{Parameters} -{\em port} & Wert für gesamten Port \\ -\hline -\end{DoxyParams} - -\begin{DoxyExceptions}{Exceptions} -{\em \mbox{\hyperlink{classDriverException}{Driver\+Exception}}} & \\ -\hline -\end{DoxyExceptions} - - -Definition at line 162 of file b15f.\+cpp. - -\mbox{\Hypertarget{classB15F_ae4740cd473f40a1a4121dfa66b25e1d5}\label{classB15F_ae4740cd473f40a1a4121dfa66b25e1d5}} -\index{B15F@{B15F}!discard@{discard}} -\index{discard@{discard}!B15F@{B15F}} -\doxysubsubsection{\texorpdfstring{discard()}{discard()}} -{\footnotesize\ttfamily void B15\+F\+::discard (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption})} - -Verwirft Daten im \mbox{\hyperlink{classUSART}{U\+S\+A\+RT}} Puffer auf dieser Maschine und B15 -\begin{DoxyExceptions}{Exceptions} -{\em \mbox{\hyperlink{classDriverException}{Driver\+Exception}}} & \\ -\hline -\end{DoxyExceptions} - - -Definition at line 72 of file b15f.\+cpp. - -\mbox{\Hypertarget{classB15F_a1a7ac52984ed7ecac008a3e4060eee3a}\label{classB15F_a1a7ac52984ed7ecac008a3e4060eee3a}} -\index{B15F@{B15F}!exec@{exec}} -\index{exec@{exec}!B15F@{B15F}} -\doxysubsubsection{\texorpdfstring{exec()}{exec()}} -{\footnotesize\ttfamily std\+::string B15\+F\+::exec (\begin{DoxyParamCaption}\item[{std\+::string}]{cmd }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [static]}} - -Führt ein Befehl auf dieser Maschine aus und liefert stdout zurück -\begin{DoxyParams}{Parameters} -{\em cmd} & Der Befehl \\ -\hline -\end{DoxyParams} - - -Definition at line 309 of file b15f.\+cpp. - -\mbox{\Hypertarget{classB15F_a4f01677e73d6d172a2c1cae9427a591b}\label{classB15F_a4f01677e73d6d172a2c1cae9427a591b}} -\index{B15F@{B15F}!getBoardInfo@{getBoardInfo}} -\index{getBoardInfo@{getBoardInfo}!B15F@{B15F}} -\doxysubsubsection{\texorpdfstring{getBoardInfo()}{getBoardInfo()}} -{\footnotesize\ttfamily std\+::vector$<$ std\+::string $>$ B15\+F\+::get\+Board\+Info (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption})} - -Liefert Informationen zur aktuellen Firmware des B15 -\begin{DoxyExceptions}{Exceptions} -{\em \mbox{\hyperlink{classDriverException}{Driver\+Exception}}} & \\ -\hline -\end{DoxyExceptions} - - -Definition at line 118 of file b15f.\+cpp. - -\mbox{\Hypertarget{classB15F_a8b4533d232c55ef2aa967e39e2d23380}\label{classB15F_a8b4533d232c55ef2aa967e39e2d23380}} -\index{B15F@{B15F}!getInstance@{getInstance}} -\index{getInstance@{getInstance}!B15F@{B15F}} -\doxysubsubsection{\texorpdfstring{getInstance()}{getInstance()}} -{\footnotesize\ttfamily \mbox{\hyperlink{classB15F}{B15F}} \& B15\+F\+::get\+Instance (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [static]}} - -Liefert eine Referenz zur aktuellen Treiber-\/\+Instanz -\begin{DoxyExceptions}{Exceptions} -{\em \mbox{\hyperlink{classDriverException}{Driver\+Exception}}} & \\ -\hline -\end{DoxyExceptions} - - -Definition at line 300 of file b15f.\+cpp. - -\mbox{\Hypertarget{classB15F_a74d8cca6edbb4e24a2f760829b3742a5}\label{classB15F_a74d8cca6edbb4e24a2f760829b3742a5}} -\index{B15F@{B15F}!init@{init}} -\index{init@{init}!B15F@{B15F}} -\doxysubsubsection{\texorpdfstring{init()}{init()}} -{\footnotesize\ttfamily void B15\+F\+::init (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption})} - -Initialisiert und testet die Verbindung zum B15 -\begin{DoxyExceptions}{Exceptions} -{\em \mbox{\hyperlink{classDriverException}{Driver\+Exception}}} & \\ -\hline -\end{DoxyExceptions} - - -Definition at line 11 of file b15f.\+cpp. - -\mbox{\Hypertarget{classB15F_a6f858f21ea81d491b5031b3644a2239a}\label{classB15F_a6f858f21ea81d491b5031b3644a2239a}} -\index{B15F@{B15F}!readDipSwitch@{readDipSwitch}} -\index{readDipSwitch@{readDipSwitch}!B15F@{B15F}} -\doxysubsubsection{\texorpdfstring{readDipSwitch()}{readDipSwitch()}} -{\footnotesize\ttfamily uint8\+\_\+t B15\+F\+::read\+Dip\+Switch (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption})} - -Liest den Wert des digitalen Eingabeports, an dem der D\+I\+P-\/switch angeschlossen ist (S7) \begin{DoxyReturn}{Returns} -Wert für gesamten Port -\end{DoxyReturn} - -\begin{DoxyExceptions}{Exceptions} -{\em \mbox{\hyperlink{classDriverException}{Driver\+Exception}}} & \\ -\hline -\end{DoxyExceptions} - - -Definition at line 190 of file b15f.\+cpp. - -\mbox{\Hypertarget{classB15F_a52557b375443c180a044e7d4e80a1ae7}\label{classB15F_a52557b375443c180a044e7d4e80a1ae7}} -\index{B15F@{B15F}!reconnect@{reconnect}} -\index{reconnect@{reconnect}!B15F@{B15F}} -\doxysubsubsection{\texorpdfstring{reconnect()}{reconnect()}} -{\footnotesize\ttfamily void B15\+F\+::reconnect (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption})} - -Versucht die Verbindung zum B15 wiederherzustellen -\begin{DoxyExceptions}{Exceptions} -{\em \mbox{\hyperlink{classDriverException}{Driver\+Exception}}} & \\ -\hline -\end{DoxyExceptions} - - -Definition at line 57 of file b15f.\+cpp. - -\mbox{\Hypertarget{classB15F_a55b0cd1ea582bda53d6979442640f8e9}\label{classB15F_a55b0cd1ea582bda53d6979442640f8e9}} -\index{B15F@{B15F}!setAbortHandler@{setAbortHandler}} -\index{setAbortHandler@{setAbortHandler}!B15F@{B15F}} -\doxysubsubsection{\texorpdfstring{setAbortHandler()}{setAbortHandler()}} -{\footnotesize\ttfamily void B15\+F\+::set\+Abort\+Handler (\begin{DoxyParamCaption}\item[{errorhandler\+\_\+t}]{func }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [static]}} - -Setzt eine Fehlerbehandlungsroutine für den Treiberabbruch (abort) -\begin{DoxyParams}{Parameters} -{\em func} & Funktion, die Exception als Parameter bekommt \\ -\hline -\end{DoxyParams} - - -Definition at line 339 of file b15f.\+cpp. - -\mbox{\Hypertarget{classB15F_af01983594f2af98ab2b1e514aa036a5d}\label{classB15F_af01983594f2af98ab2b1e514aa036a5d}} -\index{B15F@{B15F}!testConnection@{testConnection}} -\index{testConnection@{testConnection}!B15F@{B15F}} -\doxysubsubsection{\texorpdfstring{testConnection()}{testConnection()}} -{\footnotesize\ttfamily bool B15\+F\+::test\+Connection (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption})} - -Testet die \mbox{\hyperlink{classUSART}{U\+S\+A\+RT}} Verbindung auf Funktion -\begin{DoxyExceptions}{Exceptions} -{\em \mbox{\hyperlink{classDriverException}{Driver\+Exception}}} & \\ -\hline -\end{DoxyExceptions} - - -Definition at line 90 of file b15f.\+cpp. - -\mbox{\Hypertarget{classB15F_a7b8a0e2a9156f7dcb05d097f23666a78}\label{classB15F_a7b8a0e2a9156f7dcb05d097f23666a78}} -\index{B15F@{B15F}!testIntConv@{testIntConv}} -\index{testIntConv@{testIntConv}!B15F@{B15F}} -\doxysubsubsection{\texorpdfstring{testIntConv()}{testIntConv()}} -{\footnotesize\ttfamily bool B15\+F\+::test\+Int\+Conv (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption})} - -Testet die Integer Konvertierung der \mbox{\hyperlink{classUSART}{U\+S\+A\+RT}} Verbindung -\begin{DoxyExceptions}{Exceptions} -{\em \mbox{\hyperlink{classDriverException}{Driver\+Exception}}} & \\ -\hline -\end{DoxyExceptions} - - -Definition at line 105 of file b15f.\+cpp. - - - -The documentation for this class was generated from the following files\+:\begin{DoxyCompactItemize} -\item -/home/famulus/\+Dokumente/b15f/control/src/drv/b15f.\+h\item -/home/famulus/\+Dokumente/b15f/control/src/drv/b15f.\+cpp\end{DoxyCompactItemize} diff --git a/docs/latex/classDot.tex b/docs/latex/classDot.tex deleted file mode 100644 index 6e72100..0000000 --- a/docs/latex/classDot.tex +++ /dev/null @@ -1,30 +0,0 @@ -\hypertarget{classDot}{}\doxysection{Dot Class Reference} -\label{classDot}\index{Dot@{Dot}} -\doxysubsection*{Public Member Functions} -\begin{DoxyCompactItemize} -\item -\mbox{\Hypertarget{classDot_ad975f119c0627a928790b3cd5ca6da05}\label{classDot_ad975f119c0627a928790b3cd5ca6da05}} -{\bfseries Dot} (uint16\+\_\+t x, uint16\+\_\+t y, uint8\+\_\+t curve) -\item -\mbox{\Hypertarget{classDot_a029f0cc99c474122b77a708a317e7f77}\label{classDot_a029f0cc99c474122b77a708a317e7f77}} -uint16\+\_\+t {\bfseries getX} (void) const -\item -\mbox{\Hypertarget{classDot_a8fcb987e6308d8184d1a2c8692227e58}\label{classDot_a8fcb987e6308d8184d1a2c8692227e58}} -uint16\+\_\+t {\bfseries getY} (void) const -\item -\mbox{\Hypertarget{classDot_ad0ae7dc1a9be3d8d985affc089b34396}\label{classDot_ad0ae7dc1a9be3d8d985affc089b34396}} -uint8\+\_\+t {\bfseries get\+Curve} (void) const -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} - - -Definition at line 7 of file dot.\+h. - - - -The documentation for this class was generated from the following files\+:\begin{DoxyCompactItemize} -\item -/home/famulus/\+Dokumente/b15f/control/src/drv/dot.\+h\item -/home/famulus/\+Dokumente/b15f/control/src/drv/dot.\+cpp\end{DoxyCompactItemize} diff --git a/docs/latex/classDriverException.eps b/docs/latex/classDriverException.eps deleted file mode 100644 index 9948080..0000000 --- a/docs/latex/classDriverException.eps +++ /dev/null @@ -1,197 +0,0 @@ -%!PS-Adobe-2.0 EPSF-2.0 -%%Title: ClassName -%%Creator: Doxygen -%%CreationDate: Time -%%For: -%Magnification: 1.00 -%%Orientation: Portrait -%%BoundingBox: 0 0 500 360.360360 -%%Pages: 0 -%%BeginSetup -%%EndSetup -%%EndComments - -% ----- variables ----- - -/boxwidth 0 def -/boxheight 40 def -/fontheight 24 def -/marginwidth 10 def -/distx 20 def -/disty 40 def -/boundaspect 1.387500 def % aspect ratio of the BoundingBox (width/height) -/boundx 500 def -/boundy boundx boundaspect div def -/xspacing 0 def -/yspacing 0 def -/rows 2 def -/cols 1 def -/scalefactor 0 def -/boxfont /Times-Roman findfont fontheight scalefont def - -% ----- procedures ----- - -/dotted { [1 4] 0 setdash } def -/dashed { [5] 0 setdash } def -/solid { [] 0 setdash } def - -/max % result = MAX(arg1,arg2) -{ - /a exch def - /b exch def - a b gt {a} {b} ifelse -} def - -/xoffset % result = MAX(0,(scalefactor-(boxwidth*cols+distx*(cols-1)))/2) -{ - 0 scalefactor boxwidth cols mul distx cols 1 sub mul add sub 2 div max -} def - -/cw % boxwidth = MAX(boxwidth, stringwidth(arg1)) -{ - /str exch def - /boxwidth boxwidth str stringwidth pop max def -} def - -/box % draws a box with text `arg1' at grid pos (arg2,arg3) -{ gsave - 2 setlinewidth - newpath - exch xspacing mul xoffset add - exch yspacing mul - moveto - boxwidth 0 rlineto - 0 boxheight rlineto - boxwidth neg 0 rlineto - 0 boxheight neg rlineto - closepath - dup stringwidth pop neg boxwidth add 2 div - boxheight fontheight 2 div sub 2 div - rmoveto show stroke - grestore -} def - -/mark -{ newpath - exch xspacing mul xoffset add boxwidth add - exch yspacing mul - moveto - 0 boxheight 4 div rlineto - boxheight neg 4 div boxheight neg 4 div rlineto - closepath - eofill - stroke -} def - -/arrow -{ newpath - moveto - 3 -8 rlineto - -6 0 rlineto - 3 8 rlineto - closepath - eofill - stroke -} def - -/out % draws an output connector for the block at (arg1,arg2) -{ - newpath - exch xspacing mul xoffset add boxwidth 2 div add - exch yspacing mul boxheight add - /y exch def - /x exch def - x y moveto - 0 disty 2 div rlineto - stroke - 1 eq { x y disty 2 div add arrow } if -} def - -/in % draws an input connector for the block at (arg1,arg2) -{ - newpath - exch xspacing mul xoffset add boxwidth 2 div add - exch yspacing mul disty 2 div sub - /y exch def - /x exch def - x y moveto - 0 disty 2 div rlineto - stroke - 1 eq { x y disty 2 div add arrow } if -} def - -/hedge -{ - exch xspacing mul xoffset add boxwidth 2 div add - exch yspacing mul boxheight 2 div sub - /y exch def - /x exch def - newpath - x y moveto - boxwidth 2 div distx add 0 rlineto - stroke - 1 eq - { newpath x boxwidth 2 div distx add add y moveto - -8 3 rlineto - 0 -6 rlineto - 8 3 rlineto - closepath - eofill - stroke - } if -} def - -/vedge -{ - /ye exch def - /ys exch def - /xs exch def - newpath - xs xspacing mul xoffset add boxwidth 2 div add dup - ys yspacing mul boxheight 2 div sub - moveto - ye yspacing mul boxheight 2 div sub - lineto - stroke -} def - -/conn % connections the blocks from col `arg1' to `arg2' of row `arg3' -{ - /ys exch def - /xe exch def - /xs exch def - newpath - xs xspacing mul xoffset add boxwidth 2 div add - ys yspacing mul disty 2 div sub - moveto - xspacing xe xs sub mul 0 - rlineto - stroke -} def - -% ----- main ------ - -boxfont setfont -1 boundaspect scale -(DriverException) cw -(exception) cw -/boxwidth boxwidth marginwidth 2 mul add def -/xspacing boxwidth distx add def -/yspacing boxheight disty add def -/scalefactor - boxwidth cols mul distx cols 1 sub mul add - boxheight rows mul disty rows 1 sub mul add boundaspect mul - max def -boundx scalefactor div boundy scalefactor div scale - -% ----- classes ----- - - (DriverException) 0.000000 0.000000 box - (exception) 0.000000 1.000000 box - -% ----- relations ----- - -solid -0 0.000000 0.000000 out -solid -1 0.000000 1.000000 in diff --git a/docs/latex/classDriverException.tex b/docs/latex/classDriverException.tex deleted file mode 100644 index 324d2fd..0000000 --- a/docs/latex/classDriverException.tex +++ /dev/null @@ -1,38 +0,0 @@ -\hypertarget{classDriverException}{}\doxysection{Driver\+Exception Class Reference} -\label{classDriverException}\index{DriverException@{DriverException}} -Inheritance diagram for Driver\+Exception\+:\begin{figure}[H] -\begin{center} -\leavevmode -\includegraphics[height=2.000000cm]{classDriverException} -\end{center} -\end{figure} -\doxysubsection*{Public Member Functions} -\begin{DoxyCompactItemize} -\item -\mbox{\Hypertarget{classDriverException_a6dcc078e6bfb7d87b53a5aef758cfe5f}\label{classDriverException_a6dcc078e6bfb7d87b53a5aef758cfe5f}} -{\bfseries Driver\+Exception} (const char $\ast$message) -\item -\mbox{\Hypertarget{classDriverException_abf7f902d3fbbfcdbde8e54a058948519}\label{classDriverException_abf7f902d3fbbfcdbde8e54a058948519}} -{\bfseries Driver\+Exception} (const std\+::string \&message) -\item -\mbox{\Hypertarget{classDriverException_a781362760bcd75b1bd5448629df58446}\label{classDriverException_a781362760bcd75b1bd5448629df58446}} -virtual const char $\ast$ {\bfseries what} () const throw () -\end{DoxyCompactItemize} -\doxysubsection*{Protected Attributes} -\begin{DoxyCompactItemize} -\item -\mbox{\Hypertarget{classDriverException_ab8777afe3f5aed2e66f2b2fcb480a651}\label{classDriverException_ab8777afe3f5aed2e66f2b2fcb480a651}} -std\+::string {\bfseries msg\+\_\+} -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} - - -Definition at line 8 of file driverexception.\+h. - - - -The documentation for this class was generated from the following file\+:\begin{DoxyCompactItemize} -\item -/home/famulus/\+Dokumente/b15f/control/src/drv/driverexception.\+h\end{DoxyCompactItemize} diff --git a/docs/latex/classPlottyFile.tex b/docs/latex/classPlottyFile.tex deleted file mode 100644 index 77d263d..0000000 --- a/docs/latex/classPlottyFile.tex +++ /dev/null @@ -1,102 +0,0 @@ -\hypertarget{classPlottyFile}{}\doxysection{Plotty\+File Class Reference} -\label{classPlottyFile}\index{PlottyFile@{PlottyFile}} -\doxysubsection*{Public Member Functions} -\begin{DoxyCompactItemize} -\item -\mbox{\Hypertarget{classPlottyFile_ae091e6eaaca16302f17572ac7dec6f7c}\label{classPlottyFile_ae091e6eaaca16302f17572ac7dec6f7c}} -void {\bfseries add\+Dot} (\mbox{\hyperlink{classDot}{Dot}} \&dot) -\item -\mbox{\Hypertarget{classPlottyFile_a80e4b45219b4e9571992edfc28a28568}\label{classPlottyFile_a80e4b45219b4e9571992edfc28a28568}} -void {\bfseries add\+Dot} (\mbox{\hyperlink{classDot}{Dot}} dot) -\item -\mbox{\Hypertarget{classPlottyFile_a189d8cfd0ae81a62ecf620279e07b966}\label{classPlottyFile_a189d8cfd0ae81a62ecf620279e07b966}} -void {\bfseries set\+Function\+Type} (Function\+Type) -\item -\mbox{\Hypertarget{classPlottyFile_ad7cc60f268d34bbb5d672a4171c75604}\label{classPlottyFile_ad7cc60f268d34bbb5d672a4171c75604}} -void {\bfseries set\+Quadrant} (uint8\+\_\+t) -\item -\mbox{\Hypertarget{classPlottyFile_afc019b323200923c2f02f9156fd29e6a}\label{classPlottyFile_afc019b323200923c2f02f9156fd29e6a}} -void {\bfseries set\+RefX} (uint16\+\_\+t) -\item -\mbox{\Hypertarget{classPlottyFile_aff7a9b1fa247588e1740e719ea19222f}\label{classPlottyFile_aff7a9b1fa247588e1740e719ea19222f}} -void {\bfseries set\+RefY} (uint16\+\_\+t) -\item -\mbox{\Hypertarget{classPlottyFile_ae24cfd5c953e7726f6140a65c989a635}\label{classPlottyFile_ae24cfd5c953e7726f6140a65c989a635}} -void {\bfseries set\+Para\+First\+Curve} (uint16\+\_\+t) -\item -\mbox{\Hypertarget{classPlottyFile_a5bba6acb78ae3fbbf35375c063690b6e}\label{classPlottyFile_a5bba6acb78ae3fbbf35375c063690b6e}} -void {\bfseries set\+Para\+Step\+Width} (uint16\+\_\+t) -\item -\mbox{\Hypertarget{classPlottyFile_a040a05b4f606c7bf904be149c039452f}\label{classPlottyFile_a040a05b4f606c7bf904be149c039452f}} -void {\bfseries set\+UnitX} (std\+::string) -\item -\mbox{\Hypertarget{classPlottyFile_ada0b074e2248b1a710d5df33ebfbc8d1}\label{classPlottyFile_ada0b074e2248b1a710d5df33ebfbc8d1}} -void {\bfseries set\+DescX} (std\+::string) -\item -\mbox{\Hypertarget{classPlottyFile_a7b41356b1d3fac9f864785f70cbf9c57}\label{classPlottyFile_a7b41356b1d3fac9f864785f70cbf9c57}} -void {\bfseries set\+UnitY} (std\+::string) -\item -\mbox{\Hypertarget{classPlottyFile_a9249d341c81f6c3b8dd02ba2459e6507}\label{classPlottyFile_a9249d341c81f6c3b8dd02ba2459e6507}} -void {\bfseries set\+DescY} (std\+::string) -\item -\mbox{\Hypertarget{classPlottyFile_a35bf02fb23f01ba0a1c3f480b69ed46d}\label{classPlottyFile_a35bf02fb23f01ba0a1c3f480b69ed46d}} -void {\bfseries set\+Unit\+Para} (std\+::string) -\item -\mbox{\Hypertarget{classPlottyFile_af617e3a349f18368e216c977da4017bc}\label{classPlottyFile_af617e3a349f18368e216c977da4017bc}} -void {\bfseries set\+Desc\+Para} (std\+::string) -\item -\mbox{\Hypertarget{classPlottyFile_a88bb7d8350ed5fbc7a40e8d903c94bdb}\label{classPlottyFile_a88bb7d8350ed5fbc7a40e8d903c94bdb}} -Function\+Type {\bfseries get\+Function\+Type} (void) const -\item -\mbox{\Hypertarget{classPlottyFile_a54e94e80061a27614f2d4d63697d3376}\label{classPlottyFile_a54e94e80061a27614f2d4d63697d3376}} -uint8\+\_\+t {\bfseries get\+Quadrant} (void) const -\item -\mbox{\Hypertarget{classPlottyFile_a7dd84b9f0826f3220fc6b5a4f1ce9890}\label{classPlottyFile_a7dd84b9f0826f3220fc6b5a4f1ce9890}} -uint16\+\_\+t {\bfseries get\+RefX} (void) const -\item -\mbox{\Hypertarget{classPlottyFile_ae6650c61a3b1a610ce716253418bd7f2}\label{classPlottyFile_ae6650c61a3b1a610ce716253418bd7f2}} -uint16\+\_\+t {\bfseries get\+RefY} (void) const -\item -\mbox{\Hypertarget{classPlottyFile_a40828c93d66fe80166c4f603d5bdfa48}\label{classPlottyFile_a40828c93d66fe80166c4f603d5bdfa48}} -uint16\+\_\+t {\bfseries get\+Para\+First\+Curve} (void) const -\item -\mbox{\Hypertarget{classPlottyFile_a9da23f2bb8e6eb1837fc992ffd4057db}\label{classPlottyFile_a9da23f2bb8e6eb1837fc992ffd4057db}} -uint16\+\_\+t {\bfseries get\+Para\+Step\+Width} (void) const -\item -\mbox{\Hypertarget{classPlottyFile_af952ac5e2c40896acaf6a86063874fe3}\label{classPlottyFile_af952ac5e2c40896acaf6a86063874fe3}} -std\+::string {\bfseries get\+UnitX} (void) const -\item -\mbox{\Hypertarget{classPlottyFile_a9cf7baa569be308c2cf6e07cadded09d}\label{classPlottyFile_a9cf7baa569be308c2cf6e07cadded09d}} -std\+::string {\bfseries get\+DescX} (void) const -\item -\mbox{\Hypertarget{classPlottyFile_a746b96036872dbece204e9739f3413b6}\label{classPlottyFile_a746b96036872dbece204e9739f3413b6}} -std\+::string {\bfseries get\+UnitY} (void) const -\item -\mbox{\Hypertarget{classPlottyFile_ab4a847fd71a804182f211233e194df45}\label{classPlottyFile_ab4a847fd71a804182f211233e194df45}} -std\+::string {\bfseries get\+DescY} (void) const -\item -\mbox{\Hypertarget{classPlottyFile_abcda4139adf8c5ab8a93b13b84ac097c}\label{classPlottyFile_abcda4139adf8c5ab8a93b13b84ac097c}} -std\+::string {\bfseries get\+Unit\+Para} (void) const -\item -\mbox{\Hypertarget{classPlottyFile_a536967daae3b382a5d6575f55450e198}\label{classPlottyFile_a536967daae3b382a5d6575f55450e198}} -std\+::string {\bfseries get\+Desc\+Para} (void) const -\item -\mbox{\Hypertarget{classPlottyFile_a82c348e7fade2edcbc907e7c2bc2e305}\label{classPlottyFile_a82c348e7fade2edcbc907e7c2bc2e305}} -void {\bfseries write\+To\+File} (std\+::string filename) -\item -\mbox{\Hypertarget{classPlottyFile_a08a115ef10458cadfe76077d623313df}\label{classPlottyFile_a08a115ef10458cadfe76077d623313df}} -void {\bfseries start\+Plotty} (std\+::string filename) -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} - - -Definition at line 17 of file plottyfile.\+h. - - - -The documentation for this class was generated from the following files\+:\begin{DoxyCompactItemize} -\item -/home/famulus/\+Dokumente/b15f/control/src/drv/plottyfile.\+h\item -/home/famulus/\+Dokumente/b15f/control/src/drv/plottyfile.\+cpp\end{DoxyCompactItemize} diff --git a/docs/latex/classTimeoutException.eps b/docs/latex/classTimeoutException.eps deleted file mode 100644 index 68c321d..0000000 --- a/docs/latex/classTimeoutException.eps +++ /dev/null @@ -1,197 +0,0 @@ -%!PS-Adobe-2.0 EPSF-2.0 -%%Title: ClassName -%%Creator: Doxygen -%%CreationDate: Time -%%For: -%Magnification: 1.00 -%%Orientation: Portrait -%%BoundingBox: 0 0 500 338.983051 -%%Pages: 0 -%%BeginSetup -%%EndSetup -%%EndComments - -% ----- variables ----- - -/boxwidth 0 def -/boxheight 40 def -/fontheight 24 def -/marginwidth 10 def -/distx 20 def -/disty 40 def -/boundaspect 1.475000 def % aspect ratio of the BoundingBox (width/height) -/boundx 500 def -/boundy boundx boundaspect div def -/xspacing 0 def -/yspacing 0 def -/rows 2 def -/cols 1 def -/scalefactor 0 def -/boxfont /Times-Roman findfont fontheight scalefont def - -% ----- procedures ----- - -/dotted { [1 4] 0 setdash } def -/dashed { [5] 0 setdash } def -/solid { [] 0 setdash } def - -/max % result = MAX(arg1,arg2) -{ - /a exch def - /b exch def - a b gt {a} {b} ifelse -} def - -/xoffset % result = MAX(0,(scalefactor-(boxwidth*cols+distx*(cols-1)))/2) -{ - 0 scalefactor boxwidth cols mul distx cols 1 sub mul add sub 2 div max -} def - -/cw % boxwidth = MAX(boxwidth, stringwidth(arg1)) -{ - /str exch def - /boxwidth boxwidth str stringwidth pop max def -} def - -/box % draws a box with text `arg1' at grid pos (arg2,arg3) -{ gsave - 2 setlinewidth - newpath - exch xspacing mul xoffset add - exch yspacing mul - moveto - boxwidth 0 rlineto - 0 boxheight rlineto - boxwidth neg 0 rlineto - 0 boxheight neg rlineto - closepath - dup stringwidth pop neg boxwidth add 2 div - boxheight fontheight 2 div sub 2 div - rmoveto show stroke - grestore -} def - -/mark -{ newpath - exch xspacing mul xoffset add boxwidth add - exch yspacing mul - moveto - 0 boxheight 4 div rlineto - boxheight neg 4 div boxheight neg 4 div rlineto - closepath - eofill - stroke -} def - -/arrow -{ newpath - moveto - 3 -8 rlineto - -6 0 rlineto - 3 8 rlineto - closepath - eofill - stroke -} def - -/out % draws an output connector for the block at (arg1,arg2) -{ - newpath - exch xspacing mul xoffset add boxwidth 2 div add - exch yspacing mul boxheight add - /y exch def - /x exch def - x y moveto - 0 disty 2 div rlineto - stroke - 1 eq { x y disty 2 div add arrow } if -} def - -/in % draws an input connector for the block at (arg1,arg2) -{ - newpath - exch xspacing mul xoffset add boxwidth 2 div add - exch yspacing mul disty 2 div sub - /y exch def - /x exch def - x y moveto - 0 disty 2 div rlineto - stroke - 1 eq { x y disty 2 div add arrow } if -} def - -/hedge -{ - exch xspacing mul xoffset add boxwidth 2 div add - exch yspacing mul boxheight 2 div sub - /y exch def - /x exch def - newpath - x y moveto - boxwidth 2 div distx add 0 rlineto - stroke - 1 eq - { newpath x boxwidth 2 div distx add add y moveto - -8 3 rlineto - 0 -6 rlineto - 8 3 rlineto - closepath - eofill - stroke - } if -} def - -/vedge -{ - /ye exch def - /ys exch def - /xs exch def - newpath - xs xspacing mul xoffset add boxwidth 2 div add dup - ys yspacing mul boxheight 2 div sub - moveto - ye yspacing mul boxheight 2 div sub - lineto - stroke -} def - -/conn % connections the blocks from col `arg1' to `arg2' of row `arg3' -{ - /ys exch def - /xe exch def - /xs exch def - newpath - xs xspacing mul xoffset add boxwidth 2 div add - ys yspacing mul disty 2 div sub - moveto - xspacing xe xs sub mul 0 - rlineto - stroke -} def - -% ----- main ------ - -boxfont setfont -1 boundaspect scale -(TimeoutException) cw -(exception) cw -/boxwidth boxwidth marginwidth 2 mul add def -/xspacing boxwidth distx add def -/yspacing boxheight disty add def -/scalefactor - boxwidth cols mul distx cols 1 sub mul add - boxheight rows mul disty rows 1 sub mul add boundaspect mul - max def -boundx scalefactor div boundy scalefactor div scale - -% ----- classes ----- - - (TimeoutException) 0.000000 0.000000 box - (exception) 0.000000 1.000000 box - -% ----- relations ----- - -solid -0 0.000000 0.000000 out -solid -1 0.000000 1.000000 in diff --git a/docs/latex/classTimeoutException.tex b/docs/latex/classTimeoutException.tex deleted file mode 100644 index cf0fa84..0000000 --- a/docs/latex/classTimeoutException.tex +++ /dev/null @@ -1,41 +0,0 @@ -\hypertarget{classTimeoutException}{}\doxysection{Timeout\+Exception Class Reference} -\label{classTimeoutException}\index{TimeoutException@{TimeoutException}} -Inheritance diagram for Timeout\+Exception\+:\begin{figure}[H] -\begin{center} -\leavevmode -\includegraphics[height=2.000000cm]{classTimeoutException} -\end{center} -\end{figure} -\doxysubsection*{Public Member Functions} -\begin{DoxyCompactItemize} -\item -\mbox{\Hypertarget{classTimeoutException_a33d1b23baf86d5481e1fe18db8a37c15}\label{classTimeoutException_a33d1b23baf86d5481e1fe18db8a37c15}} -{\bfseries Timeout\+Exception} (const char $\ast$message, int timeout) -\item -\mbox{\Hypertarget{classTimeoutException_a6c6f1372eaeab7dd2f4dec06cc1e8f8f}\label{classTimeoutException_a6c6f1372eaeab7dd2f4dec06cc1e8f8f}} -{\bfseries Timeout\+Exception} (const std\+::string \&message, int timeout) -\item -\mbox{\Hypertarget{classTimeoutException_a97eaf01fc39ddb94b060020b42fefd6e}\label{classTimeoutException_a97eaf01fc39ddb94b060020b42fefd6e}} -virtual const char $\ast$ {\bfseries what} () const throw () -\end{DoxyCompactItemize} -\doxysubsection*{Protected Attributes} -\begin{DoxyCompactItemize} -\item -\mbox{\Hypertarget{classTimeoutException_aa625fc0fae48a67737a98eafb91c9624}\label{classTimeoutException_aa625fc0fae48a67737a98eafb91c9624}} -std\+::string {\bfseries msg} -\item -\mbox{\Hypertarget{classTimeoutException_a00704ad4af4a07e6956949f633b5b161}\label{classTimeoutException_a00704ad4af4a07e6956949f633b5b161}} -int {\bfseries m\+\_\+timeout} -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} - - -Definition at line 8 of file timeoutexception.\+h. - - - -The documentation for this class was generated from the following file\+:\begin{DoxyCompactItemize} -\item -/home/famulus/\+Dokumente/b15f/control/src/drv/timeoutexception.\+h\end{DoxyCompactItemize} diff --git a/docs/latex/classUSART.tex b/docs/latex/classUSART.tex deleted file mode 100644 index e5e0aaa..0000000 --- a/docs/latex/classUSART.tex +++ /dev/null @@ -1,273 +0,0 @@ -\hypertarget{classUSART}{}\doxysection{U\+S\+A\+RT Class Reference} -\label{classUSART}\index{USART@{USART}} -\doxysubsection*{Public Member Functions} -\begin{DoxyCompactItemize} -\item -void \mbox{\hyperlink{classUSART_a5f7e2abda2ec4a68a5fdb8ee2f8a940a}{open\+Device}} (std\+::string device) -\item -void \mbox{\hyperlink{classUSART_af80d6291ac1d2df04cfa1d8d27458cc5}{close\+Device}} (void) -\item -void \mbox{\hyperlink{classUSART_a28a2b4c5ed66b2c3a81196f76884f156}{clear\+Input\+Buffer}} (void) -\item -void \mbox{\hyperlink{classUSART_a756d268a8762c316f91ca3238972b0c1}{clear\+Output\+Buffer}} (void) -\item -void \mbox{\hyperlink{classUSART_adb6ff4d1cf1af79ca255c5a81780200d}{flush\+Output\+Buffer}} (void) -\item -void \mbox{\hyperlink{classUSART_a33559bb8f0eda33a489d47b9c9227b59}{print\+Statistics}} (void) -\item -void \mbox{\hyperlink{classUSART_a60eadbe9956bab8144ee96d89eacd9f5}{write\+Byte}} (uint8\+\_\+t b) -\item -void \mbox{\hyperlink{classUSART_a78b30d9aa863f38745e982860392599a}{write\+Int}} (uint16\+\_\+t d) -\item -uint8\+\_\+t \mbox{\hyperlink{classUSART_a8f54b98b26bfe084359a5604bda82562}{read\+Byte}} (void) -\item -uint16\+\_\+t \mbox{\hyperlink{classUSART_a1534c229db71a375e556cf1e7d0b8119}{read\+Int}} (void) -\item -\mbox{\Hypertarget{classUSART_a7d024eae412c26c8026a19c23152fb15}\label{classUSART_a7d024eae412c26c8026a19c23152fb15}} -int {\bfseries read\+\_\+timeout} (uint8\+\_\+t $\ast$buffer, uint16\+\_\+t offset, uint8\+\_\+t len, uint32\+\_\+t timeout) -\item -\mbox{\Hypertarget{classUSART_abc38663b1be6af13dd6bc295b34b1f91}\label{classUSART_abc38663b1be6af13dd6bc295b34b1f91}} -int {\bfseries write\+\_\+timeout} (uint8\+\_\+t $\ast$buffer, uint16\+\_\+t offset, uint8\+\_\+t len, uint32\+\_\+t timeout) -\item -\mbox{\Hypertarget{classUSART_aa5380551953f95293287d93a3291e6f9}\label{classUSART_aa5380551953f95293287d93a3291e6f9}} -void {\bfseries write\+Block} (uint8\+\_\+t $\ast$buffer, uint16\+\_\+t offset, uint8\+\_\+t len) -\item -\mbox{\Hypertarget{classUSART_a6301a60df27ab1506ce8d64e3b061eb2}\label{classUSART_a6301a60df27ab1506ce8d64e3b061eb2}} -bool {\bfseries read\+Block} (uint8\+\_\+t $\ast$buffer, uint16\+\_\+t offset) -\item -uint32\+\_\+t \mbox{\hyperlink{classUSART_a4918672d8069df205378a528b1892db3}{get\+Baudrate}} (void) -\item -uint8\+\_\+t \mbox{\hyperlink{classUSART_a19cf777956a038878fc2d2b58c3d2b41}{get\+Timeout}} (void) -\item -void \mbox{\hyperlink{classUSART_aac63918a8b97ae63ee607cfa39e6d88d}{set\+Baudrate}} (uint32\+\_\+t baudrate) -\item -void \mbox{\hyperlink{classUSART_ad7fe866cebe920784d2b17602824c7ff}{set\+Timeout}} (uint8\+\_\+t timeout) -\end{DoxyCompactItemize} -\doxysubsection*{Static Public Attributes} -\begin{DoxyCompactItemize} -\item -\mbox{\Hypertarget{classUSART_a3401693a5b971f54a2bf177e9a8b55fd}\label{classUSART_a3401693a5b971f54a2bf177e9a8b55fd}} -constexpr static uint8\+\_\+t {\bfseries C\+R\+C7\+\_\+\+P\+O\+LY} = 0x91 -\item -\mbox{\Hypertarget{classUSART_a43cc131e2611437ed3c6c0448ba5ade5}\label{classUSART_a43cc131e2611437ed3c6c0448ba5ade5}} -constexpr static uint8\+\_\+t {\bfseries M\+A\+X\+\_\+\+B\+L\+O\+C\+K\+\_\+\+S\+I\+ZE} = 64 -\item -\mbox{\Hypertarget{classUSART_a19bfa88e843626b2d822361738cf0039}\label{classUSART_a19bfa88e843626b2d822361738cf0039}} -constexpr static uint8\+\_\+t {\bfseries B\+L\+O\+C\+K\+\_\+\+E\+ND} = 0x80 -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} - - -Definition at line 16 of file usart.\+h. - - - -\doxysubsection{Member Function Documentation} -\mbox{\Hypertarget{classUSART_a28a2b4c5ed66b2c3a81196f76884f156}\label{classUSART_a28a2b4c5ed66b2c3a81196f76884f156}} -\index{USART@{USART}!clearInputBuffer@{clearInputBuffer}} -\index{clearInputBuffer@{clearInputBuffer}!USART@{USART}} -\doxysubsubsection{\texorpdfstring{clearInputBuffer()}{clearInputBuffer()}} -{\footnotesize\ttfamily void U\+S\+A\+R\+T\+::clear\+Input\+Buffer (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption})} - -Verwirft Daten, die bereits im Puffer liegen, aber noch nicht gelesen wurden -\begin{DoxyExceptions}{Exceptions} -{\em \mbox{\hyperlink{classUSARTException}{U\+S\+A\+R\+T\+Exception}}} & \\ -\hline -\end{DoxyExceptions} - - -Definition at line 39 of file usart.\+cpp. - -\mbox{\Hypertarget{classUSART_a756d268a8762c316f91ca3238972b0c1}\label{classUSART_a756d268a8762c316f91ca3238972b0c1}} -\index{USART@{USART}!clearOutputBuffer@{clearOutputBuffer}} -\index{clearOutputBuffer@{clearOutputBuffer}!USART@{USART}} -\doxysubsubsection{\texorpdfstring{clearOutputBuffer()}{clearOutputBuffer()}} -{\footnotesize\ttfamily void U\+S\+A\+R\+T\+::clear\+Output\+Buffer (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption})} - -Verwirft Daten, die bereits im Puffer liegen, aber noch nicht gesendet wurden -\begin{DoxyExceptions}{Exceptions} -{\em \mbox{\hyperlink{classUSARTException}{U\+S\+A\+R\+T\+Exception}}} & \\ -\hline -\end{DoxyExceptions} - - -Definition at line 46 of file usart.\+cpp. - -\mbox{\Hypertarget{classUSART_af80d6291ac1d2df04cfa1d8d27458cc5}\label{classUSART_af80d6291ac1d2df04cfa1d8d27458cc5}} -\index{USART@{USART}!closeDevice@{closeDevice}} -\index{closeDevice@{closeDevice}!USART@{USART}} -\doxysubsubsection{\texorpdfstring{closeDevice()}{closeDevice()}} -{\footnotesize\ttfamily void U\+S\+A\+R\+T\+::close\+Device (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption})} - -Schließt die \mbox{\hyperlink{classUSART}{U\+S\+A\+RT}} Schnittstelle -\begin{DoxyExceptions}{Exceptions} -{\em \mbox{\hyperlink{classUSARTException}{U\+S\+A\+R\+T\+Exception}}} & \\ -\hline -\end{DoxyExceptions} - - -Definition at line 32 of file usart.\+cpp. - -\mbox{\Hypertarget{classUSART_adb6ff4d1cf1af79ca255c5a81780200d}\label{classUSART_adb6ff4d1cf1af79ca255c5a81780200d}} -\index{USART@{USART}!flushOutputBuffer@{flushOutputBuffer}} -\index{flushOutputBuffer@{flushOutputBuffer}!USART@{USART}} -\doxysubsubsection{\texorpdfstring{flushOutputBuffer()}{flushOutputBuffer()}} -{\footnotesize\ttfamily void U\+S\+A\+R\+T\+::flush\+Output\+Buffer (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption})} - -Schreibt Daten, die bereits im Puffer liegen, aber noch nicht gesendet wurden -\begin{DoxyExceptions}{Exceptions} -{\em \mbox{\hyperlink{classUSARTException}{U\+S\+A\+R\+T\+Exception}}} & \\ -\hline -\end{DoxyExceptions} - - -Definition at line 53 of file usart.\+cpp. - -\mbox{\Hypertarget{classUSART_a4918672d8069df205378a528b1892db3}\label{classUSART_a4918672d8069df205378a528b1892db3}} -\index{USART@{USART}!getBaudrate@{getBaudrate}} -\index{getBaudrate@{getBaudrate}!USART@{USART}} -\doxysubsubsection{\texorpdfstring{getBaudrate()}{getBaudrate()}} -{\footnotesize\ttfamily uint32\+\_\+t U\+S\+A\+R\+T\+::get\+Baudrate (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption})} - -Liefert die eingestellte Baudrate {\bfseries{Änderungen werden erst nach einem open() wirksam}} - -Definition at line 306 of file usart.\+cpp. - -\mbox{\Hypertarget{classUSART_a19cf777956a038878fc2d2b58c3d2b41}\label{classUSART_a19cf777956a038878fc2d2b58c3d2b41}} -\index{USART@{USART}!getTimeout@{getTimeout}} -\index{getTimeout@{getTimeout}!USART@{USART}} -\doxysubsubsection{\texorpdfstring{getTimeout()}{getTimeout()}} -{\footnotesize\ttfamily uint8\+\_\+t U\+S\+A\+R\+T\+::get\+Timeout (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption})} - -Liefert den eingestellten Timeout (in Dezisekunden) {\bfseries{Änderungen werden erst nach einem open() wirksam}} - -Definition at line 311 of file usart.\+cpp. - -\mbox{\Hypertarget{classUSART_a5f7e2abda2ec4a68a5fdb8ee2f8a940a}\label{classUSART_a5f7e2abda2ec4a68a5fdb8ee2f8a940a}} -\index{USART@{USART}!openDevice@{openDevice}} -\index{openDevice@{openDevice}!USART@{USART}} -\doxysubsubsection{\texorpdfstring{openDevice()}{openDevice()}} -{\footnotesize\ttfamily void U\+S\+A\+R\+T\+::open\+Device (\begin{DoxyParamCaption}\item[{std\+::string}]{device }\end{DoxyParamCaption})} - -Öffnet die \mbox{\hyperlink{classUSART}{U\+S\+A\+RT}} Schnittstelle -\begin{DoxyParams}{Parameters} -{\em device} & Linux-\/\+Gerätepfad \\ -\hline -\end{DoxyParams} - -\begin{DoxyExceptions}{Exceptions} -{\em \mbox{\hyperlink{classUSARTException}{U\+S\+A\+R\+T\+Exception}}} & \\ -\hline -\end{DoxyExceptions} - - -Definition at line 3 of file usart.\+cpp. - -\mbox{\Hypertarget{classUSART_a33559bb8f0eda33a489d47b9c9227b59}\label{classUSART_a33559bb8f0eda33a489d47b9c9227b59}} -\index{USART@{USART}!printStatistics@{printStatistics}} -\index{printStatistics@{printStatistics}!USART@{USART}} -\doxysubsubsection{\texorpdfstring{printStatistics()}{printStatistics()}} -{\footnotesize\ttfamily void U\+S\+A\+R\+T\+::print\+Statistics (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption})} - -Gibt Anzahl an erfolgreichen und fehlgeschlagenen Block-\/Übertragungen an - -Definition at line 60 of file usart.\+cpp. - -\mbox{\Hypertarget{classUSART_a8f54b98b26bfe084359a5604bda82562}\label{classUSART_a8f54b98b26bfe084359a5604bda82562}} -\index{USART@{USART}!readByte@{readByte}} -\index{readByte@{readByte}!USART@{USART}} -\doxysubsubsection{\texorpdfstring{readByte()}{readByte()}} -{\footnotesize\ttfamily uint8\+\_\+t U\+S\+A\+R\+T\+::read\+Byte (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption})} - -Empfängt ein Byte über die \mbox{\hyperlink{classUSART}{U\+S\+A\+RT}} Schnittstelle -\begin{DoxyExceptions}{Exceptions} -{\em \mbox{\hyperlink{classUSARTException}{U\+S\+A\+R\+T\+Exception}}} & \\ -\hline -\end{DoxyExceptions} - - -Definition at line 210 of file usart.\+cpp. - -\mbox{\Hypertarget{classUSART_a1534c229db71a375e556cf1e7d0b8119}\label{classUSART_a1534c229db71a375e556cf1e7d0b8119}} -\index{USART@{USART}!readInt@{readInt}} -\index{readInt@{readInt}!USART@{USART}} -\doxysubsubsection{\texorpdfstring{readInt()}{readInt()}} -{\footnotesize\ttfamily uint16\+\_\+t U\+S\+A\+R\+T\+::read\+Int (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption})} - -Empfängt ein Integer über die \mbox{\hyperlink{classUSART}{U\+S\+A\+RT}} Schnittstelle -\begin{DoxyExceptions}{Exceptions} -{\em \mbox{\hyperlink{classUSARTException}{U\+S\+A\+R\+T\+Exception}}} & \\ -\hline -\end{DoxyExceptions} - - -Definition at line 229 of file usart.\+cpp. - -\mbox{\Hypertarget{classUSART_aac63918a8b97ae63ee607cfa39e6d88d}\label{classUSART_aac63918a8b97ae63ee607cfa39e6d88d}} -\index{USART@{USART}!setBaudrate@{setBaudrate}} -\index{setBaudrate@{setBaudrate}!USART@{USART}} -\doxysubsubsection{\texorpdfstring{setBaudrate()}{setBaudrate()}} -{\footnotesize\ttfamily void U\+S\+A\+R\+T\+::set\+Baudrate (\begin{DoxyParamCaption}\item[{uint32\+\_\+t}]{baudrate }\end{DoxyParamCaption})} - -Setzt die Baudrate {\bfseries{Änderungen werden erst nach einem open() wirksam}} - -Definition at line 316 of file usart.\+cpp. - -\mbox{\Hypertarget{classUSART_ad7fe866cebe920784d2b17602824c7ff}\label{classUSART_ad7fe866cebe920784d2b17602824c7ff}} -\index{USART@{USART}!setTimeout@{setTimeout}} -\index{setTimeout@{setTimeout}!USART@{USART}} -\doxysubsubsection{\texorpdfstring{setTimeout()}{setTimeout()}} -{\footnotesize\ttfamily void U\+S\+A\+R\+T\+::set\+Timeout (\begin{DoxyParamCaption}\item[{uint8\+\_\+t}]{timeout }\end{DoxyParamCaption})} - -Setzt den Timeout (in Dezisekunden) {\bfseries{Änderungen werden erst nach einem open() wirksam}} - -Definition at line 321 of file usart.\+cpp. - -\mbox{\Hypertarget{classUSART_a60eadbe9956bab8144ee96d89eacd9f5}\label{classUSART_a60eadbe9956bab8144ee96d89eacd9f5}} -\index{USART@{USART}!writeByte@{writeByte}} -\index{writeByte@{writeByte}!USART@{USART}} -\doxysubsubsection{\texorpdfstring{writeByte()}{writeByte()}} -{\footnotesize\ttfamily void U\+S\+A\+R\+T\+::write\+Byte (\begin{DoxyParamCaption}\item[{uint8\+\_\+t}]{b }\end{DoxyParamCaption})} - -Sendet ein Byte über die \mbox{\hyperlink{classUSART}{U\+S\+A\+RT}} Schnittstelle -\begin{DoxyParams}{Parameters} -{\em b} & das zu sendende Byte \\ -\hline -\end{DoxyParams} - -\begin{DoxyExceptions}{Exceptions} -{\em \mbox{\hyperlink{classUSARTException}{U\+S\+A\+R\+T\+Exception}}} & \\ -\hline -\end{DoxyExceptions} - - -Definition at line 67 of file usart.\+cpp. - -\mbox{\Hypertarget{classUSART_a78b30d9aa863f38745e982860392599a}\label{classUSART_a78b30d9aa863f38745e982860392599a}} -\index{USART@{USART}!writeInt@{writeInt}} -\index{writeInt@{writeInt}!USART@{USART}} -\doxysubsubsection{\texorpdfstring{writeInt()}{writeInt()}} -{\footnotesize\ttfamily void U\+S\+A\+R\+T\+::write\+Int (\begin{DoxyParamCaption}\item[{uint16\+\_\+t}]{d }\end{DoxyParamCaption})} - -Sendet ein Integer über die \mbox{\hyperlink{classUSART}{U\+S\+A\+RT}} Schnittstelle -\begin{DoxyParams}{Parameters} -{\em b} & das zu sendende Byte \\ -\hline -\end{DoxyParams} - -\begin{DoxyExceptions}{Exceptions} -{\em \mbox{\hyperlink{classUSARTException}{U\+S\+A\+R\+T\+Exception}}} & \\ -\hline -\end{DoxyExceptions} - - -Definition at line 81 of file usart.\+cpp. - - - -The documentation for this class was generated from the following files\+:\begin{DoxyCompactItemize} -\item -/home/famulus/\+Dokumente/b15f/control/src/drv/usart.\+h\item -/home/famulus/\+Dokumente/b15f/control/src/drv/usart.\+cpp\end{DoxyCompactItemize} diff --git a/docs/latex/classUSARTException.eps b/docs/latex/classUSARTException.eps deleted file mode 100644 index 965877a..0000000 --- a/docs/latex/classUSARTException.eps +++ /dev/null @@ -1,197 +0,0 @@ -%!PS-Adobe-2.0 EPSF-2.0 -%%Title: ClassName -%%Creator: Doxygen -%%CreationDate: Time -%%For: -%Magnification: 1.00 -%%Orientation: Portrait -%%BoundingBox: 0 0 500 347.826087 -%%Pages: 0 -%%BeginSetup -%%EndSetup -%%EndComments - -% ----- variables ----- - -/boxwidth 0 def -/boxheight 40 def -/fontheight 24 def -/marginwidth 10 def -/distx 20 def -/disty 40 def -/boundaspect 1.437500 def % aspect ratio of the BoundingBox (width/height) -/boundx 500 def -/boundy boundx boundaspect div def -/xspacing 0 def -/yspacing 0 def -/rows 2 def -/cols 1 def -/scalefactor 0 def -/boxfont /Times-Roman findfont fontheight scalefont def - -% ----- procedures ----- - -/dotted { [1 4] 0 setdash } def -/dashed { [5] 0 setdash } def -/solid { [] 0 setdash } def - -/max % result = MAX(arg1,arg2) -{ - /a exch def - /b exch def - a b gt {a} {b} ifelse -} def - -/xoffset % result = MAX(0,(scalefactor-(boxwidth*cols+distx*(cols-1)))/2) -{ - 0 scalefactor boxwidth cols mul distx cols 1 sub mul add sub 2 div max -} def - -/cw % boxwidth = MAX(boxwidth, stringwidth(arg1)) -{ - /str exch def - /boxwidth boxwidth str stringwidth pop max def -} def - -/box % draws a box with text `arg1' at grid pos (arg2,arg3) -{ gsave - 2 setlinewidth - newpath - exch xspacing mul xoffset add - exch yspacing mul - moveto - boxwidth 0 rlineto - 0 boxheight rlineto - boxwidth neg 0 rlineto - 0 boxheight neg rlineto - closepath - dup stringwidth pop neg boxwidth add 2 div - boxheight fontheight 2 div sub 2 div - rmoveto show stroke - grestore -} def - -/mark -{ newpath - exch xspacing mul xoffset add boxwidth add - exch yspacing mul - moveto - 0 boxheight 4 div rlineto - boxheight neg 4 div boxheight neg 4 div rlineto - closepath - eofill - stroke -} def - -/arrow -{ newpath - moveto - 3 -8 rlineto - -6 0 rlineto - 3 8 rlineto - closepath - eofill - stroke -} def - -/out % draws an output connector for the block at (arg1,arg2) -{ - newpath - exch xspacing mul xoffset add boxwidth 2 div add - exch yspacing mul boxheight add - /y exch def - /x exch def - x y moveto - 0 disty 2 div rlineto - stroke - 1 eq { x y disty 2 div add arrow } if -} def - -/in % draws an input connector for the block at (arg1,arg2) -{ - newpath - exch xspacing mul xoffset add boxwidth 2 div add - exch yspacing mul disty 2 div sub - /y exch def - /x exch def - x y moveto - 0 disty 2 div rlineto - stroke - 1 eq { x y disty 2 div add arrow } if -} def - -/hedge -{ - exch xspacing mul xoffset add boxwidth 2 div add - exch yspacing mul boxheight 2 div sub - /y exch def - /x exch def - newpath - x y moveto - boxwidth 2 div distx add 0 rlineto - stroke - 1 eq - { newpath x boxwidth 2 div distx add add y moveto - -8 3 rlineto - 0 -6 rlineto - 8 3 rlineto - closepath - eofill - stroke - } if -} def - -/vedge -{ - /ye exch def - /ys exch def - /xs exch def - newpath - xs xspacing mul xoffset add boxwidth 2 div add dup - ys yspacing mul boxheight 2 div sub - moveto - ye yspacing mul boxheight 2 div sub - lineto - stroke -} def - -/conn % connections the blocks from col `arg1' to `arg2' of row `arg3' -{ - /ys exch def - /xe exch def - /xs exch def - newpath - xs xspacing mul xoffset add boxwidth 2 div add - ys yspacing mul disty 2 div sub - moveto - xspacing xe xs sub mul 0 - rlineto - stroke -} def - -% ----- main ------ - -boxfont setfont -1 boundaspect scale -(USARTException) cw -(exception) cw -/boxwidth boxwidth marginwidth 2 mul add def -/xspacing boxwidth distx add def -/yspacing boxheight disty add def -/scalefactor - boxwidth cols mul distx cols 1 sub mul add - boxheight rows mul disty rows 1 sub mul add boundaspect mul - max def -boundx scalefactor div boundy scalefactor div scale - -% ----- classes ----- - - (USARTException) 0.000000 0.000000 box - (exception) 0.000000 1.000000 box - -% ----- relations ----- - -solid -0 0.000000 0.000000 out -solid -1 0.000000 1.000000 in diff --git a/docs/latex/classUSARTException.tex b/docs/latex/classUSARTException.tex deleted file mode 100644 index 16eecb0..0000000 --- a/docs/latex/classUSARTException.tex +++ /dev/null @@ -1,38 +0,0 @@ -\hypertarget{classUSARTException}{}\doxysection{U\+S\+A\+R\+T\+Exception Class Reference} -\label{classUSARTException}\index{USARTException@{USARTException}} -Inheritance diagram for U\+S\+A\+R\+T\+Exception\+:\begin{figure}[H] -\begin{center} -\leavevmode -\includegraphics[height=2.000000cm]{classUSARTException} -\end{center} -\end{figure} -\doxysubsection*{Public Member Functions} -\begin{DoxyCompactItemize} -\item -\mbox{\Hypertarget{classUSARTException_a3c359db129825703b91392d5128cf93d}\label{classUSARTException_a3c359db129825703b91392d5128cf93d}} -{\bfseries U\+S\+A\+R\+T\+Exception} (const char $\ast$message) -\item -\mbox{\Hypertarget{classUSARTException_a643c0a8b7f0d81e2f1693a75b378e6c2}\label{classUSARTException_a643c0a8b7f0d81e2f1693a75b378e6c2}} -{\bfseries U\+S\+A\+R\+T\+Exception} (const std\+::string \&message) -\item -\mbox{\Hypertarget{classUSARTException_a2af5e3c00cd0585c7427c2e0420a8f15}\label{classUSARTException_a2af5e3c00cd0585c7427c2e0420a8f15}} -virtual const char $\ast$ {\bfseries what} () const throw () -\end{DoxyCompactItemize} -\doxysubsection*{Protected Attributes} -\begin{DoxyCompactItemize} -\item -\mbox{\Hypertarget{classUSARTException_a14c80df95f216d221aa97cffbcd8dd79}\label{classUSARTException_a14c80df95f216d221aa97cffbcd8dd79}} -std\+::string {\bfseries msg} -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} - - -Definition at line 9 of file usartexception.\+h. - - - -The documentation for this class was generated from the following file\+:\begin{DoxyCompactItemize} -\item -/home/famulus/\+Dokumente/b15f/control/src/drv/usartexception.\+h\end{DoxyCompactItemize} diff --git a/docs/latex/classView.eps b/docs/latex/classView.eps deleted file mode 100644 index 29178de..0000000 --- a/docs/latex/classView.eps +++ /dev/null @@ -1,213 +0,0 @@ -%!PS-Adobe-2.0 EPSF-2.0 -%%Title: ClassName -%%Creator: Doxygen -%%CreationDate: Time -%%For: -%Magnification: 1.00 -%%Orientation: Portrait -%%BoundingBox: 0 0 500 200.000000 -%%Pages: 0 -%%BeginSetup -%%EndSetup -%%EndComments - -% ----- variables ----- - -/boxwidth 0 def -/boxheight 40 def -/fontheight 24 def -/marginwidth 10 def -/distx 20 def -/disty 40 def -/boundaspect 2.500000 def % aspect ratio of the BoundingBox (width/height) -/boundx 500 def -/boundy boundx boundaspect div def -/xspacing 0 def -/yspacing 0 def -/rows 3 def -/cols 3 def -/scalefactor 0 def -/boxfont /Times-Roman findfont fontheight scalefont def - -% ----- procedures ----- - -/dotted { [1 4] 0 setdash } def -/dashed { [5] 0 setdash } def -/solid { [] 0 setdash } def - -/max % result = MAX(arg1,arg2) -{ - /a exch def - /b exch def - a b gt {a} {b} ifelse -} def - -/xoffset % result = MAX(0,(scalefactor-(boxwidth*cols+distx*(cols-1)))/2) -{ - 0 scalefactor boxwidth cols mul distx cols 1 sub mul add sub 2 div max -} def - -/cw % boxwidth = MAX(boxwidth, stringwidth(arg1)) -{ - /str exch def - /boxwidth boxwidth str stringwidth pop max def -} def - -/box % draws a box with text `arg1' at grid pos (arg2,arg3) -{ gsave - 2 setlinewidth - newpath - exch xspacing mul xoffset add - exch yspacing mul - moveto - boxwidth 0 rlineto - 0 boxheight rlineto - boxwidth neg 0 rlineto - 0 boxheight neg rlineto - closepath - dup stringwidth pop neg boxwidth add 2 div - boxheight fontheight 2 div sub 2 div - rmoveto show stroke - grestore -} def - -/mark -{ newpath - exch xspacing mul xoffset add boxwidth add - exch yspacing mul - moveto - 0 boxheight 4 div rlineto - boxheight neg 4 div boxheight neg 4 div rlineto - closepath - eofill - stroke -} def - -/arrow -{ newpath - moveto - 3 -8 rlineto - -6 0 rlineto - 3 8 rlineto - closepath - eofill - stroke -} def - -/out % draws an output connector for the block at (arg1,arg2) -{ - newpath - exch xspacing mul xoffset add boxwidth 2 div add - exch yspacing mul boxheight add - /y exch def - /x exch def - x y moveto - 0 disty 2 div rlineto - stroke - 1 eq { x y disty 2 div add arrow } if -} def - -/in % draws an input connector for the block at (arg1,arg2) -{ - newpath - exch xspacing mul xoffset add boxwidth 2 div add - exch yspacing mul disty 2 div sub - /y exch def - /x exch def - x y moveto - 0 disty 2 div rlineto - stroke - 1 eq { x y disty 2 div add arrow } if -} def - -/hedge -{ - exch xspacing mul xoffset add boxwidth 2 div add - exch yspacing mul boxheight 2 div sub - /y exch def - /x exch def - newpath - x y moveto - boxwidth 2 div distx add 0 rlineto - stroke - 1 eq - { newpath x boxwidth 2 div distx add add y moveto - -8 3 rlineto - 0 -6 rlineto - 8 3 rlineto - closepath - eofill - stroke - } if -} def - -/vedge -{ - /ye exch def - /ys exch def - /xs exch def - newpath - xs xspacing mul xoffset add boxwidth 2 div add dup - ys yspacing mul boxheight 2 div sub - moveto - ye yspacing mul boxheight 2 div sub - lineto - stroke -} def - -/conn % connections the blocks from col `arg1' to `arg2' of row `arg3' -{ - /ys exch def - /xe exch def - /xs exch def - newpath - xs xspacing mul xoffset add boxwidth 2 div add - ys yspacing mul disty 2 div sub - moveto - xspacing xe xs sub mul 0 - rlineto - stroke -} def - -% ----- main ------ - -boxfont setfont -1 boundaspect scale -(View) cw -(ViewInfo) cw -(ViewPromt) cw -(ViewSelection) cw -(ViewMonitor) cw -/boxwidth boxwidth marginwidth 2 mul add def -/xspacing boxwidth distx add def -/yspacing boxheight disty add def -/scalefactor - boxwidth cols mul distx cols 1 sub mul add - boxheight rows mul disty rows 1 sub mul add boundaspect mul - max def -boundx scalefactor div boundy scalefactor div scale - -% ----- classes ----- - - (View) 1.000000 2.000000 box - (ViewInfo) 0.000000 1.000000 box - (ViewPromt) 1.000000 1.000000 box - (ViewSelection) 2.000000 1.000000 box - (ViewMonitor) 0.000000 0.000000 box - -% ----- relations ----- - -solid -1 1.000000 1.250000 out -solid -0.000000 2.000000 2.000000 conn -solid -0 0.000000 1.750000 in -solid -1 0.000000 0.250000 out -solid -0 1.000000 1.750000 in -solid -0 2.000000 1.750000 in -solid -0 0.000000 0.750000 in diff --git a/docs/latex/classView.tex b/docs/latex/classView.tex deleted file mode 100644 index 0129493..0000000 --- a/docs/latex/classView.tex +++ /dev/null @@ -1,78 +0,0 @@ -\hypertarget{classView}{}\doxysection{View Class Reference} -\label{classView}\index{View@{View}} -Inheritance diagram for View\+:\begin{figure}[H] -\begin{center} -\leavevmode -\includegraphics[height=3.000000cm]{classView} -\end{center} -\end{figure} -\doxysubsection*{Public Member Functions} -\begin{DoxyCompactItemize} -\item -\mbox{\Hypertarget{classView_a6c725e4d83fd7474635a7e64200c7a08}\label{classView_a6c725e4d83fd7474635a7e64200c7a08}} -virtual void {\bfseries set\+Title} (std\+::string title) -\item -\mbox{\Hypertarget{classView_aa7b1f1179e3c4f06bef1e99355d0d592}\label{classView_aa7b1f1179e3c4f06bef1e99355d0d592}} -virtual void {\bfseries repaint} (void) -\item -\mbox{\Hypertarget{classView_a092a269bf53569af7fca4d710dd5b980}\label{classView_a092a269bf53569af7fca4d710dd5b980}} -virtual void {\bfseries draw} (void)=0 -\item -\mbox{\Hypertarget{classView_a60f77156dc4786bb6227d58a3061d2f6}\label{classView_a60f77156dc4786bb6227d58a3061d2f6}} -virtual call\+\_\+t {\bfseries keypress} (int \&key)=0 -\end{DoxyCompactItemize} -\doxysubsection*{Static Public Member Functions} -\begin{DoxyCompactItemize} -\item -\mbox{\Hypertarget{classView_a990aa2223befde031dfcce54a740c558}\label{classView_a990aa2223befde031dfcce54a740c558}} -static void {\bfseries set\+Win\+Context} (W\+I\+N\+D\+OW $\ast$win) -\item -\mbox{\Hypertarget{classView_a0710c6ba06e3795e7ddf369361308b79}\label{classView_a0710c6ba06e3795e7ddf369361308b79}} -static W\+I\+N\+D\+OW $\ast$ {\bfseries get\+Win\+Context} (void) -\item -\mbox{\Hypertarget{classView_a52c2e2a7bc56388e7d9bfa398ad52668}\label{classView_a52c2e2a7bc56388e7d9bfa398ad52668}} -static std\+::vector$<$ std\+::string $>$ {\bfseries str\+\_\+split} (const std\+::string \&str, const std\+::string delim) -\end{DoxyCompactItemize} -\doxysubsection*{Protected Attributes} -\begin{DoxyCompactItemize} -\item -\mbox{\Hypertarget{classView_ae039aa744b085db819ae149705b2c32b}\label{classView_ae039aa744b085db819ae149705b2c32b}} -int {\bfseries width} -\item -\mbox{\Hypertarget{classView_a6e3e5c18893617490f02166641356746}\label{classView_a6e3e5c18893617490f02166641356746}} -int {\bfseries height} -\item -\mbox{\Hypertarget{classView_a9fc9f3b0c876d063e6f57dee320a43fe}\label{classView_a9fc9f3b0c876d063e6f57dee320a43fe}} -int {\bfseries start\+\_\+x} = 0 -\item -\mbox{\Hypertarget{classView_ac424db4c13776c3ce9d33f9074dfcfaa}\label{classView_ac424db4c13776c3ce9d33f9074dfcfaa}} -int {\bfseries start\+\_\+y} = 0 -\item -\mbox{\Hypertarget{classView_a80441aa81b52e04677a2aa2bd9c47753}\label{classView_a80441aa81b52e04677a2aa2bd9c47753}} -std\+::string {\bfseries title} -\item -\mbox{\Hypertarget{classView_a610367214a727e2f7da72ac5bdb60fa3}\label{classView_a610367214a727e2f7da72ac5bdb60fa3}} -std\+::vector$<$ call\+\_\+t $>$ {\bfseries calls} -\end{DoxyCompactItemize} -\doxysubsection*{Static Protected Attributes} -\begin{DoxyCompactItemize} -\item -\mbox{\Hypertarget{classView_a5ddee2bf0b26dbcfa7780be17ff33dd7}\label{classView_a5ddee2bf0b26dbcfa7780be17ff33dd7}} -static W\+I\+N\+D\+OW $\ast$ {\bfseries win} = nullptr -\item -\mbox{\Hypertarget{classView_a3554cf8689cad24c643665aa3d182134}\label{classView_a3554cf8689cad24c643665aa3d182134}} -constexpr static int {\bfseries K\+E\+Y\+\_\+\+E\+NT} = 10 -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} - - -Definition at line 17 of file view.\+h. - - - -The documentation for this class was generated from the following files\+:\begin{DoxyCompactItemize} -\item -/home/famulus/\+Dokumente/b15f/control/src/ui/view.\+h\item -/home/famulus/\+Dokumente/b15f/control/src/ui/view.\+cpp\end{DoxyCompactItemize} diff --git a/docs/latex/classViewInfo.eps b/docs/latex/classViewInfo.eps deleted file mode 100644 index 940c28b..0000000 --- a/docs/latex/classViewInfo.eps +++ /dev/null @@ -1,203 +0,0 @@ -%!PS-Adobe-2.0 EPSF-2.0 -%%Title: ClassName -%%Creator: Doxygen -%%CreationDate: Time -%%For: -%Magnification: 1.00 -%%Orientation: Portrait -%%BoundingBox: 0 0 500 659.340659 -%%Pages: 0 -%%BeginSetup -%%EndSetup -%%EndComments - -% ----- variables ----- - -/boxwidth 0 def -/boxheight 40 def -/fontheight 24 def -/marginwidth 10 def -/distx 20 def -/disty 40 def -/boundaspect 0.758333 def % aspect ratio of the BoundingBox (width/height) -/boundx 500 def -/boundy boundx boundaspect div def -/xspacing 0 def -/yspacing 0 def -/rows 3 def -/cols 1 def -/scalefactor 0 def -/boxfont /Times-Roman findfont fontheight scalefont def - -% ----- procedures ----- - -/dotted { [1 4] 0 setdash } def -/dashed { [5] 0 setdash } def -/solid { [] 0 setdash } def - -/max % result = MAX(arg1,arg2) -{ - /a exch def - /b exch def - a b gt {a} {b} ifelse -} def - -/xoffset % result = MAX(0,(scalefactor-(boxwidth*cols+distx*(cols-1)))/2) -{ - 0 scalefactor boxwidth cols mul distx cols 1 sub mul add sub 2 div max -} def - -/cw % boxwidth = MAX(boxwidth, stringwidth(arg1)) -{ - /str exch def - /boxwidth boxwidth str stringwidth pop max def -} def - -/box % draws a box with text `arg1' at grid pos (arg2,arg3) -{ gsave - 2 setlinewidth - newpath - exch xspacing mul xoffset add - exch yspacing mul - moveto - boxwidth 0 rlineto - 0 boxheight rlineto - boxwidth neg 0 rlineto - 0 boxheight neg rlineto - closepath - dup stringwidth pop neg boxwidth add 2 div - boxheight fontheight 2 div sub 2 div - rmoveto show stroke - grestore -} def - -/mark -{ newpath - exch xspacing mul xoffset add boxwidth add - exch yspacing mul - moveto - 0 boxheight 4 div rlineto - boxheight neg 4 div boxheight neg 4 div rlineto - closepath - eofill - stroke -} def - -/arrow -{ newpath - moveto - 3 -8 rlineto - -6 0 rlineto - 3 8 rlineto - closepath - eofill - stroke -} def - -/out % draws an output connector for the block at (arg1,arg2) -{ - newpath - exch xspacing mul xoffset add boxwidth 2 div add - exch yspacing mul boxheight add - /y exch def - /x exch def - x y moveto - 0 disty 2 div rlineto - stroke - 1 eq { x y disty 2 div add arrow } if -} def - -/in % draws an input connector for the block at (arg1,arg2) -{ - newpath - exch xspacing mul xoffset add boxwidth 2 div add - exch yspacing mul disty 2 div sub - /y exch def - /x exch def - x y moveto - 0 disty 2 div rlineto - stroke - 1 eq { x y disty 2 div add arrow } if -} def - -/hedge -{ - exch xspacing mul xoffset add boxwidth 2 div add - exch yspacing mul boxheight 2 div sub - /y exch def - /x exch def - newpath - x y moveto - boxwidth 2 div distx add 0 rlineto - stroke - 1 eq - { newpath x boxwidth 2 div distx add add y moveto - -8 3 rlineto - 0 -6 rlineto - 8 3 rlineto - closepath - eofill - stroke - } if -} def - -/vedge -{ - /ye exch def - /ys exch def - /xs exch def - newpath - xs xspacing mul xoffset add boxwidth 2 div add dup - ys yspacing mul boxheight 2 div sub - moveto - ye yspacing mul boxheight 2 div sub - lineto - stroke -} def - -/conn % connections the blocks from col `arg1' to `arg2' of row `arg3' -{ - /ys exch def - /xe exch def - /xs exch def - newpath - xs xspacing mul xoffset add boxwidth 2 div add - ys yspacing mul disty 2 div sub - moveto - xspacing xe xs sub mul 0 - rlineto - stroke -} def - -% ----- main ------ - -boxfont setfont -1 boundaspect scale -(ViewInfo) cw -(View) cw -(ViewMonitor) cw -/boxwidth boxwidth marginwidth 2 mul add def -/xspacing boxwidth distx add def -/yspacing boxheight disty add def -/scalefactor - boxwidth cols mul distx cols 1 sub mul add - boxheight rows mul disty rows 1 sub mul add boundaspect mul - max def -boundx scalefactor div boundy scalefactor div scale - -% ----- classes ----- - - (ViewInfo) 0.000000 1.000000 box - (View) 0.000000 2.000000 box - (ViewMonitor) 0.000000 0.000000 box - -% ----- relations ----- - -solid -0 0.000000 1.000000 out -solid -1 0.000000 2.000000 in -solid -1 0.000000 0.250000 out -solid -0 0.000000 0.750000 in diff --git a/docs/latex/classViewInfo.tex b/docs/latex/classViewInfo.tex deleted file mode 100644 index a67e1d9..0000000 --- a/docs/latex/classViewInfo.tex +++ /dev/null @@ -1,64 +0,0 @@ -\hypertarget{classViewInfo}{}\doxysection{View\+Info Class Reference} -\label{classViewInfo}\index{ViewInfo@{ViewInfo}} -Inheritance diagram for View\+Info\+:\begin{figure}[H] -\begin{center} -\leavevmode -\includegraphics[height=3.000000cm]{classViewInfo} -\end{center} -\end{figure} -\doxysubsection*{Public Member Functions} -\begin{DoxyCompactItemize} -\item -\mbox{\Hypertarget{classViewInfo_abc93067b319df17e19f013a86d762f81}\label{classViewInfo_abc93067b319df17e19f013a86d762f81}} -virtual void {\bfseries set\+Text} (std\+::string text) -\item -\mbox{\Hypertarget{classViewInfo_a4c3db4806515ea8b0f07a9864f983377}\label{classViewInfo_a4c3db4806515ea8b0f07a9864f983377}} -virtual void {\bfseries set\+Label\+Close} (std\+::string label) -\item -\mbox{\Hypertarget{classViewInfo_a45fd0b8b96d15fd92824ce63fb6814ca}\label{classViewInfo_a45fd0b8b96d15fd92824ce63fb6814ca}} -virtual void {\bfseries set\+Call} (call\+\_\+t call) -\item -\mbox{\Hypertarget{classViewInfo_ab7f9ea145f8cf26dbd27e29982cda206}\label{classViewInfo_ab7f9ea145f8cf26dbd27e29982cda206}} -virtual void {\bfseries draw} (void) override -\item -\mbox{\Hypertarget{classViewInfo_a7d231a44600aa100ad4a0b9f283e5bd8}\label{classViewInfo_a7d231a44600aa100ad4a0b9f283e5bd8}} -virtual call\+\_\+t {\bfseries keypress} (int \&key) override -\end{DoxyCompactItemize} -\doxysubsection*{Protected Attributes} -\begin{DoxyCompactItemize} -\item -\mbox{\Hypertarget{classViewInfo_ac392a569ef16af3dc11ee659f3fa1eb4}\label{classViewInfo_ac392a569ef16af3dc11ee659f3fa1eb4}} -std\+::string {\bfseries text} -\item -\mbox{\Hypertarget{classViewInfo_a34879bd1c0a8fe230429cc600dcd6739}\label{classViewInfo_a34879bd1c0a8fe230429cc600dcd6739}} -std\+::string {\bfseries label\+\_\+close} -\item -\mbox{\Hypertarget{classViewInfo_ae4dab70d82761e0f59f51dcae79685fe}\label{classViewInfo_ae4dab70d82761e0f59f51dcae79685fe}} -int {\bfseries close\+\_\+offset\+\_\+x} = 0 -\item -\mbox{\Hypertarget{classViewInfo_a5954adf853cb44d4655ede731faf1a28}\label{classViewInfo_a5954adf853cb44d4655ede731faf1a28}} -int {\bfseries close\+\_\+offset\+\_\+y} = 0 -\end{DoxyCompactItemize} -\doxysubsection*{Static Protected Attributes} -\begin{DoxyCompactItemize} -\item -\mbox{\Hypertarget{classViewInfo_a4681a8138f17ea229aca02e6db7357cd}\label{classViewInfo_a4681a8138f17ea229aca02e6db7357cd}} -constexpr static int {\bfseries text\+\_\+offset\+\_\+x} = 2 -\item -\mbox{\Hypertarget{classViewInfo_a34a9239c8954a0c27a22cf44d112f5b8}\label{classViewInfo_a34a9239c8954a0c27a22cf44d112f5b8}} -constexpr static int {\bfseries text\+\_\+offset\+\_\+y} = 3 -\end{DoxyCompactItemize} -\doxysubsection*{Additional Inherited Members} - - -\doxysubsection{Detailed Description} - - -Definition at line 6 of file view\+\_\+info.\+h. - - - -The documentation for this class was generated from the following files\+:\begin{DoxyCompactItemize} -\item -/home/famulus/\+Dokumente/b15f/control/src/ui/view\+\_\+info.\+h\item -/home/famulus/\+Dokumente/b15f/control/src/ui/view\+\_\+info.\+cpp\end{DoxyCompactItemize} diff --git a/docs/latex/classViewMonitor.eps b/docs/latex/classViewMonitor.eps deleted file mode 100644 index d74fe53..0000000 --- a/docs/latex/classViewMonitor.eps +++ /dev/null @@ -1,203 +0,0 @@ -%!PS-Adobe-2.0 EPSF-2.0 -%%Title: ClassName -%%Creator: Doxygen -%%CreationDate: Time -%%For: -%Magnification: 1.00 -%%Orientation: Portrait -%%BoundingBox: 0 0 500 659.340659 -%%Pages: 0 -%%BeginSetup -%%EndSetup -%%EndComments - -% ----- variables ----- - -/boxwidth 0 def -/boxheight 40 def -/fontheight 24 def -/marginwidth 10 def -/distx 20 def -/disty 40 def -/boundaspect 0.758333 def % aspect ratio of the BoundingBox (width/height) -/boundx 500 def -/boundy boundx boundaspect div def -/xspacing 0 def -/yspacing 0 def -/rows 3 def -/cols 1 def -/scalefactor 0 def -/boxfont /Times-Roman findfont fontheight scalefont def - -% ----- procedures ----- - -/dotted { [1 4] 0 setdash } def -/dashed { [5] 0 setdash } def -/solid { [] 0 setdash } def - -/max % result = MAX(arg1,arg2) -{ - /a exch def - /b exch def - a b gt {a} {b} ifelse -} def - -/xoffset % result = MAX(0,(scalefactor-(boxwidth*cols+distx*(cols-1)))/2) -{ - 0 scalefactor boxwidth cols mul distx cols 1 sub mul add sub 2 div max -} def - -/cw % boxwidth = MAX(boxwidth, stringwidth(arg1)) -{ - /str exch def - /boxwidth boxwidth str stringwidth pop max def -} def - -/box % draws a box with text `arg1' at grid pos (arg2,arg3) -{ gsave - 2 setlinewidth - newpath - exch xspacing mul xoffset add - exch yspacing mul - moveto - boxwidth 0 rlineto - 0 boxheight rlineto - boxwidth neg 0 rlineto - 0 boxheight neg rlineto - closepath - dup stringwidth pop neg boxwidth add 2 div - boxheight fontheight 2 div sub 2 div - rmoveto show stroke - grestore -} def - -/mark -{ newpath - exch xspacing mul xoffset add boxwidth add - exch yspacing mul - moveto - 0 boxheight 4 div rlineto - boxheight neg 4 div boxheight neg 4 div rlineto - closepath - eofill - stroke -} def - -/arrow -{ newpath - moveto - 3 -8 rlineto - -6 0 rlineto - 3 8 rlineto - closepath - eofill - stroke -} def - -/out % draws an output connector for the block at (arg1,arg2) -{ - newpath - exch xspacing mul xoffset add boxwidth 2 div add - exch yspacing mul boxheight add - /y exch def - /x exch def - x y moveto - 0 disty 2 div rlineto - stroke - 1 eq { x y disty 2 div add arrow } if -} def - -/in % draws an input connector for the block at (arg1,arg2) -{ - newpath - exch xspacing mul xoffset add boxwidth 2 div add - exch yspacing mul disty 2 div sub - /y exch def - /x exch def - x y moveto - 0 disty 2 div rlineto - stroke - 1 eq { x y disty 2 div add arrow } if -} def - -/hedge -{ - exch xspacing mul xoffset add boxwidth 2 div add - exch yspacing mul boxheight 2 div sub - /y exch def - /x exch def - newpath - x y moveto - boxwidth 2 div distx add 0 rlineto - stroke - 1 eq - { newpath x boxwidth 2 div distx add add y moveto - -8 3 rlineto - 0 -6 rlineto - 8 3 rlineto - closepath - eofill - stroke - } if -} def - -/vedge -{ - /ye exch def - /ys exch def - /xs exch def - newpath - xs xspacing mul xoffset add boxwidth 2 div add dup - ys yspacing mul boxheight 2 div sub - moveto - ye yspacing mul boxheight 2 div sub - lineto - stroke -} def - -/conn % connections the blocks from col `arg1' to `arg2' of row `arg3' -{ - /ys exch def - /xe exch def - /xs exch def - newpath - xs xspacing mul xoffset add boxwidth 2 div add - ys yspacing mul disty 2 div sub - moveto - xspacing xe xs sub mul 0 - rlineto - stroke -} def - -% ----- main ------ - -boxfont setfont -1 boundaspect scale -(ViewMonitor) cw -(ViewInfo) cw -(View) cw -/boxwidth boxwidth marginwidth 2 mul add def -/xspacing boxwidth distx add def -/yspacing boxheight disty add def -/scalefactor - boxwidth cols mul distx cols 1 sub mul add - boxheight rows mul disty rows 1 sub mul add boundaspect mul - max def -boundx scalefactor div boundy scalefactor div scale - -% ----- classes ----- - - (ViewMonitor) 0.000000 0.000000 box - (ViewInfo) 0.000000 1.000000 box - (View) 0.000000 2.000000 box - -% ----- relations ----- - -solid -0 0.000000 0.000000 out -solid -1 0.000000 1.000000 in -solid -0 0.000000 1.000000 out -solid -1 0.000000 2.000000 in diff --git a/docs/latex/classViewMonitor.tex b/docs/latex/classViewMonitor.tex deleted file mode 100644 index ae6274d..0000000 --- a/docs/latex/classViewMonitor.tex +++ /dev/null @@ -1,43 +0,0 @@ -\hypertarget{classViewMonitor}{}\doxysection{View\+Monitor Class Reference} -\label{classViewMonitor}\index{ViewMonitor@{ViewMonitor}} -Inheritance diagram for View\+Monitor\+:\begin{figure}[H] -\begin{center} -\leavevmode -\includegraphics[height=3.000000cm]{classViewMonitor} -\end{center} -\end{figure} -\doxysubsection*{Public Member Functions} -\begin{DoxyCompactItemize} -\item -\mbox{\Hypertarget{classViewMonitor_a2224002fe45655df87130fe07a161693}\label{classViewMonitor_a2224002fe45655df87130fe07a161693}} -virtual call\+\_\+t {\bfseries keypress} (int \&key) override -\end{DoxyCompactItemize} -\doxysubsection*{Protected Member Functions} -\begin{DoxyCompactItemize} -\item -\mbox{\Hypertarget{classViewMonitor_a245a1dc3cc43a84f63e1175a195581a2}\label{classViewMonitor_a245a1dc3cc43a84f63e1175a195581a2}} -virtual void {\bfseries worker} (void) -\end{DoxyCompactItemize} -\doxysubsection*{Protected Attributes} -\begin{DoxyCompactItemize} -\item -\mbox{\Hypertarget{classViewMonitor_a79a68894c0a05422b5707202d28a6db0}\label{classViewMonitor_a79a68894c0a05422b5707202d28a6db0}} -volatile bool {\bfseries run\+\_\+worker} = true -\item -\mbox{\Hypertarget{classViewMonitor_a377eb8deab3061aa4e084be9b791c056}\label{classViewMonitor_a377eb8deab3061aa4e084be9b791c056}} -std\+::thread {\bfseries t\+\_\+worker} -\end{DoxyCompactItemize} -\doxysubsection*{Additional Inherited Members} - - -\doxysubsection{Detailed Description} - - -Definition at line 11 of file view\+\_\+monitor.\+h. - - - -The documentation for this class was generated from the following files\+:\begin{DoxyCompactItemize} -\item -/home/famulus/\+Dokumente/b15f/control/src/ui/view\+\_\+monitor.\+h\item -/home/famulus/\+Dokumente/b15f/control/src/ui/view\+\_\+monitor.\+cpp\end{DoxyCompactItemize} diff --git a/docs/latex/classViewPromt.eps b/docs/latex/classViewPromt.eps deleted file mode 100644 index 9554b0a..0000000 --- a/docs/latex/classViewPromt.eps +++ /dev/null @@ -1,197 +0,0 @@ -%!PS-Adobe-2.0 EPSF-2.0 -%%Title: ClassName -%%Creator: Doxygen -%%CreationDate: Time -%%For: -%Magnification: 1.00 -%%Orientation: Portrait -%%BoundingBox: 0 0 500 500.000000 -%%Pages: 0 -%%BeginSetup -%%EndSetup -%%EndComments - -% ----- variables ----- - -/boxwidth 0 def -/boxheight 40 def -/fontheight 24 def -/marginwidth 10 def -/distx 20 def -/disty 40 def -/boundaspect 1.000000 def % aspect ratio of the BoundingBox (width/height) -/boundx 500 def -/boundy boundx boundaspect div def -/xspacing 0 def -/yspacing 0 def -/rows 2 def -/cols 1 def -/scalefactor 0 def -/boxfont /Times-Roman findfont fontheight scalefont def - -% ----- procedures ----- - -/dotted { [1 4] 0 setdash } def -/dashed { [5] 0 setdash } def -/solid { [] 0 setdash } def - -/max % result = MAX(arg1,arg2) -{ - /a exch def - /b exch def - a b gt {a} {b} ifelse -} def - -/xoffset % result = MAX(0,(scalefactor-(boxwidth*cols+distx*(cols-1)))/2) -{ - 0 scalefactor boxwidth cols mul distx cols 1 sub mul add sub 2 div max -} def - -/cw % boxwidth = MAX(boxwidth, stringwidth(arg1)) -{ - /str exch def - /boxwidth boxwidth str stringwidth pop max def -} def - -/box % draws a box with text `arg1' at grid pos (arg2,arg3) -{ gsave - 2 setlinewidth - newpath - exch xspacing mul xoffset add - exch yspacing mul - moveto - boxwidth 0 rlineto - 0 boxheight rlineto - boxwidth neg 0 rlineto - 0 boxheight neg rlineto - closepath - dup stringwidth pop neg boxwidth add 2 div - boxheight fontheight 2 div sub 2 div - rmoveto show stroke - grestore -} def - -/mark -{ newpath - exch xspacing mul xoffset add boxwidth add - exch yspacing mul - moveto - 0 boxheight 4 div rlineto - boxheight neg 4 div boxheight neg 4 div rlineto - closepath - eofill - stroke -} def - -/arrow -{ newpath - moveto - 3 -8 rlineto - -6 0 rlineto - 3 8 rlineto - closepath - eofill - stroke -} def - -/out % draws an output connector for the block at (arg1,arg2) -{ - newpath - exch xspacing mul xoffset add boxwidth 2 div add - exch yspacing mul boxheight add - /y exch def - /x exch def - x y moveto - 0 disty 2 div rlineto - stroke - 1 eq { x y disty 2 div add arrow } if -} def - -/in % draws an input connector for the block at (arg1,arg2) -{ - newpath - exch xspacing mul xoffset add boxwidth 2 div add - exch yspacing mul disty 2 div sub - /y exch def - /x exch def - x y moveto - 0 disty 2 div rlineto - stroke - 1 eq { x y disty 2 div add arrow } if -} def - -/hedge -{ - exch xspacing mul xoffset add boxwidth 2 div add - exch yspacing mul boxheight 2 div sub - /y exch def - /x exch def - newpath - x y moveto - boxwidth 2 div distx add 0 rlineto - stroke - 1 eq - { newpath x boxwidth 2 div distx add add y moveto - -8 3 rlineto - 0 -6 rlineto - 8 3 rlineto - closepath - eofill - stroke - } if -} def - -/vedge -{ - /ye exch def - /ys exch def - /xs exch def - newpath - xs xspacing mul xoffset add boxwidth 2 div add dup - ys yspacing mul boxheight 2 div sub - moveto - ye yspacing mul boxheight 2 div sub - lineto - stroke -} def - -/conn % connections the blocks from col `arg1' to `arg2' of row `arg3' -{ - /ys exch def - /xe exch def - /xs exch def - newpath - xs xspacing mul xoffset add boxwidth 2 div add - ys yspacing mul disty 2 div sub - moveto - xspacing xe xs sub mul 0 - rlineto - stroke -} def - -% ----- main ------ - -boxfont setfont -1 boundaspect scale -(ViewPromt) cw -(View) cw -/boxwidth boxwidth marginwidth 2 mul add def -/xspacing boxwidth distx add def -/yspacing boxheight disty add def -/scalefactor - boxwidth cols mul distx cols 1 sub mul add - boxheight rows mul disty rows 1 sub mul add boundaspect mul - max def -boundx scalefactor div boundy scalefactor div scale - -% ----- classes ----- - - (ViewPromt) 0.000000 0.000000 box - (View) 0.000000 1.000000 box - -% ----- relations ----- - -solid -0 0.000000 0.000000 out -solid -1 0.000000 1.000000 in diff --git a/docs/latex/classViewPromt.tex b/docs/latex/classViewPromt.tex deleted file mode 100644 index 59cd8ec..0000000 --- a/docs/latex/classViewPromt.tex +++ /dev/null @@ -1,85 +0,0 @@ -\hypertarget{classViewPromt}{}\doxysection{View\+Promt Class Reference} -\label{classViewPromt}\index{ViewPromt@{ViewPromt}} -Inheritance diagram for View\+Promt\+:\begin{figure}[H] -\begin{center} -\leavevmode -\includegraphics[height=2.000000cm]{classViewPromt} -\end{center} -\end{figure} -\doxysubsection*{Public Member Functions} -\begin{DoxyCompactItemize} -\item -\mbox{\Hypertarget{classViewPromt_a8f3f805bece2a669f10e29d1d22a9de1}\label{classViewPromt_a8f3f805bece2a669f10e29d1d22a9de1}} -virtual void {\bfseries draw} (void) override -\item -\mbox{\Hypertarget{classViewPromt_ab67a9f9ecb7345f9cb3d7fb04145a81a}\label{classViewPromt_ab67a9f9ecb7345f9cb3d7fb04145a81a}} -virtual void {\bfseries set\+Message} (std\+::string message) -\item -\mbox{\Hypertarget{classViewPromt_adbdbc4bd715637b97b9a60ddb8c7dcc6}\label{classViewPromt_adbdbc4bd715637b97b9a60ddb8c7dcc6}} -virtual void {\bfseries set\+Confirm} (std\+::string name, call\+\_\+t call) -\item -\mbox{\Hypertarget{classViewPromt_a4129b57bfeea20c328c6bbc93e226d45}\label{classViewPromt_a4129b57bfeea20c328c6bbc93e226d45}} -virtual void {\bfseries set\+Cancel} (std\+::string name, bool cancelable) -\item -\mbox{\Hypertarget{classViewPromt_aa82bf5da77c041f733a0f29918c29319}\label{classViewPromt_aa82bf5da77c041f733a0f29918c29319}} -virtual std\+::string {\bfseries get\+Input} (void) -\item -\mbox{\Hypertarget{classViewPromt_a24aa1e8887fc5e6631d6cb88adb7f3db}\label{classViewPromt_a24aa1e8887fc5e6631d6cb88adb7f3db}} -virtual call\+\_\+t {\bfseries keypress} (int \&key) override -\end{DoxyCompactItemize} -\doxysubsection*{Protected Attributes} -\begin{DoxyCompactItemize} -\item -\mbox{\Hypertarget{classViewPromt_a86916a820e28320c91c9d053b350b9c9}\label{classViewPromt_a86916a820e28320c91c9d053b350b9c9}} -size\+\_\+t {\bfseries selection} = 1 -\item -\mbox{\Hypertarget{classViewPromt_a02573b9ae37cf6c2adacd8f2a0152a38}\label{classViewPromt_a02573b9ae37cf6c2adacd8f2a0152a38}} -std\+::string {\bfseries input} -\item -\mbox{\Hypertarget{classViewPromt_a00aff1fb73dfe44595b259ca8c8b12af}\label{classViewPromt_a00aff1fb73dfe44595b259ca8c8b12af}} -std\+::string {\bfseries message} = \char`\"{}Input\char`\"{} -\item -\mbox{\Hypertarget{classViewPromt_a97f8bb434ac6663c64d41e95bad8a539}\label{classViewPromt_a97f8bb434ac6663c64d41e95bad8a539}} -std\+::string {\bfseries label\+\_\+confirm} = \char`\"{}\mbox{[} OK \mbox{]}\char`\"{} -\item -\mbox{\Hypertarget{classViewPromt_ad1491d50a47f70d0af91cc1db65ac18d}\label{classViewPromt_ad1491d50a47f70d0af91cc1db65ac18d}} -std\+::string {\bfseries sep} = \char`\"{} \char`\"{} -\item -\mbox{\Hypertarget{classViewPromt_a61c6061beeb27a1e3ffca87489ad5b7b}\label{classViewPromt_a61c6061beeb27a1e3ffca87489ad5b7b}} -std\+::string {\bfseries label\+\_\+cancel} = \char`\"{}\mbox{[} Cancel \mbox{]}\char`\"{} -\item -\mbox{\Hypertarget{classViewPromt_a29288778b003ec44e8a3b72edcada99c}\label{classViewPromt_a29288778b003ec44e8a3b72edcada99c}} -call\+\_\+t {\bfseries call\+\_\+confirm} = nullptr -\item -\mbox{\Hypertarget{classViewPromt_a941325e694e0e2f42e42f7b9b6ecf3e0}\label{classViewPromt_a941325e694e0e2f42e42f7b9b6ecf3e0}} -bool {\bfseries cancelable} = true -\item -\mbox{\Hypertarget{classViewPromt_a0e23911230a135f02d3108864a1a2c94}\label{classViewPromt_a0e23911230a135f02d3108864a1a2c94}} -int {\bfseries button\+\_\+offset\+\_\+x} = 0 -\item -\mbox{\Hypertarget{classViewPromt_a4781094c5c3dede08f38906fca0a53c3}\label{classViewPromt_a4781094c5c3dede08f38906fca0a53c3}} -int {\bfseries button\+\_\+offset\+\_\+y} = 0 -\end{DoxyCompactItemize} -\doxysubsection*{Static Protected Attributes} -\begin{DoxyCompactItemize} -\item -\mbox{\Hypertarget{classViewPromt_acc22bf152b511eeaa1d056927fe556ff}\label{classViewPromt_acc22bf152b511eeaa1d056927fe556ff}} -constexpr static int {\bfseries text\+\_\+offset\+\_\+x} = 2 -\item -\mbox{\Hypertarget{classViewPromt_a87c3e5440179a1b36c616489b5c29787}\label{classViewPromt_a87c3e5440179a1b36c616489b5c29787}} -constexpr static int {\bfseries text\+\_\+offset\+\_\+y} = 2 -\end{DoxyCompactItemize} -\doxysubsection*{Additional Inherited Members} - - -\doxysubsection{Detailed Description} - - -Definition at line 8 of file view\+\_\+promt.\+h. - - - -The documentation for this class was generated from the following files\+:\begin{DoxyCompactItemize} -\item -/home/famulus/\+Dokumente/b15f/control/src/ui/view\+\_\+promt.\+h\item -/home/famulus/\+Dokumente/b15f/control/src/ui/view\+\_\+promt.\+cpp\end{DoxyCompactItemize} diff --git a/docs/latex/classViewSelection.eps b/docs/latex/classViewSelection.eps deleted file mode 100644 index 3aae2bd..0000000 --- a/docs/latex/classViewSelection.eps +++ /dev/null @@ -1,197 +0,0 @@ -%!PS-Adobe-2.0 EPSF-2.0 -%%Title: ClassName -%%Creator: Doxygen -%%CreationDate: Time -%%For: -%Magnification: 1.00 -%%Orientation: Portrait -%%BoundingBox: 0 0 500 400.000000 -%%Pages: 0 -%%BeginSetup -%%EndSetup -%%EndComments - -% ----- variables ----- - -/boxwidth 0 def -/boxheight 40 def -/fontheight 24 def -/marginwidth 10 def -/distx 20 def -/disty 40 def -/boundaspect 1.250000 def % aspect ratio of the BoundingBox (width/height) -/boundx 500 def -/boundy boundx boundaspect div def -/xspacing 0 def -/yspacing 0 def -/rows 2 def -/cols 1 def -/scalefactor 0 def -/boxfont /Times-Roman findfont fontheight scalefont def - -% ----- procedures ----- - -/dotted { [1 4] 0 setdash } def -/dashed { [5] 0 setdash } def -/solid { [] 0 setdash } def - -/max % result = MAX(arg1,arg2) -{ - /a exch def - /b exch def - a b gt {a} {b} ifelse -} def - -/xoffset % result = MAX(0,(scalefactor-(boxwidth*cols+distx*(cols-1)))/2) -{ - 0 scalefactor boxwidth cols mul distx cols 1 sub mul add sub 2 div max -} def - -/cw % boxwidth = MAX(boxwidth, stringwidth(arg1)) -{ - /str exch def - /boxwidth boxwidth str stringwidth pop max def -} def - -/box % draws a box with text `arg1' at grid pos (arg2,arg3) -{ gsave - 2 setlinewidth - newpath - exch xspacing mul xoffset add - exch yspacing mul - moveto - boxwidth 0 rlineto - 0 boxheight rlineto - boxwidth neg 0 rlineto - 0 boxheight neg rlineto - closepath - dup stringwidth pop neg boxwidth add 2 div - boxheight fontheight 2 div sub 2 div - rmoveto show stroke - grestore -} def - -/mark -{ newpath - exch xspacing mul xoffset add boxwidth add - exch yspacing mul - moveto - 0 boxheight 4 div rlineto - boxheight neg 4 div boxheight neg 4 div rlineto - closepath - eofill - stroke -} def - -/arrow -{ newpath - moveto - 3 -8 rlineto - -6 0 rlineto - 3 8 rlineto - closepath - eofill - stroke -} def - -/out % draws an output connector for the block at (arg1,arg2) -{ - newpath - exch xspacing mul xoffset add boxwidth 2 div add - exch yspacing mul boxheight add - /y exch def - /x exch def - x y moveto - 0 disty 2 div rlineto - stroke - 1 eq { x y disty 2 div add arrow } if -} def - -/in % draws an input connector for the block at (arg1,arg2) -{ - newpath - exch xspacing mul xoffset add boxwidth 2 div add - exch yspacing mul disty 2 div sub - /y exch def - /x exch def - x y moveto - 0 disty 2 div rlineto - stroke - 1 eq { x y disty 2 div add arrow } if -} def - -/hedge -{ - exch xspacing mul xoffset add boxwidth 2 div add - exch yspacing mul boxheight 2 div sub - /y exch def - /x exch def - newpath - x y moveto - boxwidth 2 div distx add 0 rlineto - stroke - 1 eq - { newpath x boxwidth 2 div distx add add y moveto - -8 3 rlineto - 0 -6 rlineto - 8 3 rlineto - closepath - eofill - stroke - } if -} def - -/vedge -{ - /ye exch def - /ys exch def - /xs exch def - newpath - xs xspacing mul xoffset add boxwidth 2 div add dup - ys yspacing mul boxheight 2 div sub - moveto - ye yspacing mul boxheight 2 div sub - lineto - stroke -} def - -/conn % connections the blocks from col `arg1' to `arg2' of row `arg3' -{ - /ys exch def - /xe exch def - /xs exch def - newpath - xs xspacing mul xoffset add boxwidth 2 div add - ys yspacing mul disty 2 div sub - moveto - xspacing xe xs sub mul 0 - rlineto - stroke -} def - -% ----- main ------ - -boxfont setfont -1 boundaspect scale -(ViewSelection) cw -(View) cw -/boxwidth boxwidth marginwidth 2 mul add def -/xspacing boxwidth distx add def -/yspacing boxheight disty add def -/scalefactor - boxwidth cols mul distx cols 1 sub mul add - boxheight rows mul disty rows 1 sub mul add boundaspect mul - max def -boundx scalefactor div boundy scalefactor div scale - -% ----- classes ----- - - (ViewSelection) 0.000000 0.000000 box - (View) 0.000000 1.000000 box - -% ----- relations ----- - -solid -0 0.000000 0.000000 out -solid -1 0.000000 1.000000 in diff --git a/docs/latex/classViewSelection.tex b/docs/latex/classViewSelection.tex deleted file mode 100644 index 2d3043c..0000000 --- a/docs/latex/classViewSelection.tex +++ /dev/null @@ -1,52 +0,0 @@ -\hypertarget{classViewSelection}{}\doxysection{View\+Selection Class Reference} -\label{classViewSelection}\index{ViewSelection@{ViewSelection}} -Inheritance diagram for View\+Selection\+:\begin{figure}[H] -\begin{center} -\leavevmode -\includegraphics[height=2.000000cm]{classViewSelection} -\end{center} -\end{figure} -\doxysubsection*{Public Member Functions} -\begin{DoxyCompactItemize} -\item -\mbox{\Hypertarget{classViewSelection_a10fa34fb676bfed472ca5ee62ef9446d}\label{classViewSelection_a10fa34fb676bfed472ca5ee62ef9446d}} -virtual void {\bfseries draw} (void) override -\item -\mbox{\Hypertarget{classViewSelection_a20984423a21a0c78c12d4ad0df656b8a}\label{classViewSelection_a20984423a21a0c78c12d4ad0df656b8a}} -virtual void {\bfseries add\+Choice} (std\+::string name, call\+\_\+t call) -\item -\mbox{\Hypertarget{classViewSelection_a04341cde5e8355edc5ff3d653d1dbc76}\label{classViewSelection_a04341cde5e8355edc5ff3d653d1dbc76}} -virtual call\+\_\+t {\bfseries keypress} (int \&key) override -\end{DoxyCompactItemize} -\doxysubsection*{Protected Attributes} -\begin{DoxyCompactItemize} -\item -\mbox{\Hypertarget{classViewSelection_a7947cb252d889a298a622adccec10fda}\label{classViewSelection_a7947cb252d889a298a622adccec10fda}} -size\+\_\+t {\bfseries selection} = 0 -\item -\mbox{\Hypertarget{classViewSelection_a118f23e16e3deeaedeee7cbf62bf34bb}\label{classViewSelection_a118f23e16e3deeaedeee7cbf62bf34bb}} -std\+::vector$<$ std\+::string $>$ {\bfseries choices} -\end{DoxyCompactItemize} -\doxysubsection*{Static Protected Attributes} -\begin{DoxyCompactItemize} -\item -\mbox{\Hypertarget{classViewSelection_a9478d01473618353734436c26e0c35cb}\label{classViewSelection_a9478d01473618353734436c26e0c35cb}} -constexpr static int {\bfseries choice\+\_\+offset\+\_\+x} = 2 -\item -\mbox{\Hypertarget{classViewSelection_a20f8c7a3df9c37f05008c7da31deed56}\label{classViewSelection_a20f8c7a3df9c37f05008c7da31deed56}} -constexpr static int {\bfseries choice\+\_\+offset\+\_\+y} = 3 -\end{DoxyCompactItemize} -\doxysubsection*{Additional Inherited Members} - - -\doxysubsection{Detailed Description} - - -Definition at line 8 of file view\+\_\+selection.\+h. - - - -The documentation for this class was generated from the following files\+:\begin{DoxyCompactItemize} -\item -/home/famulus/\+Dokumente/b15f/control/src/ui/view\+\_\+selection.\+h\item -/home/famulus/\+Dokumente/b15f/control/src/ui/view\+\_\+selection.\+cpp\end{DoxyCompactItemize} diff --git a/docs/latex/doxygen.sty b/docs/latex/doxygen.sty deleted file mode 100644 index bd5fdba..0000000 --- a/docs/latex/doxygen.sty +++ /dev/null @@ -1,571 +0,0 @@ -\NeedsTeXFormat{LaTeX2e} -\ProvidesPackage{doxygen} - -% Packages used by this style file -\RequirePackage{alltt} -\RequirePackage{array} -\RequirePackage{calc} -\RequirePackage{float} -\RequirePackage{ifthen} -\RequirePackage{verbatim} -\RequirePackage[table]{xcolor} -\RequirePackage{longtable} -\RequirePackage{tabu} -\RequirePackage{fancyvrb} -\RequirePackage{tabularx} -\RequirePackage{multirow} -\RequirePackage{hanging} -\RequirePackage{ifpdf} -\RequirePackage{adjustbox} -\RequirePackage{amssymb} -\RequirePackage{stackengine} -\RequirePackage[normalem]{ulem} % for strikeout, but don't modify emphasis - -%---------- Internal commands used in this style file ---------------- - -\newcommand{\ensurespace}[1]{% - \begingroup% - \setlength{\dimen@}{#1}% - \vskip\z@\@plus\dimen@% - \penalty -100\vskip\z@\@plus -\dimen@% - \vskip\dimen@% - \penalty 9999% - \vskip -\dimen@% - \vskip\z@skip% hide the previous |\vskip| from |\addvspace| - \endgroup% -} - -\newcommand{\DoxyHorRuler}{% - \setlength{\parskip}{0ex plus 0ex minus 0ex}% - \hrule% -} -\newcommand{\DoxyLabelFont}{} -\newcommand{\entrylabel}[1]{% - {% - \parbox[b]{\labelwidth-4pt}{% - \makebox[0pt][l]{\DoxyLabelFont#1}% - \vspace{1.5\baselineskip}% - }% - }% -} - -\newenvironment{DoxyDesc}[1]{% - \ensurespace{4\baselineskip}% - \begin{list}{}{% - \settowidth{\labelwidth}{20pt}% - %\setlength{\parsep}{0pt}% - \setlength{\itemsep}{0pt}% - \setlength{\leftmargin}{\labelwidth+\labelsep}% - \renewcommand{\makelabel}{\entrylabel}% - }% - \item[#1]% -}{% - \end{list}% -} - -\newsavebox{\xrefbox} -\newlength{\xreflength} -\newcommand{\xreflabel}[1]{% - \sbox{\xrefbox}{#1}% - \setlength{\xreflength}{\wd\xrefbox}% - \ifthenelse{\xreflength>\labelwidth}{% - \begin{minipage}{\textwidth}% - \setlength{\parindent}{0pt}% - \hangindent=15pt\bfseries #1\vspace{1.2\itemsep}% - \end{minipage}% - }{% - \parbox[b]{\labelwidth}{\makebox[0pt][l]{\textbf{#1}}}% - }% -} - -%---------- Commands used by doxygen LaTeX output generator ---------- - -% Used by 
     ...
    -\newenvironment{DoxyPre}{% - \small% - \begin{alltt}% -}{% - \end{alltt}% - \normalsize% -} -% Necessary for redefining not defined charcaters, i.e. "Replacement Character" in tex output. -\newlength{\CodeWidthChar} -\newlength{\CodeHeightChar} -\settowidth{\CodeWidthChar}{?} -\settoheight{\CodeHeightChar}{?} -% Necessary for hanging indent -\newlength{\DoxyCodeWidth} - -\newcommand\DoxyCodeLine[1]{\hangpara{\DoxyCodeWidth}{1}{#1}\par} - -\newcommand\NiceSpace{% - \discretionary{}{\kern\fontdimen2\font}{\kern\fontdimen2\font}% -} - -% Used by @code ... @endcode -\newenvironment{DoxyCode}[1]{% - \par% - \scriptsize% - \normalfont\ttfamily% - \rightskip0pt plus 1fil% - \settowidth{\DoxyCodeWidth}{000000}% - \settowidth{\CodeWidthChar}{?}% - \settoheight{\CodeHeightChar}{?}% - \setlength{\parskip}{0ex plus 0ex minus 0ex}% - \ifthenelse{\equal{#1}{0}} - { - {\lccode`~32 \lowercase{\global\let~}\NiceSpace}\obeyspaces% - } - { - {\lccode`~32 \lowercase{\global\let~}}\obeyspaces% - } - -}{% - \normalfont% - \normalsize% - \settowidth{\CodeWidthChar}{?}% - \settoheight{\CodeHeightChar}{?}% -} - -% Redefining not defined characters, i.e. "Replacement Character" in tex output. -\def\ucr{\adjustbox{width=\CodeWidthChar,height=\CodeHeightChar}{\stackinset{c}{}{c}{-.2pt}{% - \textcolor{white}{\sffamily\bfseries\small ?}}{% - \rotatebox{45}{$\blacksquare$}}}} - -% Used by @example, @include, @includelineno and @dontinclude -\newenvironment{DoxyCodeInclude}[1]{% - \DoxyCode{#1}% -}{% - \endDoxyCode% -} - -% Used by @verbatim ... @endverbatim -\newenvironment{DoxyVerb}{% - \footnotesize% - \verbatim% -}{% - \endverbatim% - \normalsize% -} - -% Used by @verbinclude -\newenvironment{DoxyVerbInclude}{% - \DoxyVerb% -}{% - \endDoxyVerb% -} - -% Used by numbered lists (using '-#' or
      ...
    ) -\newenvironment{DoxyEnumerate}{% - \enumerate% -}{% - \endenumerate% -} - -% Used by bullet lists (using '-', @li, @arg, or
      ...
    ) -\newenvironment{DoxyItemize}{% - \itemize% -}{% - \enditemize% -} - -% Used by description lists (using
    ...
    ) -\newenvironment{DoxyDescription}{% - \description% -}{% - \enddescription% -} - -% Used by @image, @dotfile, @dot ... @enddot, and @msc ... @endmsc -% (only if caption is specified) -\newenvironment{DoxyImage}{% - \begin{figure}[H]% - \begin{center}% -}{% - \end{center}% - \end{figure}% -} - -% Used by @image, @dotfile, @dot ... @enddot, and @msc ... @endmsc -% (only if no caption is specified) -\newenvironment{DoxyImageNoCaption}{% - \begin{center}% -}{% - \end{center}% -} - -% Used by @image -% (only if inline is specified) -\newenvironment{DoxyInlineImage}{% -}{% -} - -% Used by @attention -\newenvironment{DoxyAttention}[1]{% - \begin{DoxyDesc}{#1}% -}{% - \end{DoxyDesc}% -} - -% Used by @author and @authors -\newenvironment{DoxyAuthor}[1]{% - \begin{DoxyDesc}{#1}% -}{% - \end{DoxyDesc}% -} - -% Used by @date -\newenvironment{DoxyDate}[1]{% - \begin{DoxyDesc}{#1}% -}{% - \end{DoxyDesc}% -} - -% Used by @invariant -\newenvironment{DoxyInvariant}[1]{% - \begin{DoxyDesc}{#1}% -}{% - \end{DoxyDesc}% -} - -% Used by @note -\newenvironment{DoxyNote}[1]{% - \begin{DoxyDesc}{#1}% -}{% - \end{DoxyDesc}% -} - -% Used by @post -\newenvironment{DoxyPostcond}[1]{% - \begin{DoxyDesc}{#1}% -}{% - \end{DoxyDesc}% -} - -% Used by @pre -\newenvironment{DoxyPrecond}[1]{% - \begin{DoxyDesc}{#1}% -}{% - \end{DoxyDesc}% -} - -% Used by @copyright -\newenvironment{DoxyCopyright}[1]{% - \begin{DoxyDesc}{#1}% -}{% - \end{DoxyDesc}% -} - -% Used by @remark -\newenvironment{DoxyRemark}[1]{% - \begin{DoxyDesc}{#1}% -}{% - \end{DoxyDesc}% -} - -% Used by @return and @returns -\newenvironment{DoxyReturn}[1]{% - \begin{DoxyDesc}{#1}% -}{% - \end{DoxyDesc}% -} - -% Used by @since -\newenvironment{DoxySince}[1]{% - \begin{DoxyDesc}{#1}% -}{% - \end{DoxyDesc}% -} - -% Used by @see -\newenvironment{DoxySeeAlso}[1]{% - \begin{DoxyDesc}{#1}% -}{% - \end{DoxyDesc}% -} - -% Used by @version -\newenvironment{DoxyVersion}[1]{% - \begin{DoxyDesc}{#1}% -}{% - \end{DoxyDesc}% -} - -% Used by @warning -\newenvironment{DoxyWarning}[1]{% - \begin{DoxyDesc}{#1}% -}{% - \end{DoxyDesc}% -} - -% Used by @internal -\newenvironment{DoxyInternal}[1]{% - \paragraph*{#1}% -}{% -} - -% Used by @par and @paragraph -\newenvironment{DoxyParagraph}[1]{% - \begin{list}{}{% - \settowidth{\labelwidth}{40pt}% - \setlength{\leftmargin}{\labelwidth+\labelsep}% - \setlength{\parsep}{0pt}% - \setlength{\itemsep}{-4pt}% - \renewcommand{\makelabel}{\entrylabel}% - }% - \item[#1]% -}{% - \end{list}% -} - -% Used by parameter lists -\newenvironment{DoxyParams}[2][]{% - \tabulinesep=1mm% - \par% - \ifthenelse{\equal{#1}{}}% - {\begin{longtabu*}spread 0pt [l]{|X[-1,l]|X[-1,l]|}}% name + description - {\ifthenelse{\equal{#1}{1}}% - {\begin{longtabu*}spread 0pt [l]{|X[-1,l]|X[-1,l]|X[-1,l]|}}% in/out + name + desc - {\begin{longtabu*}spread 0pt [l]{|X[-1,l]|X[-1,l]|X[-1,l]|X[-1,l]|}}% in/out + type + name + desc - } - \multicolumn{2}{l}{\hspace{-6pt}\bfseries\fontseries{bc}\selectfont\color{darkgray} #2}\\[1ex]% - \hline% - \endfirsthead% - \multicolumn{2}{l}{\hspace{-6pt}\bfseries\fontseries{bc}\selectfont\color{darkgray} #2}\\[1ex]% - \hline% - \endhead% -}{% - \end{longtabu*}% - \vspace{6pt}% -} - -% Used for fields of simple structs -\newenvironment{DoxyFields}[1]{% - \tabulinesep=1mm% - \par% - \begin{longtabu*}spread 0pt [l]{|X[-1,r]|X[-1,l]|X[-1,l]|}% - \multicolumn{3}{l}{\hspace{-6pt}\bfseries\fontseries{bc}\selectfont\color{darkgray} #1}\\[1ex]% - \hline% - \endfirsthead% - \multicolumn{3}{l}{\hspace{-6pt}\bfseries\fontseries{bc}\selectfont\color{darkgray} #1}\\[1ex]% - \hline% - \endhead% -}{% - \end{longtabu*}% - \vspace{6pt}% -} - -% Used for fields simple class style enums -\newenvironment{DoxyEnumFields}[1]{% - \tabulinesep=1mm% - \par% - \begin{longtabu*}spread 0pt [l]{|X[-1,r]|X[-1,l]|}% - \multicolumn{2}{l}{\hspace{-6pt}\bfseries\fontseries{bc}\selectfont\color{darkgray} #1}\\[1ex]% - \hline% - \endfirsthead% - \multicolumn{2}{l}{\hspace{-6pt}\bfseries\fontseries{bc}\selectfont\color{darkgray} #1}\\[1ex]% - \hline% - \endhead% -}{% - \end{longtabu*}% - \vspace{6pt}% -} - -% Used for parameters within a detailed function description -\newenvironment{DoxyParamCaption}{% - \renewcommand{\item}[2][]{\\ \hspace*{2.0cm} ##1 {\em ##2}}% -}{% -} - -% Used by return value lists -\newenvironment{DoxyRetVals}[1]{% - \tabulinesep=1mm% - \par% - \begin{longtabu*}spread 0pt [l]{|X[-1,r]|X[-1,l]|}% - \multicolumn{2}{l}{\hspace{-6pt}\bfseries\fontseries{bc}\selectfont\color{darkgray} #1}\\[1ex]% - \hline% - \endfirsthead% - \multicolumn{2}{l}{\hspace{-6pt}\bfseries\fontseries{bc}\selectfont\color{darkgray} #1}\\[1ex]% - \hline% - \endhead% -}{% - \end{longtabu*}% - \vspace{6pt}% -} - -% Used by exception lists -\newenvironment{DoxyExceptions}[1]{% - \tabulinesep=1mm% - \par% - \begin{longtabu*}spread 0pt [l]{|X[-1,r]|X[-1,l]|}% - \multicolumn{2}{l}{\hspace{-6pt}\bfseries\fontseries{bc}\selectfont\color{darkgray} #1}\\[1ex]% - \hline% - \endfirsthead% - \multicolumn{2}{l}{\hspace{-6pt}\bfseries\fontseries{bc}\selectfont\color{darkgray} #1}\\[1ex]% - \hline% - \endhead% -}{% - \end{longtabu*}% - \vspace{6pt}% -} - -% Used by template parameter lists -\newenvironment{DoxyTemplParams}[1]{% - \tabulinesep=1mm% - \par% - \begin{longtabu*}spread 0pt [l]{|X[-1,r]|X[-1,l]|}% - \multicolumn{2}{l}{\hspace{-6pt}\bfseries\fontseries{bc}\selectfont\color{darkgray} #1}\\[1ex]% - \hline% - \endfirsthead% - \multicolumn{2}{l}{\hspace{-6pt}\bfseries\fontseries{bc}\selectfont\color{darkgray} #1}\\[1ex]% - \hline% - \endhead% -}{% - \end{longtabu*}% - \vspace{6pt}% -} - -% Used for member lists -\newenvironment{DoxyCompactItemize}{% - \begin{itemize}% - \setlength{\itemsep}{-3pt}% - \setlength{\parsep}{0pt}% - \setlength{\topsep}{0pt}% - \setlength{\partopsep}{0pt}% -}{% - \end{itemize}% -} - -% Used for member descriptions -\newenvironment{DoxyCompactList}{% - \begin{list}{}{% - \setlength{\leftmargin}{0.5cm}% - \setlength{\itemsep}{0pt}% - \setlength{\parsep}{0pt}% - \setlength{\topsep}{0pt}% - \renewcommand{\makelabel}{\hfill}% - }% -}{% - \end{list}% -} - -% Used for reference lists (@bug, @deprecated, @todo, etc.) -\newenvironment{DoxyRefList}{% - \begin{list}{}{% - \setlength{\labelwidth}{10pt}% - \setlength{\leftmargin}{\labelwidth}% - \addtolength{\leftmargin}{\labelsep}% - \renewcommand{\makelabel}{\xreflabel}% - }% -}{% - \end{list}% -} - -% Used by @bug, @deprecated, @todo, etc. -\newenvironment{DoxyRefDesc}[1]{% - \begin{list}{}{% - \renewcommand\makelabel[1]{\textbf{##1}}% - \settowidth\labelwidth{\makelabel{#1}}% - \setlength\leftmargin{\labelwidth+\labelsep}% - }% -}{% - \end{list}% -} - -% Used by parameter lists and simple sections -\newenvironment{Desc} -{\begin{list}{}{% - \settowidth{\labelwidth}{20pt}% - \setlength{\parsep}{0pt}% - \setlength{\itemsep}{0pt}% - \setlength{\leftmargin}{\labelwidth+\labelsep}% - \renewcommand{\makelabel}{\entrylabel}% - } -}{% - \end{list}% -} - -% Used by tables -\newcommand{\PBS}[1]{\let\temp=\\#1\let\\=\temp}% -\newenvironment{TabularC}[1]% -{\tabulinesep=1mm -\begin{longtabu*}spread 0pt [c]{*#1{|X[-1]}|}}% -{\end{longtabu*}\par}% - -\newenvironment{TabularNC}[1]% -{\begin{tabu}spread 0pt [l]{*#1{|X[-1]}|}}% -{\end{tabu}\par}% - -% Used for member group headers -\newenvironment{Indent}{% - \begin{list}{}{% - \setlength{\leftmargin}{0.5cm}% - }% - \item[]\ignorespaces% -}{% - \unskip% - \end{list}% -} - -% Used when hyperlinks are turned off -\newcommand{\doxyref}[3]{% - \textbf{#1} (\textnormal{#2}\,\pageref{#3})% -} - -% Used to link to a table when hyperlinks are turned on -\newcommand{\doxytablelink}[2]{% - \ref{#1}% -} - -% Used to link to a table when hyperlinks are turned off -\newcommand{\doxytableref}[3]{% - \ref{#3}% -} - -% Used by @addindex -\newcommand{\lcurly}{\{} -\newcommand{\rcurly}{\}} - -% Colors used for syntax highlighting -\definecolor{comment}{rgb}{0.5,0.0,0.0} -\definecolor{keyword}{rgb}{0.0,0.5,0.0} -\definecolor{keywordtype}{rgb}{0.38,0.25,0.125} -\definecolor{keywordflow}{rgb}{0.88,0.5,0.0} -\definecolor{preprocessor}{rgb}{0.5,0.38,0.125} -\definecolor{stringliteral}{rgb}{0.0,0.125,0.25} -\definecolor{charliteral}{rgb}{0.0,0.5,0.5} -\definecolor{vhdldigit}{rgb}{1.0,0.0,1.0} -\definecolor{vhdlkeyword}{rgb}{0.43,0.0,0.43} -\definecolor{vhdllogic}{rgb}{1.0,0.0,0.0} -\definecolor{vhdlchar}{rgb}{0.0,0.0,0.0} - -% Color used for table heading -\newcommand{\tableheadbgcolor}{lightgray}% - -% Version of hypertarget with correct landing location -\newcommand{\Hypertarget}[1]{\Hy@raisedlink{\hypertarget{#1}{}}} - -% possibility to have sections etc. be within the margins -\makeatletter -\newcommand{\doxysection}{\@ifstar{\doxysection@star}{\doxysection@nostar}} -\newcommand{\doxysection@star}[1]{\begingroup\sloppy\raggedright\section*{#1}\endgroup} -\newcommand{\doxysection@nostar}[1]{\begingroup\sloppy\raggedright\section{#1}\endgroup} -\newcommand{\doxysubsection}{\@ifstar{\doxysubsection@star}{\doxysubsection@nostar}} -\newcommand{\doxysubsection@star}[1]{\begingroup\sloppy\raggedright\subsection*{#1}\endgroup} -\newcommand{\doxysubsection@nostar}[1]{\begingroup\sloppy\raggedright\subsection{#1}\endgroup} -\newcommand{\doxysubsubsection}{\@ifstar{\doxysubsubsection@star}{\doxysubsubsection@nostar}} -\newcommand{\doxysubsubsection@star}[1]{\begingroup\sloppy\raggedright\subsubsection*{#1}\endgroup} -\newcommand{\doxysubsubsection@nostar}[1]{\begingroup\sloppy\raggedright\subsubsection{#1}\endgroup} -\newcommand{\doxyparagraph}{\@ifstar{\doxyparagraph@star}{\doxyparagraph@nostar}} -\newcommand{\doxyparagraph@star}[1]{\begingroup\sloppy\raggedright\paragraph*{#1}\endgroup} -\newcommand{\doxyparagraph@nostar}[1]{\begingroup\sloppy\raggedright\paragraph{#1}\endgroup} -\newcommand{\doxysubparagraph}{\@ifstar{\doxysubparagraph@star}{\doxysubparagraph@nostar}} -\newcommand{\doxysubparagraph@star}[1]{\begingroup\sloppy\raggedright\subparagraph*{#1}\endgroup} -\newcommand{\doxysubparagraph@nostar}[1]{\begingroup\sloppy\raggedright\subparagraph{#1}\endgroup} -\makeatother -% Define caption that is also suitable in a table -\makeatletter -\def\doxyfigcaption{% -\refstepcounter{figure}% -\@dblarg{\@caption{figure}}} -\makeatother diff --git a/docs/latex/hierarchy.tex b/docs/latex/hierarchy.tex deleted file mode 100644 index 4f0819d..0000000 --- a/docs/latex/hierarchy.tex +++ /dev/null @@ -1,21 +0,0 @@ -\doxysection{Class Hierarchy} -This inheritance list is sorted roughly, but not completely, alphabetically\+:\begin{DoxyCompactList} -\item \contentsline{section}{B15F}{\pageref{classB15F}}{} -\item \contentsline{section}{Dot}{\pageref{classDot}}{} -\item exception\begin{DoxyCompactList} -\item \contentsline{section}{Driver\+Exception}{\pageref{classDriverException}}{} -\item \contentsline{section}{Timeout\+Exception}{\pageref{classTimeoutException}}{} -\item \contentsline{section}{U\+S\+A\+R\+T\+Exception}{\pageref{classUSARTException}}{} -\end{DoxyCompactList} -\item \contentsline{section}{Plotty\+File}{\pageref{classPlottyFile}}{} -\item \contentsline{section}{U\+S\+A\+RT}{\pageref{classUSART}}{} -\item \contentsline{section}{View}{\pageref{classView}}{} -\begin{DoxyCompactList} -\item \contentsline{section}{View\+Info}{\pageref{classViewInfo}}{} -\begin{DoxyCompactList} -\item \contentsline{section}{View\+Monitor}{\pageref{classViewMonitor}}{} -\end{DoxyCompactList} -\item \contentsline{section}{View\+Promt}{\pageref{classViewPromt}}{} -\item \contentsline{section}{View\+Selection}{\pageref{classViewSelection}}{} -\end{DoxyCompactList} -\end{DoxyCompactList} diff --git a/docs/latex/refman.tex b/docs/latex/refman.tex deleted file mode 100644 index a82c3da..0000000 --- a/docs/latex/refman.tex +++ /dev/null @@ -1,189 +0,0 @@ -\let\mypdfximage\pdfximage\def\pdfximage{\immediate\mypdfximage}\documentclass[twoside]{book} - -% Packages required by doxygen -\usepackage{fixltx2e} -\usepackage{calc} -\usepackage{doxygen} -\usepackage{graphicx} -\usepackage[utf8]{inputenc} -\usepackage{makeidx} -\usepackage{multicol} -\usepackage{multirow} -\PassOptionsToPackage{warn}{textcomp} -\usepackage{textcomp} -\usepackage[nointegrals]{wasysym} -\usepackage[table]{xcolor} -\usepackage{ifpdf,ifxetex} - -% Font selection -\usepackage[T1]{fontenc} -\usepackage[scaled=.90]{helvet} -\usepackage{courier} -\usepackage{amssymb} -\usepackage{sectsty} -\renewcommand{\familydefault}{\sfdefault} -\allsectionsfont{% - \fontseries{bc}\selectfont% - \color{darkgray}% -} -\renewcommand{\DoxyLabelFont}{% - \fontseries{bc}\selectfont% - \color{darkgray}% -} -\newcommand{\+}{\discretionary{\mbox{\scriptsize$\hookleftarrow$}}{}{}} - -% Arguments of doxygenemoji: -% 1) '::' form of the emoji, already "LaTeX"-escaped -% 2) file with the name of the emoji without the .png extension -% in case image exist use this otherwise use the '::' form -\newcommand{\doxygenemoji}[2]{% - \IfFileExists{./#2.png}{\raisebox{-0.1em}{\includegraphics[height=0.9em]{./#2.png}}}{#1}% -} -% Page & text layout -\usepackage{geometry} -\geometry{% - a4paper,% - top=2.5cm,% - bottom=2.5cm,% - left=2.5cm,% - right=2.5cm% -} -\tolerance=750 -\hfuzz=15pt -\hbadness=750 -\setlength{\emergencystretch}{15pt} -\setlength{\parindent}{0cm} -\newcommand{\doxynormalparskip}{\setlength{\parskip}{3ex plus 2ex minus 2ex}} -\newcommand{\doxytocparskip}{\setlength{\parskip}{1ex plus 0ex minus 0ex}} -\doxynormalparskip -\makeatletter -\renewcommand{\paragraph}{% - \@startsection{paragraph}{4}{0ex}{-1.0ex}{1.0ex}{% - \normalfont\normalsize\bfseries\SS@parafont% - }% -} -\renewcommand{\subparagraph}{% - \@startsection{subparagraph}{5}{0ex}{-1.0ex}{1.0ex}{% - \normalfont\normalsize\bfseries\SS@subparafont% - }% -} -\makeatother - -% Headers & footers -\usepackage{fancyhdr} -\pagestyle{fancyplain} -\fancyhead[LE]{\fancyplain{}{\bfseries\thepage}} -\fancyhead[CE]{\fancyplain{}{}} -\fancyhead[RE]{\fancyplain{}{\bfseries\leftmark}} -\fancyhead[LO]{\fancyplain{}{\bfseries\rightmark}} -\fancyhead[CO]{\fancyplain{}{}} -\fancyhead[RO]{\fancyplain{}{\bfseries\thepage}} -\fancyfoot[LE]{\fancyplain{}{}} -\fancyfoot[CE]{\fancyplain{}{}} -\fancyfoot[RE]{\fancyplain{}{\bfseries\scriptsize Generated by Doxygen }} -\fancyfoot[LO]{\fancyplain{}{\bfseries\scriptsize Generated by Doxygen }} -\fancyfoot[CO]{\fancyplain{}{}} -\fancyfoot[RO]{\fancyplain{}{}} -\renewcommand{\footrulewidth}{0.4pt} -\renewcommand{\chaptermark}[1]{% - \markboth{#1}{}% -} -\renewcommand{\sectionmark}[1]{% - \markright{\thesection\ #1}% -} - -% Indices & bibliography -\usepackage{natbib} -\usepackage[titles]{tocloft} -\setcounter{tocdepth}{3} -\setcounter{secnumdepth}{5} -\makeindex - -\usepackage{newunicodechar} - \newunicodechar{⁻}{${}^{-}$}% Superscript minus - \newunicodechar{²}{${}^{2}$}% Superscript two - \newunicodechar{³}{${}^{3}$}% Superscript three - -% Hyperlinks (required, but should be loaded last) -\ifpdf - \usepackage[pdftex,pagebackref=true]{hyperref} -\else - \ifxetex - \usepackage[pagebackref=true]{hyperref} - \else - \usepackage[ps2pdf,pagebackref=true]{hyperref} - \fi -\fi - -\hypersetup{% - colorlinks=true,% - linkcolor=blue,% - citecolor=blue,% - unicode% -} - -% Custom commands -\newcommand{\clearemptydoublepage}{% - \newpage{\pagestyle{empty}\cleardoublepage}% -} - -\usepackage{caption} -\captionsetup{labelsep=space,justification=centering,font={bf},singlelinecheck=off,skip=4pt,position=top} - -\usepackage{etoc} -\etocsettocstyle{\doxytocparskip}{\doxynormalparskip} -\renewcommand{\numberline}[1]{#1~} -%===== C O N T E N T S ===== - -\begin{document} - -% Titlepage & ToC -\hypersetup{pageanchor=false, - bookmarksnumbered=true, - pdfencoding=unicode - } -\pagenumbering{alph} -\begin{titlepage} -\vspace*{7cm} -\begin{center}% -{\Large B15F }\\ -\vspace*{1cm} -{\large Generated by Doxygen 1.8.16}\\ -\end{center} -\end{titlepage} -\clearemptydoublepage -\pagenumbering{roman} -\tableofcontents -\clearemptydoublepage -\pagenumbering{arabic} -\hypersetup{pageanchor=true} - -%--- Begin generated contents --- -\chapter{Hierarchical Index} -\input{hierarchy} -\chapter{Class Index} -\input{annotated} -\chapter{Class Documentation} -\input{classB15F} -\input{classDot} -\input{classDriverException} -\input{classPlottyFile} -\input{classTimeoutException} -\input{classUSART} -\input{classUSARTException} -\input{classView} -\input{classViewInfo} -\input{classViewMonitor} -\input{classViewPromt} -\input{classViewSelection} -%--- End generated contents --- - -% Index -\backmatter -\newpage -\phantomsection -\clearemptydoublepage -\addcontentsline{toc}{chapter}{\indexname} -\printindex - -\end{document}