it.unibo.alchemist.core.interfaces.DependencyGraph Maven / Gradle / Ivy

Go to download

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

Interfaces of core and model components of Alchemist

There is a newer version: 20.0.1

/*
 * Copyright (C) 2010-2019, Danilo Pianini and contributors listed in the main project's alchemist/build.gradle 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.core.interfaces;

import it.unibo.alchemist.model.interfaces.Node;
import it.unibo.alchemist.model.interfaces.Reaction;
import org.danilopianini.util.ListSet;

/**
 * This interface allows to separate the usage of a dependency graph from its
 * implementation.
 *
 * @param 
 *            The parametrization type for reactions
 */
public interface DependencyGraph {

    /**
     * Given two nodes, the graph assumes they are now neighbors and calculates the
     * neighborhood dependencies between them.
     *
     * @param n1
     *            The first node
     * @param n2
     *            The second node
     */
    void addNeighbor(Node n1, Node n2);

    /**
     * This method creates the dependencies when a new reaction is added to the
     * environment. Please be careful when building the environment and populating
     * the existing reactions map: this method assumes that all the dependencies
     * among the existing reactions are correct and up to date.
     *
     * @param rh
     *            the reaction handler whose dependencies should be calculated.
     */
    void createDependencies(Reaction rh);

    /**
     * This method removes all the dependencies (both in and out dependencies) for a
     * given reaction handler. This method is meant to be used in order to keep the
     * dependencies clean when removing a reaction.
     *
     * @param rh
     *            the reaction handler whose dependencies will be deleted.
     */
    void removeDependencies(Reaction rh);

    /**
     * Given two nodes, the engine assumes they are no longer neighbors and deletes
     * the neighborhood dependencies between them.
     *
     * @param n1
     *            The first node
     * @param n2
     *            The second node
     */
    void removeNeighbor(Node n1, Node n2);

    /**
     * Returns the set of reactions that may be influenced by the provided reaction.
     *
     * @param reaction the input reaction
     *
     * @return the set of reactions that may be influenced by the provided reaction
     *
     */
    ListSet> outboundDependencies(Reaction reaction);

    /**
     *
     * @return the set of all reactions with a {@link it.unibo.alchemist.model.interfaces.Context#GLOBAL} input context
     */
    ListSet> globalInputContextReactions();
}