• 動作環境
• 制限

動作環境

RTCBuilder の動作に必要な環境は以下のとおりです。

また以下の開発を行う言語によっては以下の環境をインストールしておくと便利です。

制限

RTCBuilder は、OpenRTM-aist を対象に開発されたものです。その他の RTC プラットフォームに対する動作は想定しておりません。

• RTCBuilder のインストール
• RTCBuilderの起動
• RTCBuilder 用プロジェクトの作成

ここでは、RTCBuilder のインストールおよび起動方法について説明します。

RTCBuilder のインストール

RTCBuilder は Eclipse プラグインであるため、 Eclipse 本体および依存している他の Eclipse プラグインをまずインストールする必要があります。 インストールに関しては、OpenRTM Eclipse tools のインストールを参照願います。

RTCBuilderの起動

インストール後、Eclipseを初めて起動すると、以下のようなWelcomeページが表示されます。

このWelcomeページを左上の「X」により閉じると以下のページが表示されます。

右上の「Open Perspective」ボタンを押下し、プルダウンの「その他（O）…」ボタンを押下します。

「RTC Builder」を選択することで、RTCBuilderが起動します。

RTCBuilder 用プロジェクトの作成

まず最初に、RT コンポーネントを作成するための Eclipse プロジェクトを作成します。 画面上部のメニューから[ファイル]－[新規]－[プロジェクト]を選択します。

表示された｢新規プロジェクト｣画面において、｢その他｣－｢ RTC ビルダ｣を選択し、｢次へ｣をクリックします。

｢プロジェクト名｣欄に作成するプロジェクト名を入力して｢終了｣をクリックします。

指定した名称のプロジェクトが生成され、パッケージエクスプローラ内に追加されます。

生成したプロジェクト内には、デフォルト値が設定された RTC プロファイル XML(RTC.xml) が自動的に生成されます。

RTC プロファイルエディタの起動

RTC プロファイルエディタを開くには、ツールバーの｢ Open New RtcBuilder Editor ｣ボタンを押下するか、メニューバーの [ファイル]-[Open New Builder Editor] を選択します。

RTCBuilder では、以下のような画面構成となっています。

• 基本プロファイル入力ページ
• アクティビティ・プロファイル入力ページ
• データポート・プロファイル入力ページ
• サービスポート・プロファイル入力ページ
• コンフィギュレーション・プロファイル入力ページ
• ドキュメント情報設定ページ
• 言語・環境情報入力ページ
• RTC プロファイル XML 編集ページ
• 制約情報の記述方式

ここでは、 RT プロファイルエディタについて説明します。

　RTプロファイルエディタは、以下のページから構成されています。

各ページの切り替えは、エディタ画面下部のタブを選択することで行うことができます。

基本プロファイル入力ページ

RT コンポーネントのプロファイル情報など、コンポーネントの基本情報を入力するページです。

以下に各入力項目について説明いたします。

アクティビティ・プロファイル入力ページ

生成対象のRTコンポーネントがサポートしているアクティビティに関する情報を入力するページです。

Documentationセクションの内容は、アクティビティ毎に設定します。Documentationセクションには、選択中のアクティビティに対応した内容が表示されます。
以下に各入力項目について説明いたします。

データポート・プロファイル入力ページ

RT コンポーネントに付属するデータポートの情報を入力するページです。

　各ポート (InPort/OutPort) を新規に追加する場合は、各セクションの｢ Add ｣ボタンを押してください。 　また、各セクションの「 Delete 」ボタンを押すと、選択中のポートを削除することができます。 　ドキュメントセクションの内容はポート毎に設定することが可能です。ドキュメントセクションには、選択中のポートに対応した内容が表示されます。 　以下に各入力項目について説明いたします。

サービスポート・プロファイル入力ページ

RT コンポーネントに付属するサービスポートの情報を入力するページです。

