service_caller.h

Go to the documentation of this file.

/*******************************************************************************
 * BSD 3-Clause License
 *
 * Copyright (c) 2021, Qiayuan Liao
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * * Redistributions of source code must retain the above copyright notice, this
 *   list of conditions and the following disclaimer.
 *
 * * Redistributions in binary form must reproduce the above copyright notice,
 *   this list of conditions and the following disclaimer in the documentation
 *   and/or other materials provided with the distribution.
 *
 * * Neither the name of the copyright holder nor the names of its
 *   contributors may be used to endorse or promote products derived from
 *   this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *******************************************************************************/
 
//
// Created by qiayuan on 5/22/21.
//
 
#pragma once
 
#include <chrono>
#include <mutex>
#include <thread>
#include <utility>
#include <ros/ros.h>
#include <ros/service.h>
#include <controller_manager_msgs/SwitchController.h>
#include <control_msgs/QueryCalibrationState.h>
#include <rm_msgs/StatusChange.h>
 
namespace rm_common
{
template <class ServiceType>
class ServiceCallerBase
{
public:
  explicit ServiceCallerBase(ros::NodeHandle& nh, const std::string& service_name = "") : fail_count_(0), fail_limit_(0)
  {
    nh.param("fail_limit", fail_limit_, 0);
    if (!nh.param("service_name", service_name_, service_name) && service_name.empty())
    {
      ROS_ERROR("Service name no defined (namespace: %s)", nh.getNamespace().c_str());
      return;
    }
    client_ = nh.serviceClient<ServiceType>(service_name_);
  }
  explicit ServiceCallerBase(ros::NodeHandle& nh, const std::string& service_name = "") : fail_count_(0), fail_limit_(0) {…}
  ServiceCallerBase(ros::NodeHandle& nh, std::string& service_name) : fail_count_(0), fail_limit_(0)
  {
    service_name_ = service_name;
    client_ = nh.serviceClient<ServiceType>(service_name_);
  }
  ServiceCallerBase(ros::NodeHandle& nh, std::string& service_name) : fail_count_(0), fail_limit_(0) {…}
  ServiceCallerBase(XmlRpc::XmlRpcValue& controllers, ros::NodeHandle& nh, const std::string& service_name = "")
    : fail_count_(0), fail_limit_(0)
  {
    if (controllers.hasMember("service_name"))
      service_name_ = static_cast<std::string>(controllers["service_name"]);
    else
    {
      service_name_ = service_name;
      if (service_name.empty())
      {
        ROS_ERROR("Service name no defined (namespace: %s)", nh.getNamespace().c_str());
        return;
      }
    }
    client_ = nh.serviceClient<ServiceType>(service_name_);
  }
  ServiceCallerBase(XmlRpc::XmlRpcValue& controllers, ros::NodeHandle& nh, const std::string& service_name = "") {…}
  ~ServiceCallerBase()
  {
    delete thread_;
  }
  ~ServiceCallerBase() {…}
  void callService()
  {
    if (isCalling())
      return;
    thread_ = new std::thread(&ServiceCallerBase::callingThread, this);
    thread_->detach();
  }
  void callService() {…}
  ServiceType& getService()
  {
    return service_;
  }
  ServiceType& getService() {…}
  bool isCalling()
  {
    std::unique_lock<std::mutex> guard(mutex_, std::try_to_lock);
    return !guard.owns_lock();
  }
  bool isCalling() {…}
 
protected:
  void callingThread()
  {
    std::lock_guard<std::mutex> guard(mutex_);
    if (!client_.call(service_))
    {
      ROS_INFO_ONCE("Failed to call service %s on %s. Retrying now ...", typeid(ServiceType).name(),
                    service_name_.c_str());
      if (fail_limit_ != 0)
      {
        fail_count_++;
        if (fail_count_ >= fail_limit_)
        {
          ROS_ERROR_ONCE("Failed to call service %s on %s", typeid(ServiceType).name(), service_name_.c_str());
          fail_count_ = 0;
        }
      }
      //      ros::WallDuration(0.2).sleep();
    }
  }
  void callingThread() {…}
  std::string service_name_;
  ros::ServiceClient client_;
  ServiceType service_;
  std::thread* thread_{};
  std::mutex mutex_;
  int fail_count_, fail_limit_;
};
class ServiceCallerBase {…};
 
class SwitchControllersServiceCaller : public ServiceCallerBase<controller_manager_msgs::SwitchController>
{
public:
  explicit SwitchControllersServiceCaller(ros::NodeHandle& nh)
    : ServiceCallerBase<controller_manager_msgs::SwitchController>(nh, "/controller_manager/switch_controller")
  {
    service_.request.strictness = service_.request.BEST_EFFORT;
    service_.request.start_asap = true;
  }
  explicit SwitchControllersServiceCaller(ros::NodeHandle& nh) {…}
  void startControllers(const std::vector<std::string>& controllers)
  {
    service_.request.start_controllers = controllers;
  }
  void startControllers(const std::vector<std::string>& controllers) {…}
  void stopControllers(const std::vector<std::string>& controllers)
  {
    service_.request.stop_controllers = controllers;
  }
  void stopControllers(const std::vector<std::string>& controllers) {…}
  bool getOk()
  {
    if (isCalling())
      return false;
    return service_.response.ok;
  }
  bool getOk() {…}
};
class SwitchControllersServiceCaller : public ServiceCallerBase<controller_manager_msgs::SwitchController> {…};
 
class QueryCalibrationServiceCaller : public ServiceCallerBase<control_msgs::QueryCalibrationState>
{
public:
  explicit QueryCalibrationServiceCaller(ros::NodeHandle& nh)
    : ServiceCallerBase<control_msgs::QueryCalibrationState>(nh)
  {
  }
  explicit QueryCalibrationServiceCaller(ros::NodeHandle& nh) {…}
  QueryCalibrationServiceCaller(ros::NodeHandle& nh, std::string& service_name)
    : ServiceCallerBase<control_msgs::QueryCalibrationState>(nh, service_name)
  {
  }
  QueryCalibrationServiceCaller(ros::NodeHandle& nh, std::string& service_name) {…}
  QueryCalibrationServiceCaller(XmlRpc::XmlRpcValue& controllers, ros::NodeHandle& nh)
    : ServiceCallerBase<control_msgs::QueryCalibrationState>(controllers, nh)
  {
  }
  QueryCalibrationServiceCaller(XmlRpc::XmlRpcValue& controllers, ros::NodeHandle& nh) {…}
  bool isCalibrated()
  {
    if (isCalling())
      return false;
    return service_.response.is_calibrated;
  }
  bool isCalibrated() {…}
};
class QueryCalibrationServiceCaller : public ServiceCallerBase<control_msgs::QueryCalibrationState> {…};
 
class SwitchDetectionCaller : public ServiceCallerBase<rm_msgs::StatusChange>
{
public:
  explicit SwitchDetectionCaller(ros::NodeHandle& nh)
    : ServiceCallerBase<rm_msgs::StatusChange>(nh, "/detection_nodelet/status_switch")
  {
    service_.request.target = rm_msgs::StatusChangeRequest::ARMOR;
    service_.request.exposure = rm_msgs::StatusChangeRequest::EXPOSURE_LEVEL_0;
    service_.request.armor_target = rm_msgs::StatusChangeRequest::ARMOR_ALL;
    callService();
  }
  explicit SwitchDetectionCaller(ros::NodeHandle& nh) {…}
 
