/*
 * Copyright (c) 2005-2006 Erik Tigerholm <eriktigerholm@gmail.com>
 *
 * Permission to use, copy, modify, and distribute this software for any
 * purpose with or without fee is hereby granted, provided that the above
 * copyright notice and this permission notice appear in all copies.
 *
 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 */

namespace OpenTraffic.Model.Simulator
{
    using System;
    using System.Collections.Generic;
    using System.Text;
    using OpenTraffic.Model.Result;
    using OpenTraffic.Model.Route;

    public interface ISimulator
    {
        ResultData Result { get; }

        int PercentFinished { get; }

        [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Design", "CA1044:PropertiesShouldNotBeWriteOnly")]
        ResultData HistoricalResult { set; }

        void Init(TrafficModel m, int id);

        bool Iterate();

        void SyncronizeModel(List<Vehicle> vehicles, List<LinkInfo> links);

        bool GetSyncronizeVehicles(
            Network.ClientDescription cd,
            List<Vehicle> vehicles,
            List<LinkInfo> links);

        void RestartIteration();

        List<RouteContainer> GenerateMoreRoutes();

        bool ShouldSync(Network.ClientDescription cd);
    }
}