　新規サービスポートは、画面左側「 RT-Component Service Ports 」欄の｢ Add Port ｣を選択することで追加することができます。 画面左側「 RT-Component Service Ports 」にてサービスポートを選択した状態で、｢Add Interface ｣を選択することで新規サービスインターフェースを追加することができます。 画面左側「 RT-Component Service Ports 」にて、サービスポートもしくはサービスインターフェースを選択した状態で「 Delete 」を選択することで、選択したポート／インターフェースを削除することができます。 以下に各入力項目について説明いたします。

コンフィギュレーション・プロファイル入力ページ

RT コンポーネントに設定するユーザ定義のコンフィギュレーション・パラメータ情報およびその他システムのコンフィギュレーション情報を入力するページです。

ユーザ定義コンフィギュレーション・パラメータ情報およびシステム・コンフィギュレーション情報を新規に追加する場合は、各セクションの｢Add｣ボタンを押してください。また、各セクションの「Delete」ボタンを押すと、選択中のコンフィギュレーション情報を削除することができます。
DetailセクションおよびDocumentationセクションの内容は、ユーザ定義コンフィギュレーション・パラメータ毎に設定することが可能です。各セクションには、選択中のユーザ定義コンフィギュレーション・パラメータに設定した内容が表示されます。
以下に各入力項目について説明いたします。

ドキュメント情報設定ページ

生成対象のRTコンポーネントに関する各種ドキュメント情報を入力します。

このページで入力された情報は、生成されたコードにdoxygen形式で埋め込まれます。
以下に各入力項目について説明いたします。

言語・環境情報入力ページ

入力した RT コンポーネント仕様に基づき生成するテンプレート・ソースコードの言語選択や、OS 等の実行環境、依存ライブラリなどを入力するページです。

　生成対象の言語ごとにセクションが分かれています。生成したい言語のセクションを選択し、各言語固有の設定情報を入力してください。 あるセクションを選択した場合には、他のセクションは全て閉じるようになっています。 コード生成実行時（基本プロファイル入力ページの｢ コード生成 ｣ボタン押下時）に選択されていたセクションの言語用テンプレートコードが生成されます。 以下に各入力項目について説明いたします。

RTC プロファイル XML 編集ページ

入力した RT コンポーネント仕様を記した XML ファイル (RTC.xml) の内容確認、編集を行うページです。他のページで設定した内容を確認したり、GUI 画面からは入力できない項目を直接編集するために使用します。

表示されるRTコンポーネント仕様の内容は、このページに切り替えた時に他ページで設定されている内容を基に作成されます。
画面右上の｢Update｣ボタンをクリックすると、このページで設定、変更した内容を他のページに反映させることができます (他のページへ反映させるのみで、ファイルへの書き込みは行いません) 。また、以下のような画面が表示され、変更点を確認することができます。修正内容を他ページへ反映する場合には｢OK｣をクリックしてください。

　このページで直接入力した内容は、このページを表示している状態で保存した場合のみ保存されます。このページにて内容編集後、他ページを開いた状態で保存すると、他のページにて入力した項目が優先されます。 このページの内容を保存する場合には、RTC.xml のスキーマ定義に従ったバリデーションが行われます。バリデーション時にエラーが発見された場合は、以下のようなエラーメッセージが表示されますので、表示内容を参考に該当箇所を修正してください。

制約情報の記述方式

データポートおよびユーザ定義コンフィギュレーション・パラメータへの制約条件は以下の書式で設定します。

• ビルドビューの表示

ビルドビューは作成中の RT コンポーネントの設定内容をグラフィカルに表示するためのビューです。 ビルドビューの表示例を以下に示します。

　ビルドビュー内には、設定したRTコンポーネントの名称、データポート (InPort/OutPort) の数・名称、サービスポートの数・名称、サービスインターフェースの数・名称が表示されます。 また各ポートは、各設定画面で設定した表示位置に表示されます。

ビルドビューの表示

｢ RTCBuilder ｣パースペクティブ切り替え時にビルドビューが表示されていない場合、以下の手順にて表示することができます。 画面上部のメニューから[ウィンドウ]－[ビューの表示]－[その他]を選択。表示された｢ビューの表示｣画面にて、｢OpenRTP Tools｣－｢BuildView｣を選択。

• リポジトリビューの表示
• ローカル版の概要
• ファイルのロード
• ディレクトリのロード
• 削除

