Skip to main content

defaultRequireSuccessStep

Short summary​

Specifies whether the SUCCESS step of the state machine can be skipped when the transition condition to SUCCESS is already fulfilled.

When set to false, the state machine immediately returns SUCCESS as soon as the transition condition to the SUCCESS state is met, without executing the dedicated SUCCESS step. This optimization can save one execution cycle per state machine invocation, which is especially beneficial in nested or complex state machine structures.

When set to true, the SUCCESS step will always be executed at least once before the state machine returns SUCCESS. This is required in cases where the SUCCESS step performs essential actions (e.g., resetting outputs, logging, or cleanup).

The default value is false.

Use Case: Use false when the SUCCESS step has no functional side effects and skipping it can improve performance. Use true when the SUCCESS step contains logic that must be executed explicitly.

  • Type: BOOL
  • Getter: public
  • Setter: public

Code​

Declaration​

PROPERTY defaultRequireSuccessStep : BOOL