【ROS教程】ROS常用API講解

UnderTurrets發表於2024-08-27

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 刪除引數

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 釋出！

【ROS教程】ROS常用命令
2024-08-27
ROS
ROS 載入yaml教程
2024-03-04
ROSYAML
ROS——無人機ROS模擬包 rotors_simulator 編譯教程
2020-10-28
ROS無人機編譯
【ROS教程】安裝ROS全流程及可能遇到的問題
2024-08-28
ROS
【ROS教程】話題通訊
2024-08-30
ROS
【ROS】從零開始學ROS
2020-12-12
ROS
ROS入門教程歸納1
2018-11-30
ROS
ROS通訊方式（保姆級教程）
2024-10-16
ROS
【ROS教程】編寫launch檔案
2024-08-30
ROS
在 ROS 中使用 Protobuf 替代 ros msg
2019-02-16
ROS
【Zeekr_Tech】ROS/ROS 2介紹
2022-04-21
ROS
ROS意外崩掉解決方案
2018-11-13
ROS
【ROS教程 008】機器視覺
2018-02-09
ROS視覺
ROS基礎入門——實操教程
2024-10-04
ROS
ros2常用命令記錄
2024-03-21
ROS
ros 日誌
2024-04-16
ROS
ros2
2024-07-09
ROS
ROS中解決中文亂碼
2024-04-21
ROS
ROS | ROS機器人開發案例（古月）學習
2018-12-15
ROS機器人
ROS 動態引數伺服器教程
2024-03-04
ROS伺服器
ROS2學習之旅（1）——初識ROS2
2021-07-10
ROS
ROS知識（21）----ROS C++程式碼格式化
2017-08-23
ROSC++
【ROS教程】用CLion編譯和除錯ROS包的全流程及可能遇到的問題
2024-08-29
ROS編譯除錯
VScode開發ROS 解決ros找不到標頭檔案等問題
2020-12-07
VSCodeROS
ROS命令列工具
2020-11-08
ROS命令列
ubuntu 安裝 ros
2024-03-08
UbuntuROS
思嵐科技釋出SLAMWARE ROS SDK，全面支援ROS系統
2019-08-22
SLAMROS
ROS-tf tree的學習筆記，夠常用
2020-10-21
ROS筆記
ROS2GO之系統升級篇（Ubuntu 18.04 + ROS 1 Melodic + ROS 2 Bouncy + V-Rep等）
2018-11-22
ROSGoUbuntu
【ROS】OpenCV+ROS 實現人臉識別（Ubantu16.04）
2022-07-21
ROSOpenCV
阿里雲國際版使用ROS搭建WordPress教程
2022-09-14
阿里ROS
Win32常用API講解
2019-05-10
Win32API
ROS之初見Hello World
2021-05-21
ROS
ROS入門學習
2018-11-10
ROS
ROS GUI-node，npm
2020-12-06
ROSGUINPM
ROS基本程式實現
2022-06-06
ROS
ROS2--Composition
2021-11-12
ROS
ROS新手上路-3
2020-09-29
ROS

【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 刪除引數

相關文章