KSLCore/ksl.simopt.evaluator/RequestData

RequestData

@Serializable

data class RequestData(val modelIdentifier: String, var numReplications: Int, val inputs: Map<String, Double> = emptyMap(), val responseNames: Set<String> = emptySet(), val experimentRunParameters: ExperimentRunParameters? = null, val modelConfiguration: Map<String, String>? = null, val requestTime: Instant = Clock.System.now())

The data associated with a request for a simulation evaluation.

Parameters

modelIdentifier

the model identifier associated with the simulation model that will be executed

numReplications

the number of replications to run the model. Must be greater than 0. This value will override a specification for the number of replications supplied by any experimental run parameters.

inputs

The input variable and its value for parameterizing the run of the simulation. If empty, the current values for the inputs will be used for the simulation.

responseNames

the names of the response variables requested from the simulation results. If no response names are provided, then all responses from the simulation will be returned. The default is all responses from the model.

experimentRunParameters

an optional set of simulation run parameters for application to the model. If not supplied, then the model's current (default) settings will be used.

requestTime

the instant that the request was constructed

Constructors

RequestData

constructor(modelIdentifier: String, numReplications: Int, inputs: Map<String, Double> = emptyMap(), responseNames: Set<String> = emptySet(), experimentRunParameters: ExperimentRunParameters? = null, modelConfiguration: Map<String, String>? = null, requestTime: Instant = Clock.System.now())

Properties

experimentRunParameters

val experimentRunParameters: ExperimentRunParameters? = null

inputs

val inputs: Map<String, Double>

inputValues

val inputValues: DoubleArray

The values of the input parameters as an array. The order of the array is based on the order of the input variables in the map of input variables.

modelConfiguration

val modelConfiguration: Map<String, String>? = null

modelIdentifier

val modelIdentifier: String

numReplications

var numReplications: Int

requestTime

val requestTime: Instant

responseNames

val responseNames: Set<String>

startingReplicationNum

var startingReplicationNum: Int

Since requests may cover portions of an experiment that has multiple replication, the starting replication number may be some number between 1 and the total number of replications in the experiment. The chunking process may set the starting replication number to the starting replication of the chunk of replications.

Functions

equals

open operator override fun equals(other: Any?): Boolean

Equals is based on modelIdentifier, inputs, and response names all being the same.

hashCode

open override fun hashCode(): Int

maxOfReplication

fun maxOfReplication(numReps: Int)

Sets the number of requested replications to the maximum of the supplied numReps or the current setting for the number of requested replications.