stopRequest

Short summary

Provides access to the stop request configuration interface.

Purpose and usage

This property returns the stop request configuration interface, providing access to methods that configure how the cycle manager handles stop requests. The configurator itself implements the IStopRequestConfiguration interface.

Available configuration modes:

• always(): Process stop requests immediately
• afterSuccess(): Process after successful step completion
• afterNotSuccess(): Process after unsuccessful step completion
• ignore(): Ignore all stop requests

typical usage patterns

1. Fluent configuration: Chain stop configuration methods
2. Mode selection: Choose appropriate stop handling
3. Dynamic configuration: Change modes during runtime
4. Safety configuration: Set safe stop behavior

When to use

• To configure stop request handling behavior
• When implementing different stop strategies
• For safety-critical stop configurations
• During mode-dependent stop handling

Example

// Configure stop after success
cycleManager.configuration.configuration.sequence
    .stopRequest
    .afterSuccess();

// Configure immediate stop
cycleManager.configuration.configuration.sequence
    .stopRequest
    .always();

// Chain with other configurations
cycleManager.configuration.configuration.sequence
    .timeout := T#10S;
    .stopRequest.afterSuccess();
    .pause.enabled(TRUE);

// Dynamic configuration based on mode
IF emergencyMode THEN
    cycleManager.configuration.configuration.sequence
        .stopRequest.always();
ELSE
    cycleManager.configuration.configuration.sequence
        .stopRequest.afterSuccess();
END_IF;

• Type: CNM_CycleManagerInterfaces.IStopRequestConfiguration
• Getter: public

Code

Declaration

PROPERTY stopRequest : CNM_CycleManagerInterfaces.IStopRequestConfiguration