Raptor:Data Store Definition: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
|||
| (One intermediate revision by one other user not shown) | |||
| Line 1: | Line 1: | ||
[[ | [[Raptor-Platform|Return to the main Raptor page]] | ||
[[Raptor | [[Raptor-Dev-Data-Storage-Library|Return to Data Storage page]] | ||
[[File:RaptorDataStoreDefinition.jpg|right|frame|Raptor Data Store Definition]] | [[File:RaptorDataStoreDefinition.jpg|right|frame|Raptor Data Store Definition]] | ||
== Description == | == Description == | ||
<p>The | <p>The Raptor data definition block defines a data store item which can be accessed with the data read and data write blocks. The data in the data store can also be made available in the calibration tool. All Raptor data storage blocks are globally accessible, unlike standard Simulink counterparts which may be accessible at or below model hierarchy.</p> | ||
== Parameters == | == Parameters == | ||
Latest revision as of 13:44, 13 September 2023
Return to the main Raptor page
Description
The Raptor data definition block defines a data store item which can be accessed with the data read and data write blocks. The data in the data store can also be made available in the calibration tool. All Raptor data storage blocks are globally accessible, unlike standard Simulink counterparts which may be accessible at or below model hierarchy.
Parameters
| Parameter | Type | Description |
|---|---|---|
| Name | String | This is the name of that will appear in the calibration tool. The name must be a valid C identifier. |
| Initial Value | Number or Vector or Matrix | This is the initial adjustment value. |
| Data Type | Specifies the data type of the data store. | |
| Storage | Specifies the storage class of the data. | |
| Visible in Cal Tool | Controls the visibility of the data in the calibration tool. | |
| Type | Controls how the data is presented in the calibration tool. Measurements are used to view data in the module, and adjustments are used to write data to the module. | |
| Display As | Specifies how to display the value in the calibration tool. | |
| Gain | Number | This controls the scaling used to display the data in the cal tool.
display value = (Gain * actual value) + Offset |
| Offset | Number | This controls the scaling used to display the data in the cal tool.
display value = (Gain * actual value) + Offset |
| Max | Number | Sets the maximum value that can be set in the calibration tool. |
| Min | Number | Sets the minimum value that can be set in the calibration tool. |
| Format | Format String | Sets the display format to use in the calibration tool. |
| Enumeration Definition | Cell Array of strings or struct array | Provides the mapping of string representation to integer value for the enumeration. |
| Unit Text | String | Sets the unit text that is displayed in the calibration tool. |
| Help Text | String | Sets the help text that is displayed in the calibration tool. |
| Access Level | Sets the access level of this item in the calibration tool | |
| Function | String | Sets the location where the variable appears in the calibration tool. Use raptor_xcp_function(gcb) to create a function based on this block's location in the model. |