MSFrame Class Reference

#include <MSFrame.h>

---

Detailed Description

Sets and checks options for microsim; inits global outputs and settings.

In addition to setting and checking options, this frame also sets global values via "setMSGlobals". They are stored in MSGlobals.

Also, global output streams are initialised within "buildStreams".

See also:

MSGlobals

Definition at line 55 of file MSFrame.h.

Static Public Member Functions
static void	buildStreams () throw (IOError)
	Builds the streams used possibly by the simulation.
static bool	checkOptions ()
	Checks the set options.
static void	fillOptions ()
	Inserts options used by the simulation into the OptionsCont-singleton.
static void	setMSGlobals (OptionsCont &oc)
	Sets the global microsim-options.

---

Member Function Documentation

void MSFrame::buildStreams

(

)

throw (IOError) [static]

Builds the streams used possibly by the simulation.

Definition at line 270 of file MSFrame.cpp.

References OutputDevice::createDeviceByOption().

Referenced by NLBuilder::buildNet().

                                     {
    // standard outputs
    OutputDevice::createDeviceByOption("netstate-dump", "sumo-netstate");
    OutputDevice::createDeviceByOption("emissions-output", "emissions");
    OutputDevice::createDeviceByOption("tripinfo-output", "tripinfos");
    OutputDevice::createDeviceByOption("vehroute-output", "routes");
}

bool MSFrame::checkOptions

(

)

[static]

Checks the set options.

The following constraints must be valid:

• the network-file was specified (otherwise no simulation is existing)
• the begin and the end of the simulation must be given
• The default lane change model must be known
• incremental-dua-step must be lower than incremental-dua-base If one is not, false is returned.

Returns:

Whether the settings are valid

Todo:

Rechek usage of the lane change model

Todo:

probably, more things should be checked...

Definition at line 280 of file MSFrame.cpp.

References OptionsCont::getBool(), MsgHandler::getErrorInstance(), OptionsCont::getInt(), OptionsCont::getOptions(), MsgHandler::inform(), and OptionsCont::isSet().

Referenced by main(), and GUILoadThread::run().

                      {
    OptionsCont &oc = OptionsCont::getOptions();
    bool ok = true;
    // check the existance of a name for simulation file
    if (!oc.isSet("n")) {
        MsgHandler::getErrorInstance()->inform("No network file (-n) specified.");
        ok = false;
    }
    // check if the begin and the end of the simulation are supplied
    if (!oc.isSet("b")) {
        MsgHandler::getErrorInstance()->inform("The begin of the simulation (-b) is not specified.");
        ok = false;
    }
    if (!oc.isSet("e")) {
        MsgHandler::getErrorInstance()->inform("The end of the simulation (-e) is not specified.");
        ok = false;
    }
    if (oc.isSet("incremental-dua-step") && oc.isSet("incremental-dua-base")) {
        if (oc.getInt("incremental-dua-step") > oc.getInt("incremental-dua-base")) {
            MsgHandler::getErrorInstance()->inform("Invalid dua step");
            ok = false;
        }
    }
    if (oc.getBool("vehroutes.exit-times") && !oc.isSet("vehroutes")) {
        MsgHandler::getErrorInstance()->inform("A vehroute-output file is needed for exit times.");
        ok = false;
    }
    return ok;
}

void MSFrame::fillOptions

(

)

[static]

Inserts options used by the simulation into the OptionsCont-singleton.

Device-options are inserted by calling the device's "insertOptions" -methods.

!! check, describe

!! check, describe

!! check, describe

!! recheck

!! recheck

!! recheck

!! recheck

!! recheck

!! recheck

!! recheck

!! recheck

!! recheck

Definition at line 58 of file MSFrame.cpp.

References OptionsCont::addCallExample(), SystemFrame::addConfigurationOptions(), OptionsCont::addDescription(), OptionsCont::addOptionSubTopic(), SystemFrame::addReportOptions(), OptionsCont::addSynonyme(), OptionsCont::doRegister(), OptionsCont::getOptions(), MSDevice_HBEFA::insertOptions(), MSDevice_Routing::insertOptions(), RandHelper::insertRandOptions(), and SUMOReal.

