String
- Alex Ribao
A string is a series of characters and what you are reading here right now is already a string. Since strings consist of a sequence of numbers, words or single characters, it is possible to perform various operations with them: different strings can be combined, keywords can be filtered, numbers can be converted into strings, or folder names can be assembled to a complete path. It is also possible to sort a string or extract a certain part of it. The graph engine's "String" nodes offer various helpers for complex tasks – even for arrays with multiple string entries.
Nodes
| Name | Description |
|---|---|
| ArrayStringConcat | This node concatenates the inputs 'array0' and 'array1' into a single 'out' array. |
| ArrayStringConstant | This node returns a constant array. |
| ArrayStringFilterByMask | This node returns the elements of the input 'array' at positions specified by the 'mask' parameter. |
| ArrayStringFindAllElementIndices | This node returns all positions in the input 'array', which fit to the input 'element' values. |
| ArrayStringFindElement | This node returns the first position of appearance of the input 'element' within the input 'array'. If the array does not contain the element, -1 is returned. |
| ArrayStringInsertElement | This node inserts all elements from the 'element' input into the input 'array' at the position specified by 'position'. If 'position' is equal or lower than 0 then the elements are inserted at the beginning of the array. If 'position' is greater or equal than the inputs 'array' size, elements are appended at the end. |
| ArrayStringMix | This node creates an output array based on the two inputs 'array0' and 'array1' and the input mask. If the mask value equals 0 then the value of 'array0' is used, if the mask value is 1 the value of 'array1' is used. |
| ArrayStringPushElement | This node appends all the elements from the 'element' at the end of the input 'array'. |
| ArrayStringRemoveElement | This node removes all elements of the 'by_value' from the input 'array'. The returned mask has the same size as the input 'array' and is set to 0 at removed positions. |
| ArrayStringRemoveIndex | This node removes all input array positions by the 'index' input. |
| ArrayStringRemoveRepeatedElements | This node removes all repetitions of elements from the input 'array'. The 'new_to_old' array can be used as an 'index' input for a GetArrayElement-Node to restore the original array. The returned mask has the same size as the input 'array' and is set to 0 at removed positions. |
| ArrayStringResize | This node resizes the input 'array'. If the result is bigger than the input array, the last value is repeated accordingly. |
| ArrayStringReverse | This node reverses the order of the input 'array'. |
| ArrayStringSlice | This node returns an array containing the range of the input 'array' from the 'first' position with the given input 'size'.Thus, the output array is a subarray or slice of the input. |
| ArrayStringSort | This node sorts the input 'array'. The 'old_to_new' array can be used as 'index' input of a GetArrayElement to sort a different array of the same size. The 'new_to_old' array can be used as 'index' input of a GetArrayElement to get the original array order if applied to the sorted one. to apply to other arrays of the same size. |
| GetArrayStringElement | This node returns the elements of the input 'array' at positions specified by the 'index' parameter. |
| GetStringGlobalVariable | This node returns a reference to previously stored variables in global memory (using the SetGlobalVariable-Nodes). |
| IntegerToString | This node composes a string from an integer, whereas you may define the padding. |
| RealToString | This node composes a string from a real, whereas you may define the number of decimal places. |
| SetArrayStringElement | This node returns the elements of the input 'array' at positions specified by the 'index' parameter. |
| SetStringGlobalVariable | This node allows the user to create a reference or a copy of the input pin in global memory to be used within other RealFlow graph through the GetGlobalVariable nodes. |
| String | A string constant. Suitable for direct user input. |
| StringCompare | This node performs several comparisons between the input strings. |
| StringConcat2 | This node takes the input 'left' and 'right' strings concatenates them in a single one. You may specify a 'separator' string between both of them. |
| StringConcatenate | This node takes the input 'array' of strings and concatenates all of them placing the 'separator' string between each of them. |
| StringCopy | This node duplicates the value of 'in' to the output 'copy'. |
| StringCopyToSystemClipboard | This node replaces the operating system clipboard with the input text. |
| StringFilePath | A file path string constant. Suitable for direct user input by opening a file dialog when clicking on the 'in' parameter. |
| StringFilePathCompose | This node composes a full file name path from its components using the convention: folder/name_frame.extension. |
| StringFolder | A folder string constant. Suitable for direct user input by opening a file dialog when clicking on the 'in' parameter. |
| StringInfo | Returns several information about the input string. |
| StringPasteFromSystemClipboard | This node returns the content of the clipboard if it is of plain text type. Otherwise, an empty string is returned. |
| StringReplace | Returns a version of the input 'string' with every occurrence of the string 'before' replaced with 'after'. |
| StringSplit | This node takes the input string and splits it into the output 'array' of strings. The separator determines where to split the strings exactly. |
| StringSubString | This node returns a substring of the input string. Thus, it contains the fragment of the input string with the specified size starting from position 'first'. |
| StringUpperLowerCase | Returns an uppercase and lowercase version of the input 'string'. |
ArrayStringConcat
This node concatenates the inputs 'array0' and 'array1' into a single 'out' array.
Inputs
| Name | Types | PassThrough | Description |
|---|---|---|---|
| array0 | String | The array0 | |
| array1 | String | The array1 |
Outputs
| Name | Types | PassThrough | Description |
|---|---|---|---|
| out array | String | The out array |
ArrayStringConstant
This node returns a constant array.
Inputs
| Name | Types | PassThrough | Description |
|---|---|---|---|
| constant | String | The constant | |
| size | Integer (1) | The size |
Outputs
| Name | Types | PassThrough | Description |
|---|---|---|---|
| out array | String | The out array |
ArrayStringFilterByMask
This node returns the elements of the input 'array' at positions specified by the 'mask' parameter.
Inputs
| Name | Types | PassThrough | Description |
|---|---|---|---|
| array | String | The array | |
| mask | Bit | The mask |
Outputs
| Name | Types | PassThrough | Description |
|---|---|---|---|
| result | String | The result |
ArrayStringFindAllElementIndices
This node returns all positions in the input 'array', which fit to the input 'element' values. .
Inputs
| Name | Types | PassThrough | Description |
|---|---|---|---|
| array | String | The array | |
| element | String | The value to find in the input array |
Outputs
| Name | Types | PassThrough | Description |
|---|---|---|---|
| index | Integer | The index | |
| mask | Bit | The mask |
ArrayStringFindElement
This node is executed in parallel according to its input pins size.
This node returns the first position of appearance of the input 'element' within the input 'array'. If the array does not contain the element, -1 is returned.
Inputs
| Name | Types | PassThrough | Description |
|---|---|---|---|
| array | String | The array | |
| element | String | The value to find in the input array | |
| start index | Integer | The first index to search the element from |
Outputs
| Name | Types | PassThrough | Description |
|---|---|---|---|
| index | Integer | The index |
ArrayStringInsertElement
This node inserts all elements from the 'element' input into the input 'array' at the position specified by 'position'. If 'position' is equal or lower than 0 then the elements are inserted at the beginning of the array. If 'position' is greater or equal than the inputs 'array' size, elements are appended at the end.
Inputs
| Name | Types | PassThrough | Description |
|---|---|---|---|
| array | String | The array | |
| element | String | The value to insert | |
| index | Integer (1) | The position to insert the input element on |
Outputs
| Name | Types | PassThrough | Description |
|---|---|---|---|
| out array | String | The out array |
ArrayStringMix
This node creates an output array based on the two inputs 'array0' and 'array1' and the input mask. If the mask value equals 0 then the value of 'array0' is used, if the mask value is 1 the value of 'array1' is used.
The size of the output is the same as mask's size.
Inputs
| Name | Types | PassThrough | Description |
|---|---|---|---|
| array0 | String | The array0 | |
| array1 | String | The array1 | |
| mask | Bit | The mask |
Outputs
| Name | Types | PassThrough | Description |
|---|---|---|---|
| out array | String | The out array |
ArrayStringPushElement
This node appends all the elements from the 'element' at the end of the input 'array'.
Inputs
| Name | Types | PassThrough | Description |
|---|---|---|---|
| array | String | The array | |
| element | String | The value to append at the end |
Outputs
| Name | Types | PassThrough | Description |
|---|---|---|---|
| out array | String | The out array |
ArrayStringRemoveElement
This node removes all elements of the 'by_value' from the input 'array'. The returned mask has the same size as the input 'array' and is set to 0 at removed positions.
Inputs
| Name | Types | PassThrough | Description |
|---|---|---|---|
| array | String | The array | |
| element | String | The value to remove all its instances from the input array |
Outputs
| Name | Types | PassThrough | Description |
|---|---|---|---|
| out array | String | The out array | |
| mask | Bit | The mask |
ArrayStringRemoveIndex
This node removes all input array positions by the 'index' input. .
Inputs
| Name | Types | PassThrough | Description |
|---|---|---|---|
| array | String | The array | |
| index | Integer | The positions of the input array to remove |
Outputs
| Name | Types | PassThrough | Description |
|---|---|---|---|
| out array | String | The out array |
ArrayStringRemoveRepeatedElements
This node removes all repetitions of elements from the input 'array'. The 'new_to_old' array can be used as an 'index' input for a GetArrayElement-Node to restore the original array. The returned mask has the same size as the input 'array' and is set to 0 at removed positions.
Inputs
| Name | Types | PassThrough | Description |
|---|---|---|---|
| array | String | The array |
Outputs
| Name | Types | PassThrough | Description |
|---|---|---|---|
| new to old | Integer | The new to old | |
| mask | Bit | The mask | |
| out array | String | The out array |
ArrayStringResize
This node resizes the input 'array'. If the result is bigger than the input array, the last value is repeated accordingly.
Inputs
| Name | Types | PassThrough | Description |
|---|---|---|---|
| array | String | The array | |
| size | Integer (1) | The size |
Outputs
| Name | Types | PassThrough | Description |
|---|---|---|---|
| out array | String | The out array |
ArrayStringReverse
This node reverses the order of the input 'array'.
Inputs
| Name | Types | PassThrough | Description |
|---|---|---|---|
| array | String | The array |
Outputs
| Name | Types | PassThrough | Description |
|---|---|---|---|
| out array | String | The out array |
ArrayStringSlice
This node returns an array containing the range of the input 'array' from the 'first' position with the given input 'size'.Thus, the output array is a subarray or slice of the input.
Inputs
| Name | Types | PassThrough | Description |
|---|---|---|---|
| array | String | The array | |
| first | Integer (1) | The position of the element that will be the first of the output array | |
| size | Integer (1) | The total number of elements to copy from the input array. If value is negative, all the elements from 'first' are copied to the output array |
Outputs
| Name | Types | PassThrough | Description |
|---|---|---|---|
| out array | String | The out array |
ArrayStringSort
This node sorts the input 'array'. The 'old_to_new' array can be used as 'index' input of a GetArrayElement to sort a different array of the same size. The 'new_to_old' array can be used as 'index' input of a GetArrayElement to get the original array order if applied to the sorted one. to apply to other arrays of the same size.
Inputs
| Name | Types | PassThrough | Description |
|---|---|---|---|
| array | String | The array |
Outputs
| Name | Types | PassThrough | Description |
|---|---|---|---|
| old to new | Integer | The old to new | |
| new to old | Integer | The new to old | |
| out array | String | The out array |
GetArrayStringElement
This node returns the elements of the input 'array' at positions specified by the 'index' parameter.
Inputs
| Name | Types | PassThrough | Description |
|---|---|---|---|
| array | String | The array | |
| index | Integer | The index |
Outputs
| Name | Types | PassThrough | Description |
|---|---|---|---|
| element | String | The element |
GetStringGlobalVariable
This node returns a reference to previously stored variables in global memory (using the SetGlobalVariable-Nodes).
Inputs
| Name | Types | PassThrough | Description |
|---|---|---|---|
| name | String (1) | The name |
Outputs
| Name | Types | PassThrough | Description |
|---|---|---|---|
| out | String | The out |
IntegerToString
This node composes a string from an integer, whereas you may define the padding.
Inputs
| Name | Types | PassThrough | Description |
|---|---|---|---|
| integer | Integer | The integer | |
| padding | Integer (1) | The number of digits used to represent the integer value (1..9) |
Outputs
| Name | Types | PassThrough | Description |
|---|---|---|---|
| string | String | The string |
RealToString
This node composes a string from a real, whereas you may define the number of decimal places.
Inputs
| Name | Types | PassThrough | Description |
|---|---|---|---|
| real | Real | The real | |
| decimal places | Integer (1) | The number of digits used to represent the decimal places |
Outputs
| Name | Types | PassThrough | Description |
|---|---|---|---|
| string | String | The string |
SetArrayStringElement
This node returns the elements of the input 'array' at positions specified by the 'index' parameter.
Inputs
| Name | Types | PassThrough | Description |
|---|---|---|---|
| array | String | The array | |
| index | Integer | The index | |
| element | String | The element |
Outputs
| Name | Types | PassThrough | Description |
|---|---|---|---|
| result | String | The result |
SetStringGlobalVariable
This node allows the user to create a reference or a copy of the input pin in global memory to be used within other RealFlow graph through the GetGlobalVariable nodes.
Inputs
| Name | Types | PassThrough | Description |
|---|---|---|---|
| name | String (1) | The name | |
| in | String | through | The in |
| store copy | Bit (1) | The store copy |
Outputs
| Name | Types | PassThrough | Description |
|---|---|---|---|
| through | PassThrough | in | The value connected to the input |
| out copy | String | The value copied in memory in case a copy has been performed. The same input value otherwise |
String
A string constant. Suitable for direct user input.
Inputs
| Name | Types | PassThrough | Description |
|---|---|---|---|
| in | String | The in |
Outputs
| Name | Types | PassThrough | Description |
|---|---|---|---|
| out | String | The out |
StringCompare
This node performs several comparisons between the input strings.
Inputs
| Name | Types | PassThrough | Description |
|---|---|---|---|
| string0 | String | The first string to compare | |
| string1 | String | The second string to compare | |
| ignore case | Bit | True to ignore the character case for the comparisons |
Outputs
| Name | Types | PassThrough | Description |
|---|---|---|---|
| is equal | Bit | True if both input strings are the same | |
| is inside | Bit | True if 'string0' is contained in 'string1' | |
| position | Integer | The position of 'string0' inside 'string1'. If 'string0' is not contained in 'string1' the returned value is -1 |
StringConcat2
This node takes the input 'left' and 'right' strings concatenates them in a single one. You may specify a 'separator' string between both of them.
For example:
'left' : 'Hi'
'right' : 'RealFlow'
'separator' : '-RF-'
'out' : 'Hi-RF-RealFlow'.
Inputs
| Name | Types | PassThrough | Description |
|---|---|---|---|
| left | String | The left | |
| right | String | The right | |
| separator | String (1) | The separator |
Outputs
| Name | Types | PassThrough | Description |
|---|---|---|---|
| out | String | The out |
StringConcatenate
This node takes the input 'array' of strings and concatenates all of them placing the 'separator' string between each of them.
If the separator is
, or the special character is used instead of displaying the escaped sequence.
For example:
'array' : ['Hi','RealFlow','user']
'separator' : '-RF-'
'out' : 'Hi-RF-RealFlow-RF-user'.
Inputs
| Name | Types | PassThrough | Description |
|---|---|---|---|
| array | String | The array | |
| separator | String | The separator |
Outputs
| Name | Types | PassThrough | Description |
|---|---|---|---|
| out | String | The out |
StringCopy
This node duplicates the value of 'in' to the output 'copy'.
Inputs
| Name | Types | PassThrough | Description |
|---|---|---|---|
| in | String | The value to duplicate |
Outputs
| Name | Types | PassThrough | Description |
|---|---|---|---|
| copy | String | A copy of 'in' |
StringCopyToSystemClipboard
This node replaces the operating system clipboard with the input text.
If the input size is more than one, all the input strings are combined separated with the new line character.
Inputs
| Name | Types | PassThrough | Description |
|---|---|---|---|
| string | String | The text to add the system clipboard | |
| in | PassThrough | through | The in |
Outputs
| Name | Types | PassThrough | Description |
|---|---|---|---|
| through | PassThrough | in | The input 'in' |
StringFilePath
A file path string constant. Suitable for direct user input by opening a file dialog when clicking on the 'in' parameter.
Inputs
| Name | Types | PassThrough | Description |
|---|---|---|---|
| in | The in |
Outputs
| Name | Types | PassThrough | Description |
|---|---|---|---|
| file path | The file path |
StringFilePathCompose
This node composes a full file name path from its components using the convention: folder/name_frame.extension
If padding is set to 0 the output 'filePath' might be undefined.
Inputs
| Name | Types | PassThrough | Description |
|---|---|---|---|
| folder | The folder | ||
| name | String | The file root name | |
| extension | String | The file extension (without the dot) | |
| extension order | The separator between filename and frame number | ||
| padding | Integer | The number of digits used to represent the frame number | |
| frame | Integer | The frame number |
Outputs
| Name | Types | PassThrough | Description |
|---|---|---|---|
| file path | String | The file path |
StringFolder
A folder string constant. Suitable for direct user input by opening a file dialog when clicking on the 'in' parameter.
Inputs
| Name | Types | PassThrough | Description |
|---|---|---|---|
| in | The in |
Outputs
| Name | Types | PassThrough | Description |
|---|---|---|---|
| folder | The folder |
StringInfo
Returns several information about the input string.
Inputs
| Name | Types | PassThrough | Description |
|---|---|---|---|
| string | String | through | The string |
Outputs
| Name | Types | PassThrough | Description |
|---|---|---|---|
| length | Integer | The length | |
| is empty | Bit | The is empty | |
| all uppercase | Bit | True if all the characters of the input are upper-case | |
| all lowercase | Bit | True if all the characters of the input are lower-case | |
| uppercase | String | The upper-case version of the input | |
| lowercase | String | The lower-case version of the input | |
| through | PassThrough | string | The input 'string' |
StringPasteFromSystemClipboard
This node returns the content of the clipboard if it is of plain text type. Otherwise, an empty string is returned.
Inputs
| Name | Types | PassThrough | Description |
|---|---|---|---|
| in | PassThrough | through | The in |
Outputs
| Name | Types | PassThrough | Description |
|---|---|---|---|
| string | String | The text pasted from clipboard | |
| through | PassThrough | in | The input 'in' |
StringReplace
Returns a version of the input 'string' with every occurrence of the string 'before' replaced with 'after'.
The operation is case sensitive.
Inputs
| Name | Types | PassThrough | Description |
|---|---|---|---|
| string | String | The string | |
| before | String (1) | The substring to be replaced. It is case sensitive and should not be empty | |
| after | String (1) | The string the 'before' substring will be replaced with |
Outputs
| Name | Types | PassThrough | Description |
|---|---|---|---|
| result | String | The result |
StringSplit
This node takes the input string and splits it into the output 'array' of strings. The separator determines where to split the strings exactly.
If the separator is empty, the input string is splitted into every one of its characters. Otherwise, it must be a single character.
For example:
'in' : 'Hi-RealFlow-user''separator' : '-'
'array' : ['Hi','RealFlow','user']
.
Inputs
| Name | Types | PassThrough | Description |
|---|---|---|---|
| in | String | The in | |
| separator | String (1) | The separator character |
Outputs
| Name | Types | PassThrough | Description |
|---|---|---|---|
| array | String | The array |
StringSubString
This node returns a substring of the input string. Thus, it contains the fragment of the input string with the specified size starting from position 'first'.
Inputs
| Name | Types | PassThrough | Description |
|---|---|---|---|
| in | String | The in | |
| first | Integer (1) | The position of the character that will be the first of the output string | |
| size | Integer (1) | The total number of characters to copy from the input string. If value is negative, all the characters from 'first' are copied to the output string |
Outputs
| Name | Types | PassThrough | Description |
|---|---|---|---|
| out | String | The out |
StringUpperLowerCase
Returns an uppercase and lowercase version of the input 'string'.
Inputs
| Name | Types | PassThrough | Description |
|---|---|---|---|
| string | String | The string |
Outputs
| Name | Types | PassThrough | Description |
|---|---|---|---|
| uppercase | String | The upper-case version of the input | |
| lowercase | String | The lower-case version of the input |