[openrtm-commit:00713] r264 - in trunk/rtmtools/jp.go.aist.rtm.rtcbuilder/src/jp/go/aist/rtm/rtcbuilder/template: . cmake/doc
openrtm ＠ openrtm.org
openrtm ＠ openrtm.org
2012年 2月 14日 (火) 19:11:43 JST
Author: sakamoto
Date: 2012-02-14 19:11:43 +0900 (Tue, 14 Feb 2012)
New Revision: 264
Modified:
trunk/rtmtools/jp.go.aist.rtm.rtcbuilder/src/jp/go/aist/rtm/rtcbuilder/template/TemplateHelper.java
trunk/rtmtools/jp.go.aist.rtm.rtcbuilder/src/jp/go/aist/rtm/rtcbuilder/template/cmake/doc/index.txt.vsl
trunk/rtmtools/jp.go.aist.rtm.rtcbuilder/src/jp/go/aist/rtm/rtcbuilder/template/cmake/doc/index_j.txt.vsl
Log:
Modified contents file
Modified: trunk/rtmtools/jp.go.aist.rtm.rtcbuilder/src/jp/go/aist/rtm/rtcbuilder/template/TemplateHelper.java
===================================================================
--- trunk/rtmtools/jp.go.aist.rtm.rtcbuilder/src/jp/go/aist/rtm/rtcbuilder/template/TemplateHelper.java 2012-02-13 04:24:12 UTC (rev 263)
+++ trunk/rtmtools/jp.go.aist.rtm.rtcbuilder/src/jp/go/aist/rtm/rtcbuilder/template/TemplateHelper.java 2012-02-14 10:11:43 UTC (rev 264)
@@ -263,6 +263,17 @@
String[] vers = ver.split("\\.");
return (vers.length > 2) ? vers[2] : "0";
}
+
+ public static String convFormatted(String source, int len) {
+ int clen = source.length();
+ StringBuilder builder = new StringBuilder();
+ builder.append(source);
+ for(int index=0;index<(len-clen);index++) {
+ builder.append(" ");
+ }
+ return builder.toString();
+ }
+
//ConfigParameterのチェック
public boolean checkPeriodicType(RtcParam param) {
for( ConfigParameterParam target : param.getConfigParameterParams() ) {
Modified: trunk/rtmtools/jp.go.aist.rtm.rtcbuilder/src/jp/go/aist/rtm/rtcbuilder/template/cmake/doc/index.txt.vsl
===================================================================
--- trunk/rtmtools/jp.go.aist.rtm.rtcbuilder/src/jp/go/aist/rtm/rtcbuilder/template/cmake/doc/index.txt.vsl 2012-02-13 04:24:12 UTC (rev 263)
+++ trunk/rtmtools/jp.go.aist.rtm.rtcbuilder/src/jp/go/aist/rtm/rtcbuilder/template/cmake/doc/index.txt.vsl 2012-02-14 10:11:43 UTC (rev 264)
@@ -43,7 +43,7 @@
to take effect before using the component.
The component can be launched by double-clicking the
-``${rtcParam.name}_standalone`` executable. The ``${rtcParam.name}`` library
+``${rtcParam.name}Comp`` executable. The ``${rtcParam.name}`` library
is available for loading into a manager, using the initialisation function
``rtc_init``.
@@ -92,10 +92,10 @@
configuring the component.
${rtcParam.name} can be launched in stand-alone mode by executing the
-``${rtcParam.name}_standalone`` executable (installed into ``${dol}{prefix}/bin``).
+``${rtcParam.name}Comp`` executable (installed into ``${dol}{prefix}/components/bin``).
Alternatively, ``lib${rtcParam.name}.so`` can be loaded into a manager, using the
initialisation function ``rtc_init``. This shared object can be found in
-``${dol}{prefix}/lib`` or ``${dol}{prefix}/lib64``.
+``${dol}{prefix}/components/lib`` or ``${dol}{prefix}/components/lib64``.
Configuration
@@ -103,26 +103,44 @@
The available configuration parameters are described below:
-================ ======
-Parameter Effect
-================ ======
-================ ======
+================ ================== ================ ======
+Parameter Data type Default Value Effect
+================ ================== ================ ======
+#if( ${rtcParam.configParams.size()} > 0 )
+#foreach($configParam in ${rtcParam.configParams})
+${tmpltHelper.convFormatted(${configParam.name},16)} ${tmpltHelper.convFormatted(${configParam.type},18)} ${tmpltHelper.convFormatted(${configParam.defaultVal},16)} ${configParam.docDescription}
+#end#end
+================ ================== ================ ======
Ports
=====
The ports provided by the component are described below:
-=========== ======= ================== =======
-Name Type Data type Purpose
-=========== ======= ================== =======
-=========== ======= ================== =======
+=============== =========== ============================== =======
+Name Type Data type Purpose
+=============== =========== ============================== =======
+#if( ${rtcParam.inports.size()} > 0 )
+#foreach($port in ${rtcParam.inports})
+${tmpltHelper.convFormatted(${port.name},15)} InPort ${tmpltHelper.convFormatted(${port.type},30)} ${port.docDescription}
+#end#end
+#if( ${rtcParam.outports.size()} > 0 )
+#foreach($port in ${rtcParam.outports})
+${tmpltHelper.convFormatted(${port.name},15)} OutPort ${tmpltHelper.convFormatted(${port.type},30)} ${port.docDescription}
+#end#end
+#if(${rtcParam.servicePorts.size()}>0)
+#foreach($servicePort in ${rtcParam.servicePorts})
+#if(${servicePort.servicePortInterfaces.size()}>0)
+#foreach($serviceInterface in ${servicePort.servicePortInterfaces})
+${tmpltHelper.convFormatted(${serviceInterface.name},15)} ServicePort ${tmpltHelper.convFormatted(${serviceInterface.interfaceType},30)} ${serviceInterface.docDescription}
+#end#end#end#end
+=============== =========== ============================== =======
Examples
========
An example configuration file is provided in the
-``${dol}{prefix}/share/${rtcParam.name}/examples/conf/`` directory.
+``${dol}{prefix}/components/share/${rtcParam.name}/examples/conf/`` directory.
Changelog
=========
Modified: trunk/rtmtools/jp.go.aist.rtm.rtcbuilder/src/jp/go/aist/rtm/rtcbuilder/template/cmake/doc/index_j.txt.vsl
===================================================================
--- trunk/rtmtools/jp.go.aist.rtm.rtcbuilder/src/jp/go/aist/rtm/rtcbuilder/template/cmake/doc/index_j.txt.vsl 2012-02-13 04:24:12 UTC (rev 263)
+++ trunk/rtmtools/jp.go.aist.rtm.rtcbuilder/src/jp/go/aist/rtm/rtcbuilder/template/cmake/doc/index_j.txt.vsl 2012-02-14 10:11:43 UTC (rev 264)
@@ -36,7 +36,7 @@
- 環境変数の変更を適用するため、コンポーネントを使用する前にコンピューターを
再起動する必要があるかもしれません。
-${rtcParam.name}は ``${rtcParam.name}_standalone`` の実行をダブルクリックして実行することが
+${rtcParam.name}は ``${rtcParam.name}Comp`` の実行をダブルクリックして実行することが
できます。あるいは、 ``${rtcParam.name}`` を初期化関数の ``rtc_init`` を利用して、
マネージャにロードすることができます。
@@ -82,11 +82,11 @@
ここまでで、コンポーネントが使えるようになりました。コンフィグレーションは次のセクションを
参照してください。
-${rtcParam.name}は ``${rtcParam.name}_standalone`` を実行（ ``${dol}{prefix}/bin`` に
+${rtcParam.name}は ``${rtcParam.name}Comp`` を実行（ ``${dol}{prefix}/components/bin`` に
インストールされます）することでスタンドアローンモードで実行することができます。
あるいは、 ``lib${rtcParam.name}.so`` を初期化関数の ``rtc_init`` を利用して、
-マネージャにロードすることができます。このライブラリは ``${dol}{prefix}/lib``
-または ``${dol}{prefix}/lib64`` にインストールされます。
+マネージャにロードすることができます。このライブラリは ``${dol}{prefix}/components/lib``
+または ``${dol}{prefix}/components/lib64`` にインストールされます。
コンフィグレーション
@@ -95,25 +95,43 @@
使えるコンフィグレーションパラメータは以下のテーブルを参照
してください。
-================ ====
-パラメータ 意味
-================ ====
-================ ====
+================ ================== ================ ====
+パラメータ データ型 デフォルト値 意味
+================ ================== ================ ====
+#if( ${rtcParam.configParams.size()} > 0 )
+#foreach($configParam in ${rtcParam.configParams})
+${tmpltHelper.convFormatted(${configParam.name},16)} ${tmpltHelper.convFormatted(${configParam.type},18)} ${tmpltHelper.convFormatted(${configParam.defaultVal},16)} ${configParam.docDescription}
+#end#end
+================ ================== ================ ====
ポート
======
コンポーネントによって提供されるポートは以下のテーブルで述べられています。
-=========== ======== ================== ====
-ポート名 ポート型 データ型 意味
-=========== ======== ================== ====
-=========== ======== ================== ====
+=============== =========== ============================== ====
+ポート名 ポート型 データ型 意味
+=============== =========== ============================== ====
+#if( ${rtcParam.inports.size()} > 0 )
+#foreach($port in ${rtcParam.inports})
+${tmpltHelper.convFormatted(${port.name},15)} InPort ${tmpltHelper.convFormatted(${port.type},30)} ${port.docDescription}
+#end#end
+#if( ${rtcParam.outports.size()} > 0 )
+#foreach($port in ${rtcParam.outports})
+${tmpltHelper.convFormatted(${port.name},15)} OutPort ${tmpltHelper.convFormatted(${port.type},30)} ${port.docDescription}
+#end#end
+#if(${rtcParam.servicePorts.size()}>0)
+#foreach($servicePort in ${rtcParam.servicePorts})
+#if(${servicePort.servicePortInterfaces.size()}>0)
+#foreach($serviceInterface in ${servicePort.servicePortInterfaces})
+${tmpltHelper.convFormatted(${serviceInterface.name},15)} ServicePort ${tmpltHelper.convFormatted(${serviceInterface.interfaceType},30)} ${serviceInterface.docDescription}
+#end#end#end#end
+=============== =========== ============================== ====
例
==
-例のrtc.confファイルは ``${dol}{prefix}/share/${rtcParam.name}/examples/conf/``
+例のrtc.confファイルは ``${dol}{prefix}/components/share/${rtcParam.name}/examples/conf/``
フォルダにインストールされています。
Changelog
openrtm-commit メーリングリストの案内