Skip to main content

ICycleError

Short summary

An interface to provide error handling in cycle management.

AccessAbstractFinalExtendsImplements
-NoNo__System.IQueryInterface-

UML Diagram

Properties

isInErrorStep

Type: BOOL

This property returns TRUE if the step was reached by evaluating an error.

Methods

acknowledge

  • Return type: VOID

This method acknowledges an error in the cycle manager

handle

  • Parameters:
    • alarm (CNM_MessageInterfaces.IAlarm): the alarm event that should be thrown
    • resumeWithLastStep (BOOL): if this flag is set AND we got to the current step because of an ERROR state, then the cyclemanager will automatically will go back to the last step
  • Return type: VOID

This method throws an alarm and waits for it to be confirmed.

Code

Declaration

INTERFACE ICycleError EXTENDS __System.IQueryInterface