　リポジトリビューは、RT コンポーネント仕様記述ファイルを読み込み、ツリービューで表示する機能をもっています。 またリポジトリビューには、大きく分けて、ローカルに存在する仕様記述ファイルを直接読み込む機能と、リモートに存在する RT リポジトリに接続し、リポジトリ内の情報をツリー表示する機能があります。

リポジトリビューの表示

メニューの「ウィンドウ(W)」から「ビューの表示(V)」を選択し、「その他(O)」を押下します。

「RepositoryView」を選択することで、リポジトリビューが起動します。

ローカル版の概要

ローカルに存在する RT コンポーネント仕様記述ファイルを読み込み、ツリービューで表示する機能です。

ファイルのロード

　ここでは、リポジトリビューに RT コンポーネント仕様記述ファイルを指定して表示する方法の説明を行います。 リポジトリビュー内で右クリックし、表示されるコンテクストメニューから「 ファイルから読込 」を選択すると、ファイル選択ダイアログが表示されます。ここでリポジトリビューに読み込む RT コンポーネント仕様記述ファイルを選択します。 このダイアログは xml ファイルのみ表示するようフィルタがかかります。

　ローカルに存在する RT コンポーネント仕様記述ファイルを読み込んだ場合、最上位階層は読み込んだ RT コンポーネント仕様記述ファイルの絶対パスを表示します。そして、２階層目は RT コンポーネント仕様記述ファイル内で定義されている category 属性の値を表示します。また３階層目は RT コンポーネント仕様記述ファイル内の name 属性に記述されている値と RT コンポーネント仕様記述ファイル名を表示します。

ディレクトリのロード

　ここでは、 RT コンポーネント仕様記述ファイルが存在するディレクトリを指定して、ディレクトリ内の全ファイルの読み込み、表示を行う方法を説明します。 リポジトリビュー上で右クリックし、表示されるコンテクストメニューから「 ディレクトリから読込 」を選択すると、ディレクトリ選択ダイアログが表示されます。リポジトリビューに読み込むディレクトリを選択します。ディレクトリ以下に存在する RT コンポーネント仕様記述ファイルを読み込みます。

　表示方法はファイルのロードと同様です。 すでに展開したディレクトリに新しい RT コンポーネント仕様記述ファイルを追加し、再度読み込みを行うと追加された RT コンポーネント仕様記述ファイルのみ読み込まれます。

削除

　リポジトリビューのコンポーネントは、リポジトリビュー上で右クリックし、コンテクストメニューから「 削除 」を選択すると、削除することが可能です。 「 削除 」はパス、 category 、コンポーネントのいずれかを選択している場合のみ選択できます。

　最上位階層であるパスを削除すると、下位の category 、コンポーネントも同時に削除されます。また３階層目のコンポーネントを削除し、他のコンポーネントが存在しない場合は再帰的に最上位階層まで削除されます。

• コード生成
  • 出力選択
  • パースペクティブ切り替え
• 生成ファイルのパッケージング機能
• 設定内容のセーブとロード
  • セーブ
  • ロード

コード生成

生成対象RTコンポーネントの各種プロファイル情報を設定した後、テンプレートコードの生成を行います。 基本プロファイル入力ページの｢ コード生成 ｣ボタンをクリックすると、入力したプロファイル情報に応じたテンプレートコードの生成が行われます。

各言語を選択した際のコード生成実行時に生成されるテンプレートファイルは以下のとおりです。

• 言語共通

• C++

• Java

• Python

• C#

　※ RtcBuilder は、このサービスプロバイダの実装ファイルを出力する際、オペレーションのテンプレートを生成するために、IDL をパースします。しかし、このパース機能には以下のような制限が存在します。

• プリプロセッサにおいて、#include ディレクティブのみ使用可能。（#ifdef などは単に無視される）
• 生成されるオペレーションは直接指定されたインタフェースのオペレーションのみで、親から継承したオペレーションは含まれない。

出力選択

