runner-api/dev.ust.zinc.grader.pipeline.local/Score

Score

class Score(val config: Score.Config) : LocalPipelineStage, Reportable

Pipeline stage for accumulating scores to report

Parameters

config

The configuration to instantiate this class.

Constructors

Score

constructor(config: Score.Config)

Types

Config

data class Config(val normalizedTo: Double?, val minScore: Double?, val maxScore: Double?) : ConfigUnit

Report

data class Report(val _score: Double, val _gradedTotal: Double, val _maxTotal: Double) : StageReportUnit

Properties

_runner

protected lateinit var _runner: Runner

className

open val className: String

The class name of this pipeline stage.

config

open override val config: Score.Config

configKeySrc

val configKeySrc: String?

The key of the configuration which instantiated this stage.

hasTimedOut

protected var hasTimedOut: Boolean

Whether this stage has timed out.

inType

val inType: KClass<out StageResult>

logger

protected val logger: Logger

maxScore

private val maxScore: Double

minScore

private val minScore: Double

normalizedTo

private val normalizedTo: Double?

outType

val outType: KClass<out StageResult>

parserContext

protected var parserContext: ConfigParsable.Context?

The context of the configuration parser associated with instantiating this stage.

pipelinePath

val pipelinePath: String

The unique stage name of this pipeline stage.

reportUnit

open override val reportUnit: Score.Report?

runner

open val runner: Runner

scoreGenerator

open val scoreGenerator: Lazy<ScoreGenerator>?

The ScoreGenerator for this stage.

scoreUnits

open override val scoreUnits: List<ScoreReportUnit>

traceableState

open override val traceableState: AtomicReference<TraceableState<PipelineStage.ExecStateData, Unit>>

Functions

execute

protected open suspend override fun execute(input: StageResult): StageResult

Implementation for executing this pipeline.

execWithInput

suspend fun execWithInput(input: StageResult): StageResult

Executes this pipeline stage using input.

markStageAsTimedOut

protected fun markStageAsTimedOut()

Marks this stage as having timed out.

onExecComplete

@MustBeInvokedByOverriders

protected open suspend fun onExecComplete()

Callback method to run when execute method completes, regardless of whether it succeeds or fails.

onExecFailed

protected fun onExecFailed(tr: Throwable)

Callback method to run when the execute method fails.

onExecFailedImpl

protected open override fun onExecFailedImpl(tr: Throwable)

Implementation for when the execute method fails.

onInitParserContext

protected open fun onInitParserContext(configContext: ConfigParsable.Context)

Implementation when parser context is provided to the stage.

putParserContext

fun putParserContext(configContext: ConfigParsable.Context)

Provides the parser context to this pipeline stage.

putRunner

fun putRunner(runner: Runner)

Puts the context of the Runner into this pipeline stage.