Referenced by GUILoadThread::initOptions(), and main().

                     {
    OptionsCont &oc = OptionsCont::getOptions();
    oc.addCallExample("-b 0 -e 1000 -n net.xml -r routes.xml");
    oc.addCallExample("-c munich_config.cfg");
    oc.addCallExample("--help");

    // insert options sub-topics
    SystemFrame::addConfigurationOptions(oc); // fill this subtopic, too
    oc.addOptionSubTopic("Input");
    oc.addOptionSubTopic("Output");
    oc.addOptionSubTopic("Time");
    oc.addOptionSubTopic("Processing");
    oc.addOptionSubTopic("TLS Defaults");
    SystemFrame::addReportOptions(oc); // fill this subtopic, too


    // register configuration options
    // register input options
    oc.doRegister("net-file", 'n', new Option_FileName());
    oc.addSynonyme("net-file", "net");
    oc.addDescription("net-file", "Input", "Load road network description from FILE");

    oc.doRegister("route-files", 'r', new Option_FileName());
    oc.addSynonyme("route-files", "routes");
    oc.addDescription("route-files", "Input", "Load routes descriptions from FILE(s)");

    oc.doRegister("additional-files", 'a', new Option_FileName());
    oc.addSynonyme("additional-files", "additional");
    oc.addDescription("additional-files", "Input", "Load further descriptions from FILE(s)");

    oc.doRegister("weight-files", 'w', new Option_FileName()); // !!! describe
    oc.addSynonyme("weight-files", "weights");
    oc.addDescription("weight-files", "Input", "Load weights from FILE");
    oc.doRegister("measure", 'm', new Option_String()); // !!! describe
    oc.addDescription("measure", "Input", "Load <measure> from weights");

#ifdef HAVE_MESOSIM
    oc.doRegister("load-state", new Option_FileName());
    oc.addDescription("load-state", "Input", "Loads a network state from FILE");
    oc.doRegister("load-state.offset", new Option_String("0", "TIME"));
    oc.addDescription("load-state.offset", "Input", "Sets the time offset for vehicle segment exit times.");
#endif

    // register output options
    oc.doRegister("netstate-dump", new Option_FileName());
    oc.addSynonyme("netstate-dump", "ndump");
    oc.addSynonyme("netstate-dump", "netstate");
    oc.addDescription("netstate-dump", "Output", "Save complete network states into FILE");
    oc.doRegister("dump-empty-edges", new Option_Bool(false));
    oc.addDescription("dump-empty-edges", "Output", "Write also empty edges completely when dumping");

    oc.doRegister("emissions-output", new Option_FileName());
    oc.addSynonyme("emissions-output", "emissions");
    oc.addDescription("emissions-output", "Output", "Save aggregated vehicle emission inf. into FILE");

    oc.doRegister("tripinfo-output", new Option_FileName());
    oc.addSynonyme("tripinfo-output", "tripinfo");
    oc.addDescription("tripinfo-output", "Output", "Save single vehicle trip inf. into FILE");

    oc.doRegister("vehroute-output", new Option_FileName());
    oc.addSynonyme("vehroute-output", "vehroutes");
    oc.addDescription("vehroute-output", "Output", "Save single vehicle route inf. into FILE");

    oc.doRegister("vehroute-output.exit-times", new Option_Bool(false));
    oc.addSynonyme("vehroute-output.exit-times", "vehroutes.exit-times");
    oc.addDescription("vehroute-output.exit-times", "Output", "Write the exit times for all edges");

    oc.doRegister("vehroute-output.last-route", new Option_Bool(false));
    oc.addSynonyme("vehroute-output.last-route", "vehroutes.last-route");
    oc.addDescription("vehroute-output.last-route", "Output", "Write the last route only");

#ifdef HAVE_MESOSIM
    oc.doRegister("save-state.times", new Option_IntVector(IntVector()));
    oc.addDescription("save-state.times", "Output", "Use INT[] as times at which a network state written");
    oc.doRegister("save-state.prefix", new Option_FileName());
    oc.addDescription("save-state.prefix", "Output", "Prefix for network states");
    oc.doRegister("save-state.files", new Option_FileName());
    oc.addDescription("save-state.files", "Output", "Files for network states");
#endif

    // register the simulation settings
    oc.doRegister("begin", 'b', new Option_String("0", "TIME"));
    oc.addDescription("begin", "Time", "Defines the begin time; The simulation starts at this time");

    oc.doRegister("end", 'e', new Option_String("-1", "TIME"));
    oc.addDescription("end", "Time", "Defines the end time; The simulation ends at this time");

#ifdef HAVE_SUBSECOND_TIMESTEPS
    oc.doRegister("step-length", new Option_String("1", "TIME"));
    oc.addDescription("step-length", "Time", "Defines the step duration");
#endif


    // register the processing options
    oc.doRegister("route-steps", 's', new Option_Integer(200));
    oc.addDescription("route-steps", "Processing", "Load routes for the next INT steps ahead");

#ifdef HAVE_INTERNAL_LANES
    oc.doRegister("no-internal-links", new Option_Bool(false));
    oc.addDescription("no-internal-links", "Processing", "Disable (junction) internal links");
#endif

    oc.doRegister("ignore-accidents", new Option_Bool(false));
    oc.addDescription("ignore-accidents", "Processing", "Do not check whether accidents occure more deeply");

    oc.doRegister("too-many-vehicles", new Option_Integer(-1));
    oc.addDescription("too-many-vehicles", "Processing", "Quit simulation if this number of vehicles is exceeded");

    oc.doRegister("incremental-dua-step", new Option_Integer(-1));
    oc.addDescription("incremental-dua-step", "Processing", "Perform the simulation as a step in incremental DUA");
    oc.doRegister("incremental-dua-base", new Option_Integer(10));
    oc.addDescription("incremental-dua-base", "Processing", "Base value for incremental DUA");

    oc.doRegister("time-to-teleport", new Option_String("300", "TIME"));
    oc.addDescription("time-to-teleport", "Processing", "Specify how long a vehicle may wait until being teleported");

    oc.doRegister("max-depart-delay", new Option_Integer(-1));
    oc.addDescription("max-depart-delay", "Processing", "How long vehicles wait for departure before being skipped");

    oc.doRegister("sloppy-emit", new Option_Bool(false));
    oc.addDescription("sloppy-emit", "Processing", "Whether emission on an edge shall not be repeated in same step once failed.");

    // devices
    MSDevice_Routing::insertOptions();
    MSDevice_HBEFA::insertOptions();


    // tls
    oc.doRegister("agent-tl.detector-len", new Option_Float(75));
    oc.addDescription("agent-tl.detector-len", "TLS Defaults", "");

    oc.doRegister("agent-tl.learn-horizon", new Option_Integer(3));
    oc.addDescription("agent-tl.learn-horizon", "TLS Defaults", "");

    oc.doRegister("agent-tl.decision-horizon", new Option_Integer(1));
    oc.addDescription("agent-tl.decision-horizon", "TLS Defaults", "");

    oc.doRegister("agent-tl.min-diff", new Option_Float((SUMOReal) .1));
    oc.addDescription("agent-tl.min-diff", "TLS Defaults", "");

    oc.doRegister("agent-tl.tcycle", new Option_Integer(90));
    oc.addDescription("agent-tl.tcycle", "TLS Defaults", "");

    oc.doRegister("actuated-tl.detector-pos", new Option_Float(100));
    oc.addDescription("actuated-tl.detector-pos", "TLS Defaults", "");

    oc.doRegister("actuated-tl.max-gap", new Option_Float(3.1f));
    oc.addDescription("actuated-tl.max-gap", "TLS Defaults", "");

    oc.doRegister("actuated-tl.detector-gap", new Option_Float(3.0f));
    oc.addDescription("actuated-tl.detector-gap", "TLS Defaults", "");

    oc.doRegister("actuated-tl.passing-time", new Option_Float(1.9f));
    oc.addDescription("actuated-tl.passing-time", "TLS Defaults", "");


    // register report options
    oc.doRegister("no-duration-log", new Option_Bool(false));
    oc.addDescription("no-duration-log", "Report", "Disable performance reports for individual simulation steps");

    oc.doRegister("no-step-log", new Option_Bool(false));
    oc.addDescription("no-step-log", "Report", "Disable console output of current simulation step");

    oc.doRegister("message-log", new Option_FileName());
    oc.addDescription("message-log", "Report", "Writes all non-error messages to FILE");

    oc.doRegister("error-log", new Option_FileName());
    oc.addDescription("error-log", "Report", "Writes all warnings and errors to FILE");


#ifndef NO_TRACI
    //remote port 0 if not used
    oc.addOptionSubTopic("TraCI Server");
    oc.doRegister("remote-port", new Option_Integer(0));
    oc.addDescription("remote-port", "TraCI Server", "Enables TraCI Server if set");
    oc.doRegister("penetration", new Option_Float(1.0f));
    oc.addDescription("penetration", "TraCI Server", "Value in 0..1 [default: 1]");
#endif
    //
#ifdef HAVE_MESOSIM
    oc.addOptionSubTopic("Mesoscopic");
    oc.doRegister("mesosim", new Option_Bool(false));
    oc.addDescription("mesosim", "Mesoscopic", "Enables mesoscopic simulation");
    oc.doRegister("meso-edgelength", new Option_Float(98.0f));
    oc.addDescription("meso-edgelength", "Mesoscopic", "Length of an edge segment in mesoscopic simulation");
    oc.doRegister("meso-tauff", new Option_String("1.4", "TIME"));
    oc.addDescription("meso-tauff", "Mesoscopic", "Factor for calculating the free-free headway time");
    oc.doRegister("meso-taufj", new Option_String("1.4", "TIME"));
    oc.addDescription("meso-taufj", "Mesoscopic", "Factor for calculating the free-jam headway time");
    oc.doRegister("meso-taujf", new Option_String("2", "TIME"));
    oc.addDescription("meso-taujf", "Mesoscopic", "Factor for calculating the jam-free headway time");
    oc.doRegister("meso-taujj", new Option_String("2", "TIME"));
    oc.addDescription("meso-taujj", "Mesoscopic", "Factor for calculating the jam-jam headway time");
    oc.doRegister("meso-jam-threshold", new Option_Float(0.29f));
    oc.addDescription("meso-jam-threshold", "Mesoscopic", "Minimum percentage of occupied space to consider a segment jammed");
    oc.doRegister("meso-multi-queue", new Option_Bool(false));
    oc.addDescription("meso-multi-queue", "Mesoscopic", "Enable multiple queues at edge ends");
    oc.doRegister("meso-junction-control", new Option_Bool(false));
    oc.addDescription("meso-junction-control", "Mesoscopic", "Enable mesoscopic traffic light and priority junction handling");
#endif

    // add rand options
    RandHelper::insertRandOptions();

    oc.addOptionSubTopic("GUI Only");
    oc.doRegister("gui-settings-file", new Option_FileName(""));
    oc.addDescription("gui-settings-file", "GUI Only", "Load visualisation settings from FILE");

}

