KSLCore/ksl.simulation/ExperimentIfc

ExperimentIfc

interface ExperimentIfc : ExperimentRunParametersIfc(source)

Inheritors

Properties

Link copied to clipboard
open val currentReplicationId: Int

The identifier for the current replication. Each replication in the set of replications for the experiment has a unique identifier. This returns the identifier for the current replication. An identifier of 0 represents that no replications have been run

Link copied to clipboard
abstract val currentReplicationNumber: Int

The current number of replications that have been run for this experiment

Link copied to clipboard
abstract var experimentalControls: Map<String, Double>

Holds values for each controllable parameter of the simulation model.

Link copied to clipboard
abstract val repIdRange: IntRange

The range of replication identifiers for the experiment based on the starting replication identifier and the number of replications to be executed.

Link copied to clipboard
abstract var runErrorMsg: String

Functions

Link copied to clipboard
abstract fun changeRunParameters(runParameters: ExperimentRunParametersIfc)

Changes the experiment run parameters for the experiment. This does not include the current number of replications or the experiment's id. Any property in ExperimentRunParametersIfc may be changed.

Link copied to clipboard
abstract fun experimentInstance(): Experiment

Returns a new Experiment based on this experiment.

Link copied to clipboard
open fun extractRunParameters(): ExperimentRunParameters

Extracts a data class representing the experiment's run parameters

Link copied to clipboard
Link copied to clipboard
abstract fun hasMoreReplications(): Boolean

Checks if the current number of replications that have been executed is less than the number of replications specified.

Link copied to clipboard
abstract fun numberOfReplications(numReps: Int, antitheticOption: Boolean)

Sets the desired number of replications for the experiment