RtcBuilder は、生成したファイルと同名のファイルが出力先に既に存在し、既存ファイルと生成ファイルの間で出力内容に差異が存在する場合、どちらの出力を利用するかを選択する確認画面が表示されます。

出力の選択では、以下の3つ出力候補の中から選択します。

• Original　　： 既に存在するファイルをそのまま残す
• Merge　　　： マージブロックを利用したマージを行う（※１）
• Generate　： 新たに生成した内容で上書きする

　※１ Mergeでは、<rtc-template block=”block”>タグで囲まれた範囲のみを最新の生成内容で上書します。生成したテンプレートは、ユーザが変更しない範囲をあらかじめこのタグで囲んでいます。このタグの中は変更後もマージすることで消えてしまいますので、修正しないようにしてください。

パースペクティブ切り替え

　生成対象言語の開発環境用プラグインがインストールされている場合、コード生成実行後にパースペクティブ切り替えの確認メッセージが表示されます。 対象のプラグインがインストールされている場合には以下のようなメッセージが表示されますので、パースペクティブの切り替えを行うかどうかを選択してください。

生成言語と開発環境用プラグインの関係は以下のとおりです。

• Java ： JDT(Java Development Tools) → あらかじめEclipseに含まれている開発環境です。
• C++ ： CDT(C/C++ Development Tooling)
• Python ：　PyDev

　※各言語用の開発環境用プラグインがインストールされており、出力対象プロジェクトが新規作成プロジェクトの場合は、各プロジェクトのプロパティに対象言語の属性が設定されます。

生成ファイルのパッケージング機能

生成したテンプレートファイル、テンプレートファイルを基に作成した RT コンポーネントの実行用バイナリファイルなどを各種形式でアーカイブする機能です。 基本プロファイル入力ページの｢ パッケージ化 ｣ボタンをクリックすると、パッケージング内容を設定するための「RTコンポーネント　パッケージ化」画面が表示されます。

以下、各項目について説明いたします。

※アーカイブ方式(｢ソース｣｢バイナリ｣｢ソース＋バイナリ｣)ごとに、どのファイル種類をアーカイブに含めるかは、後述の｢設定画面｣にて設定することができます。

設定内容のセーブとロード

RTCBuilder では、RTC プロファイルエディタで入力した内容を RTC プロファイル XML(RTC.xml) に保存したり、保存した内容を再度読み込むことが可能です。

セーブ

　RTC プロファイルエディタで入力した内容は、RTC プロファイル XML(RTC.xml) に保存することが可能です。入力内容は以下の操作により保存することができます。

• エディタを右クリックし、表示されたコンテクストメニューから「Save」もしくは｢Save As…｣を選択
• メニューバーの[File]－[Save…]もしくは[File]－[Save As…]を選択

　※[Save As…]を選んだ場合、任意のプロジェクト内に保存することが可能です。

ロード

RTC プロファイルエディタの内容を保存した RTC プロファイル XML(RTC.xml) は以下の操作により読み込むことが可能です。

• エディタを右クリックし、コンテクストメニューから「Open」を選択
• メニューバーの[File]－[Open File…]を選択
  

RTC プロファイルエディタで入力，設定した内容をXML形式、 YAML 形式で外部ファイルにエクスポート、エクスポートしたファイルをインポートする機能です。 基本プロファイル入力ページの｢ エクスポート ｣ボタンをクリックすると、プロファイル情報をエクスポートする先を選択するファイルダイアログが、｢ インポート ｣ボタンをクリックすると、インポート元のプロファイル情報を選択するファイルダイアログがそれぞれ表示されます。

　　※エクスポート処理時の形式は、｢ファイル　エクスポート先選択｣ダイアログの｢ファイルの種類｣によって選択することが可能です。

• データ型
• コード生成
• Port
• Configuration
• Export
• Build View
• Document

ここでは RTCBuilder の各種設定について説明します。 RTCBuilder の設定画面は、画面上部メニューの[ウィンドウ]－[設定....]を選択して表示される「設定」画面から｢ RTCBuilder ｣を選択すると表示されます。

データ型

