sas_robot_driver_ros.hpp

/*
# Copyright (c) 2016-2025 Murilo Marques Marinho
#
#    This file is part of sas_robot_driver.
#
#    sas_robot_driver is free software: you can redistribute it and/or modify
#    it under the terms of the GNU Lesser General Public License as published by
#    the Free Software Foundation, either version 3 of the License, or
#    (at your option) any later version.
#
#    sas_robot_driver is distributed in the hope that it will be useful,
#    but WITHOUT ANY WARRANTY; without even the implied warranty of
#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
#    GNU Lesser General Public License for more details.
#
#    You should have received a copy of the GNU Lesser General Public License
#    along with sas_robot_driver.  If not, see <https://www.gnu.org/licenses/>.
#
# ################################################################
#
#   Author: Murilo M. Marinho, email: murilomarinho@ieee.org
#
# ################################################################
# Contributors:
#
#   1. Juan Jose Quiroz Omana (juanjose.quirozomana@manchester.ac.uk)
#      - Added the Watchdog functionality.
#      - Renamed robot_driver_provider_ to robot_driver_server_
#      - Added a new std::optional parameter in RobotDriverROSConfiguration to define the watchdog period
#
*/
 
#pragma once
 
#include <atomic>
#include <vector>
#include <memory>
 
#include <rclcpp/rclcpp.hpp>
#include <sas_core/sas_shutdown_signaler.hpp>
#include <sas_core/sas_clock.hpp>
#include <sas_core/sas_robot_driver.hpp>
#include <sas_robot_driver/sas_robot_driver_server.hpp>
 
 
namespace sas
{

struct RobotDriverROSConfiguration
{
    std::string robot_driver_provider_prefix;

    double thread_sampling_time_sec;

    double  watchdog_period_in_seconds;

    std::vector<double> q_min;

    std::vector<double> q_max;
};

class RobotDriverROS
{
private:
    std::shared_ptr<rclcpp::Node> node_;
 
    RobotDriverROSConfiguration configuration_;
    std::atomic_bool* kill_this_node_; //Deprecated
    std::shared_ptr<ShutdownSignaler> shutdown_signaler_;
    std::shared_ptr<RobotDriver> robot_driver_;
    Clock clock_;
    RobotDriverServer robot_driver_server_;
    bool watchdog_started_;
    double watchdog_period_in_seconds_;
    double watchdog_maximum_acceptable_delay_in_seconds_;
    bool _should_shutdown() const;
 
public:
    RobotDriverROS(const RobotDriverROS&)=delete;
    RobotDriverROS()=delete;

    RobotDriverROS(std::shared_ptr<rclcpp::Node>& node,
                   const std::shared_ptr<RobotDriver>& robot_driver,
                   const RobotDriverROSConfiguration& configuration,
                   const std::shared_ptr<ShutdownSignaler>& shutdown_signaler_);
 
    [[deprecated("Use RobotDriver(const std::shared_ptr<ShutdownSignaler>& shutdown_signaler_) instead.")]]
    RobotDriverROS(std::shared_ptr<rclcpp::Node>& node,
                   const std::shared_ptr<RobotDriver>& robot_driver,
                   const RobotDriverROSConfiguration& configuration,
                   std::atomic_bool* kill_this_node);

    ~RobotDriverROS();

    int control_loop();
};
 
}