OptimizationPassCompletedEventArgs.Pass

property · OptimizationPassCompletedEventArgs · cAlgo.API Since 5.9

DesktopCLICloud

Gets the pass that completed.

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

C#Python

public OptimizationPass Pass {get;}

optimizationPassCompletedEventArgs.Pass: OptimizationPass

Returns OptimizationPass

Examples

C#Python

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

private void OnPassCompleted(OptimizationPassCompletedEventArgs args)
{
    var pass = args.Pass;
    Print("Pass {0}: fitness {1}, profit factor {2}", pass.Id, pass.Fitness, pass.ProfitFactor);
}

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

def on_pass_completed(self, args):
    optimizationPass = args.Pass
    api.Print(f"Pass {optimizationPass.Id}: fitness {optimizationPass.Fitness}, profit factor {optimizationPass.ProfitFactor}")