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 Compiler (0.14.1-yarped)
7//
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
67 // Default constructor
68 PidGainsData() = default;
69
70 // Constructor with field values
71 PidGainsData(const double kp,
72 const double kd,
73 const double ki,
74 const double max_int,
75 const double scale,
76 const double max_output,
77 const double offset,
78 const double stiction_up_val,
79 const double stiction_down_val,
80 const double kff);
81
82 // Read structure on a Wire
83 bool read(yarp::os::idl::WireReader& reader) override;
84
85 // Read structure on a Connection
86 bool read(yarp::os::ConnectionReader& connection) override;
87
88 // Write structure on a Wire
89 bool write(const yarp::os::idl::WireWriter& writer) const override;
90
91 // Write structure on a Connection
92 bool write(yarp::os::ConnectionWriter& connection) const override;
93
94 // Convert to a printable string
95 std::string toString() const;
96
97 // If you want to serialize this class without nesting, use this helper
99
100private:
101 // read/write kp field
102 bool read_kp(yarp::os::idl::WireReader& reader);
103 bool write_kp(const yarp::os::idl::WireWriter& writer) const;
104 bool nested_read_kp(yarp::os::idl::WireReader& reader);
105 bool nested_write_kp(const yarp::os::idl::WireWriter& writer) const;
106
107 // read/write kd field
108 bool read_kd(yarp::os::idl::WireReader& reader);
109 bool write_kd(const yarp::os::idl::WireWriter& writer) const;
110 bool nested_read_kd(yarp::os::idl::WireReader& reader);
111 bool nested_write_kd(const yarp::os::idl::WireWriter& writer) const;
112
113 // read/write ki field
114 bool read_ki(yarp::os::idl::WireReader& reader);
115 bool write_ki(const yarp::os::idl::WireWriter& writer) const;
116 bool nested_read_ki(yarp::os::idl::WireReader& reader);
117 bool nested_write_ki(const yarp::os::idl::WireWriter& writer) const;
118
119 // read/write max_int field
120 bool read_max_int(yarp::os::idl::WireReader& reader);
121 bool write_max_int(const yarp::os::idl::WireWriter& writer) const;
122 bool nested_read_max_int(yarp::os::idl::WireReader& reader);
123 bool nested_write_max_int(const yarp::os::idl::WireWriter& writer) const;
124
125 // read/write scale field
126 bool read_scale(yarp::os::idl::WireReader& reader);
127 bool write_scale(const yarp::os::idl::WireWriter& writer) const;
128 bool nested_read_scale(yarp::os::idl::WireReader& reader);
129 bool nested_write_scale(const yarp::os::idl::WireWriter& writer) const;
130
131 // read/write max_output field
132 bool read_max_output(yarp::os::idl::WireReader& reader);
133 bool write_max_output(const yarp::os::idl::WireWriter& writer) const;
134 bool nested_read_max_output(yarp::os::idl::WireReader& reader);
135 bool nested_write_max_output(const yarp::os::idl::WireWriter& writer) const;
136
137 // read/write offset field
138 bool read_offset(yarp::os::idl::WireReader& reader);
139 bool write_offset(const yarp::os::idl::WireWriter& writer) const;
140 bool nested_read_offset(yarp::os::idl::WireReader& reader);
141 bool nested_write_offset(const yarp::os::idl::WireWriter& writer) const;
142
143 // read/write stiction_up_val field
144 bool read_stiction_up_val(yarp::os::idl::WireReader& reader);
145 bool write_stiction_up_val(const yarp::os::idl::WireWriter& writer) const;
146 bool nested_read_stiction_up_val(yarp::os::idl::WireReader& reader);
147 bool nested_write_stiction_up_val(const yarp::os::idl::WireWriter& writer) const;
148
149 // read/write stiction_down_val field
150 bool read_stiction_down_val(yarp::os::idl::WireReader& reader);
151 bool write_stiction_down_val(const yarp::os::idl::WireWriter& writer) const;
152 bool nested_read_stiction_down_val(yarp::os::idl::WireReader& reader);
153 bool nested_write_stiction_down_val(const yarp::os::idl::WireWriter& writer) const;
154
155 // read/write kff field
156 bool read_kff(yarp::os::idl::WireReader& reader);
157 bool write_kff(const yarp::os::idl::WireWriter& writer) const;
158 bool nested_read_kff(yarp::os::idl::WireReader& reader);
159 bool nested_write_kff(const yarp::os::idl::WireWriter& writer) const;
160};
161
162} // namespace yarp::dev
163
164#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