|
HEBI C++ API
1.0.0
|
|
HEBI C++ API
1.0.0
|
Feedback objects have various fields representing feedback from modules; which fields are populated depends on the module type and various other settings. More...
#include <feedback.hpp>
Classes | |
| class | Actuator |
| Actuator-specific feedback. More... | |
| class | FloatField |
| A message field representable by a single-precision floating point value. More... | |
| class | HighResAngleField |
| A message field for an angle measurement which does not lose precision at very high angles. More... | |
| class | Imu |
| Inertial measurement unit feedback (accelerometers and gyros). More... | |
| class | Io |
| Feedback from any available I/O pins on the device. More... | |
| class | IoBank |
| A message field for interfacing with a bank of I/O pins. More... | |
| class | LedField |
| A message field for interfacing with an LED. More... | |
| class | NumberedFloatField |
| A message field containing a numbered set of single-precision floating point values. More... | |
| class | UInt64Field |
| A message field representable by an unsigned 64 bit integer value. More... | |
| class | Vector3fField |
| A message field representable by a 3-D vector of single-precision floating point values. More... | |
Public Member Functions | |
| Feedback (Feedback &&other) | |
| Move constructor (necessary for containment in STL template classes) More... | |
| ~Feedback () noexcept | |
| Cleans up feedback object as necessary. More... | |
| const Io & | io () const |
| Feedback from any available I/O pins on the device. More... | |
| const Actuator & | actuator () const |
| Actuator-specific feedback. More... | |
| const Imu & | imu () const |
| Inertial measurement unit feedback (accelerometers and gyros). More... | |
| const FloatField & | boardTemperature () const |
| Ambient temperature inside the module (measured at the IMU chip), in degrees Celsius. More... | |
| const FloatField & | processorTemperature () const |
| Temperature of the processor chip, in degrees Celsius. More... | |
| const FloatField & | voltage () const |
| Bus voltage that the module is running at (in Volts). More... | |
| const LedField & | led () const |
| The module's LED. More... | |
Feedback objects have various fields representing feedback from modules; which fields are populated depends on the module type and various other settings.
This object has a hierarchical structure – there are some direct general-purpose fields at the top level, and many more specific fields contained in different nested subobjects.
The subobjects contain references to the parent feedback object, and so should not be used after the parent object has been destroyed.
The fields in the feedback object are typed; generally, these are optional-style read-only fields (i.e., have the concept of has/get), although the return types and exact interface vary slightly between fields. Where appropriate, the explicit bool operator has been overridden so that you can shortcut if(field.has()) by calling if(field).
Although this header file can be used to look at the hierarchy of the messages, in general the online documentation at apidocs.hebi.us presents this information. in a more readable form.
| hebi::Feedback::Feedback | ( | Feedback && | other | ) |
Move constructor (necessary for containment in STL template classes)
|
noexcept |
Cleans up feedback object as necessary.
|
inline |
Actuator-specific feedback.
|
inline |
Inertial measurement unit feedback (accelerometers and gyros).
| const Feedback::FloatField & hebi::Feedback::boardTemperature | ( | ) | const |
Ambient temperature inside the module (measured at the IMU chip), in degrees Celsius.
| const Feedback::FloatField & hebi::Feedback::processorTemperature | ( | ) | const |
Temperature of the processor chip, in degrees Celsius.
| const Feedback::FloatField & hebi::Feedback::voltage | ( | ) | const |
Bus voltage that the module is running at (in Volts).
| const Feedback::LedField & hebi::Feedback::led | ( | ) | const |
The module's LED.
1.8.11 
