これからRTコンポーネントの作成方法について解説します。自分のロボットを作ためには、RTコンポーネント作成しなくてはなりません。この作業自体はインストールが出来ていれば実は超かんたんです．

概要

RTコンポーネントを作成する手順としては、

• RTC Builderでスケルトンコードを生成する
• スケルトンコードを編集する
• ビルドして実行する

という感じです。

スケルトンコードを生成する時点で殆どの手間が省かれちゃいますので、特定の関数（イベントハンドラ）を編集するのが作業の中心です。

スケルトンコードの生成

まず，骨格（スケルトン）となるソースコードを作ります．これにはEclipseを使います．というのもRTCのプログラムコードのテンプレートを作成してくれるツール，RTC BuilderをEclipseで使うのが正解．またeclipseはRTCの起動状態をRT System Editorというツールを使って操作するときにも使うので，しばらくは起動しっぱなしだと思います．

Eclipse（RTツール全部入り）のインストールについては，インストール編を参考にすると良いでしょう．

RTC Builder

まず，Eclipse（ツール全部入り）を起動します．
メニューの「Window（ウィンドウ)」＞「Perspective(パースペクティブ)」を選択し，「RtcBuilder」を選択します．これでRTC Builderが使える状態です．

RTC Builder perspective

File（ファイル）から，「Open new Builder Editor」を選びます．図のようなエディタが起動します．コレを順番に設定していって，プログラムのテンプレートを作成するのです．

RTC Builder Editor

まずは超かんたんなコンポーネントを作ってみましょう．

PERIODICなコンポーネントの作成

RTC Builderのコンフィグ

ただ単純にコンソールに文字を出力するだけのプログラムを作成してみましょう．
基本的に下図のタブを選択しながら大まかなカテゴリごとに設定を勧めます．

Tabs

以下のように設定して下さい．ほかの部分には何も記入しないで下さい．

これまでのバージョンとの大きな変更点は，下図のようにアクティビティのタブで，イベントハンドラを実装することが出来る点です．

注意：Visual C++で開発される方

Visual Studioのソリューションファイルを生成するには，言語タブの「Use old build environment」というチェックボックスをOnにする必要があります．
このサイトのC++の開設ではVisual C++を使っていますので，チェックボックスをONにしてください．

各パラメータの説明（読み飛ばしても出来る！)

• 基本タグ
  • Module name・・・コンポーネントの名前．スペースを含まない方がいい．
  • Module description・・・コンポーネントの説明．
  • Module version・・・コンポーネントのバージョン．最初は低めで・・・
  • Module vendor・・・コンポーネントのベンダー．あなたの名前を書きましょう．これであなたもRTCベンダーの仲間入り．
  • Module category・・・とりあえずTESTとしておきます．複数のRTCを作るようになれば，これを使って管理する必要が出てくるかもしれませんが，個人でやるレベルでは必要ないと思います．
  • Component type・・・STATIC，UNIQUE，COMMUNICATIVEの3種類がありますが，まだ対応していないようです．
  • Component’s activity type・・・PERIODIC，SPORADIC，EVENT_DRIVENがありますが，PERIODICしか対応していません．
  • Component Kind・・・「Data Flow」「FSM」「Multimode」の3種類があります．RTコンポーネントの仕様で，3つのコンポーネントの種類が定義されていますが，OpenRTM-aistではまだData Flowコンポーネントのみの対応です．
  • Number of maximum instance・・・コンポーネントの同時生成可能数
  • Execution type・・・実行コンテキストのタイプです．実行コンテキストによって，イベントハンドラ「on_execute」の実行タイミングの制御方式が変わります．PeriodicExecutionContext（周期実行）とExtTrigExecutionContext（外部トリガによる実行）があります．通常はPeriodicExecutionContextを選びます．
  • Execution rate・・・実行周期です．単位はHz．
  • Abstract・・・コンポーネントの説明．
  • RTC type・・・RTCのタイプ．PERIODICとか．不要．
  • Output Project・・・Eclipse上のプロジェクト名．コンポーネントと同じで十分．
