001
002/* *********************************************************************** *
003 * project: org.matsim.*
004 * WithinDayConfigGroup.java
005 *                                                                         *
006 * *********************************************************************** *
007 *                                                                         *
008 * copyright       : (C) 2019 by the members listed in the COPYING,        *
009 *                   LICENSE and WARRANTY file.                            *
010 * email           : info at matsim dot org                                *
011 *                                                                         *
012 * *********************************************************************** *
013 *                                                                         *
014 *   This program is free software; you can redistribute it and/or modify  *
015 *   it under the terms of the GNU General Public License as published by  *
016 *   the Free Software Foundation; either version 2 of the License, or     *
017 *   (at your option) any later version.                                   *
018 *   See also COPYING, LICENSE and WARRANTY file                           *
019 *                                                                         *
020 * *********************************************************************** */
021
022 /**
023 * 
024 */
025package org.matsim.withinday.controller;
026
027import java.util.Map;
028
029import org.matsim.core.config.ReflectiveConfigGroup;
030
031/**
032 * @author nagel
033 *
034 */
035public final class WithinDayConfigGroup extends ReflectiveConfigGroup {
036        public static final String GROUP_NAME = "withinDay" ;
037
038        public WithinDayConfigGroup() {
039                super(GROUP_NAME);
040        }
041        
042        // --- 
043        // ---
044
045        // yyyy I cannot say yet if this should restrict to "TravelTimePrediction".  Probably yes.  Needs to be decided before escalated to xml config.  kai, may'17 
046        
047        public enum ShortTermPredictionMethod { currentSpeeds } 
048        
049        ShortTermPredictionMethod predictionMethod = ShortTermPredictionMethod.currentSpeeds ;
050        // I think this is what the original code does: use "current" travel times (whatever that means; I still need to find out). kai, may'17
051        
052        @SuppressWarnings("unused")
053        private static final String SHORT_TERM_PREDICTION_METHOD_CMT="method to predict travel times for the future" ;
054
055        /**
056         * {@value #SHORT_TERM_PREDICTION_METHOD_CMT}
057         * 
058         * @return the predictionMethod
059         */
060        public ShortTermPredictionMethod getPredictionMethod() {
061                return predictionMethod;
062        }
063        /**
064         * {@value #SHORT_TERM_PREDICTION_METHOD_CMT}
065         * 
066         * @param predictionMethod the predictionMethod to set
067         */
068        public void setPredictionMethod(ShortTermPredictionMethod predictionMethod) {
069                this.predictionMethod = predictionMethod;
070        }
071
072        // ---
073        // ---
074        
075        @Override public Map<String, String> getComments() {
076                Map<String, String> comments = super.getComments();
077                return comments ;
078        }
079}