aswi2021tri-musketyri-gitlab/Server/ServerApp/Predictor/IPredictionController.cs @ ce0940b5

//
// Author: Roman Kalivoda
//

using System.Collections.Generic;
using ServerApp.Connection.XMLProtocolHandler;

namespace ServerApp.Predictor
{
    /// <summary>
    /// Interface for PredictionController class. Defines basic interface methods to access the "model" package.
    /// </summary>
    public interface IPredictionController
    {
        /// <summary>
        /// </summary>
        /// <returns>A list with all existing predictors.</returns>
        List<string> GetPredictors();

        /// <summary>
        /// Trains all predictors. The training data are taken from given path location.
        /// </summary>
        /// <param name="locationKey">A string identifier of the location for which to train a predictor.</param>
        void Train(string locationKey = null);

        /// <summary>
        /// Loads trained predictors from files in <c>path</c>.
        /// </summary>
        /// <param name="locationKey">A string identifier of the location for which to load a predictor.</param>
        /// <param name="path">A path to folder with trained prediction model.</param>
        void Load(string locationKey = null, string path = null);

        /// <summary>
        /// Predicts turnout level at given time supposing given weather conditions.
        /// </summary>
        /// <param name="request">A request with time and weather information.</param>
        /// <returns>A server response filled with predictions.</returns>
        Response Predict(Request request);
    }
}