YARP
Yet Another Robot Platform
 
Loading...
Searching...
No Matches
PidGainsData.h
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
11#ifndef YARP_THRIFT_GENERATOR_STRUCT_PIDGAINSDATA_H
12#define YARP_THRIFT_GENERATOR_STRUCT_PIDGAINSDATA_H
13
14#include <yarp/dev/api.h>
15
16#include <yarp/os/Wire.h>
18
19namespace yarp::dev {
20
23{
24public:
25 // Fields
29 double kp{0.0};
33 double kd{0.0};
37 double ki{0.0};
41 double max_int{0.0};
45 double scale{0.0};
49 double max_output{0.0};
53 double offset{0.0};
57 double stiction_up_val{0.0};
61 double stiction_down_val{0.0};
65 double kff{0.0};
66
67public:
68 // Default constructor
69 PidGainsData() = default;
70
71 // Constructor with field values
72 PidGainsData(const double kp,
73 const double kd,
74 const double ki,
75 const double max_int,
76 const double scale,
77 const double max_output,
78 const double offset,
79 const double stiction_up_val,
80 const double stiction_down_val,
81 const double kff);
82
83 // Read structure on a Wire
84 bool read(yarp::os::idl::WireReader& reader) override;
85
86 // Read structure on a Connection
87 bool read(yarp::os::ConnectionReader& connection) override;
88
89 // Write structure on a Wire
90 bool write(const yarp::os::idl::WireWriter& writer) const override;
91
92 // Write structure on a Connection
93 bool write(yarp::os::ConnectionWriter& connection) const override;
94
95 // Convert to a printable string
96 std::string toString() const;
97
98 // If you want to serialize this class without nesting, use this helper
100
101private:
102 // read/write kp field
103 bool read_kp(yarp::os::idl::WireReader& reader);
104 bool write_kp(const yarp::os::idl::WireWriter& writer) const;
105 bool nested_read_kp(yarp::os::idl::WireReader& reader);
106 bool nested_write_kp(const yarp::os::idl::WireWriter& writer) const;
107
108 // read/write kd field
109 bool read_kd(yarp::os::idl::WireReader& reader);
110 bool write_kd(const yarp::os::idl::WireWriter& writer) const;
111 bool nested_read_kd(yarp::os::idl::WireReader& reader);
112 bool nested_write_kd(const yarp::os::idl::WireWriter& writer) const;
113
114 // read/write ki field
115 bool read_ki(yarp::os::idl::WireReader& reader);
116 bool write_ki(const yarp::os::idl::WireWriter& writer) const;
117 bool nested_read_ki(yarp::os::idl::WireReader& reader);
118 bool nested_write_ki(const yarp::os::idl::WireWriter& writer) const;
119
120 // read/write max_int field
121 bool read_max_int(yarp::os::idl::WireReader& reader);
122 bool write_max_int(const yarp::os::idl::WireWriter& writer) const;
123 bool nested_read_max_int(yarp::os::idl::WireReader& reader);
124 bool nested_write_max_int(const yarp::os::idl::WireWriter& writer) const;
125
126 // read/write scale field
127 bool read_scale(yarp::os::idl::WireReader& reader);
128 bool write_scale(const yarp::os::idl::WireWriter& writer) const;
129 bool nested_read_scale(yarp::os::idl::WireReader& reader);
130 bool nested_write_scale(const yarp::os::idl::WireWriter& writer) const;
131
132 // read/write max_output field
133 bool read_max_output(yarp::os::idl::WireReader& reader);
134 bool write_max_output(const yarp::os::idl::WireWriter& writer) const;
135 bool nested_read_max_output(yarp::os::idl::WireReader& reader);
136 bool nested_write_max_output(const yarp::os::idl::WireWriter& writer) const;
137
138 // read/write offset field
139 bool read_offset(yarp::os::idl::WireReader& reader);
140 bool write_offset(const yarp::os::idl::WireWriter& writer) const;
141 bool nested_read_offset(yarp::os::idl::WireReader& reader);
142 bool nested_write_offset(const yarp::os::idl::WireWriter& writer) const;
143
144 // read/write stiction_up_val field
145 bool read_stiction_up_val(yarp::os::idl::WireReader& reader);
146 bool write_stiction_up_val(const yarp::os::idl::WireWriter& writer) const;
147 bool nested_read_stiction_up_val(yarp::os::idl::WireReader& reader);
148 bool nested_write_stiction_up_val(const yarp::os::idl::WireWriter& writer) const;
149
150 // read/write stiction_down_val field
151 bool read_stiction_down_val(yarp::os::idl::WireReader& reader);
152 bool write_stiction_down_val(const yarp::os::idl::WireWriter& writer) const;
153 bool nested_read_stiction_down_val(yarp::os::idl::WireReader& reader);
154 bool nested_write_stiction_down_val(const yarp::os::idl::WireWriter& writer) const;
155
156 // read/write kff field
157 bool read_kff(yarp::os::idl::WireReader& reader);
158 bool write_kff(const yarp::os::idl::WireWriter& writer) const;
159 bool nested_read_kff(yarp::os::idl::WireReader& reader);
160 bool nested_write_kff(const yarp::os::idl::WireWriter& writer) const;
161};
162
163} // namespace yarp::dev
164
165#endif // YARP_THRIFT_GENERATOR_STRUCT_PIDGAINSDATA_H
std::string toString(const T &value)
convert an arbitrary type to string.
yarp::os::idl::Unwrapped< PidGainsData > unwrapped
An interface for reading from a network connection.
An interface for writing to a network connection.
A "tamed" Portable, that promises to serialize itself in an IDL-friendly way.
IDL-friendly connection reader.
Definition WireReader.h:27
IDL-friendly connection writer.
Definition WireWriter.h:28
For streams capable of holding different kinds of content, check what they actually have.
#define YARP_dev_API
Definition api.h:18