• アクティビティ
  • on_execute・・・PERIODIC実行の場合，周期的に実行されるイベントハンドラ．
• 言語・環境
  • 言語・・・OpenRTM-aistでは，C++，Java，Python，.Netに対応しています．Rubyにも対応予定？

生成

ここで「コード生成」というボタンを押すと「プロジェクトがワークスペース内に存在しません」と言われますが，OKとします．「Generate success」というメッセージが出て，ワークスペースにコンポーネントのテンプレートが生成されています．

Generated Project

言語ごとの開発

タブを選んでください．

/*
RTC::ReturnCode_t PeriodicConsoleOut::onDeactivated(RTC::UniqueId ec_id)
{
  return RTC::RTC_OK;
}
*/
RTC::ReturnCode_t PeriodicConsoleOut::onExecute(RTC::UniqueId ec_id) { 
  std::cout << "Hello RTC (ver. 1.0)!!!!" << std::endl;
  return RTC::RTC_OK; 
} 
/*
RTC::ReturnCode_t PeriodicConsoleOut::onAborting(RTC::UniqueId ec_id)
{
  return RTC::RTC_OK;
}
*/

// <rtc-template block="module_spec">
static const char* directinputcomponent_spec[] =
{
  "implementation_id", "DirectInput",
  "type_name", "DirectInput",
  "description", "DirectInput Component",
  "version", "0.1.0",
  "vendor", "ysuga_net",
  "category", "Test",
  "activity_type", "PERIODIC",
  "kind", "DataFlowComponent",
  "max_instance", "1",
  "language", "C++",
  "lang_type", "compile",
  "exec_cxt.periodic.rate", "100.0",　このペアを削除
  "conf.default.debug", "0",
  ""
};

//    @Override
//    protected ReturnCode_t onDeactivated(int ec_id) {
//        return super.onDeactivated(ec_id);
//    }
 
/***
*
* The execution action that is invoked periodically
* former rtc_active_do()
*
* @param ec_id target ExecutionContext Id
*
* @return RTC::ReturnCode_t
*
*
*/
@Override
protected ReturnCode_t onExecute(int ec_id) {
  System.out.println("Hello RT-Component!");
  return super.onExecute(ec_id);
}
 
/***
*
* The aborting action when main logic error occurred.
* former rtc_aborting_entry()
*
* @param ec_id target ExecutionContext Id
*
* @return RTC::ReturnCode_t
*
*
*/
//  @Override
//  public ReturnCode_t onAborting(int ec_id) {
//      return super.onAborting(ec_id);
//  }

import sys
import time
sys.path.append(".")
import RTC
import OpenRTM_aist
 
periodicconsoleout_spec = ["implementation_id", "PeriodicConsoleOut", 
		 "type_name",         "PeriodicConsoleOut", 
		 "description",       "Periodic Console Out", 
		 "version",           "1.0.0", 
		 "vendor",            "ysuga.net", 
		 "category",          "Test", 
		 "activity_type",     "STATIC", 
		 "max_instance",      "1", 
		 "language",          "Python", 
		 "lang_type",         "SCRIPT",
		 ""]
 
class PeriodicConsoleOut(OpenRTM_aist.DataFlowComponentBase):
 
        # 思い切り中略！
 
	def onExecute(self, ec_id):
		"""
 
		The execution action that is invoked periodically
		former rtc_active_do()
 
		\param ec_id target ExecutionContext Id
 
		\return RTC::ReturnCode_t
 
		"""
 
		return RTC.RTC_OK

	def onExecute(self, ec_id):
		print "Hello RT-Component!"	
		return RTC.RTC_OK

これでOK．ビルドしましょう．エラーはないですよね．

rtc.confの変更

コンポーネントを実行する前にやらなくてはならないことがもう一つ．rtc.confファイルの変更です．

このファイルには，RTCの実行に関する設定を記述できます．主な目的は

• RTCの実行頻度などの管理
• ネームサービスの位置（URLもしくはIPアドレス）
• ネームサービス上の名前付けルール
• ログの管理
• そのほかCORBAの設定

といったところです．ここではネームサービスの実行されているPCのネットワーク上の位置を追加する必要があります．