Data PortおよびConfigurationパラメータで設定するデータ型を定義したIDLファイルの位置を設定することができます。 IDL格納ディレクトリを新規に追加する場合は、｢Add｣ボタンをクリックしてください。また、「Delete」ボタンをクリックすると、選択中のIDL格納ディレクトリを削除することができます。 IDL格納ディレクトリの実際の位置は、｢IDL File Directories｣欄内をクリックして表示されるディレクトリ選択画面にて選択してください。

コード生成

RTC プロファイルエディタの基本プロファイル入力ページおよびコンフィギュレーション・プロファイル入力ページにて新規エディタ表示時、新規項目追加時にデフォルトで設定される内容を設定することができます。

なお、この設定画面中のデフォルト設定(｢デフォルトの復元｣ボタンをクリックした際に設定される内容)は以下のとおりです。

Port

RTC プロファイルエディタのデータポート・プロファイル入力ページおよびサービスポート・プロファイル入力ページにて新規項目を追加した際にデフォルトで設定される内容を設定することができます。

なお、この設定画面中のデフォルト設定(｢デフォルトの復元｣ボタンをクリックした際に設定される内容)は以下のとおりです。

Configuration

RTC プロファイルエディタのコンフィギュレーション・プロファイル入力ページのシステム・コンフィギュレーション情報に表示される項目を設定することができます。

なお、この設定画面中のデフォルト設定(｢デフォルトの復元｣ボタンをクリックした際に設定される内容)は以下のとおりです。

Export

RT コンポーネントのパッケージング機能の各アーカイブ形式に含めるファイルを設定することができます。

設定画面はアーカイブ形式ごとのセクション（Source Export，Binary Export，Source+Binary Export）に分かれています。また、各セクションは拡張子指定部と、ファイル名指定部から構成されています。

拡張子指定部では、各アーカイブ形式に含めるファイルの拡張子を設定することができます。｢タイプの選択｣ボタンをクリックすると、以下のようなタイプ選択画面が表示されますので、アーカイブに含めたいファイルタイプを選択してください。

ファイル設定部ではアーカイブに含めるファイル名を設定することができます。「ファイル名」リスト下部の「 Add 」ボタンをクリックすると新しい行が追加されますので、アーカイブに含めたいファイル名を直接入力してください。また、｢ Delete ｣ボタンをクリックすると、選択している行を削除することができます。 上図の Export設定画面(セクション)の例では、アーカイブ方式として｢ Source+Binary ｣を選択した際に、拡張子が｢ cpp ｣｢ h｣ であるファイルと、ファイル名が｢ Makefile ｣｢ README ｣であるファイルをアーカイブに含める設定となります。 なお、この設定画面中のデフォルト設定(｢デフォルトの復元｣ボタンをクリックした際に設定される内容)は以下のとおりです。

Build View

Build View 内に表示されるアイコンの色情報を設定することができます。

それぞれの色設定ボタンにより、コンポーネント本体、DataInPort、DataOutPort、ServicePort、ServiceInterface の色設定を変更することが可能です。

Document

各アクティビティの有効無効属性（ON/OFF）を設定することができます。

• その他
  • FAQ
  • 謝辞

その他

FAQ

RTC プロファイルエディタで入力した内容を RTC プロファイルへ保存するときに、「 Error writing file. 」というエラーが発生します。

A. 保存先の指定が不正な場合に表示されます。保存先を任意のプロジェクト内のディレクトリにして保存してください。

謝辞

RTCBuilderは、以下のライブラリあるいは製品を使用して開発されました。これらのプロジェクトの開発と設計にかかわった方々に感謝します。

• Apache Velocity 1.5 ~Copyright (C) 2000-2007 The Apache Software Foundation This product includes software developed by The Apache Software Foundation ( http://www.apache.org/ ).
• Apache Jakarta Commons CLI 1.1 ~Copyright 2001-2007 The Apache Software Foundation This product includes software developed by The Apache Software Foundation ( http://www.apache.org/ ).
• JYaml 1.3 ~Copyright (c) 2005, Yu Cheung Ho All rights reserved.
• Java CC (生成されたソースコードを利用しています) https://javacc.dev.java.net/