  explicit SwitchDetectionCaller(ros::NodeHandle& nh, std::string service_name)
    : ServiceCallerBase<rm_msgs::StatusChange>(nh, service_name)
  {
    service_.request.target = rm_msgs::StatusChangeRequest::ARMOR;
    service_.request.exposure = rm_msgs::StatusChangeRequest::EXPOSURE_LEVEL_0;
    service_.request.armor_target = rm_msgs::StatusChangeRequest::ARMOR_ALL;
    callService();
  }
  explicit SwitchDetectionCaller(ros::NodeHandle& nh, std::string service_name) {…}
 
  void setEnemyColor(const int& robot_id_, const std::string& robot_color_)
  {
    if (robot_id_ != 0)
    {
      service_.request.color =
          robot_color_ == "blue" ? rm_msgs::StatusChangeRequest::RED : rm_msgs::StatusChangeRequest::BLUE;
      ROS_INFO_STREAM("Set enemy color: " << (service_.request.color == service_.request.RED ? "red" : "blue"));
 
      callService();
    }
    else
      ROS_INFO_STREAM("Set enemy color failed: referee offline");
  }
  void setEnemyColor(const int& robot_id_, const std::string& robot_color_) {…}
  void setColor(uint8_t color)
  {
    service_.request.color = color;
  }
  void setColor(uint8_t color) {…}
  void switchEnemyColor()
  {
    service_.request.color = service_.request.color == rm_msgs::StatusChangeRequest::RED;
  }
  void switchEnemyColor() {…}
  void switchTargetType()
  {
    service_.request.target = service_.request.target == rm_msgs::StatusChangeRequest::ARMOR;
  }
  void switchTargetType() {…}
  void setTargetType(uint8_t target)
  {
    service_.request.target = target;
  }
  void setTargetType(uint8_t target) {…}
  void switchArmorTargetType()
  {
    service_.request.armor_target = service_.request.armor_target == rm_msgs::StatusChangeRequest::ARMOR_ALL;
  }
  void switchArmorTargetType() {…}
  void setArmorTargetType(uint8_t armor_target)
  {
    service_.request.armor_target = armor_target;
  }
  void setArmorTargetType(uint8_t armor_target) {…}
  void switchExposureLevel()
  {
    service_.request.exposure = service_.request.exposure == rm_msgs::StatusChangeRequest::EXPOSURE_LEVEL_4 ?
                                    rm_msgs::StatusChangeRequest::EXPOSURE_LEVEL_0 :
                                    service_.request.exposure + 1;
  }
  void switchExposureLevel() {…}
  int getColor()
  {
    return service_.request.color;
  }
  int getColor() {…}
  int getTarget()
  {
    return service_.request.target;
  }
  int getTarget() {…}
  int getArmorTarget()
  {
    return service_.request.armor_target;
  }
  int getArmorTarget() {…}
  uint8_t getExposureLevel()
  {
    return service_.request.exposure;
  }
  uint8_t getExposureLevel() {…}
  bool getIsSwitch()
  {
    if (isCalling())
      return false;
    return service_.response.switch_is_success;
  }
  bool getIsSwitch() {…}
 
private:
  bool is_set_{};
};
class SwitchDetectionCaller : public ServiceCallerBase<rm_msgs::StatusChange> {…};
 
}  // namespace rm_common