MODAAnalyzerData

data class MODAAnalyzerData(val responseName: String, val direction: MetricIfc.Direction = MetricIfc.Direction.SmallerIsBetter, var weight: Double = 1.0, val valueFunction: ValueFunctionIfc = LinearValueFunction(), val domain: Interval = Interval(0.0, Double.MAX_VALUE), var unitsOfMeasure: String? = null, var description: String? = null)

Parameters

responseName

the name of the response or counter to be included in the analysis

direction

the indication of the direction of value that provides the context for evaluation based on the response value, with two cases: 1) bigger values are considered better or 2) smaller values are considered better. The default is SmallerIsBetter.

weight

thw swing weight associated with the response. The default is 1.0. The weights are normalized to ultimately be between 0 and 1. A common equal weight will lead to equal weighting of the responses.

valueFunction

the value function associated with the response. The default is a linear value function.

domain

an interval that specifies the set of possible values for the response. The default is 0.0 to Double.Max_Value. If the lower limit or upper limit of the domain is negative infinity, positive infinity, -Double.MAX_VALUE, or Double.MAX_VALUE then the limits will be respecified based on available data.

unitsOfMeasure

an optional description of the units of measure for the response

description

an optional narrative explanation of the response

Constructors

Link copied to clipboard
constructor(responseName: String, direction: MetricIfc.Direction = MetricIfc.Direction.SmallerIsBetter, weight: Double = 1.0, valueFunction: ValueFunctionIfc = LinearValueFunction(), domain: Interval = Interval(0.0, Double.MAX_VALUE), unitsOfMeasure: String? = null, description: String? = null)

Properties

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard