HEBI C++ API  1.0.0-rc1
Public Member Functions | List of all members
hebi::GroupInfo Class Referencefinal

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

 GroupInfo (int number_of_modules)
 Create a group info with the specified number of modules. More...
 
virtual ~GroupInfo () noexcept
 Destructor cleans up group info object as necessary. More...
 
int size () const
 Returns the number of module infos in this group info. More...
 
const Info & operator[] (int index) const
 Access the info for an individual module. More...
 
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...
 

Detailed Description

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.

Constructor & Destructor Documentation

hebi::GroupInfo::GroupInfo ( int  number_of_modules)

Create a group info with the specified number of modules.

hebi::GroupInfo::~GroupInfo ( )
virtualnoexcept

Destructor cleans up group info object as necessary.

Member Function Documentation

int hebi::GroupInfo::size ( ) const

Returns the number of module infos in this group info.

const Info & hebi::GroupInfo::operator[] ( int  index) const

Access the info for an individual module.

Eigen::VectorXd hebi::GroupInfo::getSpringConstant ( ) const

Convenience function for returning spring constant values.

void hebi::GroupInfo::getSpringConstant ( Eigen::VectorXd &  out) const

Convenience function for returning spring constant values.

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