hebi::Command::Settings Class Reference

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

#include <command.hpp>

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

Public Member Functions
Actuator &	actuator ()
	Actuator-specific settings, such as controller gains. More...
const Actuator &	actuator () const
	Actuator-specific settings, such as controller gains. More...
Imu &	imu ()
	IMU-specific settings. More...
const Imu &	imu () const
	IMU-specific settings. More...
StringField &	name ()
const StringField &	name () const
StringField &	family ()
const StringField &	family () const
StringField &	userSettingsBytes (size_t number)
const StringField &	userSettingsBytes (size_t number) const
FloatField &	userSettingsFloat (size_t number)
const FloatField &	userSettingsFloat (size_t number) const
IpAddressField &	ipAddress ()
const IpAddressField &	ipAddress () const
IpAddressField &	subnetMask ()
	Sets the subnet mask for this module; must be used with IP Address if setting a static IP address. More...
const IpAddressField &	subnetMask () const
	Sets the subnet mask for this module; must be used with IP Address if setting a static IP address. More...
FlagField &	saveCurrentSettings ()
	Indicates if the module should save the current values of all of its settings. 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() [1/2]

Actuator& hebi::Command::Settings::actuator ( )

inline

Actuator-specific settings, such as controller gains.

actuator() [2/2]

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

inline

Actuator-specific settings, such as controller gains.

imu() [1/2]

Imu& hebi::Command::Settings::imu ( )

inline

IMU-specific settings.

imu() [2/2]

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

inline

IMU-specific settings.

name() [1/2]

StringField& hebi::Command::Settings::name ( )

inline

Sets the name for this module. Name must be null-terminated character string for the name; must be <= 20 characters.

name() [2/2]

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

inline

Sets the name for this module. Name must be null-terminated character string for the name; must be <= 20 characters.

family() [1/2]

StringField& hebi::Command::Settings::family ( )

inline

Sets the family for this module. Name must be null-terminated character string for the family; must be <= 20 characters.

family() [2/2]

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

inline

Sets the family for this module. Name must be null-terminated character string for the family; must be <= 20 characters.

userSettingsBytes() [1/2]

StringField& hebi::Command::Settings::userSettingsBytes ( size_t  number )

inline

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

userSettingsBytes() [2/2]

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

inline

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

userSettingsFloat() [1/2]

FloatField& hebi::Command::Settings::userSettingsFloat ( size_t  number )

inline

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

userSettingsFloat() [2/2]

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

inline

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

ipAddress() [1/2]

IpAddressField& hebi::Command::Settings::ipAddress ( )

inline

Sets the static IP address for this module; must be set in conjunction with the subnet mask. Can be set to 0.0.0.0 to reset to DHCP.

ipAddress() [2/2]

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

inline

Sets the static IP address for this module; must be set in conjunction with the subnet mask. Can be set to 0.0.0.0 to reset to DHCP.

subnetMask() [1/2]

IpAddressField& hebi::Command::Settings::subnetMask ( )

inline

Sets the subnet mask for this module; must be used with IP Address if setting a static IP address.

subnetMask() [2/2]

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

inline

Sets the subnet mask for this module; must be used with IP Address if setting a static IP address.

saveCurrentSettings() [1/2]

FlagField& hebi::Command::Settings::saveCurrentSettings ( )

inline

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

saveCurrentSettings() [2/2]

const FlagField& hebi::Command::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:

• command.hpp