KSLCore/ksl.simopt.solvers.trackers/AbstractSolverStateTracker

AbstractSolverStateTracker

abstract class AbstractSolverStateTracker(val solver: Solver)(source)

An abstract base class that autonomously tracks a Solver's state and lifecycle. It remains permanently attached to the solver, allowing it to record multiple subsequent runs seamlessly without user intervention.

Parameters

solver

The solver whose emitters we want to track.

Inheritors

ConsoleSolverStateTracker

CsvSolverStateTracker

DataFrameSolverStateTracker

Constructors

AbstractSolverStateTracker

constructor(solver: Solver)

Properties

experimentName

var experimentName: String

solver

protected val solver: Solver

trackingContext

protected val trackingContext: TrackingContext

Functions

consume

protected abstract fun consume(snapshot: SolverStateSnapshot)

Defines how the concrete tracker handles the mathematical state payload.

onLifecycleEvent

protected open fun onLifecycleEvent(status: SolverStatus)

Optional hook for subclasses to react to lifecycle changes (e.g., opening/closing files on INITIALIZED/COMPLETED).

startTracking

fun startTracking()

Attaches this tracker to the solver's emitters.

stopTracking

fun stopTracking()

Safely detaches from the solver's emitters. In the continuous tracking architecture, this is usually only called manually if the user explicitly wants to silence the tracker.