it.unibo.alchemist.model.interfaces.BenchmarkableEnvironment 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.model.interfaces;

/**
 * An environment which provides a mean to get infos about its performances.
 *
 * @param  Concentration type
 * @param  {@link Position} type
 */
public interface BenchmarkableEnvironment> extends Environment {

    /**
     * Call this method to tell this environment that it should record its performances.
     * Please note that some environments might ignore this message if this method is not called before
     * starting using the environment itself.
     * 
     */
    void enableBenchmark();

    /**
     * @return a double which is a index of the performances
     */
    double getBenchmarkResult();
}