Skip to content

OptimizationPassCompletedEventArgs

record cAlgo.API Since 5.9

DesktopCLICloud

Provides data for the optimization pass completed event.

Environment behaviour

CLI — not supported. Available to plugins only, and plugins cannot run in the CLI.

Cloud — not supported. Available to plugins only, and plugins cannot run in the cloud.

Definition

public class OptimizationPassCompletedEventArgs

Namespace: cAlgo.API · Group: Optimization

Examples

protected override void OnStart()
{
    Optimization.PassCompleted += OnPassCompleted;
}

private void OnPassCompleted(OptimizationPassCompletedEventArgs args)
{
    Print("Pass {0} done, {1} passes completed so far", args.Pass.Id, args.Process.Passes.Count);
}

def on_start(self):
    api.Optimization.PassCompleted += self.on_pass_completed

def on_pass_completed(self, args):
    api.Print(f"Pass {args.Pass.Id} done, {args.Process.Passes.Count} passes completed so far")

Constructors

Name Description
OptimizationPassCompletedEventArgsDesktopCLICloud

Properties

Name Description
PassDesktopCLICloudOptimizationPass Gets the pass that completed.
ProcessDesktopCLICloudOptimizationProcess Gets the optimization process that produced the pass.

See also