net.sourceforge.cilib.algorithm.AlgorithmEvent Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of cilib-library Show documentation

A library of composable components enabling simpler Computational Intelligence

There is a newer version: 0.8

/**           __  __
 *    _____ _/ /_/ /_    Computational Intelligence Library (CIlib)
 *   / ___/ / / / __ \   (c) CIRG @ UP
 *  / /__/ / / / /_/ /   http://cilib.net
 *  \___/_/_/_/_.___/
 */
package net.sourceforge.cilib.algorithm;

/**
 * This is the event raised by algorithms after iterations and completion.
 *
 * See {@see AlgorithmListener}
 *
 */
public class AlgorithmEvent {

    /**
     * Creates a new instance of AlgorithmEvent with a given source algorithm.
     *
     * @param source The source {@link Algorithm}.
     */
    public AlgorithmEvent(Algorithm source) {
        this.source = source;
    }

    /**
     * Accessor for the source algorithm.
     *
     * @return The {@link Algorithm} that raised this event.
     */
    public Algorithm getSource() {
        return source;
    }

    private Algorithm source;
}