Common
Common - ChooseByBool
Selects a value based on a boolean condition.If true, InValueTrue is selected; otherwise, InValueFalse is selected.
IN
| Name | Type | Description |
|---|---|---|
| InCondition | Bool | The condition value |
| InValueTrue | T | The value to select when condition is true |
| InValueFalse | T | The value to select when condition is false |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutSelected | T | The selected value based on InCondition |
| Error | ErrorState | Gets the execution error message |
Common - ChooseByCaseString
Selects a value based on a case condition.InCasesNumber defines the number of pairs (InCaseX,InValueX) to create.Each InCaseX is confronted with InTestValue and the corresponding InValueX is selected or InValueDefault if no match is found.
IN
| Name | Type | Description |
|---|---|---|
| InCasesNumber | Int | The number of cases |
| InTestValue | String | The value used as reference. |
| InCases | RegisterParamCollection | The collection of cases |
| InValues | RegisterParamCollection | The collection of values |
| InValueDefault | T | The value to select no match is found. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutSelected | T | The selected value based on range condition. |
| Error | ErrorState | Gets the execution error message |
Common - ChooseByCaseInt
Selects a value based on a case condition.InCasesNumber defines the number of pairs (InCaseX,InValueX) to create.Each InCaseX is confronted with InTestValue and the corresponding InValueX is selected or InValueDefault if no match is found.
IN
| Name | Type | Description |
|---|---|---|
| InCasesNumber | Int | The number of cases |
| InTestValue | Int | The value used as reference. |
| InCases | RegisterParamCollection | The collection of cases |
| InValues | RegisterParamCollection | The collection of values |
| InValueDefault | T | The value to select no match is found. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutSelected | T | The selected value based on range condition. |
| Error | ErrorState | Gets the execution error message |
Common - ChooseByInterval
Selects a value based on a range condition.If InTestValue is below the range InValueLow is selected,if InTestValue is above the range InValueHigh is selected, otherwise InValueInRange is selected
IN
| Name | Type | Description |
|---|---|---|
| InTestValue | Float | The value used as reference. |
| InInterval | Interval | The range interval used to test InTestValue. |
| InIncludeMin | Bool | Specifies if the min value is inclusive. |
| InIncludeMax | Bool | Specifies if the max value is inclusive. |
| InValueLow | T | The value to select when InTestValue is below the range. |
| InValueInRange | T | The value to select when InTestValue satisfies the range. |
| InValueHigh | T | The value to select when InTestValue is above the range. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutSelected | T | The selected value based on range condition. |
| Error | ErrorState | Gets the execution error message |
Common - Comment
Adds a custom comment line
IN
| Name | Type | Description |
|---|---|---|
OUT
| Name | Type | Description |
|---|---|---|
Common - Copy
Create a copy of the input object.
IN
| Name | Type | Description |
|---|---|---|
| InValue | < T > | The object to be copied |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutValue | < T > | The copied object |
| Error | ErrorState | Gets the execution error message |
Common - CopyArray
Create a copy of the input object.
IN
| Name | Type | Description |
|---|---|---|
| InValue | < T > | The object to be copied |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutValue | < T > | The copied object |
| Error | ErrorState | Gets the execution error message |
Common - ReplaceNullWithDefault
Replace null values with default values
IN
| Name | Type | Description |
|---|---|---|
| InValue | T | The input register to be checked for null values |
| DefaultValue | < T > | The default value to replace null values with |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutValue | < T > | The output register with null values replaced by the default value |
| Error | ErrorState | Gets the execution error message |
Common - TestEqual
Checks whether the input object is equal to another object.
IN
| Name | Type | Description |
|---|---|---|
| InValue1 | < T > | The first object |
| InValue2 | < T > | The second object |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutAreEqual | Bool | The operation result |
| Error | ErrorState | Gets the execution error message |
Common - TestHasValue
Checks if the input has a valid value ( not null and not empty).
IN
| Name | Type | Description |
|---|---|---|
| InValue | < T > | The input value to test |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutHasValue | Bool | True if has not a valid value （null or empty） |
| Error | ErrorState | Gets the execution error message |
Common - TestNotEqual
Checks whether the input object is not equal to another object.
IN
| Name | Type | Description |
|---|---|---|
| InValue1 | < T > | The first object |
| InValue2 | < T > | The second object |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutAreNotEqual | Bool | The operation result |
| Error | ErrorState | Gets the execution error message |
Common - TestNotHasValue
Checks if the input hasn't a valid value (null or empty).
IN
| Name | Type | Description |
|---|---|---|
| InValue | < T > | The input value to test |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutNotHasValue | Bool | True if has not a valid value （null or empty） |
| Error | ErrorState | Gets the execution error message |