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

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

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& hebi::Command::Settings::actuator ( )

inline

Actuator-specific settings, such as controller gains.

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

inline

Actuator-specific settings, such as controller gains.

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.

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.

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.

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.

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

inline

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

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: