YARP
Yet Another Robot Platform
jointData.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_JOINTDATA_H
12 #define YARP_THRIFT_GENERATOR_STRUCT_JOINTDATA_H
13 
14 #include <yarp/dev/api.h>
15 
16 #include <yarp/os/Wire.h>
17 #include <yarp/os/idl/WireTypes.h>
18 #include <yarp/sig/Vector.h>
19 
20 namespace yarp {
21 namespace dev {
22 namespace impl {
23 
26 {
27 public:
28  // Fields
51 
52  // Default constructor
53  jointData();
54 
55  // Constructor with field values
56  jointData(const yarp::sig::VectorOf<double>& jointPosition,
57  const bool jointPosition_isValid,
58  const yarp::sig::VectorOf<double>& jointVelocity,
59  const bool jointVelocity_isValid,
60  const yarp::sig::VectorOf<double>& jointAcceleration,
61  const bool jointAcceleration_isValid,
62  const yarp::sig::VectorOf<double>& motorPosition,
63  const bool motorPosition_isValid,
64  const yarp::sig::VectorOf<double>& motorVelocity,
65  const bool motorVelocity_isValid,
66  const yarp::sig::VectorOf<double>& motorAcceleration,
67  const bool motorAcceleration_isValid,
68  const yarp::sig::VectorOf<double>& torque,
69  const bool torque_isValid,
70  const yarp::sig::VectorOf<double>& pwmDutycycle,
71  const bool pwmDutycycle_isValid,
72  const yarp::sig::VectorOf<double>& current,
73  const bool current_isValid,
74  const yarp::sig::VectorOf<int>& controlMode,
75  const bool controlMode_isValid,
76  const yarp::sig::VectorOf<int>& interactionMode,
77  const bool interactionMode_isValid);
78 
79  // Read structure on a Wire
80  bool read(yarp::os::idl::WireReader& reader) override;
81 
82  // Read structure on a Connection
83  bool read(yarp::os::ConnectionReader& connection) override;
84 
85  // Write structure on a Wire
86  bool write(const yarp::os::idl::WireWriter& writer) const override;
87 
88  // Write structure on a Connection
89  bool write(yarp::os::ConnectionWriter& connection) const override;
90 
91  // Convert to a printable string
92  std::string toString() const;
93 
94  // If you want to serialize this class without nesting, use this helper
96 
97  class Editor :
98  public yarp::os::Wire,
100  {
101  public:
102  // Editor: default constructor
103  Editor();
104 
105  // Editor: constructor with base class
106  Editor(jointData& obj);
107 
108  // Editor: destructor
109  ~Editor() override;
110 
111  // Editor: Deleted constructors and operator=
112  Editor(const Editor& rhs) = delete;
113  Editor(Editor&& rhs) = delete;
114  Editor& operator=(const Editor& rhs) = delete;
115  Editor& operator=(Editor&& rhs) = delete;
116 
117  // Editor: edit
118  bool edit(jointData& obj, bool dirty = true);
119 
120  // Editor: validity check
121  bool isValid() const;
122 
123  // Editor: state
124  jointData& state();
125 
126  // Editor: start editing
127  void start_editing();
128 
129 #ifndef YARP_NO_DEPRECATED // Since YARP 3.2
130  YARP_DEPRECATED_MSG("Use start_editing() instead")
131  void begin()
132  {
133  start_editing();
134  }
135 #endif // YARP_NO_DEPRECATED
136 
137  // Editor: stop editing
138  void stop_editing();
139 
140 #ifndef YARP_NO_DEPRECATED // Since YARP 3.2
141  YARP_DEPRECATED_MSG("Use stop_editing() instead")
142  void end()
143  {
144  stop_editing();
145  }
146 #endif // YARP_NO_DEPRECATED
147 
148  // Editor: jointPosition field
149  void set_jointPosition(const yarp::sig::VectorOf<double>& jointPosition);
150  const yarp::sig::VectorOf<double>& get_jointPosition() const;
151  virtual bool will_set_jointPosition();
152  virtual bool did_set_jointPosition();
153 
154  // Editor: jointPosition_isValid field
155  void set_jointPosition_isValid(const bool jointPosition_isValid);
156  bool get_jointPosition_isValid() const;
157  virtual bool will_set_jointPosition_isValid();
158  virtual bool did_set_jointPosition_isValid();
159 
160  // Editor: jointVelocity field
161  void set_jointVelocity(const yarp::sig::VectorOf<double>& jointVelocity);
162  const yarp::sig::VectorOf<double>& get_jointVelocity() const;
163  virtual bool will_set_jointVelocity();
164  virtual bool did_set_jointVelocity();
165 
166  // Editor: jointVelocity_isValid field
167  void set_jointVelocity_isValid(const bool jointVelocity_isValid);
168  bool get_jointVelocity_isValid() const;
169  virtual bool will_set_jointVelocity_isValid();
170  virtual bool did_set_jointVelocity_isValid();
171 
172  // Editor: jointAcceleration field
173  void set_jointAcceleration(const yarp::sig::VectorOf<double>& jointAcceleration);
174  const yarp::sig::VectorOf<double>& get_jointAcceleration() const;
175  virtual bool will_set_jointAcceleration();
176  virtual bool did_set_jointAcceleration();
177 
178  // Editor: jointAcceleration_isValid field
179  void set_jointAcceleration_isValid(const bool jointAcceleration_isValid);
180  bool get_jointAcceleration_isValid() const;
181  virtual bool will_set_jointAcceleration_isValid();
182  virtual bool did_set_jointAcceleration_isValid();
183 
184  // Editor: motorPosition field
185  void set_motorPosition(const yarp::sig::VectorOf<double>& motorPosition);
186  const yarp::sig::VectorOf<double>& get_motorPosition() const;
187  virtual bool will_set_motorPosition();
188  virtual bool did_set_motorPosition();
189 
190  // Editor: motorPosition_isValid field
191  void set_motorPosition_isValid(const bool motorPosition_isValid);
192  bool get_motorPosition_isValid() const;
193  virtual bool will_set_motorPosition_isValid();
194  virtual bool did_set_motorPosition_isValid();
195 
196  // Editor: motorVelocity field
197  void set_motorVelocity(const yarp::sig::VectorOf<double>& motorVelocity);
198  const yarp::sig::VectorOf<double>& get_motorVelocity() const;
199  virtual bool will_set_motorVelocity();
200  virtual bool did_set_motorVelocity();
201 
202  // Editor: motorVelocity_isValid field
203  void set_motorVelocity_isValid(const bool motorVelocity_isValid);
204  bool get_motorVelocity_isValid() const;
205  virtual bool will_set_motorVelocity_isValid();
206  virtual bool did_set_motorVelocity_isValid();
207 
208  // Editor: motorAcceleration field
209  void set_motorAcceleration(const yarp::sig::VectorOf<double>& motorAcceleration);
210  const yarp::sig::VectorOf<double>& get_motorAcceleration() const;
211  virtual bool will_set_motorAcceleration();
212  virtual bool did_set_motorAcceleration();
213 
214  // Editor: motorAcceleration_isValid field
215  void set_motorAcceleration_isValid(const bool motorAcceleration_isValid);
216  bool get_motorAcceleration_isValid() const;
217  virtual bool will_set_motorAcceleration_isValid();
218  virtual bool did_set_motorAcceleration_isValid();
219 
220  // Editor: torque field
221  void set_torque(const yarp::sig::VectorOf<double>& torque);
222  const yarp::sig::VectorOf<double>& get_torque() const;
223  virtual bool will_set_torque();
224  virtual bool did_set_torque();
225 
226  // Editor: torque_isValid field
227  void set_torque_isValid(const bool torque_isValid);
228  bool get_torque_isValid() const;
229  virtual bool will_set_torque_isValid();
230  virtual bool did_set_torque_isValid();
231 
232  // Editor: pwmDutycycle field
233  void set_pwmDutycycle(const yarp::sig::VectorOf<double>& pwmDutycycle);
234  const yarp::sig::VectorOf<double>& get_pwmDutycycle() const;
235  virtual bool will_set_pwmDutycycle();
236  virtual bool did_set_pwmDutycycle();
237 
238  // Editor: pwmDutycycle_isValid field
239  void set_pwmDutycycle_isValid(const bool pwmDutycycle_isValid);
240  bool get_pwmDutycycle_isValid() const;
241  virtual bool will_set_pwmDutycycle_isValid();
242  virtual bool did_set_pwmDutycycle_isValid();
243 
244  // Editor: current field
245  void set_current(const yarp::sig::VectorOf<double>& current);
246  const yarp::sig::VectorOf<double>& get_current() const;
247  virtual bool will_set_current();
248  virtual bool did_set_current();
249 
250  // Editor: current_isValid field
251  void set_current_isValid(const bool current_isValid);
252  bool get_current_isValid() const;
253  virtual bool will_set_current_isValid();
254  virtual bool did_set_current_isValid();
255 
256  // Editor: controlMode field
257  void set_controlMode(const yarp::sig::VectorOf<int>& controlMode);
258  const yarp::sig::VectorOf<int>& get_controlMode() const;
259  virtual bool will_set_controlMode();
260  virtual bool did_set_controlMode();
261 
262  // Editor: controlMode_isValid field
263  void set_controlMode_isValid(const bool controlMode_isValid);
264  bool get_controlMode_isValid() const;
265  virtual bool will_set_controlMode_isValid();
266  virtual bool did_set_controlMode_isValid();
267 
268  // Editor: interactionMode field
269  void set_interactionMode(const yarp::sig::VectorOf<int>& interactionMode);
270  const yarp::sig::VectorOf<int>& get_interactionMode() const;
271  virtual bool will_set_interactionMode();
272  virtual bool did_set_interactionMode();
273 
274  // Editor: interactionMode_isValid field
275  void set_interactionMode_isValid(const bool interactionMode_isValid);
276  bool get_interactionMode_isValid() const;
277  virtual bool will_set_interactionMode_isValid();
278  virtual bool did_set_interactionMode_isValid();
279 
280  // Editor: clean
281  void clean();
282 
283  // Editor: read
284  bool read(yarp::os::ConnectionReader& connection) override;
285 
286  // Editor: write
287  bool write(yarp::os::ConnectionWriter& connection) const override;
288 
289  private:
290  // Editor: state
291  jointData* obj;
292  bool obj_owned;
293  int group;
294 
295  // Editor: dirty variables
296  bool is_dirty;
297  bool is_dirty_jointPosition;
298  bool is_dirty_jointPosition_isValid;
299  bool is_dirty_jointVelocity;
300  bool is_dirty_jointVelocity_isValid;
301  bool is_dirty_jointAcceleration;
302  bool is_dirty_jointAcceleration_isValid;
303  bool is_dirty_motorPosition;
304  bool is_dirty_motorPosition_isValid;
305  bool is_dirty_motorVelocity;
306  bool is_dirty_motorVelocity_isValid;
307  bool is_dirty_motorAcceleration;
308  bool is_dirty_motorAcceleration_isValid;
309  bool is_dirty_torque;
310  bool is_dirty_torque_isValid;
311  bool is_dirty_pwmDutycycle;
312  bool is_dirty_pwmDutycycle_isValid;
313  bool is_dirty_current;
314  bool is_dirty_current_isValid;
315  bool is_dirty_controlMode;
316  bool is_dirty_controlMode_isValid;
317  bool is_dirty_interactionMode;
318  bool is_dirty_interactionMode_isValid;
319  int dirty_count;
320 
321  // Editor: send if possible
322  void communicate();
323 
324  // Editor: mark dirty overall
325  void mark_dirty();
326 
327  // Editor: mark dirty single fields
328  void mark_dirty_jointPosition();
329  void mark_dirty_jointPosition_isValid();
330  void mark_dirty_jointVelocity();
331  void mark_dirty_jointVelocity_isValid();
332  void mark_dirty_jointAcceleration();
333  void mark_dirty_jointAcceleration_isValid();
334  void mark_dirty_motorPosition();
335  void mark_dirty_motorPosition_isValid();
336  void mark_dirty_motorVelocity();
337  void mark_dirty_motorVelocity_isValid();
338  void mark_dirty_motorAcceleration();
339  void mark_dirty_motorAcceleration_isValid();
340  void mark_dirty_torque();
341  void mark_dirty_torque_isValid();
342  void mark_dirty_pwmDutycycle();
343  void mark_dirty_pwmDutycycle_isValid();
344  void mark_dirty_current();
345  void mark_dirty_current_isValid();
346  void mark_dirty_controlMode();
347  void mark_dirty_controlMode_isValid();
348  void mark_dirty_interactionMode();
349  void mark_dirty_interactionMode_isValid();
350 
351  // Editor: dirty_flags
352  void dirty_flags(bool flag);
353  };
354 
355 private:
356  // read/write jointPosition field
357  bool read_jointPosition(yarp::os::idl::WireReader& reader);
358  bool write_jointPosition(const yarp::os::idl::WireWriter& writer) const;
359  bool nested_read_jointPosition(yarp::os::idl::WireReader& reader);
360  bool nested_write_jointPosition(const yarp::os::idl::WireWriter& writer) const;
361 
362  // read/write jointPosition_isValid field
363  bool read_jointPosition_isValid(yarp::os::idl::WireReader& reader);
364  bool write_jointPosition_isValid(const yarp::os::idl::WireWriter& writer) const;
365  bool nested_read_jointPosition_isValid(yarp::os::idl::WireReader& reader);
366  bool nested_write_jointPosition_isValid(const yarp::os::idl::WireWriter& writer) const;
367 
368  // read/write jointVelocity field
369  bool read_jointVelocity(yarp::os::idl::WireReader& reader);
370  bool write_jointVelocity(const yarp::os::idl::WireWriter& writer) const;
371  bool nested_read_jointVelocity(yarp::os::idl::WireReader& reader);
372  bool nested_write_jointVelocity(const yarp::os::idl::WireWriter& writer) const;
373 
374  // read/write jointVelocity_isValid field
375  bool read_jointVelocity_isValid(yarp::os::idl::WireReader& reader);
376  bool write_jointVelocity_isValid(const yarp::os::idl::WireWriter& writer) const;
377  bool nested_read_jointVelocity_isValid(yarp::os::idl::WireReader& reader);
378  bool nested_write_jointVelocity_isValid(const yarp::os::idl::WireWriter& writer) const;
379 
380  // read/write jointAcceleration field
381  bool read_jointAcceleration(yarp::os::idl::WireReader& reader);
382  bool write_jointAcceleration(const yarp::os::idl::WireWriter& writer) const;
383  bool nested_read_jointAcceleration(yarp::os::idl::WireReader& reader);
384  bool nested_write_jointAcceleration(const yarp::os::idl::WireWriter& writer) const;
385 
386  // read/write jointAcceleration_isValid field
387  bool read_jointAcceleration_isValid(yarp::os::idl::WireReader& reader);
388  bool write_jointAcceleration_isValid(const yarp::os::idl::WireWriter& writer) const;
389  bool nested_read_jointAcceleration_isValid(yarp::os::idl::WireReader& reader);
390  bool nested_write_jointAcceleration_isValid(const yarp::os::idl::WireWriter& writer) const;
391 
392  // read/write motorPosition field
393  bool read_motorPosition(yarp::os::idl::WireReader& reader);
394  bool write_motorPosition(const yarp::os::idl::WireWriter& writer) const;
395  bool nested_read_motorPosition(yarp::os::idl::WireReader& reader);
396  bool nested_write_motorPosition(const yarp::os::idl::WireWriter& writer) const;
397 
398  // read/write motorPosition_isValid field
399  bool read_motorPosition_isValid(yarp::os::idl::WireReader& reader);
400  bool write_motorPosition_isValid(const yarp::os::idl::WireWriter& writer) const;
401  bool nested_read_motorPosition_isValid(yarp::os::idl::WireReader& reader);
402  bool nested_write_motorPosition_isValid(const yarp::os::idl::WireWriter& writer) const;
403 
404  // read/write motorVelocity field
405  bool read_motorVelocity(yarp::os::idl::WireReader& reader);
406  bool write_motorVelocity(const yarp::os::idl::WireWriter& writer) const;
407  bool nested_read_motorVelocity(yarp::os::idl::WireReader& reader);
408  bool nested_write_motorVelocity(const yarp::os::idl::WireWriter& writer) const;
409 
410  // read/write motorVelocity_isValid field
411  bool read_motorVelocity_isValid(yarp::os::idl::WireReader& reader);
412  bool write_motorVelocity_isValid(const yarp::os::idl::WireWriter& writer) const;
413  bool nested_read_motorVelocity_isValid(yarp::os::idl::WireReader& reader);
414  bool nested_write_motorVelocity_isValid(const yarp::os::idl::WireWriter& writer) const;
415 
416  // read/write motorAcceleration field
417  bool read_motorAcceleration(yarp::os::idl::WireReader& reader);
418  bool write_motorAcceleration(const yarp::os::idl::WireWriter& writer) const;
419  bool nested_read_motorAcceleration(yarp::os::idl::WireReader& reader);
420  bool nested_write_motorAcceleration(const yarp::os::idl::WireWriter& writer) const;
421 
422  // read/write motorAcceleration_isValid field
423  bool read_motorAcceleration_isValid(yarp::os::idl::WireReader& reader);
424  bool write_motorAcceleration_isValid(const yarp::os::idl::WireWriter& writer) const;
425  bool nested_read_motorAcceleration_isValid(yarp::os::idl::WireReader& reader);
426  bool nested_write_motorAcceleration_isValid(const yarp::os::idl::WireWriter& writer) const;
427 
428  // read/write torque field
429  bool read_torque(yarp::os::idl::WireReader& reader);
430  bool write_torque(const yarp::os::idl::WireWriter& writer) const;
431  bool nested_read_torque(yarp::os::idl::WireReader& reader);
432  bool nested_write_torque(const yarp::os::idl::WireWriter& writer) const;
433 
434  // read/write torque_isValid field
435  bool read_torque_isValid(yarp::os::idl::WireReader& reader);
436  bool write_torque_isValid(const yarp::os::idl::WireWriter& writer) const;
437  bool nested_read_torque_isValid(yarp::os::idl::WireReader& reader);
438  bool nested_write_torque_isValid(const yarp::os::idl::WireWriter& writer) const;
439 
440  // read/write pwmDutycycle field
441  bool read_pwmDutycycle(yarp::os::idl::WireReader& reader);
442  bool write_pwmDutycycle(const yarp::os::idl::WireWriter& writer) const;
443  bool nested_read_pwmDutycycle(yarp::os::idl::WireReader& reader);
444  bool nested_write_pwmDutycycle(const yarp::os::idl::WireWriter& writer) const;
445 
446  // read/write pwmDutycycle_isValid field
447  bool read_pwmDutycycle_isValid(yarp::os::idl::WireReader& reader);
448  bool write_pwmDutycycle_isValid(const yarp::os::idl::WireWriter& writer) const;
449  bool nested_read_pwmDutycycle_isValid(yarp::os::idl::WireReader& reader);
450  bool nested_write_pwmDutycycle_isValid(const yarp::os::idl::WireWriter& writer) const;
451 
452  // read/write current field
453  bool read_current(yarp::os::idl::WireReader& reader);
454  bool write_current(const yarp::os::idl::WireWriter& writer) const;
455  bool nested_read_current(yarp::os::idl::WireReader& reader);
456  bool nested_write_current(const yarp::os::idl::WireWriter& writer) const;
457 
458  // read/write current_isValid field
459  bool read_current_isValid(yarp::os::idl::WireReader& reader);
460  bool write_current_isValid(const yarp::os::idl::WireWriter& writer) const;
461  bool nested_read_current_isValid(yarp::os::idl::WireReader& reader);
462  bool nested_write_current_isValid(const yarp::os::idl::WireWriter& writer) const;
463 
464  // read/write controlMode field
465  bool read_controlMode(yarp::os::idl::WireReader& reader);
466  bool write_controlMode(const yarp::os::idl::WireWriter& writer) const;
467  bool nested_read_controlMode(yarp::os::idl::WireReader& reader);
468  bool nested_write_controlMode(const yarp::os::idl::WireWriter& writer) const;
469 
470  // read/write controlMode_isValid field
471  bool read_controlMode_isValid(yarp::os::idl::WireReader& reader);
472  bool write_controlMode_isValid(const yarp::os::idl::WireWriter& writer) const;
473  bool nested_read_controlMode_isValid(yarp::os::idl::WireReader& reader);
474  bool nested_write_controlMode_isValid(const yarp::os::idl::WireWriter& writer) const;
475 
476  // read/write interactionMode field
477  bool read_interactionMode(yarp::os::idl::WireReader& reader);
478  bool write_interactionMode(const yarp::os::idl::WireWriter& writer) const;
479  bool nested_read_interactionMode(yarp::os::idl::WireReader& reader);
480  bool nested_write_interactionMode(const yarp::os::idl::WireWriter& writer) const;
481 
482  // read/write interactionMode_isValid field
483  bool read_interactionMode_isValid(yarp::os::idl::WireReader& reader);
484  bool write_interactionMode_isValid(const yarp::os::idl::WireWriter& writer) const;
485  bool nested_read_interactionMode_isValid(yarp::os::idl::WireReader& reader);
486  bool nested_write_interactionMode_isValid(const yarp::os::idl::WireWriter& writer) const;
487 };
488 
489 } // namespace yarp
490 } // namespace dev
491 } // namespace impl
492 
493 #endif // YARP_THRIFT_GENERATOR_STRUCT_JOINTDATA_H
contains the definition of a Vector type
Editor & operator=(const Editor &rhs)=delete
Editor & operator=(Editor &&rhs)=delete
Editor(const Editor &rhs)=delete
yarp::os::idl::Unwrapped< jointData > unwrapped
Definition: jointData.h:95
yarp::sig::VectorOf< double > motorVelocity
Definition: jointData.h:37
yarp::sig::VectorOf< double > jointAcceleration
Definition: jointData.h:33
yarp::sig::VectorOf< int > controlMode
Definition: jointData.h:47
yarp::sig::VectorOf< int > interactionMode
Definition: jointData.h:49
yarp::sig::VectorOf< double > current
Definition: jointData.h:45
yarp::sig::VectorOf< double > motorAcceleration
Definition: jointData.h:39
yarp::sig::VectorOf< double > motorPosition
Definition: jointData.h:35
yarp::sig::VectorOf< double > pwmDutycycle
Definition: jointData.h:43
yarp::sig::VectorOf< double > torque
Definition: jointData.h:41
yarp::sig::VectorOf< double > jointPosition
Definition: jointData.h:29
yarp::sig::VectorOf< double > jointVelocity
Definition: jointData.h:31
An interface for reading from a network connection.
An interface for writing to a network connection.
Interface implemented by all objects that can write themselves to the network, such as Bottle objects...
Definition: PortWriter.h:24
Base class for IDL client/server.
Definition: Wire.h:19
A "tamed" Portable, that promises to serialize itself in an IDL-friendly way.
Definition: WirePortable.h:23
IDL-friendly connection reader.
Definition: WireReader.h:30
IDL-friendly connection writer.
Definition: WireWriter.h:30
#define YARP_DEPRECATED_MSG(MSG)
Expands to either the standard [[deprecated]] attribute or a compiler-specific decorator such as __at...
Definition: compiler.h:2885
std::string toString(const T &value)
convert an arbitrary type to string.
bool isValid()
Check if time is valid (non-zero).
Definition: Time.cpp:314
bool read(ImageOf< PixelRgb > &dest, const std::string &src, image_fileformat format=FORMAT_ANY)
Definition: ImageFile.cpp:922
bool write(const ImageOf< PixelRgb > &src, const std::string &dest, image_fileformat format=FORMAT_PPM)
Definition: ImageFile.cpp:1098
The main, catch-all namespace for YARP.
Definition: dirs.h:16
#define YARP_dev_API
Definition: api.h:18