1 files changed, 46 insertions, 0 deletions
diff --git a/opendc-harness/src/main/kotlin/org/opendc/harness/api/Scenario.kt b/opendc-harness/src/main/kotlin/org/opendc/harness/api/Scenario.kt
new file mode 100644
index 00000000..a8dbf01e
--- /dev/null
+++ b/opendc-harness/src/main/kotlin/org/opendc/harness/api/Scenario.kt
@@ -0,0 +1,46 @@
+/*
+ * Copyright (c) 2021 AtLarge Research
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+package org.opendc.harness.api
+
+/**
+ * A [Scenario] represents a single point in the design space of an experiment.
+ */
+public interface Scenario {
+    /**
+     * A unique identifier that identifies a single scenario.
+     */
+    public val id: Int
+
+    /**
+     * The [ExperimentDefinition] describing the experiment this scenario is part of.
+     */
+    public val experiment: ExperimentDefinition
+
+    /**
+     * Obtain the instantiated value for a [parameter][param] of the experiment.
+     *
+     * @param param The parameter to obtain the value of.
+     * @throws IllegalArgumentException if [param] is not defined for the experiment.
+     */
+    public operator fun <T> get(param: Parameter<T>): T
+}