rtc.confを秀丸やMeadowなどのテキストエディタで編集してください．

編集前

exec_cxt.periodic.rate:1.0

編集後

exec_cxt.periodic.rate:1.0
corba.nameservers: localhost

このlocalhostの部分にネームサーバーが実行されているマシンのIPアドレスを指定します．複数台のPCで分散的にRTCを実行＆接続する場合に関しては後述します．

RTCの実行

インストールのページで踏んだ手順で実行します．

1. ネームサービスの起動
2. Eclipse（RT System Editor）の起動
3. ネームサービスをRTSystemEditorに登録(デフォルトで登録される場合も）
4. RTC（今回はPeriodicConsoleOutComp）の実行 (VC2008からデバッグで実行でOK)
5. RT System Editor上で接続（今回は無視）
6. RT System Editorでアクティベート

Activated RTC

文字がたくさん出ます．

周期の変更

先ほどのrtc.confの「exec_cxt.periodic.rate」に続く値が実行周期（単位Hz）です．これを変更すれば，文字が表示される頻度が変わります．

リアルタイムなの？リアルタイムにならないの？

OpenRTM-aistのコードを見ればわかりますが，リアルタイムではありません．つまり，周期を100とした場合でも，実行時に100Hzが補償出来ません．Windowsだとキツイです．

ただ，Linuxではカーネルプリエンプションを使ったリアルタイム周期実行が可能になります．いずれ解説します．

RTCの終了

注意！いきなりDOS窓を閉じない！！

終了時はRT System Editor上でRTCを右クリックし，非アクティブ化（deactivate）をした後，さらに右クリックして「終了（exit）」を選択してから終了させてください．現在の状態では，Exit関数を呼び出す方法が他にありません．

exit関数を呼ばずにDOS窓を閉じてしまうと，下図のようにRTCがネームサーバー上に登録されたまま実体の無い「ゾンビー状態」になります．ゾンビーってふざけているようですが，ふつうにハッカー達はゾンビーと呼んでます．

RTC ZOMBEE!

ゾンビが出来てしまってもバージョン1.0からは怖くありません．ゾンビをクリアボタンが付いています．これを押すとゾンビが消えます．

ZOMBEE KILLER!

再度開発を行う場合

RTC Builderの設定は，RTCBuilderで自動的に生成されたRTC.xmlというファイルに，RTCProfile形式という形で記録されています．これをインポートすることによって，RTC Builderの設定を読み出し，再度スケルトンコードを生成することが出来ます．

EclipseからRTC Builderを開き，RTC Builder Editorを開きます．
基本タブからプロファイル情報のインポート・エクスポートを選び，インポートボタンをクリック！

Reading RTC Profile (RTC.xml)

PeriodicConsoleOutのプロジェクトフォルダからRTC.xmlファイルを選択してインポートします．

RTC.xml is RTC Profile

これで前回の設定が復活です．

新しい設定を追加した後に，再度「コード生成」ボタンでコードを生成します．このとき，「比較エディター」画面になります．選択肢として「Original（もとのコードを保持）」「Merge（RTCBuilderのコード生成部分のみ最新で上書き）」「Generate（最新で上書き）」の3つの選択肢があります．Mergeを選べばよいのですが，2009年7月24日現在，バグらしき箇所がありますので，基本的にGenerateを選びます．古いファイルも○○.cpp20090724・・・のようにファイル名が書きかえられて残っています．こちらから自分の手作業でコピー＆ペーストしてプログラムを最新にします．

＊この方法が許されるように，基本的にメインロジックをRTCコード上に書かずに，独自クラスを実装するようにしましょう．RTCのコードには最小限のコードを書く方がベター．

まとめ

いかがですか？コンポーネント作成がかなり簡単であることが分かると思います．今回はPeriodicなコンポーネントで，しかもデータの授受を全く行いませんでしたが，次回はRT
System Editorからコンフィグレーションの設定が出来るように，今回のプログラムを拡張してみましょう．

今回作成したファイル
PeriodicConsoleOut_v10(C++)
PeriodicConsoleOutJava
PeriodicConsoleOutPy