【ROS教程】ROS常用API講解

@

1.節點初始化

ROSCPP_DECL void init(int &argc, char **argv, const std::string& name, uint32_t options = 0);
ROSCPP_DECL void init(const M_string& remappings, const std::string& name, uint32_t options = 0);
ROSCPP_DECL void init(const VP_string& remapping_args, const std::string& name, uint32_t options = 0);

這里講解第一種初始化方式

參數	含義
argc	main函數的第一個參數
argv	main函數的第二個參數
name	節點的名字，必須是唯一的

2.話題通信

2.1 創建發布者對象

template <class M>
Publisher NodeHandle::advertise(const std::string& topic, uint32_t queue_size, bool latch = false);
  
template <class M>
Publisher NodeHandle::advertise(const std::string& topic, uint32_t queue_size,
                        const SubscriberStatusCallback& connect_cb,
                        const SubscriberStatusCallback& disconnect_cb = SubscriberStatusCallback(),
                        const VoidConstPtr& tracked_object = VoidConstPtr(),
                        bool latch = false);

這里講解第一種構造方式

參數	含義
topic	話題的名字，必須是唯一的
queue_size	等待發送給訂閱者的最大消息數量
latch	如果為 true,該話題發布的最后一條消息將被保存，并且后期當有訂閱者連接時會將該消息發送給訂閱者

2.2 消息發布

template <typename M>
      void Publisher::publish(const M& message) const;

參數	含義
message	被組織的消息

2.3 創建訂閱者對象

template<class M>
Subscriber NodeHandle::subscribe(const std::string& topic, uint32_t queue_size, void(*fp)(const boost::shared_ptr<M const>&), const TransportHints& transport_hints = TransportHints());

template<class M>
Subscriber NodeHandle::subscribe(const std::string& topic, uint32_t queue_size, const boost::function<void (const boost::shared_ptr<M const>&)>& callback,
                         const VoidConstPtr& tracked_object = VoidConstPtr(), const TransportHints& transport_hints = TransportHints());

參數	含義
topic	話題的名字，必須是唯一的
queue_size	main函數的第二個參數
fp	回調函數的函數指針
return	調用成功時，返回一個訂閱者對象，失敗時，返回空對象

3.服務通信

3.1 創建服務對象

  template<class T, class MReq, class MRes>
  ServiceServer NodeHandle::advertiseService(const std::string& service, bool(T::*srv_func)(MReq &, MRes &), T *obj);
  
  template<class T, class MReq, class MRes>
  ServiceServer NodeHandle::advertiseService(const std::string& service, bool(T::*srv_func)(ServiceEvent<MReq, MRes>&), T *obj);

  template<class T, class MReq, class MRes>
  ServiceServer NodeHandle::advertiseService(const std::string& service, bool(T::*srv_func)(MReq &, MRes &), const boost::shared_ptr<T>& obj);

  template<class T, class MReq, class MRes>
  ServiceServer NodeHandle::advertiseService(const std::string& service, bool(T::*srv_func)(ServiceEvent<MReq, MRes>&), const boost::shared_ptr<T>& obj);

  template<class MReq, class MRes>
  ServiceServer NodeHandle::advertiseService(const std::string& service, bool(*srv_func)(MReq&, MRes&));

  template<class MReq, class MRes>
  ServiceServer NodeHandle::advertiseService(const std::string& service, bool(*srv_func)(ServiceEvent<MReq, MRes>&));
  
  template<class MReq, class MRes>
  ServiceServer NodeHandle::advertiseService(const std::string& service, const boost::function<bool(MReq&, MRes&)>& callback, 
                                 const VoidConstPtr& tracked_object = VoidConstPtr());

  template<class S>
  ServiceServer NodeHandle::advertiseService(const std::string& service, const boost::function<bool(S&)>& callback, 
                                 const VoidConstPtr& tracked_object = VoidConstPtr());

參數	含義
service	服務名稱，必須是唯一的
srv_func	接收到請求時，需要處理請求的回調函數
return	請求成功時返回服務對象，否則返回空對象

3.2 創建客戶對象

  template<class MReq, class MRes>
  ServiceClient NodeHandle::serviceClient(const std::string& service_name, bool persistent = false, 
                              const M_string& header_values = M_string());
  template<class Service>
  ServiceClient NodeHandle::serviceClient(const std::string& service_name, bool persistent = false, 
                              const M_string& header_values = M_string());

參數	含義
service_name	服務名稱，必須是唯一的

3.3 客戶發送請求

  template<class Service>
  bool ServiceClient::call(Service& service);

參數	含義
service	.srv文件定義的服務類型

3.4 客戶對象等待服務

ROSCPP_DECL bool service::waitForService(const std::string& service_name, int32_t timeout);
ROSCPP_DECL bool service::waitForService(const std::string& service_name, ros::Duration timeout = ros::Duration(-1));

參數	含義
service_name	被等待的服務名稱，必須是唯一的
timeout	等待最大時常，默認為 -1，可以永久等待直至節點關閉
return	成功返回 true，否則返回 false

4. 回旋函數

簡而言之，用到回調函數，就要用回旋函數處理

4.1 spin

/** 
 * \brief 進入循環處理回調 
 */
ROSCPP_DECL void spin();

4.2 spinOnce

/**
 * \brief 處理一輪回調
 *
 * 一般應用場景:
 *     在循環體內，處理所有可用的回調函數
 * 
 */
ROSCPP_DECL void spinOnce();

5.時間

5.1 時刻

5.1.1 獲取當前時刻

