it.unibo.alchemist.model.cognitive.actions.AbstractLayerAction.kt Maven / Gradle / Ivy

Go to download

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

Abstraction for group of pedestrians capable of influence each other emotionally.

There is a newer version: 35.0.0

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.cognitive.actions

import it.unibo.alchemist.model.Layer
import it.unibo.alchemist.model.Molecule
import it.unibo.alchemist.model.Node
import it.unibo.alchemist.model.Position
import it.unibo.alchemist.model.Reaction
import it.unibo.alchemist.model.cognitive.PedestrianProperty
import it.unibo.alchemist.model.environments.Euclidean2DEnvironment
import it.unibo.alchemist.model.geometry.Euclidean2DTransformation
import it.unibo.alchemist.model.layers.BidimensionalGaussianLayer
import it.unibo.alchemist.model.positions.Euclidean2DPosition

/**
 * Abstract implementation of an action influenced by the concentration of a given molecule in the environment.
 *
 * @param environment
 *          the environment inside which the node moves.
 * @param reaction
 *          the reaction which executes this action.
 * @param pedestrian
 *          the owner of this action.
 * @param targetMolecule
 *          the {@link Molecule} you want to know the concentration in the different positions of the environment.
 */
abstract class AbstractLayerAction(
    protected val environment: Euclidean2DEnvironment,
    reaction: Reaction,
    override val pedestrian: PedestrianProperty,
    protected val targetMolecule: Molecule,
) : AbstractSteeringAction(environment, reaction, pedestrian) {

    abstract override fun cloneAction(node: Node, reaction: Reaction): AbstractLayerAction

    /**
     * @returns the layer containing [targetMolecule] or fails.
     */
    protected fun getLayerOrFail(): Layer = environment.getLayer(targetMolecule)
        .orElseThrow { IllegalStateException("no layer containing $targetMolecule") }

    /**
     * @returns the center of the layer or null if there's no center.
     */
    protected fun Layer<*, Euclidean2DPosition>.center(): Euclidean2DPosition? =
        (this as? BidimensionalGaussianLayer)?.let { environment.makePosition(it.centerX, it.centerY) }

    /**
     * @returns the concentration of the layer in the given [position].
     */
    protected fun > Layer.concentrationIn(position: P): Double =
        getValue(position).toDouble()
}