Raptor:Fault Data Read: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
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:Faults|Return to Faults page]] | [[Raptor:Faults|Return to Faults page]] | ||
| Line 14: | Line 14: | ||
! scope="col" style="width: 15%;"|Type | ! scope="col" style="width: 15%;"|Type | ||
! scope="col" style="width: 70%;"|Description | ! scope="col" style="width: 70%;"|Description | ||
|- | |||
! Fault | |||
| | |||
| Fault index of fault to read data from (only available in certain modes). | |||
|- | |||
! Vector | |||
| | |||
| If the fault data is a vector, the index in the fault data vector to read data from (only available in certain modes). | |||
|} | |} | ||
| Line 22: | Line 30: | ||
! scope="col" style="width: 15%;"|Type | ! scope="col" style="width: 15%;"|Type | ||
! scope="col" style="width: 70%;"|Description | ! scope="col" style="width: 70%;"|Description | ||
|- | |||
! Data | |||
| | |||
| The value read from the fault. | |||
|} | |} | ||
| Line 39: | Line 51: | ||
| Selects source of fault to read data of. | | Selects source of fault to read data of. | ||
|- | |- | ||
! | ! Data Shape | ||
| | | | ||
| | | Whether the targeted fault data is a Scalar or a Vector. | ||
|- | |||
! Index Source | |||
| | |||
| If the Data Shape is a Vector, where to get the data index from; | |||
from a Parameter in the mask, from Input through a port, or by Reading the Entire Vector at once (no index needed). | |||
|- | |||
! Data Index | |||
| integer | |||
| If the Data Shape is a Vector and the Index Source is a Parameter, then this the Index to read data from. | |||
This must be an integer between 1 and the size of the fault data vector, inclusive. | |||
|} | |} | ||
Latest revision as of 17:42, 13 September 2023
Return to the main Raptor page
Description
This reads the value of a fault data store for a single fault. The data store must be defined with a fault data definition block.
Inputs
| Input | Type | Description |
|---|---|---|
| Fault | Fault index of fault to read data from (only available in certain modes). | |
| Vector | If the fault data is a vector, the index in the fault data vector to read data from (only available in certain modes). |
Outputs
| Output | Type | Description |
|---|---|---|
| Data | The value read from the fault. |
Parameters
| Parameter | Type | Description |
|---|---|---|
| Data Name | String | This is the name of the fault data store to access. |
| Fault Source | Selects source of fault to read data of. | |
| Data Shape | Whether the targeted fault data is a Scalar or a Vector. | |
| Index Source | If the Data Shape is a Vector, where to get the data index from;
from a Parameter in the mask, from Input through a port, or by Reading the Entire Vector at once (no index needed). | |
| Data Index | integer | If the Data Shape is a Vector and the Index Source is a Parameter, then this the Index to read data from.
This must be an integer between 1 and the size of the fault data vector, inclusive. |