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 StringField &	family () const
	Gets the family for this module. More...
const Imu &	imu () const
	IMU-specific settings. More...
const StringField &	name () const
	Gets the name for this module. More...
const FlagField &	saveCurrentSettings () const
	Indicates if the module should save the current values of all of its settings. More...
	Settings (HebiInfoPtr internal_ptr, const HebiInfoRef &internal)

Private Attributes
Actuator	actuator_
StringField	family_
Imu	imu_
StringField	name_
FlagField	save_current_settings_

Detailed Description

Module settings that are typically changed at a slower rate.

Definition at line 312 of file info.hpp.

Constructor & Destructor Documentation

hebi::Info::Settings::Settings ( HebiInfoPtr  internal_ptr, const HebiInfoRef &  internal  )

inline

Definition at line 414 of file info.hpp.

Member Function Documentation

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

inline

Actuator-specific settings, such as controller gains.

Definition at line 428 of file info.hpp.

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

inline

Gets the family for this module.

Definition at line 437 of file info.hpp.

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

inline

IMU-specific settings.

Definition at line 430 of file info.hpp.

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

inline

Gets the name for this module.

Definition at line 435 of file info.hpp.

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

inline

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

Definition at line 439 of file info.hpp.

Member Data Documentation

Actuator hebi::Info::Settings::actuator_

private

Definition at line 443 of file info.hpp.

StringField hebi::Info::Settings::family_

private

Definition at line 447 of file info.hpp.

Imu hebi::Info::Settings::imu_

private

Definition at line 444 of file info.hpp.

StringField hebi::Info::Settings::name_

private

Definition at line 446 of file info.hpp.

FlagField hebi::Info::Settings::save_current_settings_

private

Definition at line 448 of file info.hpp.

---

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

• info.hpp