Skip to main content

step

Short summary​

Provides access to step-specific configuration for individual cycle manager steps.

Purpose and usage​

This property returns the step configuration interface that allows setting parameters for specific steps in the cycle manager. It provides a fluent interface for configuring individual step behavior that overrides the sequence defaults.

The step configuration allows fine-grained control over individual steps including:

  • Step-specific timeouts
  • Individual pause behavior
  • Custom stepping settings
  • Step-specific stop handling

typical usage patterns​

  1. Step-specific timeouts: Override default timeout for critical steps
  2. Disable pause: Prevent pausing on critical operation steps
  3. Skip stepping: Make certain steps non-steppable in debug mode
  4. Custom behavior: Define unique behavior for specific steps

When to use​

  • When specific steps need different behavior than the sequence default
  • For critical steps that should not be pausable or steppable
  • To set custom timeouts for long-running operations
  • When implementing step-specific error handling

Example​

// Configure specific step with custom timeout
cycleManager.configuration.configuration.step
    .forStep(MySteps.LONG_OPERATION)
    .setTimeout(T#30S)
    .pauseAllowed(FALSE);  // Critical step - no pause allowed

// Configure multiple steps
cycleManager.configuration.configuration.step
    .forStep(MySteps.INIT)
    .setTimeout(T#5S)
    .steppingAllowed(TRUE);

cycleManager.configuration.configuration.step
    .forStep(MySteps.CRITICAL_PROCESS)
    .setTimeout(T#10S)
    .pauseAllowed(FALSE)
    .stopAllowed(FALSE);  // Must complete once started

// Configure error step
cycleManager.configuration.configuration.step
    .forStep(DefaultSteps.STEP.ERROR)
    .setTimeout(T#0S)  // No timeout in error state
    .steppingAllowed(TRUE);  // Allow stepping through error handling

Code​

Declaration​

PROPERTY step : CNM_CycleManagerInterfaces.IStepConfiguration