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

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 ()
	Sets the family for this module. Name must be null-terminated character string for the family; must be <= 20 characters. More...
const StringField &	family () const
	Sets the family for this module. Name must be null-terminated character string for the family; must be <= 20 characters. More...
StringField &	name ()
	Sets the name for this module. Name must be null-terminated character string for the name; must be <= 20 characters. More...
const StringField &	name () const
	Sets the name for this module. Name must be null-terminated character string for the name; must be <= 20 characters. 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...
	Settings (HebiCommandPtr internal)

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

Detailed Description

Module settings that are typically changed at a slower rate.

Definition at line 485 of file command.hpp.

Constructor & Destructor Documentation

hebi::Command::Settings::Settings ( HebiCommandPtr  internal )

inline

Definition at line 573 of file command.hpp.

Member Function Documentation

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

inline

Actuator-specific settings, such as controller gains.

Definition at line 589 of file command.hpp.

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

inline

Actuator-specific settings, such as controller gains.

Definition at line 591 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 600 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 602 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 596 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 598 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 604 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 606 of file command.hpp.

Member Data Documentation

Actuator hebi::Command::Settings::actuator_

private

Definition at line 611 of file command.hpp.

StringField hebi::Command::Settings::family_

private

Definition at line 614 of file command.hpp.

HebiCommandPtr const hebi::Command::Settings::internal_

private

Definition at line 609 of file command.hpp.

StringField hebi::Command::Settings::name_

private

Definition at line 613 of file command.hpp.

FlagField hebi::Command::Settings::save_current_settings_

private

Definition at line 615 of file command.hpp.

---

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

• command.hpp