YARP
Yet Another Robot Platform
SensorStreamingData.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_SENSORSTREAMINGDATA_H
12 #define YARP_THRIFT_GENERATOR_STRUCT_SENSORSTREAMINGDATA_H
13 
14 #include <yarp/os/Wire.h>
15 #include <yarp/os/idl/WireTypes.h>
16 #include <SensorMeasurements.h>
17 
20 {
21 public:
22  // Fields
33 
34  // Default constructor
36 
37  // Constructor with field values
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
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(SensorStreamingData& 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
121  virtual bool will_set_ThreeAxisGyroscopes();
122  virtual bool did_set_ThreeAxisGyroscopes();
123 
124  // Editor: ThreeAxisLinearAccelerometers field
129 
130  // Editor: ThreeAxisMagnetometers field
133  virtual bool will_set_ThreeAxisMagnetometers();
134  virtual bool did_set_ThreeAxisMagnetometers();
135 
136  // Editor: OrientationSensors field
139  virtual bool will_set_OrientationSensors();
140  virtual bool did_set_OrientationSensors();
141 
142  // Editor: TemperatureSensors field
145  virtual bool will_set_TemperatureSensors();
146  virtual bool did_set_TemperatureSensors();
147 
148  // Editor: SixAxisForceTorqueSensors field
151  virtual bool will_set_SixAxisForceTorqueSensors();
152  virtual bool did_set_SixAxisForceTorqueSensors();
153 
154  // Editor: ContactLoadCellArrays field
157  virtual bool will_set_ContactLoadCellArrays();
158  virtual bool did_set_ContactLoadCellArrays();
159 
160  // Editor: EncoderArrays field
162  const SensorMeasurements& get_EncoderArrays() const;
163  virtual bool will_set_EncoderArrays();
164  virtual bool did_set_EncoderArrays();
165 
166  // Editor: SkinPatches field
168  const SensorMeasurements& get_SkinPatches() const;
169  virtual bool will_set_SkinPatches();
170  virtual bool did_set_SkinPatches();
171 
172  // Editor: PositionSensors field
175  virtual bool will_set_PositionSensors();
176  virtual bool did_set_PositionSensors();
177 
178  // Editor: clean
179  void clean();
180 
181  // Editor: read
182  bool read(yarp::os::ConnectionReader& connection) override;
183 
184  // Editor: write
185  bool write(yarp::os::ConnectionWriter& connection) const override;
186 
187  private:
188  // Editor: state
189  SensorStreamingData* obj;
190  bool obj_owned;
191  int group;
192 
193  // Editor: dirty variables
194  bool is_dirty;
195  bool is_dirty_ThreeAxisGyroscopes;
196  bool is_dirty_ThreeAxisLinearAccelerometers;
197  bool is_dirty_ThreeAxisMagnetometers;
198  bool is_dirty_OrientationSensors;
199  bool is_dirty_TemperatureSensors;
200  bool is_dirty_SixAxisForceTorqueSensors;
201  bool is_dirty_ContactLoadCellArrays;
202  bool is_dirty_EncoderArrays;
203  bool is_dirty_SkinPatches;
204  bool is_dirty_PositionSensors;
205  int dirty_count;
206 
207  // Editor: send if possible
208  void communicate();
209 
210  // Editor: mark dirty overall
211  void mark_dirty();
212 
213  // Editor: mark dirty single fields
214  void mark_dirty_ThreeAxisGyroscopes();
215  void mark_dirty_ThreeAxisLinearAccelerometers();
216  void mark_dirty_ThreeAxisMagnetometers();
217  void mark_dirty_OrientationSensors();
218  void mark_dirty_TemperatureSensors();
219  void mark_dirty_SixAxisForceTorqueSensors();
220  void mark_dirty_ContactLoadCellArrays();
221  void mark_dirty_EncoderArrays();
222  void mark_dirty_SkinPatches();
223  void mark_dirty_PositionSensors();
224 
225  // Editor: dirty_flags
226  void dirty_flags(bool flag);
227  };
228 
229 private:
230  // read/write ThreeAxisGyroscopes field
231  bool read_ThreeAxisGyroscopes(yarp::os::idl::WireReader& reader);
232  bool write_ThreeAxisGyroscopes(const yarp::os::idl::WireWriter& writer) const;
233  bool nested_read_ThreeAxisGyroscopes(yarp::os::idl::WireReader& reader);
234  bool nested_write_ThreeAxisGyroscopes(const yarp::os::idl::WireWriter& writer) const;
235 
236  // read/write ThreeAxisLinearAccelerometers field
237  bool read_ThreeAxisLinearAccelerometers(yarp::os::idl::WireReader& reader);
238  bool write_ThreeAxisLinearAccelerometers(const yarp::os::idl::WireWriter& writer) const;
239  bool nested_read_ThreeAxisLinearAccelerometers(yarp::os::idl::WireReader& reader);
240  bool nested_write_ThreeAxisLinearAccelerometers(const yarp::os::idl::WireWriter& writer) const;
241 
242  // read/write ThreeAxisMagnetometers field
243  bool read_ThreeAxisMagnetometers(yarp::os::idl::WireReader& reader);
244  bool write_ThreeAxisMagnetometers(const yarp::os::idl::WireWriter& writer) const;
245  bool nested_read_ThreeAxisMagnetometers(yarp::os::idl::WireReader& reader);
246  bool nested_write_ThreeAxisMagnetometers(const yarp::os::idl::WireWriter& writer) const;
247 
248  // read/write OrientationSensors field
249  bool read_OrientationSensors(yarp::os::idl::WireReader& reader);
250  bool write_OrientationSensors(const yarp::os::idl::WireWriter& writer) const;
251  bool nested_read_OrientationSensors(yarp::os::idl::WireReader& reader);
252  bool nested_write_OrientationSensors(const yarp::os::idl::WireWriter& writer) const;
253 
254  // read/write TemperatureSensors field
255  bool read_TemperatureSensors(yarp::os::idl::WireReader& reader);
256  bool write_TemperatureSensors(const yarp::os::idl::WireWriter& writer) const;
257  bool nested_read_TemperatureSensors(yarp::os::idl::WireReader& reader);
258  bool nested_write_TemperatureSensors(const yarp::os::idl::WireWriter& writer) const;
259 
260  // read/write SixAxisForceTorqueSensors field
261  bool read_SixAxisForceTorqueSensors(yarp::os::idl::WireReader& reader);
262  bool write_SixAxisForceTorqueSensors(const yarp::os::idl::WireWriter& writer) const;
263  bool nested_read_SixAxisForceTorqueSensors(yarp::os::idl::WireReader& reader);
264  bool nested_write_SixAxisForceTorqueSensors(const yarp::os::idl::WireWriter& writer) const;
265 
266  // read/write ContactLoadCellArrays field
267  bool read_ContactLoadCellArrays(yarp::os::idl::WireReader& reader);
268  bool write_ContactLoadCellArrays(const yarp::os::idl::WireWriter& writer) const;
269  bool nested_read_ContactLoadCellArrays(yarp::os::idl::WireReader& reader);
270  bool nested_write_ContactLoadCellArrays(const yarp::os::idl::WireWriter& writer) const;
271 
272  // read/write EncoderArrays field
273  bool read_EncoderArrays(yarp::os::idl::WireReader& reader);
274  bool write_EncoderArrays(const yarp::os::idl::WireWriter& writer) const;
275  bool nested_read_EncoderArrays(yarp::os::idl::WireReader& reader);
276  bool nested_write_EncoderArrays(const yarp::os::idl::WireWriter& writer) const;
277 
278  // read/write SkinPatches field
279  bool read_SkinPatches(yarp::os::idl::WireReader& reader);
280  bool write_SkinPatches(const yarp::os::idl::WireWriter& writer) const;
281  bool nested_read_SkinPatches(yarp::os::idl::WireReader& reader);
282  bool nested_write_SkinPatches(const yarp::os::idl::WireWriter& writer) const;
283 
284  // read/write PositionSensors field
285  bool read_PositionSensors(yarp::os::idl::WireReader& reader);
286  bool write_PositionSensors(const yarp::os::idl::WireWriter& writer) const;
287  bool nested_read_PositionSensors(yarp::os::idl::WireReader& reader);
288  bool nested_write_PositionSensors(const yarp::os::idl::WireWriter& writer) const;
289 };
290 
291 #endif // YARP_THRIFT_GENERATOR_STRUCT_SENSORSTREAMINGDATA_H
void set_SkinPatches(const SensorMeasurements &SkinPatches)
void set_PositionSensors(const SensorMeasurements &PositionSensors)
Editor(const Editor &rhs)=delete
const SensorMeasurements & get_SixAxisForceTorqueSensors() const
bool edit(SensorStreamingData &obj, bool dirty=true)
void set_EncoderArrays(const SensorMeasurements &EncoderArrays)
void set_ThreeAxisLinearAccelerometers(const SensorMeasurements &ThreeAxisLinearAccelerometers)
const SensorMeasurements & get_OrientationSensors() const
Editor(Editor &&rhs)=delete
void set_SixAxisForceTorqueSensors(const SensorMeasurements &SixAxisForceTorqueSensors)
bool read(yarp::os::ConnectionReader &connection) override
Read this object from a network connection.
const SensorMeasurements & get_ThreeAxisMagnetometers() const
const SensorMeasurements & get_TemperatureSensors() const
Editor & operator=(Editor &&rhs)=delete
const SensorMeasurements & get_PositionSensors() const
const SensorMeasurements & get_ContactLoadCellArrays() const
bool write(yarp::os::ConnectionWriter &connection) const override
Write this object to a network connection.
const SensorMeasurements & get_EncoderArrays() const
virtual bool will_set_ThreeAxisMagnetometers()
virtual bool will_set_SixAxisForceTorqueSensors()
void set_ThreeAxisMagnetometers(const SensorMeasurements &ThreeAxisMagnetometers)
virtual bool did_set_SixAxisForceTorqueSensors()
virtual bool will_set_ThreeAxisLinearAccelerometers()
SensorStreamingData & state()
void set_TemperatureSensors(const SensorMeasurements &TemperatureSensors)
void set_OrientationSensors(const SensorMeasurements &OrientationSensors)
Editor & operator=(const Editor &rhs)=delete
const SensorMeasurements & get_ThreeAxisLinearAccelerometers() const
void set_ThreeAxisGyroscopes(const SensorMeasurements &ThreeAxisGyroscopes)
const SensorMeasurements & get_SkinPatches() const
virtual bool did_set_ThreeAxisLinearAccelerometers()
const SensorMeasurements & get_ThreeAxisGyroscopes() const
void set_ContactLoadCellArrays(const SensorMeasurements &ContactLoadCellArrays)
std::string toString() const
SensorMeasurements EncoderArrays
SensorMeasurements ThreeAxisLinearAccelerometers
SensorMeasurements PositionSensors
SensorMeasurements OrientationSensors
bool write(const yarp::os::idl::WireWriter &writer) const override
SensorMeasurements ThreeAxisMagnetometers
yarp::os::idl::Unwrapped< SensorStreamingData > unwrapped
SensorMeasurements ThreeAxisGyroscopes
SensorMeasurements SixAxisForceTorqueSensors
SensorMeasurements SkinPatches
bool read(yarp::os::idl::WireReader &reader) override
SensorMeasurements ContactLoadCellArrays
SensorMeasurements TemperatureSensors
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