KDL Conversion Modules

Parameter Descriptions:

Check For Valid Choice:

Modifies how a list choice is selected by value. See "Choose by" below.

FALSE: no validating is performed, and the list is forced to make this choice. This can cause unexpected behavior, including crashes, in some modules.

TRUE: the value is selected from the available choices, with the nearest choice selected if the value is not among the choices. If two choices are equidistant from the input, the last one by choice number is selected. This is the default setting.

Choose by:

Determines method of selecting between list choices.

Value: selects the list choice with the same value as input. This can be modified by Check For Valid Choice. This is the default setting.

Index: selects the list choice in a 0-based order. Inputing less than 0 always returns the first choice on the list. Inputing a number larger than the number of choices returns the last choice on the list.

Example List:
Choice #	Choice Name	Value
0	Zero	0
1	One	1
2	Two	2
3	Three	3
4	Four	4
5	Five	5
6	Ten	10
7	Twenty	20
8	Fifty	50
9	One Hundred	100

 

Input	Value Output	Index Output
0	0 (Zero)	0 (Zero)
1	1 (One)	1 (One)
6	6 (???)*	10 (Ten)
8	8 (???)**	50 (Fifty)
9	9 (???)***	100 (One Hundred)
10	10 (Ten)	100 (One Hundred)
	* returns 5 (Five) if 'Check For Valid Choice' is true.
	** returns 10 (Ten) if 'Check For Valid Choice' is true.
	*** returns 10 (Ten) if 'Check For Valid Choice' is true.

Conversions 1 & 2:

Used in the GuiText2GuiText module, this is a comma-seperated list of text/text pairs. See "Interpret Direction" below.

To enter your own custom conversions, it is done in a text/text pair system, with each choice seperated by a comma. If a word is not given for a particular choice, then it will be converted to nothing.

Both of these fields are limited to the first 1000 characters. They are both added to the internal conversion list.

An example: You have a module that outputs an integer representing some possible note length values, and you want the user to be able to see the choice in a text box. Enter '1=Whole Note,2=Half Note,4=Quarter Note,8=Eighth Note,16=Sixteenth Note' into the 'Conversions 1' field. Use an int to text module to convert the integer into text that this module can then convert. Words entered that have no corresponding value (eg, '7' in this case) will pass through unchanged. To convert these words back into the numeric representations, use the 'A<->B' option of 'Interpret Direction'.

Interpret Direction:

Used in the GuiText2GuiText module, this selects how words are translated. Word pairs are entered in a A=B,A=B,... pattern.

A->B:Words from the 'A' list are translated to the equivalent words on the 'B' list.

A<-B:Words from the 'B' list are translated to the equivalent words on the 'A' list.

A<->B:Words from the 'A' or 'B' lists are translated to the equivalent words on the opposite list.

Interpret Text:

Used in Text to Bool/Int/List modules, this allows text proper to be converted to values, instead of just numbers entered into a text field. Tests are case insensitive.

FALSE: converts numbers in the text to a number to use as the output, stopping when the first character that cannot be interpreted is found. 0 or FALSE is returned if nothing can be interpreted. If the output is boolean, any non-zero number will output TRUE. This is the default setting.

TRUE: performs several tests to find a value to output:

1: Attempts to find the name of a choice on a list, if this outputs list choices.

2: Converts text to values listed in the 'Other Conversions' field. See "Other Conversions" below.3: Converts some typical text to values, depending on the type of output:

If output type is Boolean, then 'true', 'on', and 'yes' output TRUE.

If output type is List, then 'first' .. 'twentieth' output that particular choice from the list, irrespective of the 'Choose by' setting.

If output type is Integer or List, then 'one' .. 'twenty' output the corresponding integers.

4: Converts numbers in the text to a number to use as the output, stopping when the first character that cannot be interpreted is found. If the output is boolean, any non-zero number will output TRUE.

5: If none of the above are able to determine a value, then 0 or FALSE is output, dependant on the output type.

Invert Output:

Inverts the boolean output. See "Output FALSE if" below.

FALSE: does not change the boolean value from the 'Output FALSE if' setting. This is the default setting.

TRUE: causes TRUE values to output FALSE and vice versa.

List Choices:

Used only on modules with a List pin on the left side. This determines the list that is sent to the List pin connected to this module. This can be used to create your own custom lists.

To enter your own custom list, it is done in a name/value pair system, with each choice seperated by a comma. The types of values and their limits depends on the specific module:

GuiList2GuiInt: the value is a long signed integer, and has a min/max of 2147483647 and -2147483678. If no value is given, then the value is one greater than the previous value (starting at 0). The default list is 'Zero=0,One,Two,Three,Four,Five,Six,Seven,Eight,Nine,Ten'.

GuiList2GuiFloat: the value is a float value, and has a min/max of 1E+37 and 1E-37. If no value is given, then the value is one greater than the previous value (starting at 0.0). The default list is 'Zero=0.0,One,Two,Three,Four,Five,Six,Seven,Eight,Nine,Ten'.

