◆ AmpFaultActionGet()

virtual RSIAction AmpFaultActionGet ( )
pure virtual

Get the Amp Fault action.

ℹ This function is avaliable in RapidCode and RapidSequencer

Part of the Limits and Action Configuration method group.

Description:
AmpFaultActionGet returns the action which will occur when an Amp Fault is triggered.
Returns
(RSIAction) Action taken on Amp Fault event.
Note:
Available Actions are Abort(), EStop(), Stop(), None, EStopAbort(), and EStopModify()
Sample Code:
ConfigAmpFault
//---ARRANGE---
const double AMP_FAULT_DURATION_TIME = 1; //value in seconds
//---ACT---
axis.AmpEnableSet(false); // Disable the amp
axis.AmpFaultActionSet(RSIAction.RSIActionABORT); // Set the action that will occur when there is an amp fault.
axis.AmpFaultTriggerStateSet(false); //Set the state of the amp fault.
axis.AmpFaultDurationSet(AMP_FAULT_DURATION_TIME); //Set the duration required before the Amp Fault event triggers.
//---ASSERT---
Assert.That(axis.AmpEnableGet(), Is.EqualTo(false), "The getter function should return a value equal to false");
Assert.That(axis.AmpFaultActionGet(), Is.EqualTo(RSIAction.RSIActionABORT), "The getter function should return a value equal to RSIActionABORT");
Assert.That(axis.AmpFaultTriggerStateGet(), Is.EqualTo(false), "The getter function should return a value equal to false");
Assert.That(axis.AmpFaultDurationGet(), Is.EqualTo(AMP_FAULT_DURATION_TIME), "The getter function should return a value equal to AMP_FAULT_DURATION_TIME");
RapidSetup:
Go to axis screen->Limits & Actions. In image below, AmpFaultActionGet returns the action type shown in the Amp Fault box. It is currently set to ABORT.
Limits_Actions.jpg
See also
AmpFaultActionSet