group_info.hpp

Go to the documentation of this file.

#pragma once

#include "hebi.h"

#include <vector>

#include "Eigen/Eigen"
#include "info.hpp"

namespace hebi {

class GroupInfo final {
public:
#ifndef DOXYGEN_OMIT_INTERNAL

  HebiGroupInfoPtr internal_;
#endif // DOXYGEN_OMIT_INTERNAL

private:
  const size_t number_of_modules_;
  std::vector<Info> infos_;

public:
  GroupInfo(size_t number_of_modules);

  ~GroupInfo() noexcept; /* annotating specified destructor as noexcept is best-practice */

  size_t size() const;

  const Info& operator[](size_t index) const;

  bool writeGains(const std::string& file) const;

  FunctionCallResult writeSafetyParameters(const std::string& file) const {
    auto res = hebiGroupInfoWriteSafetyParameters(internal_, file.c_str()) == HebiStatusSuccess;
    if (res) {
      return FunctionCallResult{true};
    }
    return FunctionCallResult{false, std::string{hebiSafetyParametersGetLastError()}};
  }

  Eigen::VectorXd getSpringConstant() const;

  void getSpringConstant(Eigen::VectorXd& out) const;
};

} // namespace hebi