it.unibo.alchemist.model.actions.ToggleMolecule.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of alchemist-implementationbase Show documentation

Abstract, incarnation independent implementations of the Alchemist's interfaces. Provides support for those who want to write incarnations.

There is a newer version: 35.0.1

Show newest version

/*
 * Copyright (C) 2010-2023, Danilo Pianini and contributors
 * listed, for each module, in the respective subproject's build.gradle.kts file.
 *
 * This file is part of Alchemist, and is distributed under the terms of the
 * GNU General Public License, with a linking exception,
 * as described in the file LICENSE in the Alchemist distribution's top directory.
 */
package it.unibo.alchemist.model.actions

import it.unibo.alchemist.model.Context
import it.unibo.alchemist.model.Molecule
import it.unibo.alchemist.model.Node
import it.unibo.alchemist.model.Reaction

/**
 * Treats [molecule] as a switch:
 * * if it is present, then it's removed from [node];
 * * otherwise, it is inserted in [node] with the provided [concentration].
 */
open class ToggleMolecule(
    node: Node,
    protected val molecule: Molecule,
    protected val concentration: T,
) : AbstractAction(node) {
    override fun cloneAction(node: Node, reaction: Reaction) = ToggleMolecule(node, molecule, concentration)

    /**
     * Toggles concentration.
     */
    override fun execute() = if (isOn()) switchOff() else switchOn()

    /**
     * Returns true if it is on, already toggled.
     */
    protected fun isOn() = node.contains(molecule)

    /**
     * Switch off the molecule, or remove it.
     */
    private fun switchOff() = node.removeConcentration(molecule)

    /**
     * Switch on the molecule and set its concentration.
     */
    private fun switchOn() = node.setConcentration(molecule, concentration)

    override fun getContext() = Context.LOCAL
}