it.unibo.alchemist.model.movestrategies.TargetSelectionStrategy 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.movestrategies;

import java.io.Serializable;

import it.unibo.alchemist.model.Node;
import it.unibo.alchemist.model.Position;
import it.unibo.alchemist.model.Reaction;

/**
 * This interface models a strategy for selecting positions where to move.
 *
 * @param  Concentration type
 * @param  Position type
 */
@FunctionalInterface
public interface TargetSelectionStrategy> extends Serializable {

    /**
     * @return the next target where the {@link Node} is directed
     */
    P getTarget();

    /**
     * @param destination the {@link Node} where the strategy is being cloned
     * @param reaction the {@link Reaction} where strategy is being cloned
     *
     * @return A copy of the strategy if the strategy is stateful, and this object otherwise.
     * The default implementation assumes a stateless strategy.
     */
    default TargetSelectionStrategy cloneIfNeeded(final Node destination, final Reaction reaction) {
        return this;
    }
}