Raptor:Fault Data Definition: Difference between revisions
Jump to navigation
Jump to search
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:Faults|Return to Faults page]] | [[Raptor:Faults|Return to Faults page]] | ||
| Line 7: | Line 7: | ||
== Description == | == Description == | ||
<p>This block defines a fault data store. This will create a data store which contains a unique value for each fault. This can be used to manage data items that must be associated with each fault.</p> | <p>This block defines a fault data store. This will create a data store which contains a unique value for each fault. This can be used to manage data items that must be associated with each fault.</p> | ||
== Parameters == | == Parameters == | ||
| Line 46: | Line 30: | ||
| | | | ||
| Specifies the storage class of the data. | | Specifies the storage class of the data. | ||
|- | |||
! Visible in Cal Tool | |||
| checkbox | |||
| Makes the fault definition visible while using the calibration tool. | |||
|- | |||
! Type | |||
| | |||
| Specifies whether the value is a measurement or an adjustment. | |||
|- | |||
! Display as | |||
| | |||
| Specifies how the value is displayed. | |||
|- | |||
! Gain | |||
| number | |||
| This controls the scaling used to display the data in the cal tool. | |||
|- | |||
! Offset | |||
| number | |||
| This controls the scaling used to display the data in the cal tool. | |||
|- | |||
! Max | |||
| number | |||
| Sets the maximum value that can be set to any table data point in the calculation. | |||
|- | |||
! Min | |||
| number | |||
| Sets the minimum value that can be set to any table data point in the calculation. | |||
|- | |||
! Display Format | |||
| format string | |||
| Sets the display format to use in the calibration tool. | |||
|- | |||
! 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 the variables location in the model. | |||
|} | |} | ||
Latest revision as of 17:30, 13 September 2023
Return to the main Raptor page
Description
This block defines a fault data store. This will create a data store which contains a unique value for each fault. This can be used to manage data items that must be associated with each fault.
Parameters
| Parameter | Type | Description |
|---|---|---|
| Data Name | String | This is the name of the fault data store to access |
| Initial Value | Number or Vector or struct | Defines the initial value of the fault data store. |
| Data Type | Specifies the data type of the data store. | |
| Storage | Specifies the storage class of the data. | |
| Visible in Cal Tool | checkbox | Makes the fault definition visible while using the calibration tool. |
| Type | Specifies whether the value is a measurement or an adjustment. | |
| Display as | Specifies how the value is displayed. | |
| Gain | number | This controls the scaling used to display the data in the cal tool. |
| Offset | number | This controls the scaling used to display the data in the cal tool. |
| Max | number | Sets the maximum value that can be set to any table data point in the calculation. |
| Min | number | Sets the minimum value that can be set to any table data point in the calculation. |
| Display Format | format string | Sets the display format to use in the calibration tool. |
| 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 the variables location in the model. |