void MSFrame::setMSGlobals

(

OptionsCont &

oc

)

[static]

Sets the global microsim-options.

Parameters:

[in]

oc

The options container to get the values from

See also:

MSGlobals

Definition at line 312 of file MSFrame.cpp.

References DELTA_T, MSGlobals::gCheck4Accidents, OptionsCont::getBool(), OptionsCont::getString(), MSGlobals::gOmitEmptyEdgesOnDump, MSGlobals::gTimeToGridlock, MSGlobals::gUsingInternalLanes, OptionsCont::isSet(), and string2time().

Referenced by load(), and GUILoadThread::run().

                                     {
    // pre-initialise the network
    // set whether empty edges shall be printed on dump
    MSGlobals::gOmitEmptyEdgesOnDump = !oc.getBool("dump-empty-edges");
#ifdef HAVE_INTERNAL_LANES
    // set whether internal lanes shall be used
    MSGlobals::gUsingInternalLanes = !oc.getBool("no-internal-links");
#else
    MSGlobals::gUsingInternalLanes = false;
#endif
    // set the grid lock time
    MSGlobals::gTimeToGridlock = string2time(oc.getString("time-to-teleport"))<0 ? 0 : string2time(oc.getString("time-to-teleport"));
    //
    MSGlobals::gCheck4Accidents = !oc.getBool("ignore-accidents");
#ifdef HAVE_MESOSIM
    MSGlobals::gStateLoaded = oc.isSet("load-state");
#endif
    //
#ifdef HAVE_SUBSECOND_TIMESTEPS
    DELTA_T = string2time(oc.getString("step-length"));
#endif
    //
#ifdef HAVE_MESOSIM
    MSGlobals::gUseMesoSim = oc.getBool("mesosim");
#endif
}

---

The documentation for this class was generated from the following files:

• MSFrame.h
• MSFrame.cpp