com.justai.jaicf.model.scenario.Scenario.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of core Show documentation

JAICF-Kotlin Core component. Provides DSL, Tests API and multiple implementable interfaces.

There is a newer version: 1.3.8

package com.justai.jaicf.model.scenario

import kotlin.reflect.KProperty

/**
 * Main interface for Scenario objects.
 *
 * Scenario objects should be generally created by using [com.justai.jaicf.builder.Scenario] function.
 * Alternative way for creating a scenario is by implementing this interface, see example:
 * ```kotlin
 * class MyScenario() : Scenario {
 *   override val model: ScenarioModel = createModel {
 *     // your states
 *     }
 * }
 *
 * ```
 *
 * @property model model of scenario
 *
 * @see [com.justai.jaicf.builder.Scenario]
 * @see [com.justai.jaicf.builder.createModel]
 * */
interface Scenario {
    val model: ScenarioModel
}

operator fun Scenario.getValue(thisRef: Scenario, property: KProperty<*>): ScenarioModel = model