Enum TuneOutcome 

pub enum TuneOutcome {
    Completed,
    Aborted,
    TimedOut,
    PoorQuality,
    ActuationFailed,
    WriteBackFailed,
    RestoreIncomplete,
}

The final disposition of a tune/simulate run – drives the printed summary (see [print_summary]) and, via crate::tune_outcome_exit_code in lib.rs, the process’s exit code.

Variants

Completed

The test completed. Either no write-back was requested/possible/attempted, or a requested write-back succeeded.

Aborted

The user pressed Ctrl+C; the loop was restored to its original mode/setpoint before returning.

TimedOut

[tuning].timeout_secs elapsed before the engine reported completion; the loop was restored to its original mode/setpoint before returning, exactly like TuneOutcome::Aborted but distinguished so a scheduler’s alerting can tell “this run had to be killed for running too long” apart from “an operator stopped it on purpose”.

PoorQuality

A driver reported a non-Good OPC quality for a tuning-critical reading – an initial reading (including the setpoint capture, when the loop starts in Auto) or an in-flight PV poll sample when the global Config > OPC quality policy rejects Uncertain (or with the policy enabled, but the quality was Bad rather than merely Uncertain) – and the run was aborted and the loop restored before returning, exactly like TuneOutcome::Aborted/TuneOutcome::TimedOut but distinguished so a scheduler’s alerting can tell “the plant data itself couldn’t be trusted” apart from either of those. See safety-quality in AGENTS.md.

ActuationFailed

An accepted OPC DA MV command could not be confirmed before its deadline or before the engine requested a replacement relay command. The loop was restored before returning unless TuneOutcome::RestoreIncomplete took precedence.

WriteBackFailed

The test itself completed, but writing the chosen PID parameters back to the DCS failed (rejected write, failed confirmation readback, or – defensively – a --write-pid level with no matching calculated result).

RestoreIncomplete

The run ended (via normal completion, Ctrl+C, or a timeout) without being able to confirm the loop was fully restored to its pre-test mode/MV/setpoint – a second Ctrl+C arrived while the restore was in flight, or [tuning].restore_timeout_secs elapsed first. The loop may still be sitting at a relay-test MV/mode; an operator must check it by hand using the tag/value named in the warning printed to stderr. See safety-cancellation in AGENTS.md.

Implementations

impl TuneOutcome

pub fn label(self) -> &'static str

A short machine-readable label, used in the --output json summary.

Trait Implementations

impl Clone for TuneOutcome

fn clone(&self) -> TuneOutcome

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for TuneOutcome

impl Debug for TuneOutcome

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Eq for TuneOutcome

impl PartialEq for TuneOutcome

fn eq(&self, other: &TuneOutcome) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for TuneOutcome