A list of Info objects that can be received from a Group of modules; the size() must match the number of modules in the group. More...
#include <group_info.hpp>
Public Member Functions | |
| Eigen::VectorXd | getSpringConstant () const |
| Convenience function for returning spring constant values. More... | |
| void | getSpringConstant (Eigen::VectorXd &out) const |
| Convenience function for returning spring constant values. More... | |
| GroupInfo (size_t number_of_modules) | |
| Create a group info with the specified number of modules. More... | |
| const Info & | operator[] (size_t index) const |
| Access the info for an individual module. More... | |
| size_t | size () const |
| Returns the number of module infos in this group info. More... | |
| bool | writeGains (const std::string &file) const |
| Export the gains from this GroupInfo object into a file, creating it as necessary. More... | |
| ~GroupInfo () noexcept | |
| Destructor cleans up group info object as necessary. More... | |
Public Attributes | |
| HebiGroupInfoPtr | internal_ |
Private Attributes | |
| std::vector< Info > | infos_ |
| const size_t | number_of_modules_ |
A list of Info objects that can be received from a Group of modules; the size() must match the number of modules in the group.
Definition at line 14 of file group_info.hpp.
| hebi::GroupInfo::GroupInfo | ( | size_t | number_of_modules | ) |
Create a group info with the specified number of modules.
Definition at line 5 of file group_info.cpp.
|
noexcept |
Destructor cleans up group info object as necessary.
Definition at line 13 of file group_info.cpp.
| Eigen::VectorXd hebi::GroupInfo::getSpringConstant | ( | ) | const |
Convenience function for returning spring constant values.
Definition at line 34 of file group_info.cpp.
| void hebi::GroupInfo::getSpringConstant | ( | Eigen::VectorXd & | out | ) | const |
Convenience function for returning spring constant values.
Definition at line 45 of file group_info.cpp.
| const Info & hebi::GroupInfo::operator[] | ( | size_t | index | ) | const |
Access the info for an individual module.
Definition at line 24 of file group_info.cpp.
| size_t hebi::GroupInfo::size | ( | ) | const |
Returns the number of module infos in this group info.
Definition at line 19 of file group_info.cpp.
| bool hebi::GroupInfo::writeGains | ( | const std::string & | file | ) | const |
Export the gains from this GroupInfo object into a file, creating it as necessary.
| file | The filename (or path + filename) to the file to write to. |
Definition at line 29 of file group_info.cpp.
|
private |
The list of Info subobjects
Definition at line 33 of file group_info.hpp.
| HebiGroupInfoPtr hebi::GroupInfo::internal_ |
C-style group info object. NOTE: this should not be used except by library functions!
Definition at line 22 of file group_info.hpp.
|
private |
The number of modules in this group info.
Definition at line 29 of file group_info.hpp.