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...
StringField &	family ()
const StringField &	family () const
Imu &	imu ()
	IMU-specific settings. More...
const Imu &	imu () const
	IMU-specific settings. More...
StringField &	name ()
const StringField &	name () const
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...
	Settings (HebiCommandPtr internal_ptr, HebiCommandRef &internal)

Private Attributes
Actuator	actuator_
StringField	family_
Imu	imu_
HebiCommandRef &	internal_
StringField	name_
FlagField	save_current_settings_

Detailed Description

Module settings that are typically changed at a slower rate.

Definition at line 498 of file command.hpp.

Constructor & Destructor Documentation

hebi::Command::Settings::Settings ( HebiCommandPtr  internal_ptr, HebiCommandRef &  internal  )

inline

Definition at line 646 of file command.hpp.

Member Function Documentation

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

inline

Actuator-specific settings, such as controller gains.

Definition at line 661 of file command.hpp.

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

inline

Actuator-specific settings, such as controller gains.

Definition at line 663 of file command.hpp.

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.

Definition at line 679 of file command.hpp.

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.

Definition at line 682 of file command.hpp.

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

inline

IMU-specific settings.

Definition at line 665 of file command.hpp.

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

inline

IMU-specific settings.

Definition at line 667 of file command.hpp.

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.

Definition at line 673 of file command.hpp.

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.

Definition at line 676 of file command.hpp.

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

inline

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

Definition at line 684 of file command.hpp.

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

inline

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

Definition at line 686 of file command.hpp.

Member Data Documentation

Actuator hebi::Command::Settings::actuator_

private

Definition at line 693 of file command.hpp.

StringField hebi::Command::Settings::family_

private

Definition at line 697 of file command.hpp.

Imu hebi::Command::Settings::imu_

private

Definition at line 694 of file command.hpp.

HebiCommandRef& hebi::Command::Settings::internal_

private

Definition at line 691 of file command.hpp.

StringField hebi::Command::Settings::name_

private

Definition at line 696 of file command.hpp.

FlagField hebi::Command::Settings::save_current_settings_

private

Definition at line 698 of file command.hpp.

---

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

• command.hpp