it.unibo.alchemist.model.biochemistry.actions.RemoveJunctionInCell Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of alchemist-incarnation-biochemistry Show documentation
Alchemist incarnation for biochemistry simulator
There is a newer version: 35.0.2
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.biochemistry.actions;

import it.unibo.alchemist.model.biochemistry.molecules.Biomolecule;
import it.unibo.alchemist.model.biochemistry.molecules.Junction;
import it.unibo.alchemist.model.Environment;
import it.unibo.alchemist.model.Node;
import it.unibo.alchemist.model.Reaction;
import it.unibo.alchemist.model.biochemistry.CellProperty;
import org.apache.commons.math3.random.RandomGenerator;

import java.util.Map;
import java.util.Objects;

/**
 * Represent the action of removing a junction between the current node and a neighbor.
 * This action only remove the junction reference inside this node, the neighbor totally ignore 
 * that a junction has been removed.
 * This is a part of the junction removal process.
 * See {@link RemoveJunctionInNeighbor} for the other part of the process
 */
public final class RemoveJunctionInCell extends AbstractNeighborAction { // TODO try local

    private static final long serialVersionUID = 3565077605882164314L;

    private final Junction jun;
    private final Environment environment;
    private final CellProperty cell;

    /**
     * 
     * @param junction the junction
     * @param node the node where the action is performed
     * @param environment the environment
     * @param randomGenerator the random generator
     */
    public RemoveJunctionInCell(
            final Environment environment,
            final Node node,
            final Junction junction,
            final RandomGenerator randomGenerator
    ) {
        super(node, environment, randomGenerator);
        cell = Objects.requireNonNull(
                node.asPropertyOrNull(CellProperty.class),
                "This Action can be set only in nodes with " + CellProperty.class.getSimpleName()
        );
        declareDependencyTo(junction);
        for (final Map.Entry entry : junction.getMoleculesInCurrentNode().entrySet()) {
            declareDependencyTo(entry.getKey());
        }
        jun = junction;
        this.environment = environment;
    }

    @Override
    public RemoveJunctionInCell cloneAction(final Node node, final Reaction reaction) {
        return new RemoveJunctionInCell(environment, node, jun, getRandomGenerator());
    }

    /**
     * If no target node is given DO NOTHING. The junction can not be removed.
     */
    @Override
    public void execute() { }

    /**
     * Removes the junction that links the node where this action is executed and the target node. 
     */
    @Override
    public void execute(final Node targetNode) { 
        if (targetNode.asPropertyOrNull(CellProperty.class) != null) {
            cell.removeJunction(jun, targetNode);
        } else {
            throw new UnsupportedOperationException(
                "Can't remove Junction in a node with no " + CellProperty.class.getSimpleName()
            );
        }
    }

    @Override 
    public String toString() {
        return "remove junction " + jun.toString() + " in cell";
    }
}