it.unibo.alchemist.model.sapere.actions.SAPEREChemotaxis Maven / Gradle / Ivy

Go to download

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

Alchemist incarnation for SAPERE

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.sapere.actions;

import it.unibo.alchemist.model.Environment;
import it.unibo.alchemist.model.sapere.ILsaMolecule;
import it.unibo.alchemist.model.sapere.ILsaNode;
import it.unibo.alchemist.model.Position;

import java.util.List;

/**
 *         This class provides a chemotaxis implementation for SAPERE, namely,
 *         an agent able to move a molecule towards a specific node.
 *
 * @param  position type
 */
public final class SAPEREChemotaxis
> extends SAPERENeighborAgent {

    private static final long serialVersionUID = -4845100315774422690L;
    private final int idPosition;
    private final ILsaMolecule response;
    private final ILsaMolecule gradient;

    /**
     * Builds a new SAPEREChemotaxis.
     * 
     * @param environment
     *            the environment
     * @param node
     *            the node
     * @param response
     *            the molecule to move
     * @param gradient
     *            the molecule template that, once matched, will contain the
     *            node ID where move the molecule
     * @param idPosition
     *            the argument number where to search for the node ID
     */
    public SAPEREChemotaxis(
            final Environment, P> environment,
            final ILsaNode node,
            final ILsaMolecule response,
            final ILsaMolecule gradient,
            final int idPosition
    ) {
        super(environment, node, response);
        /*
         * Thanks Java, for not having unsigned primitives! -.-
         */
        assert idPosition >= 0 : "Argument number must be positive";
        this.response = response;
        this.gradient = gradient;
        this.idPosition = idPosition;
    }

    @Override
    public void execute() {
        final int nodeId = getLSAArgumentAsInt(gradient, idPosition);
        final ILsaNode dest = (ILsaNode) getEnvironment().getNodeByID(nodeId);
        allocateAndInject(response, dest);
    }

}