init

2021-10-14 13:47:35 +02:00
commit 6625a8dfaa
4026 changed files with 844291 additions and 0 deletions
@@ -0,0 +1,67 @@
+/**
+ * \page BoxAlgorithm_ModifiableSettings Modifiable Settings
+__________________________________________________________________
+
+Detailed description
+__________________________________________________________________
+
+ * |OVP_DocBegin_BoxAlgorithm_ModifiableSettings_Description|
+This box purpose is to test and demonstrate the modifiable settings feature. 
+It has a setting of each type and all are modifiable during scenario playback.
+Values are displayed in log (LogLevel_Info) every 5 seconds.
+ * |OVP_DocEnd_BoxAlgorithm_ModifiableSettings_Description|
+__________________________________________________________________
+
+Settings description
+__________________________________________________________________
+
+ * |OVP_DocBegin_BoxAlgorithm_ModifiableSettings_Settings|
+ * |OVP_DocEnd_BoxAlgorithm_ModifiableSettings_Settings|
+
+ * |OVP_DocBegin_BoxAlgorithm_ModifiableSettings_Setting1|
+An integer.
+ * |OVP_DocEnd_BoxAlgorithm_ModifiableSettings_Setting1|
+ 
+ * |OVP_DocBegin_BoxAlgorithm_ModifiableSettings_Setting2|
+A float.
+ * |OVP_DocEnd_BoxAlgorithm_ModifiableSettings_Setting2|
+
+ * |OVP_DocBegin_BoxAlgorithm_ModifiableSettings_Setting3|
+A boolean.
+ * |OVP_DocEnd_BoxAlgorithm_ModifiableSettings_Setting3|
+ 
+ * |OVP_DocBegin_BoxAlgorithm_ModifiableSettings_Setting4|
+A string.
+ * |OVP_DocEnd_BoxAlgorithm_ModifiableSettings_Setting4|
+
+ * |OVP_DocBegin_BoxAlgorithm_ModifiableSettings_Setting5|
+A filename.
+ * |OVP_DocEnd_BoxAlgorithm_ModifiableSettings_Setting5|
+
+ * |OVP_DocBegin_BoxAlgorithm_ModifiableSettings_Setting6|
+A script.
+ * |OVP_DocEnd_BoxAlgorithm_ModifiableSettings_Setting6|
+
+ * |OVP_DocBegin_BoxAlgorithm_ModifiableSettings_Setting7|
+A color.
+ * |OVP_DocEnd_BoxAlgorithm_ModifiableSettings_Setting7|
+
+ * |OVP_DocBegin_BoxAlgorithm_ModifiableSettings_Setting8|
+A color gradient.
+ * |OVP_DocEnd_BoxAlgorithm_ModifiableSettings_Setting8|
+__________________________________________________________________
+
+Examples description
+__________________________________________________________________
+
+ * |OVP_DocBegin_BoxAlgorithm_ModifiableSettings_Examples|
+ * |OVP_DocEnd_BoxAlgorithm_ModifiableSettings_Examples|
+
+__________________________________________________________________
+
+Miscellaneous description
+__________________________________________________________________
+
+ * |OVP_DocBegin_BoxAlgorithm_ModifiableSettings_Miscellaneous|
+ * |OVP_DocEnd_BoxAlgorithm_ModifiableSettings_Miscellaneous|
+ */
@@ -0,0 +1,135 @@
+.. _Doc_BoxAlgorithm_ModifiableSettingsExample:
+
+Modifiable Settings example
+===========================
+
+
+.. todo::  Write general box description...
+
+
+.. _Doc_BoxAlgorithm_ModifiableSettingsExample_Settings:
+
+Settings
+--------
+
+.. todo::  Write settings general description...
+
+.. csv-table::
+   :header: "Setting Name", "Type", "Default Value"
+
+   "Int", "Integer", "1"
+   "Float", "Float", "1.3"
+   "Bool", "Boolean", "false"
+   "String", "String", "string"
+   "filename", "Filename", "somefile.txt"
+   "script", "Script", "somescript.lua"
+   "color", "", "20,65,90"
+   "colorgradient", "", "0:0,0,0; 100:60,40,40"
+   "unit", "Measurement unit", "V"
+   "factor", "Factor", "1e-01"
+
+.. _Doc_BoxAlgorithm_ModifiableSettingsExample_Setting_1:
+
+Int
+~~~
+
+.. todo:: Write setting description... 
+
+
+
+.. _Doc_BoxAlgorithm_ModifiableSettingsExample_Setting_2:
+
+Float
+~~~~~
+
+.. todo:: Write setting description... 
+
+
+
+.. _Doc_BoxAlgorithm_ModifiableSettingsExample_Setting_3:
+
+Bool
+~~~~
+
+.. todo:: Write setting description... 
+
+
+
+.. _Doc_BoxAlgorithm_ModifiableSettingsExample_Setting_4:
+
+String
+~~~~~~
+
+.. todo:: Write setting description... 
+
+
+
+.. _Doc_BoxAlgorithm_ModifiableSettingsExample_Setting_5:
+
+filename
+~~~~~~~~
+
+.. todo:: Write setting description... 
+
+
+
+.. _Doc_BoxAlgorithm_ModifiableSettingsExample_Setting_6:
+
+script
+~~~~~~
+
+.. todo:: Write setting description... 
+
+
+
+.. _Doc_BoxAlgorithm_ModifiableSettingsExample_Setting_7:
+
+color
+~~~~~
+
+.. todo:: Write setting description... 
+
+
+
+.. _Doc_BoxAlgorithm_ModifiableSettingsExample_Setting_8:
+
+colorgradient
+~~~~~~~~~~~~~
+
+.. todo:: Write setting description... 
+
+
+
+.. _Doc_BoxAlgorithm_ModifiableSettingsExample_Setting_9:
+
+unit
+~~~~
+
+.. todo:: Write setting description... 
+
+
+
+.. _Doc_BoxAlgorithm_ModifiableSettingsExample_Setting_10:
+
+factor
+~~~~~~
+
+.. todo:: Write setting description... 
+
+
+.. _Doc_BoxAlgorithm_ModifiableSettingsExample_Examples:
+
+Examples
+--------
+
+.. todo::  Write example of use...
+
+
+.. _Doc_BoxAlgorithm_ModifiableSettingsExample_Miscellaneous:
+
+Miscellaneous
+-------------
+
+.. todo::  Write any miscellaneous information...
+
+