KSLCore/ksl.utilities.moda/MetricIfc

MetricIfc

A performance metric is figure of merit that characterizes the performance of a device, system, method, or entity, relative to its alternatives.

A metric has a required name to help identify it and an optional description to provide context for the metric. The domain of the metric represents the natural set of possible (real) legal values for its values. The default interval for the domain is 0.0 to positive infinity. The direction provides the context for evaluation based on the metric value, with two cases:

bigger values are considered better or 2) smaller values are considered better. The default direction is bigger is better. The metric can have a description of its units of measure unitsOfMeasure.

Inheritors

Metric

Types

Direction

enum Direction : Enum<MetricIfc.Direction>

Properties

allowLowerLimitAdjustment

abstract val allowLowerLimitAdjustment: Boolean

Indicates if the lower limit of the domain may be adjusted during scaling processes

allowUpperLimitAdjustment

abstract val allowUpperLimitAdjustment: Boolean

Indicates if the upper limit of the domain may be adjusted during scaling processes

description

abstract val description: String?

direction

abstract val direction: MetricIfc.Direction

domain

abstract val domain: Interval

name

abstract val name: String

unitsOfMeasure

abstract val unitsOfMeasure: String?

Functions

badScore

open fun badScore(): Score

Returns a valid score that has the worst possible value according to the direction of the meaning of better.

metricData

open fun metricData(modaName: String, weight: Double): MetricData

Returns an instance of MetricData based on (modaName, weight), recording this metric's own domain. This is what a metric considered on its own should report.

open fun metricData(modaName: String, weight: Double, reportedDomain: Interval): MetricData

Returns an instance of MetricData based on (modaName, weight), recording the supplied domain.

newInstance

abstract fun newInstance(): MetricIfc