SimulationObject.java

/**
 * ****************************************************************************
 * Copyright (c) 2010-2016 by Min Cai (min.cai.china@gmail.com).
 * <p>
 * This file is part of the Archimulator multicore architectural simulator.
 * <p>
 * Archimulator is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * <p>
 * Archimulator is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * <p>
 * You should have received a copy of the GNU General Public License
 * along with Archimulator. If not, see <http://www.gnu.org/licenses/>.
 * ****************************************************************************
 */
package archimulator.common;

import archimulator.util.event.BlockingEvent;
import archimulator.util.event.BlockingEventDispatcher;
import archimulator.util.event.CycleAccurateEventQueue;

/**
 * Simulation object.
 *
 * @author Min Cai
 */
public interface SimulationObject<ExperimentT extends Experiment<?>, SimulationT> extends Named {
    /**
     * Get the blocking event dispatcher.
     *
     * @return the blocking event dispatcher
     */
    BlockingEventDispatcher<BlockingEvent> getBlockingEventDispatcher();

    /**
     * Get the cycle accurate event queue.
     *
     * @return the cycle accurate event queue
     */
    CycleAccurateEventQueue getCycleAccurateEventQueue();

    /**
     * Get the parent experiment.
     *
     * @return the parent experiment
     */
    ExperimentT getExperiment();

    /**
     * Get the parent simulation.
     *
     * @return the parent simulation
     */
    SimulationT getSimulation();
}