HEBI C++ API
3.10.0
|
Info objects have various fields representing the module state; which fields are populated depends on the module type and various other settings. More...
#include <info.hpp>
Classes | |
class | Actuator |
Actuator-specific information. More... | |
class | BoolField |
A message field representable by a bool value. More... | |
class | EnumField |
A message field representable by an enum of a given type. More... | |
class | FlagField |
A two-state message field (either set/true or cleared/false). 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 | Io |
Any available digital or analog output pins on the device. More... | |
class | IoBank |
A message field for interfacing with a bank of I/O pins. More... | |
class | IpAddressField |
A message field representable by an unsigned 64 bit integer value. More... | |
class | LedField |
A message field for interfacing with an LED. More... | |
class | Settings |
Module settings that are typically changed at a slower rate. More... | |
class | StringField |
A message field representable by a std::string. More... | |
class | UInt64Field |
A message field representable by an unsigned 64 bit integer value. More... | |
Public Member Functions | |
Info (Info &&other) | |
Move constructor (necessary for containment in STL template classes) More... | |
Io & | io () |
Any available digital or analog output pins on the device. More... | |
const Io & | io () const |
Any available digital or analog output pins on the device. More... | |
const Settings & | settings () const |
Module settings that are typically changed at a slower rate. More... | |
const Actuator & | actuator () const |
Actuator-specific information. More... | |
const StringField & | serial () const |
Gets the serial number for this module (e.g., X5-0001). More... | |
const LedField & | led () const |
The module's LED. More... | |
const UInt64Field & | secondsCommanded () const |
const UInt64Field & | secondsOn () const |
Info & | operator= (Info &&other)=delete |
Protected Types | |
using | InfoGains = Gains< HebiInfoRef, FloatField, BoolField, HebiInfoFloatField, HebiInfoBoolField > |
Info objects have various fields representing the module state; 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 info object, and so should not be used after the parent object has been destroyed.
The fields in the info 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.
|
protected |
|
strong |
|
strong |
|
strong |
|
strong |
hebi::Info::Info | ( | Info && | other | ) |
Move constructor (necessary for containment in STL template classes)
|
inline |
Any available digital or analog output pins on the device.
|
inline |
Any available digital or analog output pins on the device.
|
inline |
Module settings that are typically changed at a slower rate.
|
inline |
Actuator-specific information.
|
inline |
Gets the serial number for this module (e.g., X5-0001).
|
inline |
The module's LED.
|
inline |
The number of total seconds the module has been sent commands; returned by RuntimeData "Extra" info request.
|
inline |
The number of total seconds the module has been on; returned by RuntimeData "Extra" info request.