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...

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 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)

Private Attributes
Actuator	actuator_
StringField	family_
HebiInfoPtr const	internal_
StringField	name_
FlagField	save_current_settings_

Detailed Description

Module settings that are typically changed at a slower rate.

Definition at line 296 of file info.hpp.

Constructor & Destructor Documentation

hebi::Info::Settings::Settings ( HebiInfoPtr  internal )

inline

Definition at line 358 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 374 of file info.hpp.

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

inline

Gets the family for this module.

Definition at line 381 of file info.hpp.

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

inline

Gets the name for this module.

Definition at line 379 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 383 of file info.hpp.

Member Data Documentation

Actuator hebi::Info::Settings::actuator_

private

Definition at line 388 of file info.hpp.

StringField hebi::Info::Settings::family_

private

Definition at line 391 of file info.hpp.

HebiInfoPtr const hebi::Info::Settings::internal_

private

Definition at line 386 of file info.hpp.

StringField hebi::Info::Settings::name_

private

Definition at line 390 of file info.hpp.

FlagField hebi::Info::Settings::save_current_settings_

private

Definition at line 392 of file info.hpp.

---

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

• info.hpp