ros::init(argc,argv,"hello_time");
ros::NodeHandle nh;//必須創建句柄，否則時間沒有初始化，導致后續API調用失敗
ros::Time right_now = ros::Time::now();//將當前時刻封裝成對象
ROS_INFO("當前時刻:%.2f",right_now.toSec());//獲取距離 1970年01月01日 00:00:00 的秒數
ROS_INFO("當前時刻:%d",right_now.sec);//獲取距離 1970年01月01日 00:00:00 的秒數

5.1.2 設置時刻

ros::init(argc,argv,"hello_time");
ros::NodeHandle nh;//必須創建句柄，否則時間沒有初始化，導致后續API調用失敗
ros::Time someTime(100,100000000);// 參數1:秒數  參數2:納秒
ROS_INFO("時刻:%.2f",someTime.toSec()); //100.10
ros::Time someTime2(100.3);//直接傳入 double 類型的秒數
ROS_INFO("時刻:%.2f",someTime2.toSec()); //100.30

5.2 時間間隔

5.2.1 設置時間間隔

ros::init(argc,argv,"hello_time");
ros::NodeHandle nh;//必須創建句柄，否則時間沒有初始化，導致后續API調用失敗
ros::Duration du(10);//持續10秒鐘,參數是double類型的，以秒為單位
ROS_INFO("持續時間:%.2f",du.toSec());//將持續時間換算成秒

5.2.2 進行休眠

ros::init(argc,argv,"hello_time");
ros::NodeHandle nh;//必須創建句柄，否則時間沒有初始化，導致后續API調用失敗
ros::Duration du(10);//持續10秒鐘,參數是double類型的，以秒為單位
du.sleep();//按照指定的持續時間休眠

5.3 設置運行頻率

Rate::Rate(double frequency);

參數	含義
frequency	運行頻率

6.參數設置

6.1 修改或新增參數

  void NodeHandle::setParam(const std::string& key, const XmlRpc::XmlRpcValue& v) const;
  void NodeHandle::setParam(const std::string& key, const std::string& s) const;
  void NodeHandle::setParam(const std::string& key, const char* s) const;
  void NodeHandle::setParam(const std::string& key, double d) const;
  void NodeHandle::setParam(const std::string& key, int i) const;
  void NodeHandle::setParam(const std::string& key, bool b) const;
  void NodeHandle::setParam(const std::string& key, const std::vector<std::string>& vec) const;
  void NodeHandle::setParam(const std::string& key, const std::vector<double>& vec) const;
  void NodeHandle::setParam(const std::string& key, const std::vector<float>& vec) const;
  void NodeHandle::setParam(const std::string& key, const std::vector<int>& vec) const;
  void NodeHandle::setParam(const std::string& key, const std::vector<bool>& vec) const;
  void NodeHandle::setParam(const std::string& key, const std::map<std::string, std::string>& map) const;
  void NodeHandle::setParam(const std::string& key, const std::map<std::string, double>& map) const;
  void NodeHandle::setParam(const std::string& key, const std::map<std::string, float>& map) const;
  void NodeHandle::setParam(const std::string& key, const std::map<std::string, int>& map) const;
  void NodeHandle::setParam(const std::string& key, const std::map<std::string, bool>& map) const;

ROS提供了16種可以設置的參數類型，如上。
使用 ros::param::set有完全相同的效果

6.2 獲取參數

/*
    參數服務器操作之查詢_C++實現:
    在 roscpp 中提供了兩套 API 實現參數操作
  
    ros::NodeHandle::param(鍵,默認值) 
            存在，返回對應結果，否則返回默認值

    ros::NodeHandle::getParam(鍵,存儲結果的變量)
            存在,返回 true,且將值賦值給參數2
            若果鍵不存在，那么返回值為 false，且不為參數2賦值

    ros::NodeHandle::getParamCached(鍵,存儲結果的變量)--提高變量獲取效率
            存在,返回 true,且將值賦值給參數2
            若果鍵不存在，那么返回值為 false，且不為參數2賦值

    ros::NodeHandle::getParamNames(std::vector<std::string>)
            獲取所有的鍵,并存儲在參數 vector 中 

    ros::NodeHandle::hasParam(鍵)
            是否包含某個鍵，存在返回 true，否則返回 false

    ros::NodeHandle::searchParam(參數1，參數2)
            搜索鍵，參數1是被搜索的鍵，參數2存儲搜索結果的變量

    ros::param ----- 與 NodeHandle 類似
*/

6.3 刪除參數

/* 
    參數服務器操作之刪除_C++實現:

    ros::NodeHandle::deleteParam("鍵")
        根據鍵刪除參數，刪除成功，返回 true，否則(參數不存在)，返回 false

    ros::param::del("鍵")
        根據鍵刪除參數，刪除成功，返回 true，否則(參數不存在)，返回 false
*/

本文由博客一文多發平臺 OpenWrite 發布！

posted @ 2024-08-27 13:12 UnderTurrets 閱讀(174) 評論(0) 收藏舉報

刷新頁面返回頂部

UnderTurrets

【ROS教程】ROS常用API講解

1.節點初始化

2.話題通信

2.1 創建發布者對象

2.2 消息發布

2.3 創建訂閱者對象

3.服務通信

3.1 創建服務對象

3.2 創建客戶對象

3.3 客戶發送請求

3.4 客戶對象等待服務

4. 回旋函數

4.1 spin

4.2 spinOnce

5.時間

5.1 時刻

5.1.1 獲取當前時刻

5.1.2 設置時刻

5.2 時間間隔

5.2.1 設置時間間隔

5.2.2 進行休眠

5.3 設置運行頻率

6.參數設置

6.1 修改或新增參數

6.2 獲取參數

6.3 刪除參數

公告