hebi::Info::Settings Class Reference

Module settings that are typically changed at a slower rate. More...

#include <info.hpp>

Classes
class	Actuator
	Actuator-specific settings, such as controller gains. More...
class	Imu
	IMU-specific settings. More...

Public Member Functions
const Actuator &	actuator () const
	Actuator-specific settings, such as controller gains. More...
const Imu &	imu () const
	IMU-specific settings. More...
const StringField &	name () const
	Gets the name for this module. More...
const StringField &	family () const
	Gets the family for this module. More...
const StringField &	electricalType () const
	Gets the electrical type of this module. More...
const StringField &	electricalRevision () const
	Gets the electrical revision of this module. More...
const StringField &	mechanicalType () const
	Gets the mechanical type of this module. More...
const StringField &	mechanicalRevision () const
	Gets the mechanical revision of this module. More...
const StringField &	firmwareType () const
	Gets the firmware type of this module. More...
const StringField &	firmwareRevision () const
	Gets the firmware revision of this module. More...
const StringField &	userSettingsBytes (size_t number) const
const FloatField &	userSettingsFloat (size_t number) const
const IpAddressField &	ipAddress () const
	Gets the IP address for this module. More...
const IpAddressField &	subnetMask () const
	Gets the subnet mask for this module. More...
const IpAddressField &	defaultGateway () const
	Gets the default gateway for this module. More...
const FlagField &	saveCurrentSettings () const
	Indicates if the module should save the current values of all of its settings. More...

Detailed Description

Module settings that are typically changed at a slower rate.

Member Function Documentation

actuator()

const Actuator& hebi::Info::Settings::actuator ( ) const

inline

Actuator-specific settings, such as controller gains.

imu()

const Imu& hebi::Info::Settings::imu ( ) const

inline

IMU-specific settings.

name()

const StringField& hebi::Info::Settings::name ( ) const

inline

Gets the name for this module.

family()

const StringField& hebi::Info::Settings::family ( ) const

inline

Gets the family for this module.

electricalType()

const StringField& hebi::Info::Settings::electricalType ( ) const

inline

Gets the electrical type of this module.

electricalRevision()

const StringField& hebi::Info::Settings::electricalRevision ( ) const

inline

Gets the electrical revision of this module.

mechanicalType()

const StringField& hebi::Info::Settings::mechanicalType ( ) const

inline

Gets the mechanical type of this module.

mechanicalRevision()

const StringField& hebi::Info::Settings::mechanicalRevision ( ) const

inline

Gets the mechanical revision of this module.

firmwareType()

const StringField& hebi::Info::Settings::firmwareType ( ) const

inline

Gets the firmware type of this module.

firmwareRevision()

const StringField& hebi::Info::Settings::firmwareRevision ( ) const

inline

Gets the firmware revision of this module.

userSettingsBytes()

const StringField& hebi::Info::Settings::userSettingsBytes ( size_t  number ) const

inline

Gets the given byte array user setting; valid for entry number 1-8. Throws out of range if given an invalid index

userSettingsFloat()

const FloatField& hebi::Info::Settings::userSettingsFloat ( size_t  number ) const

inline

Gets the given float user setting; valid for entry number 1-8. Throws out of range if given an invalid index

ipAddress()

const IpAddressField& hebi::Info::Settings::ipAddress ( ) const

inline

Gets the IP address for this module.

subnetMask()

const IpAddressField& hebi::Info::Settings::subnetMask ( ) const

inline

Gets the subnet mask for this module.

defaultGateway()

const IpAddressField& hebi::Info::Settings::defaultGateway ( ) const

inline

Gets the default gateway for this module.

saveCurrentSettings()

const FlagField& hebi::Info::Settings::saveCurrentSettings ( ) const

inline

Indicates if the module should save the current values of all of its settings.

---

The documentation for this class was generated from the following file:

• info.hpp