ISingleExecutionCycleManager

Short summary

An interface to provide simple cycle management for steps in state machines.

Access	Abstract	Final	Extends	Implements
-	No	No	CNM_AbstractObject.IObject, CNM_AssertionInterfaces.IAssertor, ICycleError, ICycleSteps, ICycleManagerConfiguration	-

UML Diagram

Properties

errors

Type: ICycleError

This property returns an ICycleError interface fluently to provide error handling methods.…

executeStep

Type: BOOL

This property returns the execute flag for the current step, …

state

Type: CNM_ReturnTypes.SingleExecutionState

This property returns the current state of the cycle manager according to its step.…

step

Type: ICycleSteps

This property returns the current, next and last step of the cycle manager via fluent interface with the ICycleSteps interfaces…

Methods

enter

• Parameters:
  • invoke (CNM_CommandInterfaces.ISingleAttempt): command to execute
  • errorStep (DINT): step to proceed with in case of error
• Return type: VOID

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

evaluate

• Parameters:
  • state (CNM_ReturnTypes.SingleExecutionState): the state which is to be evaluated
  • errorStep (DINT): step to proceed with in case of error
• Return type: VOID

This method evaluates an execution state to calculate the next step.…

executeCommand

• Parameters:
  • command (CNM_CommandInterfaces.ICommand): command to execute
  • errorStep (DINT): step to proceed with in case of error
• Return type: VOID

This method performs the given command and evaluates the return value.…

leave

• Parameters:
  • invoke (CNM_CommandInterfaces.ISingleAttempt): command to execute
  • errorStep (DINT): step to proceed with in case of error
  • forceOnError (BOOL): whether the attempt should be called even if there was an error in the current step
• Return type: VOID

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

proceed

• Return type: VOID

This method changes the current step in the cycle manager to the next in order (current + stepWidth) .…

proceedWith

• Parameters:
  • step (DINT): step to move to
• Return type: VOID

This method changes the current step in the cycle manager to the given step.…

update

• Parameters:
  • execute (BOOL): control bit to start or abort the cycle manager
  • stopRequest (BOOL): used for StopRequest evaluation if configured
  • pause (BOOL): if true and Pausing Enabled and busy will proceed with PAUSE
  • resume (BOOL): if true, will acknowledge error and return to previous step
  • stepControl (BOOL): must be TRUE if stepping is enabled to proceed steps automatically
• Return type: VOID

This method updates the current state and current step of the cycle manager. …

waitFor

• Parameters:
  • value (BOOL): the value to wait for
• Return type: VOID

This method waits for a boolean signal until the step can be changed.…

Code

Declaration

INTERFACE ISingleExecutionCycleManager 
EXTENDS CNM_AbstractObject.IObject, 
	CNM_AssertionInterfaces.IAssertor, 
	ICycleError, 
	ICycleSteps, 
	ICycleManagerConfiguration