Raptor:Fault Action Read: Difference between revisions
Jump to navigation
Jump to search
(Created page with 'Return to the main Raptor page Return to Faults page right|frame|Raptor Fault Action Read == Description ==…') |
No edit summary |
||
(3 intermediate revisions by 3 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]] | ||
[[File:RaptorFaultActionRead.jpg|right|frame| | [[File:RaptorFaultActionRead.jpg|right|frame|Raptor™ Fault Action Read]] | ||
== Description == | == Description == | ||
<p>This block reads the value of a fault action that has already been defined by a Fault Action block. This allows the fault action to be read in multiple locations in the model. A Raptor Fault Action block must exist in the model which defines the fault action.</p> | <p>This block reads the value of a fault action that has already been defined by a Fault Action block. This allows the fault action to be read in multiple locations in the model. A Raptor Fault Action block must exist in the model which defines the fault action.</p> | ||
<p>The output of this block is updated every time it executes as it does a complete search of all faults that might be triggering the specified action. This is more CPU intensive than the Raptor Fault Action block.</p> | |||
== Outputs == | == Outputs == | ||
Line 43: | Line 37: | ||
| Name of the fault action to read. Must be a valid C identifier. | | Name of the fault action to read. Must be a valid C identifier. | ||
|} | |} | ||
Latest revision as of 17:09, 13 September 2023
Return to the main Raptor page
Description
This block reads the value of a fault action that has already been defined by a Fault Action block. This allows the fault action to be read in multiple locations in the model. A Raptor Fault Action block must exist in the model which defines the fault action.
The output of this block is updated every time it executes as it does a complete search of all faults that might be triggering the specified action. This is more CPU intensive than the Raptor Fault Action block.
Outputs
Output | Type | Description |
---|---|---|
Active | boolean | Boolean which represents if any of the faults are in the states defined for this action. |
Fault | Index of fault which caused the action to be true |
Parameters
Parameter | Type | Description |
---|---|---|
Action Name | String | Name of the fault action to read. Must be a valid C identifier. |