com.ocadotechnology.scenario.ScenarioSimulationApi Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of OcavaScenarioTest Show documentation

The newest version!

/*
 * Copyright © 2017-2024 Ocado (Ocava)
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.ocadotechnology.scenario;

import java.util.concurrent.TimeUnit;

import com.ocadotechnology.event.scheduling.EventScheduler;
import com.ocadotechnology.simulation.Simulation;

/**
 * Used to interface the scenario testing framework with your simulation.
 * The AbstractScenarioSimulationAPI implementation is provided for convenience, but may not always suit.
 */
public interface ScenarioSimulationApi {
    boolean isStarted();
    EventScheduler getEventScheduler();
    void setDiscreteEventTimeout(double duration, TimeUnit unit);
    void start(ScenarioNotificationListener listener);
    double getSchedulerStartTime();
    TimeUnit getSchedulerTimeUnit();
    
    default S getSimulation() {
        throw new UnsupportedOperationException("getSimulation");
    }
}