SUMO - Simulation of Urban MObility
SystemFrame.cpp
Go to the documentation of this file.
1 /****************************************************************************/
9 // A set of actions common to all applications
10 /****************************************************************************/
11 // SUMO, Simulation of Urban MObility; see http://sumo.dlr.de/
12 // Copyright (C) 2001-2016 DLR (http://www.dlr.de/) and contributors
13 /****************************************************************************/
14 //
15 // This file is part of SUMO.
16 // SUMO is free software: you can redistribute it and/or modify
17 // it under the terms of the GNU General Public License as published by
18 // the Free Software Foundation, either version 3 of the License, or
19 // (at your option) any later version.
20 //
21 /****************************************************************************/
22 
23 
24 // ===========================================================================
25 // included modules
26 // ===========================================================================
27 #ifdef _MSC_VER
28 #include <windows_config.h>
29 #else
30 #include <config.h>
31 #endif
32 
33 #include "SystemFrame.h"
34 #include <string>
35 #include <utils/xml/XMLSubSys.h>
39 #include "RandHelper.h"
40 
41 #ifdef CHECK_MEMORY_LEAKS
42 #include <foreign/nvwa/debug_new.h>
43 #endif // CHECK_MEMORY_LEAKS
44 
45 
46 // ===========================================================================
47 // method definitions
48 // ===========================================================================
49 void
51  oc.addOptionSubTopic("Configuration");
52 
53  oc.doRegister("configuration-file", 'c', new Option_FileName());
54  oc.addSynonyme("configuration-file", "configuration");
55  oc.addDescription("configuration-file", "Configuration", "Loads the named config on startup");
56  oc.addXMLDefault("configuration-file");
57 
58  oc.doRegister("save-configuration", new Option_FileName());
59  oc.addSynonyme("save-config", "save-configuration");
60  oc.addDescription("save-configuration", "Configuration", "Saves current configuration into FILE");
61 
62  oc.doRegister("save-template", new Option_FileName());
63  oc.addDescription("save-template", "Configuration", "Saves a configuration template (empty) into FILE");
64 
65  oc.doRegister("save-schema", new Option_FileName());
66  oc.addDescription("save-schema", "Configuration", "Saves the configuration schema into FILE");
67 
68  oc.doRegister("save-commented", new Option_Bool(false));
69  oc.addSynonyme("save-commented", "save-template.commented");
70  oc.addDescription("save-commented", "Configuration", "Adds comments to saved template, configuration, or schema");
71 }
72 
73 
74 void
76  oc.addOptionSubTopic("Report");
77 
78  oc.doRegister("verbose", 'v', new Option_Bool(false));
79  oc.addDescription("verbose", "Report", "Switches to verbose output");
80 
81  oc.doRegister("print-options", new Option_Bool(false));
82  oc.addDescription("print-options", "Report", "Prints option values before processing");
83 
84  oc.doRegister("help", '?', new Option_Bool(false));
85  oc.addDescription("help", "Report", "Prints this screen");
86 
87  oc.doRegister("version", 'V', new Option_Bool(false));
88  oc.addDescription("version", "Report", "Prints the current version");
89 
90  oc.doRegister("xml-validation", 'X', new Option_String("auto"));
91  oc.addDescription("xml-validation", "Report", "Set schema validation scheme of XML inputs (\"never\", \"auto\" or \"always\")");
92 
93  oc.doRegister("xml-validation.net", new Option_String("never"));
94  oc.addDescription("xml-validation.net", "Report", "Set schema validation scheme of SUMO network inputs (\"never\", \"auto\" or \"always\")");
95 
96  oc.doRegister("no-warnings", 'W', new Option_Bool(false));
97  oc.addSynonyme("no-warnings", "suppress-warnings", true);
98  oc.addDescription("no-warnings", "Report", "Disables output of warnings");
99 
100  oc.doRegister("log", 'l', new Option_FileName());
101  oc.addSynonyme("log", "log-file");
102  oc.addDescription("log", "Report", "Writes all messages to FILE (implies verbose)");
103 
104  oc.doRegister("message-log", new Option_FileName());
105  oc.addDescription("message-log", "Report", "Writes all non-error messages to FILE (implies verbose)");
106 
107  oc.doRegister("error-log", new Option_FileName());
108  oc.addDescription("error-log", "Report", "Writes all warnings and errors to FILE");
109 
110  oc.doRegister("output-prefix", new Option_String());
111  oc.addDescription("output-prefix", "Output", "Prefix which is applied to all output files. The special string 'TIME' is replaced by the current time.");
112 }
113 
114 
115 void
117  // close all output devices
119  // close the xml-subsystem
121  // delete build program options
123  // delete messages
125 }
126 
127 
128 /****************************************************************************/
129 
void doRegister(const std::string &name, Option *v)
Adds an option under the given name.
Definition: OptionsCont.cpp:86
static void close()
Closes the xml-subsystem.
Definition: XMLSubSys.cpp:92
static void addReportOptions(OptionsCont &oc)
Adds reporting options to the given container.
Definition: SystemFrame.cpp:75
static void close()
Closes all of an applications subsystems.
static void addConfigurationOptions(OptionsCont &oc)
Adds configuration options to the given container.
Definition: SystemFrame.cpp:50
static OptionsCont & getOptions()
Retrieves the options.
Definition: OptionsCont.cpp:69
void addSynonyme(const std::string &name1, const std::string &name2, bool isDeprecated=false)
Adds a synonyme for an options name (any order)
void clear()
Removes all information from the container.
static void cleanupOnEnd()
Removes pending handler.
Definition: MsgHandler.cpp:242
static void closeAll()
void addOptionSubTopic(const std::string &topic)
Adds an option subtopic.
void addXMLDefault(const std::string &name, const std::string &xmlRoot="")
Adds an XML root element to handle by default. The special root "" denotes the default handler...
A storage for options typed value containers)
Definition: OptionsCont.h:99
void addDescription(const std::string &name, const std::string &subtopic, const std::string &description)
Adds a description for an option.