[openrtm-commit:00537] r2257 - trunk/OpenRTM-aist/etc

[openrtm ＠ openrtm.org]

Author: n-ando
Date: 2012-01-04 15:33:07 +0900 (Wed, 04 Jan 2012)
New Revision: 2257

Modified:
   trunk/OpenRTM-aist/etc/component.conf
   trunk/OpenRTM-aist/etc/rtc.conf.sample
Log:
Example configuration files have been updated.

Modified: trunk/OpenRTM-aist/etc/component.conf
===================================================================
--- trunk/OpenRTM-aist/etc/component.conf	2012-01-04 04:22:24 UTC (rev 2256)
+++ trunk/OpenRTM-aist/etc/component.conf	2012-01-04 06:33:07 UTC (rev 2257)
@@ -15,9 +15,32 @@
 
 #============================================================
 # execution context options
+#============================================================
 #
+# Periodic type ExecutionContext
+#
+# Other availabilities in OpenRTM-aist
+#
+# - ExtTrigExecutionContext: External triggered EC. It is embedded in
+#                            OpenRTM library.
+# - OpenHRPExecutionContext: External triggred paralell execution
+#                            EC. It is embedded in OpenRTM
+#                            library. This is usually used with
+#                            OpenHRP3.
+# - RTPreemptEC:             Real-time execution context for Linux
+#                            RT-preemptive pathed kernel.
+# - ArtExecutionContext:     Real-time execution context for ARTLinux
+#                            (http://sourceforge.net/projects/art-linux/)
 # exec_cxt.periodic.type: [specify periodic type EC]
+
+#
+# The execution cycle of ExecutionContext
+#
 # exec_cxt.periodic.rate: [Hz]
+
+#
+# Event driven execution context (not implemented yet)
+#
 # exec_cxt.event_driven.type: [specify event driven type EC]
 #
 
@@ -72,10 +95,10 @@
 # configuration parameters
 #
 # conf.[configuration_set_name].[parameter_name]:
-# conf.constraint.[parameter_name]:
+# conf.__widget__.[parameter_name]: GUI control type for RTSystemEditor
+# conf.__constraint__.[parameter_name]: Constraints for the value
 #
 #
-#
 
 #------------------------------------------------------------
 # configuration sets
@@ -83,12 +106,49 @@
 # conf.[configuration_set_name].[parameter_name]:
 
 #------------------------------------------------------------
-# constraint condition of configuration parameter 
+# GUI control option for RTSystemEditor
+#------------------------------------------------------------
 #
-# substitute variable name: "x"
+# Available GUI control options [__widget__]:
 #
-# available constraint formats
+# conf.__widget__.[widget_name]:
 #
+# available wdget name:
+# - text:          text box [default].
+# - slider.<step>: Horizontal slider. <step> is step for the slider.
+#                  A range constraints option is required. 
+# - spin:          Spin button. A range constraitns option is required.
+# - radio:         Radio button. An enumeration constraints is required.
+# - checkbox:      Checkbox control. An enumeration constraints is
+#                  required. The parameter has to be able to accept a
+#                  comma separated list.
+# - orderd_list:   Orderd list control.  An enumeration constraint is
+#                  required. The parameter has to be able to accept a
+#                  comma separated list. In this control, Enumerated
+#                  elements can appear one or more times in the given list.
+# examples:
+# conf.__widget__.int_param0: slider.10
+# conf.__widget__.int_param1: spin
+# conf.__widget__.double_param0: slider.10
+# conf.__widget__.double_param1: text
+# conf.__widget__.str_param0: radio
+# conf.__widget__.vector_param0: checkbox
+# conf.__widget__.vector_param1: orderd_list
+
+#
+# Available GUI control constraint options [__constraints__]:
+#
+# conf.__constraints__.[parameter_name]:
+#
+# available constraints:
+# - none:         blank
+# - direct value: 100 (constant value)
+# - range:        <, >, <=, >= can be used.
+# - enumeration:  (enum0, enum1, ...)
+# - array:        <constraints0>, ,constraints1>, ... for only array value
+# - hash:         {key0: value0, key1:, value0, ...}
+#
+# available constraint formats (substitute variable name: "x"):
 # - No constraint              : (blank)
 # - Direct                     : 100 (read only)
 # - 100 or over                : x >= 100
@@ -101,4 +161,12 @@
 # - Array                      : x < 1, x < 10, x > 100
 # - Hash                       : {key0: 100<x<200, key1: x>=100}
 #
-# conf.constraint.[parameter_name]:
+# examples:
+# conf.__constraints__.int_param0: 0<=x<=150
+# conf.__constraints__.int_param1: 0<=x<=1000
+# conf.__constraints__.double_param0: 0<=x<=100
+# conf.__constraints__.double_param1:
+# conf.__constraints__.str_param0: (default,mode0,mode1)
+# conf.__constraints__.vector_param0: (dog,monky,pheasant,cat)
+# conf.__constraints__.vector_param1: (pita,gora,switch)
+

Modified: trunk/OpenRTM-aist/etc/rtc.conf.sample
===================================================================
--- trunk/OpenRTM-aist/etc/rtc.conf.sample	2012-01-04 04:22:24 UTC (rev 2256)
+++ trunk/OpenRTM-aist/etc/rtc.conf.sample	2012-01-04 06:33:07 UTC (rev 2257)
@@ -369,6 +369,19 @@
 #
 # Periodic type ExecutionContext
 #
+# Other availabilities in OpenRTM-aist
+#
+# - ExtTrigExecutionContext: External triggered EC. It is embedded in
+#                            OpenRTM library.
+# - OpenHRPExecutionContext: External triggred paralell execution
+#                            EC. It is embedded in OpenRTM
+#                            library. This is usually used with
+#                            OpenHRP3.
+# - RTPreemptEC:             Real-time execution context for Linux
+#                            RT-preemptive pathed kernel.
+# - ArtExecutionContext:     Real-time execution context for ARTLinux
+#                            (http://sourceforge.net/projects/art-linux/)
+#
 exec_cxt.periodic.type: PeriodicExecutionContext
 
 #