パラメータ

安曇野の森から > ROS(Robot Operating System)を使う > パラメータ

パラメーター

パラメーターサーバーに記録されている情報をパラメーターといいます。

パラメーターサーバーはマスター起動と同時に起動されます。

以下では、このパラメーターをコマンド、プログラム、ローンチファイルから利用する方法について説明します。

パラメーターコマンド

コマンドを使ってパラメーターの読み書きが出来ます。また、パラメータの一覧を表示することも出来ます。

パラメーターの書き込み

以下のコマンドでパラメータに値を書き込むことが出来ます。

パラメータ名は文字列で設定します。
パラメータ値はstd::string, bool, int, doubleのいずれかで値を設定します。

$ rosparam set パラメーター名 パラメーター値

パラメーターの読み出し

以下のコマンドで指定したパラメータの値を読み出すことが出来ます。

$ rosparam get パラメーター名

以下のコマンドで指定した名前空間の全てのパラメータの値を読み出すことが出来ます。

$ rosparam get 名前空間名

以下のコマンドで登録されている全てのパラメータの値を読み出すことが出来ます。

$ rosparam get /

ファイルへのパラメーターの書き込み

以下のコマンドでパラメーターをファイルに書き込むことが出来ます。
名前空間名を指定しない場合はグローバル名前空間「/」となります。

$ rospalam dump ファイル名 [名前空間名]

ファイルからのパラメーターの読み出し

以下のコマンドでファイルから読み出した値をパラメーターに書き込むことが出来ます。
名前空間名を指定しない場合はグローバル名前空間「/」となります。

$ rospalam load ファイル名 [名前空間名]

パラメーターの一覧表示

以下のコマンドで全パラメータの一覧を表示することが出来ます。

$ rosparam list

プログラムからのパラメーターへのアクセス

パラメーターへアクセスするサンプルプログラム

以下のプログラムはパラメータへの書き込みと読み出しを行うサンプルプログラムです。

/* パラメータ書き込み、読み出し */
#include <ros/ros.h>                        // ROSヘッダファイル

int main(int argc, char **argv) {
  ros::init(argc, argv, "param_test");      // ROS初期化（ノード名を"param_test"に設定）
  ros::NodeHandle nh;                       // ノードハンドルの生成
  ros::param::set("param_str", "Hello World"); // パラメータparam_strに"Hello World"を書き込み
  std::string str;
  ros::param::get("param_str", str);        // パラメータparam_strを読み出し
  ROS_INFO_STREAM(str);                     // 標準出力へ読み出した結果を表示
}

パラメーターへアクセスするサンプルプログラムの説明

次の２行はノードを作る際に、お約束で必ず呼び出さないといけないAPIです。

詳しくは「簡単なプログラムを作って動かしてみる」の「プログラムの簡単な説明」を見てください。

ros::init(argc, argv, "param_test");
ros::NodeHandle nh;

次のAPIを使い指定したパラメータparam_strに値"Hello Wordl"を書き込んでいます。

ros::param::set("param_str", "Hello World");

次の１行目のAPIで指定したパラメータの値を読み出し。２行目のマクロで表示しています。

ros::param::get("param_str", str);
ROS_INFO_STREAM(str);

ローンチファイルでパラメーターへのアクセス

ローンチファイルでパラメーターへ値を書き込むことが出来ます。

ローンチファイルでパラメーターの書き込み

ローンチファイルへ以下を記載することで指定したパラメータへ値を書き込むことが出来ます。

<param name="パラメーター名" value="値"/>

ローンチファイルでファイルからパラメーターへの書き込み

ローンチファイルへ以下を記載することでファイルから読み出した値をパラメーターに書き込むことが出来ます。

<rosparam command="load" file="パス/パラメータ名"/>

又は以下のようにfindを使ってパスを探させます。

<rosparam command="load" file="$(find パッケージ名)/パラメータ名"/>

<< 前のページ次のページ >>