YARP
Yet Another Robot Platform
SensorRPCData.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_SENSORRPCDATA_H
12 #define YARP_THRIFT_GENERATOR_STRUCT_SENSORRPCDATA_H
13 
14 #include <yarp/os/Wire.h>
15 #include <yarp/os/idl/WireTypes.h>
16 #include <SensorMetadata.h>
17 
20 {
21 public:
22  // Fields
23  std::vector<SensorMetadata> ThreeAxisGyroscopes;
24  std::vector<SensorMetadata> ThreeAxisLinearAccelerometers;
25  std::vector<SensorMetadata> ThreeAxisMagnetometers;
26  std::vector<SensorMetadata> OrientationSensors;
27  std::vector<SensorMetadata> TemperatureSensors;
28  std::vector<SensorMetadata> SixAxisForceTorqueSensors;
29  std::vector<SensorMetadata> ContactLoadCellArrays;
30  std::vector<SensorMetadata> EncoderArrays;
31  std::vector<SensorMetadata> SkinPatches;
32  std::vector<SensorMetadata> PositionSensors;
33 
34  // Default constructor
35  SensorRPCData();
36 
37  // Constructor with field values
38  SensorRPCData(const std::vector<SensorMetadata>& ThreeAxisGyroscopes,
39  const std::vector<SensorMetadata>& ThreeAxisLinearAccelerometers,
40  const std::vector<SensorMetadata>& ThreeAxisMagnetometers,
41  const std::vector<SensorMetadata>& OrientationSensors,
42  const std::vector<SensorMetadata>& TemperatureSensors,
43  const std::vector<SensorMetadata>& SixAxisForceTorqueSensors,
44  const std::vector<SensorMetadata>& ContactLoadCellArrays,
45  const std::vector<SensorMetadata>& EncoderArrays,
46  const std::vector<SensorMetadata>& SkinPatches,
47  const std::vector<SensorMetadata>& PositionSensors);
48 
49  // Read structure on a Wire
50  bool read(yarp::os::idl::WireReader& reader) override;
51 
52  // Read structure on a Connection
53  bool read(yarp::os::ConnectionReader& connection) override;
54 
55  // Write structure on a Wire
56  bool write(const yarp::os::idl::WireWriter& writer) const override;
57 
58  // Write structure on a Connection
59  bool write(yarp::os::ConnectionWriter& connection) const override;
60 
61  // Convert to a printable string
62  std::string toString() const;
63 
64  // If you want to serialize this class without nesting, use this helper
66 
67  class Editor :
68  public yarp::os::Wire,
70  {
71  public:
72  // Editor: default constructor
73  Editor();
74 
75  // Editor: constructor with base class
76  Editor(SensorRPCData& obj);
77 
78  // Editor: destructor
79  ~Editor() override;
80 
81  // Editor: Deleted constructors and operator=
82  Editor(const Editor& rhs) = delete;
83  Editor(Editor&& rhs) = delete;
84  Editor& operator=(const Editor& rhs) = delete;
85  Editor& operator=(Editor&& rhs) = delete;
86 
87  // Editor: edit
88  bool edit(SensorRPCData& obj, bool dirty = true);
89 
90  // Editor: validity check
91  bool isValid() const;
92 
93  // Editor: state
95 
96  // Editor: start editing
97  void start_editing();
98 
99 #ifndef YARP_NO_DEPRECATED // Since YARP 3.2
100  YARP_DEPRECATED_MSG("Use start_editing() instead")
101  void begin()
102  {
103  start_editing();
104  }
105 #endif // YARP_NO_DEPRECATED
106 
107  // Editor: stop editing
108  void stop_editing();
109 
110 #ifndef YARP_NO_DEPRECATED // Since YARP 3.2
111  YARP_DEPRECATED_MSG("Use stop_editing() instead")
112  void end()
113  {
114  stop_editing();
115  }
116 #endif // YARP_NO_DEPRECATED
117 
118  // Editor: ThreeAxisGyroscopes field
119  void set_ThreeAxisGyroscopes(const std::vector<SensorMetadata>& ThreeAxisGyroscopes);
120  void set_ThreeAxisGyroscopes(size_t index, const SensorMetadata& elem);
121  const std::vector<SensorMetadata>& get_ThreeAxisGyroscopes() const;
122  virtual bool will_set_ThreeAxisGyroscopes();
123  virtual bool did_set_ThreeAxisGyroscopes();
124 
125  // Editor: ThreeAxisLinearAccelerometers field
126  void set_ThreeAxisLinearAccelerometers(const std::vector<SensorMetadata>& ThreeAxisLinearAccelerometers);
127  void set_ThreeAxisLinearAccelerometers(size_t index, const SensorMetadata& elem);
128  const std::vector<SensorMetadata>& get_ThreeAxisLinearAccelerometers() const;
131 
132  // Editor: ThreeAxisMagnetometers field
133  void set_ThreeAxisMagnetometers(const std::vector<SensorMetadata>& ThreeAxisMagnetometers);
134  void set_ThreeAxisMagnetometers(size_t index, const SensorMetadata& elem);
135  const std::vector<SensorMetadata>& get_ThreeAxisMagnetometers() const;
136  virtual bool will_set_ThreeAxisMagnetometers();
137  virtual bool did_set_ThreeAxisMagnetometers();
138 
139  // Editor: OrientationSensors field
140  void set_OrientationSensors(const std::vector<SensorMetadata>& OrientationSensors);
141  void set_OrientationSensors(size_t index, const SensorMetadata& elem);
142  const std::vector<SensorMetadata>& get_OrientationSensors() const;
143  virtual bool will_set_OrientationSensors();
144  virtual bool did_set_OrientationSensors();
145 
146  // Editor: TemperatureSensors field
147  void set_TemperatureSensors(const std::vector<SensorMetadata>& TemperatureSensors);
148  void set_TemperatureSensors(size_t index, const SensorMetadata& elem);
149  const std::vector<SensorMetadata>& get_TemperatureSensors() const;
150  virtual bool will_set_TemperatureSensors();
151  virtual bool did_set_TemperatureSensors();
152 
153  // Editor: SixAxisForceTorqueSensors field
154  void set_SixAxisForceTorqueSensors(const std::vector<SensorMetadata>& SixAxisForceTorqueSensors);
155  void set_SixAxisForceTorqueSensors(size_t index, const SensorMetadata& elem);
156  const std::vector<SensorMetadata>& get_SixAxisForceTorqueSensors() const;
157  virtual bool will_set_SixAxisForceTorqueSensors();
158  virtual bool did_set_SixAxisForceTorqueSensors();
159 
160  // Editor: ContactLoadCellArrays field
161  void set_ContactLoadCellArrays(const std::vector<SensorMetadata>& ContactLoadCellArrays);
162  void set_ContactLoadCellArrays(size_t index, const SensorMetadata& elem);
163  const std::vector<SensorMetadata>& get_ContactLoadCellArrays() const;
164  virtual bool will_set_ContactLoadCellArrays();
165  virtual bool did_set_ContactLoadCellArrays();
166 
167  // Editor: EncoderArrays field
168  void set_EncoderArrays(const std::vector<SensorMetadata>& EncoderArrays);
169  void set_EncoderArrays(size_t index, const SensorMetadata& elem);
170  const std::vector<SensorMetadata>& get_EncoderArrays() const;
171  virtual bool will_set_EncoderArrays();
172  virtual bool did_set_EncoderArrays();
173 
174  // Editor: SkinPatches field
175  void set_SkinPatches(const std::vector<SensorMetadata>& SkinPatches);
176  void set_SkinPatches(size_t index, const SensorMetadata& elem);
177  const std::vector<SensorMetadata>& get_SkinPatches() const;
178  virtual bool will_set_SkinPatches();
179  virtual bool did_set_SkinPatches();
180 
181  // Editor: PositionSensors field
182  void set_PositionSensors(const std::vector<SensorMetadata>& PositionSensors);
183  void set_PositionSensors(size_t index, const SensorMetadata& elem);
184  const std::vector<SensorMetadata>& get_PositionSensors() const;
185  virtual bool will_set_PositionSensors();
186  virtual bool did_set_PositionSensors();
187 
188  // Editor: clean
189  void clean();
190 
191  // Editor: read
192  bool read(yarp::os::ConnectionReader& connection) override;
193 
194  // Editor: write
195  bool write(yarp::os::ConnectionWriter& connection) const override;
196 
197  private:
198  // Editor: state
199  SensorRPCData* obj;
200  bool obj_owned;
201  int group;
202 
203  // Editor: dirty variables
204  bool is_dirty;
205  bool is_dirty_ThreeAxisGyroscopes;
206  bool is_dirty_ThreeAxisLinearAccelerometers;
207  bool is_dirty_ThreeAxisMagnetometers;
208  bool is_dirty_OrientationSensors;
209  bool is_dirty_TemperatureSensors;
210  bool is_dirty_SixAxisForceTorqueSensors;
211  bool is_dirty_ContactLoadCellArrays;
212  bool is_dirty_EncoderArrays;
213  bool is_dirty_SkinPatches;
214  bool is_dirty_PositionSensors;
215  int dirty_count;
216 
217  // Editor: send if possible
218  void communicate();
219 
220  // Editor: mark dirty overall
221  void mark_dirty();
222 
223  // Editor: mark dirty single fields
224  void mark_dirty_ThreeAxisGyroscopes();
225  void mark_dirty_ThreeAxisLinearAccelerometers();
226  void mark_dirty_ThreeAxisMagnetometers();
227  void mark_dirty_OrientationSensors();
228  void mark_dirty_TemperatureSensors();
229  void mark_dirty_SixAxisForceTorqueSensors();
230  void mark_dirty_ContactLoadCellArrays();
231  void mark_dirty_EncoderArrays();
232  void mark_dirty_SkinPatches();
233  void mark_dirty_PositionSensors();
234 
235  // Editor: dirty_flags
236  void dirty_flags(bool flag);
237  };
238 
239 private:
240  // read/write ThreeAxisGyroscopes field
241  bool read_ThreeAxisGyroscopes(yarp::os::idl::WireReader& reader);
242  bool write_ThreeAxisGyroscopes(const yarp::os::idl::WireWriter& writer) const;
243  bool nested_read_ThreeAxisGyroscopes(yarp::os::idl::WireReader& reader);
244  bool nested_write_ThreeAxisGyroscopes(const yarp::os::idl::WireWriter& writer) const;
245 
246  // read/write ThreeAxisLinearAccelerometers field
247  bool read_ThreeAxisLinearAccelerometers(yarp::os::idl::WireReader& reader);
248  bool write_ThreeAxisLinearAccelerometers(const yarp::os::idl::WireWriter& writer) const;
249  bool nested_read_ThreeAxisLinearAccelerometers(yarp::os::idl::WireReader& reader);
250  bool nested_write_ThreeAxisLinearAccelerometers(const yarp::os::idl::WireWriter& writer) const;
251 
252  // read/write ThreeAxisMagnetometers field
253  bool read_ThreeAxisMagnetometers(yarp::os::idl::WireReader& reader);
254  bool write_ThreeAxisMagnetometers(const yarp::os::idl::WireWriter& writer) const;
255  bool nested_read_ThreeAxisMagnetometers(yarp::os::idl::WireReader& reader);
256  bool nested_write_ThreeAxisMagnetometers(const yarp::os::idl::WireWriter& writer) const;
257 
258  // read/write OrientationSensors field
259  bool read_OrientationSensors(yarp::os::idl::WireReader& reader);
260  bool write_OrientationSensors(const yarp::os::idl::WireWriter& writer) const;
261  bool nested_read_OrientationSensors(yarp::os::idl::WireReader& reader);
262  bool nested_write_OrientationSensors(const yarp::os::idl::WireWriter& writer) const;
263 
264  // read/write TemperatureSensors field
265  bool read_TemperatureSensors(yarp::os::idl::WireReader& reader);
266  bool write_TemperatureSensors(const yarp::os::idl::WireWriter& writer) const;
267  bool nested_read_TemperatureSensors(yarp::os::idl::WireReader& reader);
268  bool nested_write_TemperatureSensors(const yarp::os::idl::WireWriter& writer) const;
269 
270  // read/write SixAxisForceTorqueSensors field
271  bool read_SixAxisForceTorqueSensors(yarp::os::idl::WireReader& reader);
272  bool write_SixAxisForceTorqueSensors(const yarp::os::idl::WireWriter& writer) const;
273  bool nested_read_SixAxisForceTorqueSensors(yarp::os::idl::WireReader& reader);
274  bool nested_write_SixAxisForceTorqueSensors(const yarp::os::idl::WireWriter& writer) const;
275 
276  // read/write ContactLoadCellArrays field
277  bool read_ContactLoadCellArrays(yarp::os::idl::WireReader& reader);
278  bool write_ContactLoadCellArrays(const yarp::os::idl::WireWriter& writer) const;
279  bool nested_read_ContactLoadCellArrays(yarp::os::idl::WireReader& reader);
280  bool nested_write_ContactLoadCellArrays(const yarp::os::idl::WireWriter& writer) const;
281 
282  // read/write EncoderArrays field
283  bool read_EncoderArrays(yarp::os::idl::WireReader& reader);
284  bool write_EncoderArrays(const yarp::os::idl::WireWriter& writer) const;
285  bool nested_read_EncoderArrays(yarp::os::idl::WireReader& reader);
286  bool nested_write_EncoderArrays(const yarp::os::idl::WireWriter& writer) const;
287 
288  // read/write SkinPatches field
289  bool read_SkinPatches(yarp::os::idl::WireReader& reader);
290  bool write_SkinPatches(const yarp::os::idl::WireWriter& writer) const;
291  bool nested_read_SkinPatches(yarp::os::idl::WireReader& reader);
292  bool nested_write_SkinPatches(const yarp::os::idl::WireWriter& writer) const;
293 
294  // read/write PositionSensors field
295  bool read_PositionSensors(yarp::os::idl::WireReader& reader);
296  bool write_PositionSensors(const yarp::os::idl::WireWriter& writer) const;
297  bool nested_read_PositionSensors(yarp::os::idl::WireReader& reader);
298  bool nested_write_PositionSensors(const yarp::os::idl::WireWriter& writer) const;
299 };
300 
301 #endif // YARP_THRIFT_GENERATOR_STRUCT_SENSORRPCDATA_H
virtual bool did_set_TemperatureSensors()
void set_SkinPatches(const std::vector< SensorMetadata > &SkinPatches)
Editor(Editor &&rhs)=delete
void set_TemperatureSensors(const std::vector< SensorMetadata > &TemperatureSensors)
virtual bool did_set_ThreeAxisMagnetometers()
bool read(yarp::os::ConnectionReader &connection) override
Read this object from a network connection.
void set_EncoderArrays(const std::vector< SensorMetadata > &EncoderArrays)
bool edit(SensorRPCData &obj, bool dirty=true)
const std::vector< SensorMetadata > & get_ThreeAxisGyroscopes() const
void set_SixAxisForceTorqueSensors(const std::vector< SensorMetadata > &SixAxisForceTorqueSensors)
Editor & operator=(Editor &&rhs)=delete
Editor & operator=(const Editor &rhs)=delete
virtual bool did_set_ThreeAxisLinearAccelerometers()
virtual bool will_set_PositionSensors()
const std::vector< SensorMetadata > & get_TemperatureSensors() const
void set_ThreeAxisLinearAccelerometers(const std::vector< SensorMetadata > &ThreeAxisLinearAccelerometers)
void set_PositionSensors(const std::vector< SensorMetadata > &PositionSensors)
virtual bool did_set_ContactLoadCellArrays()
virtual bool did_set_ThreeAxisGyroscopes()
void set_ThreeAxisMagnetometers(const std::vector< SensorMetadata > &ThreeAxisMagnetometers)
virtual bool will_set_OrientationSensors()
SensorRPCData & state()
virtual bool will_set_ThreeAxisGyroscopes()
virtual bool will_set_TemperatureSensors()
const std::vector< SensorMetadata > & get_ContactLoadCellArrays() const
bool write(yarp::os::ConnectionWriter &connection) const override
Write this object to a network connection.
void set_ContactLoadCellArrays(const std::vector< SensorMetadata > &ContactLoadCellArrays)
virtual bool did_set_SkinPatches()
const std::vector< SensorMetadata > & get_ThreeAxisLinearAccelerometers() const
const std::vector< SensorMetadata > & get_ThreeAxisMagnetometers() const
virtual bool will_set_EncoderArrays()
virtual bool did_set_PositionSensors()
const std::vector< SensorMetadata > & get_SkinPatches() const
const std::vector< SensorMetadata > & get_SixAxisForceTorqueSensors() const
const std::vector< SensorMetadata > & get_EncoderArrays() const
virtual bool will_set_SixAxisForceTorqueSensors()
virtual bool will_set_ThreeAxisMagnetometers()
virtual bool did_set_SixAxisForceTorqueSensors()
virtual bool will_set_SkinPatches()
virtual bool will_set_ContactLoadCellArrays()
Editor(const Editor &rhs)=delete
const std::vector< SensorMetadata > & get_PositionSensors() const
virtual bool will_set_ThreeAxisLinearAccelerometers()
const std::vector< SensorMetadata > & get_OrientationSensors() const
virtual bool did_set_OrientationSensors()
void set_ThreeAxisGyroscopes(const std::vector< SensorMetadata > &ThreeAxisGyroscopes)
virtual bool did_set_EncoderArrays()
void set_OrientationSensors(const std::vector< SensorMetadata > &OrientationSensors)
std::vector< SensorMetadata > SkinPatches
Definition: SensorRPCData.h:31
bool read(yarp::os::idl::WireReader &reader) override
std::vector< SensorMetadata > ContactLoadCellArrays
Definition: SensorRPCData.h:29
std::string toString() const
bool write(const yarp::os::idl::WireWriter &writer) const override
std::vector< SensorMetadata > EncoderArrays
Definition: SensorRPCData.h:30
std::vector< SensorMetadata > PositionSensors
Definition: SensorRPCData.h:32
std::vector< SensorMetadata > ThreeAxisGyroscopes
Definition: SensorRPCData.h:23
std::vector< SensorMetadata > ThreeAxisLinearAccelerometers
Definition: SensorRPCData.h:24
yarp::os::idl::Unwrapped< SensorRPCData > unwrapped
Definition: SensorRPCData.h:65
std::vector< SensorMetadata > ThreeAxisMagnetometers
Definition: SensorRPCData.h:25
std::vector< SensorMetadata > OrientationSensors
Definition: SensorRPCData.h:26
std::vector< SensorMetadata > SixAxisForceTorqueSensors
Definition: SensorRPCData.h:28
std::vector< SensorMetadata > TemperatureSensors
Definition: SensorRPCData.h:27
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