Program Listing for File data_structures.hpp

↰ Return to documentation for file (include/joint_limits/data_structures.hpp)

// Copyright 2024 PAL Robotics S.L.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.


#ifndef JOINT_LIMITS__DATA_STRUCTURES_HPP_
#define JOINT_LIMITS__DATA_STRUCTURES_HPP_

#include <fmt/compile.h>

#include <limits>
#include <memory>
#include <optional>
#include <string>

#define DEFINE_LIMIT_STRUCT(LimitType)                             \
  struct LimitType                                                 \
  {                                                                \
    LimitType(double minimum_value, double maximum_value)          \
    : lower_limit(minimum_value), upper_limit(maximum_value)       \
    {                                                              \
    }                                                              \
    double lower_limit = -std::numeric_limits<double>::infinity(); \
    double upper_limit = std::numeric_limits<double>::infinity();  \
  };

namespace joint_limits
{

DEFINE_LIMIT_STRUCT(PositionLimits)
DEFINE_LIMIT_STRUCT(VelocityLimits)
DEFINE_LIMIT_STRUCT(EffortLimits)
DEFINE_LIMIT_STRUCT(AccelerationLimits)

struct JointControlInterfacesData
{
  std::string joint_name;
  std::optional<double> position = std::nullopt;
  std::optional<double> velocity = std::nullopt;
  std::optional<double> effort = std::nullopt;
  std::optional<double> acceleration = std::nullopt;
  std::optional<double> jerk = std::nullopt;

  bool has_data() const
  {
    return has_position() || has_velocity() || has_effort() || has_acceleration() || has_jerk();
  }

  bool has_position() const { return position.has_value(); }

  bool has_velocity() const { return velocity.has_value(); }

  bool has_effort() const { return effort.has_value(); }

  bool has_acceleration() const { return acceleration.has_value(); }

  bool has_jerk() const { return jerk.has_value(); }

  std::string to_string() const
  {
    std::string str;
    str += "Joint: '" + joint_name + "', ";
    if (has_position())
    {
      str += "position: " + std::to_string(position.value()) + ", ";
    }
    if (has_velocity())
    {
      str += "velocity: " + std::to_string(velocity.value()) + ", ";
    }
    if (has_effort())
    {
      str += "effort: " + std::to_string(effort.value()) + ", ";
    }
    if (has_acceleration())
    {
      str += "acceleration: " + std::to_string(acceleration.value()) + ", ";
    }
    if (has_jerk())
    {
      str += "jerk: " + std::to_string(jerk.value());
    }
    // trim the last comma and space
    if (!str.empty() && str.back() == ' ')
    {
      str.pop_back();
    }
    if (!str.empty() && str.back() == ',')
    {
      str.pop_back();
    }
    return str;
  }
};

struct JointInterfacesCommandLimiterData
{
  std::string joint_name;
  JointControlInterfacesData actual;
  JointControlInterfacesData command;
  JointControlInterfacesData prev_command;
  JointControlInterfacesData limited;

  bool has_actual_data() const { return actual.has_data(); }

  bool has_command_data() const { return command.has_data(); }

  bool has_limited_data() const { return limited.has_data(); }

  void set_joint_name(const std::string & name)
  {
    joint_name = name;
    actual.joint_name = name;
    command.joint_name = name;
    limited.joint_name = name;
    prev_command.joint_name = name;
  }

  std::string to_string() const
  {
    return fmt::format(
      FMT_COMPILE("Joint: '{}', (actual: [{}], command: [{}], limited: [{}])"), joint_name,
      actual.to_string(), command.to_string(), limited.to_string());
  }
};

}  // namespace joint_limits
#endif  // JOINT_LIMITS__DATA_STRUCTURES_HPP_