Raptor:Raptor String: Difference between revisions
No edit summary |
No edit summary |
||
| (2 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
[[ | [[Raptor-Platform|Return to the main Raptor page]] | ||
[[Raptor:Strings|Return to Strings page]] | [[Raptor:Strings|Return to Strings page]] | ||
| Line 8: | Line 8: | ||
<p>This block is used to create a string which can be used to store text data. Strings behave differently from other native simulink data types in that they are always accessed by reference. This means that only one copy of the data exists. This means that if a string handle is run to two blocks and the first block modifies the string, the second block will see the modified string even if it is not connected to the output of the first block. This is due to the large memory requirement of most strings. The size of the string must be set before compiling. The size of the string represents the largest amount of data that it can hold. A string can have less data in it than its size. It is best to set the size to the longest string that will be stored. Setting the size significantly higher can lead to high memory use.</p> | <p>This block is used to create a string which can be used to store text data. Strings behave differently from other native simulink data types in that they are always accessed by reference. This means that only one copy of the data exists. This means that if a string handle is run to two blocks and the first block modifies the string, the second block will see the modified string even if it is not connected to the output of the first block. This is due to the large memory requirement of most strings. The size of the string must be set before compiling. The size of the string represents the largest amount of data that it can hold. A string can have less data in it than its size. It is best to set the size to the longest string that will be stored. Setting the size significantly higher can lead to high memory use.</p> | ||
<p>Note: Line breaks and tabs will not display correctly with a Draw Text block.</p> | |||
<p>Note: Simulink String blocks are not compatible with Raptor blocks. Please use Raptor String blocks.</p> | |||
== Outputs == | == Outputs == | ||
| Line 23: | Line 20: | ||
! scope="col" style="width: 70%;"|Description | ! scope="col" style="width: 70%;"|Description | ||
|- | |- | ||
! | ! Value | ||
| | | r_string | ||
| String handle | | String handle | ||
|} | |} | ||
| Line 51: | Line 48: | ||
| Sets the size of the string when the type is set to 'Fixed Size'. | | Sets the size of the string when the type is set to 'Fixed Size'. | ||
|} | |} | ||
Latest revision as of 13:55, 14 September 2023
Return to the main Raptor page
Description
This block is used to create a string which can be used to store text data. Strings behave differently from other native simulink data types in that they are always accessed by reference. This means that only one copy of the data exists. This means that if a string handle is run to two blocks and the first block modifies the string, the second block will see the modified string even if it is not connected to the output of the first block. This is due to the large memory requirement of most strings. The size of the string must be set before compiling. The size of the string represents the largest amount of data that it can hold. A string can have less data in it than its size. It is best to set the size to the longest string that will be stored. Setting the size significantly higher can lead to high memory use.
Note: Line breaks and tabs will not display correctly with a Draw Text block.
Note: Simulink String blocks are not compatible with Raptor blocks. Please use Raptor String blocks.
Outputs
| Output | Type | Description |
|---|---|---|
| Value | r_string | String handle |
Parameters
| Parameter | Type | Description |
|---|---|---|
| Name | String | Defines the name of this string to be used with the string reference block. |
| Initial Value | String | The initial value of the string. |
| Type | Chooses the source of the size of the string. | |
| Size | Sets the size of the string when the type is set to 'Fixed Size'. |