leave

Short summary

This method performs the given invoke only in the last cycle of the current step.

Parameters

Name	Type	Comment	Kind
invoke	CNM_CommandInterfaces.ISingleAttempt	command to execute	input
errorStep	DINT	step to proceed with in case of error	input
forceOnError	BOOL	whether the invoke should be called even if there was an error in the current step	input

Code

Declaration

METHOD leave
VAR_INPUT
	(* command to execute *)
	invoke	:CNM_CommandInterfaces.ISingleAttempt;
	(* step to proceed with in case of error *)
	errorStep	:DINT := CNM_ReturnTypes.DefaultSteps.STEP.ERROR; 
	(* whether the invoke should be called even if there was an error in the current step *)
	forceOnError	:BOOL := FALSE;
END_VAR

Implementation

THIS^.registeredLeave := TRUE;

RETURN ((
			((NOT wasSuccess) OR_ELSE THIS^.wasNotSuccess) 
		AND 
			NOT(forceOnError AND THIS^.wasError)
		) 
	OR 
		THIS^.state <> CNM_ReturnTypes.SingleExecutionState.BUSY
);

IF(THIS^.isObjectNull(invoke) OR_ELSE invoke.invoke() <> CNM_ReturnTypes.SingleExecutionResult.SUCCESS)THEN
	THIS^.evaluate(CNM_ReturnTypes.SingleExecutionState.ERROR, errorStep);	
END_IF