GuiList2GuiBool: the value is a boolean, either true or false. If no value is given, then the value is retrieved from the 'Other choices are' property. Values of 'true', 'yes', 'on', and any non-zero number are interpreted as 'TRUE'. All others are 'FALSE'. The default list is 'False=FALSE,True=TRUE'.

GuiList2GuiText: the value is in text format, and thus has no minimum or maximum. If no value is given then the value is the same as the text. The default list is 'Zero=0,One=1,Two=2,Three=3,Four=4,Five=5,Six=6,Seven=7,Eight=8,Nine=9,Ten=10'.

Lists are limited to the first 1000 characters in this field.

The List setting for the example list given in the description of "Choose by" above would be 'Zero=0,One,Two,Three,Four,Five,Ten=10,Twenty=20,Fifty=50,One Hundred=100'

Other Conversions:

Used for text to int or list modules, this is an optional comma-seperated list of text/value pairs. This is only checked if 'Interpret Text' is set to TRUE. See "Interpret Text" above.

To enter your own custom values, it is done in a text/value pair system, with each choice seperated by a comma. The types of values and their limits depends on the specific module:

GuiText2GuiInt: the value is a long signed integer, and has a min/max of 2147483647 and -2147483678. If no value is given, then the value is one greater than the previous value (starting at 0).

GuiText2GuiList: the value is in text format, and thus has no minimum or maximum. If no value is given then the value is the same as the text.

This field limited to the first 1000 characters.

An example: you want to output the number of notes in a measure, and you want the user to be able to enter some common note names, then enter 'Whole=1,Half,Quarter=4,Eighth=8,Sixteenth=16' into the 'Other Conversions' field.

Other TRUE Words:

Used for text to bool modules, this is an optional comma-seperated list of other words you would like to output a TRUE value if entered. For example, to make the module a s'koshe bit multilingual, you could put 'Vero,Sann,Vrai,Wahr,Jippi' into the field. This is only checked if 'Interpret Text' is set to TRUE. See "Interpret Text" above.

Output FALSE if:

Selects the method used to determine whether a boolean output should be TRUE or FALSE.

Eq to TH: outputs FALSE only if the input matches the threshold exactly. This is the default setting.

TH or Less: outputs FALSE if the input is equal to or less than the threshold.

Passing Mode:

Used only in GUI to GUI modules, this determines the direction data will travel.

L->R: inputing values on the left-side pin will adjust the output of the right-side pin. This is the default setting.

L<-R: inputing values on the right-side pin will adjust the output on the left-side pin.

L<->R: inputing values on either side's pin will adjust the output on the opposite side's pin.

L->R w/FB: inputing values on the left-side pin will adjust the output of the right-side pin. Any changes to the value will also be 'reflected' back to the left-side pin, within the capabilities of that pin.

L<-R w/FB: inputing values on the right-side pin will adjust the output on the left-side pin. Any changes to the value will also be 'reflected' back to the right-side pin, within the capabilities of that pin.

L<->R w/FB: inputing values on either side's pin will adjust the output on the opposite side's pin. Any changes to the value will also be 'reflected' back to the first pin, within the capabilities of that pin.

Retrieve List Text:

Used only in GuiList2GuiText and GuiText2GuiList, this returns the actual name of the choice rather than either it's value or index.

Rounding Mode:

Determines the method used to convert decimal numbers to integers.

Truncate: round down to the nearest integer, towards negative infinity. This is the default setting.

Round Off: round to the nearest integer, with x.5 rounding up.

Round Up: round up to the nearest integer, towards positive infinity.

	Output
Input	Truncate	Round Off	Round Up
2.00	2	2	2
1.75	1	2	2
1.50	1	2	2
1.25	1	1	2
1.00	1	1	1
-1.00	-1	-1	-1
-1.25	-2	-1	-1
-1.50	-2	-1	-1
-1.75	-2	-2	-1
-2.00	-2	-2	-2

Sampling Method:

Determines the method used to sample the data.

Start: returns the beginning value of the sampling period.

End: returns the ending value of the sampling period. This is the default setting.Start/End: averages the beginning and ending values of the sampling period.All: returns the average of all the values received during the sampling period.

	Output
Period	Start	End	Start/End	All
1	-5.0	0.0	-2.5	-2.5
2	0.0	0.0	0.0	0.0
3	0.0	5.0	2.5	-4.8
4	5.0	-5.0	0.0	-4.9
5	-5.0	-5.0	-5.0	0.0

Sampling Rate:

Determines how often to update the output. The rate is given in hertz (times/second), with 40 Hz as the default.

The amount is capped to 0.0001 Hz (1x/2hrs 46min 40sec) to 500.0 Hz, inclusive.

Threshold (TH):

Determines the threshold to test against for boolean outputs. The default value is 0. See "Output FALSE if" above.

Value if FALSE:

Selects what the output should be if the boolean input is FALSE. The default value is 0, "False", or the first choice on a list, dependant on the type of output.

Value if TRUE:

Selects what the output should be if the boolean input is TRUE. The default value is 10, "True", or the last choice on a list, dependant on the type of output.