1 /****************************************************************************/
2 // Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.org/sumo
3 // Copyright (C) 2001-2019 German Aerospace Center (DLR) and others.
4 // This program and the accompanying materials
5 // are made available under the terms of the Eclipse Public License v2.0
6 // which accompanies this distribution, and is available at
7 // http://www.eclipse.org/legal/epl-v20.html
8 // SPDX-License-Identifier: EPL-2.0
9 /****************************************************************************/
10 /// @file    ROFrame.h
11 /// @author  Daniel Krajzewicz
12 /// @author  Jakob Erdmann
13 /// @date    Sept 2002
14 /// @version $Id$
15 ///
16 // Sets and checks options for routing
17 /****************************************************************************/
18 #ifndef ROFrame_h
19 #define ROFrame_h
20 
21 
22 // ===========================================================================
23 // included modules
24 // ===========================================================================
25 #include <config.h>
26 
27 
28 // ===========================================================================
29 // class declarations
30 // ===========================================================================
31 class OptionsCont;
32 
33 
34 // ===========================================================================
35 // class definitions
36 // ===========================================================================
37 /**
38  * @class ROFrame
39  * @brief Sets and checks options for routing
40  *
41  * Normally, these methods are called from another frame (ROJTRFrame, RODUAFrame)...
42  */
43 class ROFrame {
44 public:
45     /** @brief Inserts options used by routing applications into the OptionsCont-singleton
46      * @param[in] oc The options container to fill
47      */
48     static void fillOptions(OptionsCont& oc);
49 
50 
51     /** @brief Checks whether options are valid
52      *
53      * To be valid,
54      * @arg an output file must be given
55      * @arg max-alternatives must not be lower than 2
56      *
57      * @param[in] oc The options container to fill
58      * @return Whether all needed options are set
59      * @todo probably, more things should be checked...
60      */
61     static bool checkOptions(OptionsCont& oc);
62 
63 };
64 
65 
66 #endif
67 
68 /****************************************************************************/
69 
70