KSLCore/ksl.utilities.random.rvariable.parameters/RVParameterData

RVParameterData

@Serializable

data class RVParameterData(val clazzName: String, val elementId: Int, val dataType: String, val rvName: String, val paramName: String, val paramValue: Double, val parentElementName: String? = null, val parentElementId: Int? = null, val parentElementType: String? = null, val elementPath: List<String> = emptyList())(source)

A data transfer class holding the information about a random variable's parameters. Used primarily to store the data within the KSL database.

The trailing parentElement* fields and elementPath surface the random variable's location in the model element tree, parallel to the hierarchy fields on ksl.controls.ControlData. GUI consumers (e.g. an RV-overrides panel) can render an Owner column and group by parent without re-walking the model graph. Populated by RVParameterSetter.extractParameters; all four default so older snapshots predating the fields still deserialize cleanly.

Constructors

RVParameterData

constructor(clazzName: String, elementId: Int, dataType: String, rvName: String, paramName: String, paramValue: Double, parentElementName: String? = null, parentElementId: Int? = null, parentElementType: String? = null, elementPath: List<String> = emptyList())

Properties

clazzName

val clazzName: String

runtime class name of the parameterized random variable (e.g. "ExponentialRV").

dataType

val dataType: String

"DOUBLE" or "INTEGER" — the expected type of paramValue when the parameter is set back.

elementId

val elementId: Int

id of the random variable itself (RandomVariable.id, not the owner's id).

elementPath

val elementPath: List<String>

ancestor names from the model root down to (but not including) the owning element, also excluding the Model itself. Empty when the owner is a direct child of the Model.

paramName

val paramName: String

parameter key on the parameterized RV (e.g. "mean").

paramValue

val paramValue: Double

current parameter value at snapshot time.

parentElementId

val parentElementId: Int?

id of the owning model element.

parentElementName

val parentElementName: String?

name of the model element that owns the random variable (its parent). null only if the RV's parent could not be resolved (the Model itself is reported as the parent for top-level RVs, mirroring the controls convention).

parentElementType

val parentElementType: String?

simple class name of the owning model element.

rvName

val rvName: String

the random variable's name as registered in the model.