HEBI C++ API  1.0.0-rc1
hebi::Info::Settings Class Referencefinal

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 Actuatoractuator () const
 Actuator-specific settings, such as controller gains. More...
 
const StringFieldname () const
 Sets the name for this module. Name must be null-terminated character string for the name; must be <= 20 characters. More...
 
const StringFieldfamily () const
 Sets the family for this module. Name must be null-terminated character string for the family; must be <= 20 characters. More...
 
const FlagFieldsaveCurrentSettings () 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

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

Actuator-specific settings, such as controller gains.

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

Sets the name for this module. Name must be null-terminated character string for the name; must be <= 20 characters.

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

Sets the family for this module. Name must be null-terminated character string for the family; must be <= 20 characters.

const FlagField& hebi::Info::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: