Changes between Version 23 and Version 24 of dialogmanager

Timestamp:

10/04/23 16:17:45 (13 months ago)

Author:

wouter

Comment:

--

dialogmanager

@@ -97 +97 @@
 
 == UpdateFunction
-An UpdateFunction is a function that changes a Parameter value. The following are available:
-||UpdateFunction||description||Additional parameters||
-||Set||Directly sets the parameter to a given value. ||value: ParameterValue||
-||BlockSubstitute||Substitutes in given value all occurences if [X] where X is a known parameter with the value of parameter X. Unknown parameters are not substituted||value: ParameterValue||
-||ValueWithCondition||Sets parameter to given value , iF the condition holds.||value:ParameterValue, condition: Parameters||
-||SetBestMatch||sets a parameter to the value that has the best condition||valueconditions: List<ValueWithCondition>||
+An UpdateFunction is a function programmed in Java (extending UpdateFunction class) that can be called from the json dialog file to change parameter values.
+
+Generally these functions look like this in json
+
+{{{ {"NameOfFunction":[val1, val2, val3....] } }}}
 
 
 
-== UpdateFunction
-An UpdateFunction is one of the phases of the DialogPhase. It allows computation of derived variable values. These functions can be programmed in Java. Generally these functions look like this in json
-
-{{{ "updatefunction":{"NameOfFunction":[["invar1","invar2",...],["outvar1","outvar2",...]]},}}}
-
 NameOfFunction is the name of a java class that implements the UpdateFunction class.
 This class implements a function {{{ Parameters call(Parameters parameters) }}}
+
+
+
+An update function has access to all parameters and can change any of them. But generally it is good practice to only use/change parameters provided in the arguments. In above case, it would use 
+
+
 
 The incoming Parameters will be set to the current parameter values in the dialogstate .
@@ -119 +119 @@
 This mechanism allows the function to be called with different parameters as needed in the dialog. And it allows functions of arbitrary input and output arity. 
 
+
+
+
+The following are available:
+||UpdateFunction||description||Additional parameters||
+||Set||Directly sets the parameter to a given value. ||value: ParameterValue||
+||BlockSubstitute||Substitutes in given value all occurences if [X] where X is a known parameter with the value of parameter X. Unknown parameters are not substituted||value: ParameterValue||
+||ValueWithCondition||Sets parameter to given value , iF the condition holds.||value:ParameterValue, condition: Parameters||
+||SetBestMatch||sets a parameter to the value that has the best condition||valueconditions: List<ValueWithCondition>||
+||SetFirstMatch||set parameter to the first value for which the condition holds, or the "orelse" value if no condition holds||
+||SetIfElse||Sets parameter to the vtrue value if the condition holds, else to vfalse value||
+
+Custom functions can be programmed in Java and then used in your json code. Of course make sure that your custom functions are properly attached to the json parser.
+
+
+== DialogPhase
+Each DialogPhase contains a list of UpdateFunctions that are executed in the given order. It allows computation of derived variable values. 
+
+
+
+