Skip to main content

CycleManagerStepConfigurator

Short summary

A class to provide fluent access to the current step configuration of a cycle manager.

AccessAbstractFinalExtendsImplements
INTERNALNoNo-CNM_CycleManagerInterfaces.IStepConfiguration, CNM_CycleManagerInterfaces.IStopRequestConfiguration

UML Diagram

Parameters

none

Properties

cycleManager

Type: ICycleManagerStepParameters

Gets or sets the cycle manager step parameters interface used by this configurator.

errorStep

Type: DINT

This property sets the next step in case of an error.

pause

Type: CNM_CycleManagerInterfaces.IPauseConfiguration

Provides access to the pause configuration for the current cycle manager step.

stepping

Type: CNM_CycleManagerInterfaces.ISteppingConfiguration

Provides access to the stepping configuration for the current cycle manager step.

stepWidth

Type: DINT

Sets the step width for automatic step increment for the current step.

stopRequest

Type: CNM_CycleManagerInterfaces.IStopRequestConfiguration

Provides access to the stop request configuration interface for the current step.

timeout

Type: TIME

This property sets the maximum execution time for the current step.

timeoutStep

Type: DINT

This property sets the step that will be set if the current step reaches a timeout.

Methods

afterSuccessfulStep

  • Return type: VOID

Sets the stop request behavior to execute after successful step completion for the current step.

FB_Init

  • Parameters:
    • bInitRetains (BOOL): TRUE: the retain variables are initialized (reset warm / reset cold)
    • bInCopyCode (BOOL): TRUE: the instance will be copied to the copy code afterward (online change)
  • Return type: BOOL

code. You can evaluate the return value.methods explicitly and provide additional code there with the standard initializationThe return value is not evaluated. For a specific influence, you can also declare theFB_Init is always available implicitly and it is used primarily for initialization.## Short summary

ignore

  • Return type: VOID

Sets the stop request behavior to ignore all stop requests for the current step.

immediate

  • Return type: VOID

Sets the stop request behavior to always process stop requests immediately for the current step.

onBusy

  • Return type: VOID

This method sets the stop request behaviour to StepStopRequestMode.AFTER_NOT_SUCCESS.

Code

Declaration

FUNCTION_BLOCK INTERNAL CycleManagerStepConfigurator IMPLEMENTS CNM_CycleManagerInterfaces.IStepConfiguration, CNM_CycleManagerInterfaces.IStopRequestConfiguration
VAR
parameters :ICycleManagerStepParameters;
pauserator :CycleManagerStepPausing();
steperator :CycleManagerStepStepping();
END_VAR