YARP
Yet Another Robot Platform
 
Loading...
Searching...
No Matches
PidUnitsData.cpp
Go to the documentation of this file.
1/*
2 * SPDX-FileCopyrightText: 2006-2021 Istituto Italiano di Tecnologia (IIT)
3 * SPDX-License-Identifier: BSD-3-Clause
4 */
5
6// Autogenerated by Thrift (based on compiler 0.14.1-yarped)
7// yarpidl_thrift version 2.0 - 11/11/2026
8// This is an automatically generated file.
9// It could get re-generated if the ALLOW_IDL_GENERATION flag is on.
10
12
13namespace yarp::dev {
14
15// Constructor with field values
16PidUnitsData::PidUnitsData(const std::string& units_kp,
17 const std::string& units_kd,
18 const std::string& units_ki,
19 const std::string& units_max_int,
20 const std::string& units_scale,
21 const std::string& units_max_output,
22 const std::string& units_offset,
23 const std::string& units_stiction_up_val,
24 const std::string& units_stiction_down_val,
25 const std::string& units_kff) :
26 WirePortable(),
27 units_kp(units_kp),
28 units_kd(units_kd),
29 units_ki(units_ki),
30 units_max_int(units_max_int),
31 units_scale(units_scale),
32 units_max_output(units_max_output),
33 units_offset(units_offset),
34 units_stiction_up_val(units_stiction_up_val),
35 units_stiction_down_val(units_stiction_down_val),
36 units_kff(units_kff)
37{
38}
39
40// Read structure on a Wire
42{
43 if (!read_units_kp(reader)) {
44 return false;
45 }
46 if (!read_units_kd(reader)) {
47 return false;
48 }
49 if (!read_units_ki(reader)) {
50 return false;
51 }
52 if (!read_units_max_int(reader)) {
53 return false;
54 }
55 if (!read_units_scale(reader)) {
56 return false;
57 }
58 if (!read_units_max_output(reader)) {
59 return false;
60 }
61 if (!read_units_offset(reader)) {
62 return false;
63 }
64 if (!read_units_stiction_up_val(reader)) {
65 return false;
66 }
67 if (!read_units_stiction_down_val(reader)) {
68 return false;
69 }
70 if (!read_units_kff(reader)) {
71 return false;
72 }
73 if (reader.isError()) {
74 return false;
75 }
76 return true;
77}
78
79// Read structure on a Connection
81{
82 yarp::os::idl::WireReader reader(connection);
83 if (!reader.readListHeader(10)) {
84 return false;
85 }
86 if (!read(reader)) {
87 return false;
88 }
89 return true;
90}
91
92// Write structure on a Wire
94{
95 if (!write_units_kp(writer)) {
96 return false;
97 }
98 if (!write_units_kd(writer)) {
99 return false;
100 }
101 if (!write_units_ki(writer)) {
102 return false;
103 }
104 if (!write_units_max_int(writer)) {
105 return false;
106 }
107 if (!write_units_scale(writer)) {
108 return false;
109 }
110 if (!write_units_max_output(writer)) {
111 return false;
112 }
113 if (!write_units_offset(writer)) {
114 return false;
115 }
116 if (!write_units_stiction_up_val(writer)) {
117 return false;
118 }
119 if (!write_units_stiction_down_val(writer)) {
120 return false;
121 }
122 if (!write_units_kff(writer)) {
123 return false;
124 }
125 if (writer.isError()) {
126 return false;
127 }
128 return true;
129}
130
131// Write structure on a Connection
133{
134 yarp::os::idl::WireWriter writer(connection);
135 if (!writer.writeListHeader(10)) {
136 return false;
137 }
138 if (!write(writer)) {
139 return false;
140 }
141 return true;
142}
143
144// Convert to a printable string
145std::string PidUnitsData::toString() const
146{
148 if (!yarp::os::Portable::copyPortable(*this, b)) {
149 return {};
150 }
151 return b.toString();
152}
153
154// read units_kp field
155bool PidUnitsData::read_units_kp(yarp::os::idl::WireReader& reader)
156{
157 if (reader.noMore()) {
158 reader.fail();
159 return false;
160 }
161 if (!reader.readString(units_kp)) {
162 reader.fail();
163 return false;
164 }
165 return true;
166}
167
168// write units_kp field
169bool PidUnitsData::write_units_kp(const yarp::os::idl::WireWriter& writer) const
170{
171 if (!writer.writeString(units_kp)) {
172 return false;
173 }
174 return true;
175}
176
177// read (nested) units_kp field
178bool PidUnitsData::nested_read_units_kp(yarp::os::idl::WireReader& reader)
179{
180 if (reader.noMore()) {
181 reader.fail();
182 return false;
183 }
184 if (!reader.readString(units_kp)) {
185 reader.fail();
186 return false;
187 }
188 return true;
189}
190
191// write (nested) units_kp field
192bool PidUnitsData::nested_write_units_kp(const yarp::os::idl::WireWriter& writer) const
193{
194 if (!writer.writeString(units_kp)) {
195 return false;
196 }
197 return true;
198}
199
200// read units_kd field
201bool PidUnitsData::read_units_kd(yarp::os::idl::WireReader& reader)
202{
203 if (reader.noMore()) {
204 reader.fail();
205 return false;
206 }
207 if (!reader.readString(units_kd)) {
208 reader.fail();
209 return false;
210 }
211 return true;
212}
213
214// write units_kd field
215bool PidUnitsData::write_units_kd(const yarp::os::idl::WireWriter& writer) const
216{
217 if (!writer.writeString(units_kd)) {
218 return false;
219 }
220 return true;
221}
222
223// read (nested) units_kd field
224bool PidUnitsData::nested_read_units_kd(yarp::os::idl::WireReader& reader)
225{
226 if (reader.noMore()) {
227 reader.fail();
228 return false;
229 }
230 if (!reader.readString(units_kd)) {
231 reader.fail();
232 return false;
233 }
234 return true;
235}
236
237// write (nested) units_kd field
238bool PidUnitsData::nested_write_units_kd(const yarp::os::idl::WireWriter& writer) const
239{
240 if (!writer.writeString(units_kd)) {
241 return false;
242 }
243 return true;
244}
245
246// read units_ki field
247bool PidUnitsData::read_units_ki(yarp::os::idl::WireReader& reader)
248{
249 if (reader.noMore()) {
250 reader.fail();
251 return false;
252 }
253 if (!reader.readString(units_ki)) {
254 reader.fail();
255 return false;
256 }
257 return true;
258}
259
260// write units_ki field
261bool PidUnitsData::write_units_ki(const yarp::os::idl::WireWriter& writer) const
262{
263 if (!writer.writeString(units_ki)) {
264 return false;
265 }
266 return true;
267}
268
269// read (nested) units_ki field
270bool PidUnitsData::nested_read_units_ki(yarp::os::idl::WireReader& reader)
271{
272 if (reader.noMore()) {
273 reader.fail();
274 return false;
275 }
276 if (!reader.readString(units_ki)) {
277 reader.fail();
278 return false;
279 }
280 return true;
281}
282
283// write (nested) units_ki field
284bool PidUnitsData::nested_write_units_ki(const yarp::os::idl::WireWriter& writer) const
285{
286 if (!writer.writeString(units_ki)) {
287 return false;
288 }
289 return true;
290}
291
292// read units_max_int field
293bool PidUnitsData::read_units_max_int(yarp::os::idl::WireReader& reader)
294{
295 if (reader.noMore()) {
296 reader.fail();
297 return false;
298 }
299 if (!reader.readString(units_max_int)) {
300 reader.fail();
301 return false;
302 }
303 return true;
304}
305
306// write units_max_int field
307bool PidUnitsData::write_units_max_int(const yarp::os::idl::WireWriter& writer) const
308{
309 if (!writer.writeString(units_max_int)) {
310 return false;
311 }
312 return true;
313}
314
315// read (nested) units_max_int field
316bool PidUnitsData::nested_read_units_max_int(yarp::os::idl::WireReader& reader)
317{
318 if (reader.noMore()) {
319 reader.fail();
320 return false;
321 }
322 if (!reader.readString(units_max_int)) {
323 reader.fail();
324 return false;
325 }
326 return true;
327}
328
329// write (nested) units_max_int field
330bool PidUnitsData::nested_write_units_max_int(const yarp::os::idl::WireWriter& writer) const
331{
332 if (!writer.writeString(units_max_int)) {
333 return false;
334 }
335 return true;
336}
337
338// read units_scale field
339bool PidUnitsData::read_units_scale(yarp::os::idl::WireReader& reader)
340{
341 if (reader.noMore()) {
342 reader.fail();
343 return false;
344 }
345 if (!reader.readString(units_scale)) {
346 reader.fail();
347 return false;
348 }
349 return true;
350}
351
352// write units_scale field
353bool PidUnitsData::write_units_scale(const yarp::os::idl::WireWriter& writer) const
354{
355 if (!writer.writeString(units_scale)) {
356 return false;
357 }
358 return true;
359}
360
361// read (nested) units_scale field
362bool PidUnitsData::nested_read_units_scale(yarp::os::idl::WireReader& reader)
363{
364 if (reader.noMore()) {
365 reader.fail();
366 return false;
367 }
368 if (!reader.readString(units_scale)) {
369 reader.fail();
370 return false;
371 }
372 return true;
373}
374
375// write (nested) units_scale field
376bool PidUnitsData::nested_write_units_scale(const yarp::os::idl::WireWriter& writer) const
377{
378 if (!writer.writeString(units_scale)) {
379 return false;
380 }
381 return true;
382}
383
384// read units_max_output field
385bool PidUnitsData::read_units_max_output(yarp::os::idl::WireReader& reader)
386{
387 if (reader.noMore()) {
388 reader.fail();
389 return false;
390 }
391 if (!reader.readString(units_max_output)) {
392 reader.fail();
393 return false;
394 }
395 return true;
396}
397
398// write units_max_output field
399bool PidUnitsData::write_units_max_output(const yarp::os::idl::WireWriter& writer) const
400{
401 if (!writer.writeString(units_max_output)) {
402 return false;
403 }
404 return true;
405}
406
407// read (nested) units_max_output field
408bool PidUnitsData::nested_read_units_max_output(yarp::os::idl::WireReader& reader)
409{
410 if (reader.noMore()) {
411 reader.fail();
412 return false;
413 }
414 if (!reader.readString(units_max_output)) {
415 reader.fail();
416 return false;
417 }
418 return true;
419}
420
421// write (nested) units_max_output field
422bool PidUnitsData::nested_write_units_max_output(const yarp::os::idl::WireWriter& writer) const
423{
424 if (!writer.writeString(units_max_output)) {
425 return false;
426 }
427 return true;
428}
429
430// read units_offset field
431bool PidUnitsData::read_units_offset(yarp::os::idl::WireReader& reader)
432{
433 if (reader.noMore()) {
434 reader.fail();
435 return false;
436 }
437 if (!reader.readString(units_offset)) {
438 reader.fail();
439 return false;
440 }
441 return true;
442}
443
444// write units_offset field
445bool PidUnitsData::write_units_offset(const yarp::os::idl::WireWriter& writer) const
446{
447 if (!writer.writeString(units_offset)) {
448 return false;
449 }
450 return true;
451}
452
453// read (nested) units_offset field
454bool PidUnitsData::nested_read_units_offset(yarp::os::idl::WireReader& reader)
455{
456 if (reader.noMore()) {
457 reader.fail();
458 return false;
459 }
460 if (!reader.readString(units_offset)) {
461 reader.fail();
462 return false;
463 }
464 return true;
465}
466
467// write (nested) units_offset field
468bool PidUnitsData::nested_write_units_offset(const yarp::os::idl::WireWriter& writer) const
469{
470 if (!writer.writeString(units_offset)) {
471 return false;
472 }
473 return true;
474}
475
476// read units_stiction_up_val field
477bool PidUnitsData::read_units_stiction_up_val(yarp::os::idl::WireReader& reader)
478{
479 if (reader.noMore()) {
480 reader.fail();
481 return false;
482 }
483 if (!reader.readString(units_stiction_up_val)) {
484 reader.fail();
485 return false;
486 }
487 return true;
488}
489
490// write units_stiction_up_val field
491bool PidUnitsData::write_units_stiction_up_val(const yarp::os::idl::WireWriter& writer) const
492{
493 if (!writer.writeString(units_stiction_up_val)) {
494 return false;
495 }
496 return true;
497}
498
499// read (nested) units_stiction_up_val field
500bool PidUnitsData::nested_read_units_stiction_up_val(yarp::os::idl::WireReader& reader)
501{
502 if (reader.noMore()) {
503 reader.fail();
504 return false;
505 }
506 if (!reader.readString(units_stiction_up_val)) {
507 reader.fail();
508 return false;
509 }
510 return true;
511}
512
513// write (nested) units_stiction_up_val field
514bool PidUnitsData::nested_write_units_stiction_up_val(const yarp::os::idl::WireWriter& writer) const
515{
516 if (!writer.writeString(units_stiction_up_val)) {
517 return false;
518 }
519 return true;
520}
521
522// read units_stiction_down_val field
523bool PidUnitsData::read_units_stiction_down_val(yarp::os::idl::WireReader& reader)
524{
525 if (reader.noMore()) {
526 reader.fail();
527 return false;
528 }
529 if (!reader.readString(units_stiction_down_val)) {
530 reader.fail();
531 return false;
532 }
533 return true;
534}
535
536// write units_stiction_down_val field
537bool PidUnitsData::write_units_stiction_down_val(const yarp::os::idl::WireWriter& writer) const
538{
540 return false;
541 }
542 return true;
543}
544
545// read (nested) units_stiction_down_val field
546bool PidUnitsData::nested_read_units_stiction_down_val(yarp::os::idl::WireReader& reader)
547{
548 if (reader.noMore()) {
549 reader.fail();
550 return false;
551 }
552 if (!reader.readString(units_stiction_down_val)) {
553 reader.fail();
554 return false;
555 }
556 return true;
557}
558
559// write (nested) units_stiction_down_val field
560bool PidUnitsData::nested_write_units_stiction_down_val(const yarp::os::idl::WireWriter& writer) const
561{
563 return false;
564 }
565 return true;
566}
567
568// read units_kff field
569bool PidUnitsData::read_units_kff(yarp::os::idl::WireReader& reader)
570{
571 if (reader.noMore()) {
572 reader.fail();
573 return false;
574 }
575 if (!reader.readString(units_kff)) {
576 reader.fail();
577 return false;
578 }
579 return true;
580}
581
582// write units_kff field
583bool PidUnitsData::write_units_kff(const yarp::os::idl::WireWriter& writer) const
584{
585 if (!writer.writeString(units_kff)) {
586 return false;
587 }
588 return true;
589}
590
591// read (nested) units_kff field
592bool PidUnitsData::nested_read_units_kff(yarp::os::idl::WireReader& reader)
593{
594 if (reader.noMore()) {
595 reader.fail();
596 return false;
597 }
598 if (!reader.readString(units_kff)) {
599 reader.fail();
600 return false;
601 }
602 return true;
603}
604
605// write (nested) units_kff field
606bool PidUnitsData::nested_write_units_kff(const yarp::os::idl::WireWriter& writer) const
607{
608 if (!writer.writeString(units_kff)) {
609 return false;
610 }
611 return true;
612}
613
614} // namespace yarp::dev
bool read(yarp::os::idl::WireReader &reader) override
bool write(const yarp::os::idl::WireWriter &writer) const override
std::string units_kd
derivative gain
std::string toString() const
std::string units_ki
integrative gain
std::string units_stiction_up_val
up stiction offset added to the pid output
std::string units_stiction_down_val
down stiction offset added to the pid output
std::string units_scale
scale for the pid output
std::string units_max_output
max output
std::string units_kff
feedforward gain
std::string units_max_int
saturation threshold for the integrator
std::string units_kp
proportional gain
std::string units_offset
pwm offset added to the pid output
A simple collection of objects that can be described and transmitted in a portable way.
Definition Bottle.h:64
std::string toString() const override
Gives a human-readable textual representation of the bottle.
Definition Bottle.cpp:212
An interface for reading from a network connection.
An interface for writing to a network connection.
static bool copyPortable(const PortWriter &writer, PortReader &reader)
Copy one portable to another, via writing and reading.
Definition Portable.cpp:16
IDL-friendly connection reader.
Definition WireReader.h:27
bool readString(std::string &str, bool *is_vocab=nullptr)
IDL-friendly connection writer.
Definition WireWriter.h:28
bool writeListHeader(int len) const
bool writeString(const std::string &str, bool skip_tag=false) const
For streams capable of holding different kinds of content, check what they actually have.