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 (size_t number_of_modules)
	Create a group info with the specified number of modules. More...

	~GroupInfo () noexcept
	Destructor cleans up group info object as necessary. More...

size_t	size () const
	Returns the number of module infos in this group info. More...

const Info &	operator[] (size_t index) const
	Access the info for an individual module. More...

bool	writeGains (const std::string &file) const
	Export the gains from this GroupInfo object into a file, creating it as necessary. More...

FunctionCallResult	writeSafetyParameters (const std::string &file) const
	Export the safety parameters from this GroupInfo object into a file, creating it as necessary. 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

◆ GroupInfo()

hebi::GroupInfo::GroupInfo ( size_t number_of_modules )

Create a group info with the specified number of modules.

◆ ~GroupInfo()

hebi::GroupInfo::~GroupInfo ( )

noexcept

Destructor cleans up group info object as necessary.

Member Function Documentation

◆ size()

size_t hebi::GroupInfo::size ( ) const

Returns the number of module infos in this group info.

◆ operator[]()

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

Access the info for an individual module.

◆ writeGains()

bool hebi::GroupInfo::writeGains ( const std::string & file ) const

Export the gains from this GroupInfo object into a file, creating it as necessary.

Parameters

file	The filename (or path + filename) to the file to write to.

◆ writeSafetyParameters()

FunctionCallResult hebi::GroupInfo::writeSafetyParameters ( const std::string & file ) const

inline

Export the safety parameters from this GroupInfo object into a file, creating it as necessary.

Parameters

file	The filename (or path + filename) to the file to write to.

◆ getSpringConstant() [1/2]

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

Convenience function for returning spring constant values.

◆ getSpringConstant() [2/2]

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