org.matsim.run.Events2Snapshot Class Reference

Public Member Functions
void	run (final String[] args)
void	run (final File eventsFile, final Config config, final Network network)
void	addExternalSnapshotWriter (final SnapshotWriter writer)

Static Public Member Functions
static void	main (final String[] args)

Private Member Functions
void	parseArguments (final String[] args)
void	printUsage ()
void	prepare ()
void	loadSnapshotWriters (final String outputDir)

Private Attributes
Config	config = null
Network	network = null
EventsManager	events = null
SnapshotGenerator	visualizer = null
String	configfile = null
String	eventsfile
SnapshotWriter	writer = null

Detailed Description

Converts an events file to a snapshot file.

Author

mrieser

glaemmel

Definition at line 50 of file Events2Snapshot.java.

Member Function Documentation

parseArguments()

void org.matsim.run.Events2Snapshot.parseArguments ( final String []  args )

private

Parses all arguments and sets the corresponding members.

Parameters

args

Definition at line 65 of file Events2Snapshot.java.

References org.matsim.core.utils.misc.ArgumentParser.iterator(), and org.matsim.run.Events2Snapshot.printUsage().

Referenced by org.matsim.run.Events2Snapshot.run().

                                                     {
        if (args.length == 0) {
            System.out.println("Too few arguments.");
            printUsage();
            System.exit(1);
        }
        Iterator<String> argIter = new ArgumentParser(args).iterator();
        while (argIter.hasNext()) {
            String arg = argIter.next();
            if (arg.equals("-h") || arg.equals("--help")) {
                printUsage();
                System.exit(0);
            } else {
                if (arg.contains(".xml"))
                    this.configfile = arg;
                else if (arg.contains("events"))
                    this.eventsfile = arg;
                else {
                    System.out.println("Unrecognized file \"" + arg + "\"");
                    printUsage();
                    System.exit(1);
                }
            }
        }
    }

Here is the call graph for this function:

printUsage()

void org.matsim.run.Events2Snapshot.printUsage ( )

private

Definition at line 91 of file Events2Snapshot.java.

Referenced by org.matsim.run.Events2Snapshot.parseArguments().

                              {
        System.out.println();
        System.out.println("Events2Snapshot");
        System.out.println("Converts an events file to a snapshot file.");
        System.out.println();
        System.out.println("usage: Events2Snapshot [OPTIONS] configfile [eventsfile]");
        System.out.println("       If no eventsfile is given, the in-events-file specified in the config-");
        System.out.println("       file will be used.");
        System.out.println("       The snapshots are generated according to the snapshot-settings in the");
        System.out.println("       simulation-part of the configuration.");
        System.out.println();
        System.out.println("Options:");
        System.out.println("-h, --help:     Displays this message.");
        System.out.println();
        System.out.println("----------------");
        System.out.println("2007, matsim.org");
        System.out.println();
    }

run() [1/2]

void org.matsim.run.Events2Snapshot.run

(

final String []

args

)

Starts the conversion of events into snapshot files. Stand-alone run-method.

Parameters

args	command-line arguments

Definition at line 114 of file Events2Snapshot.java.

References org.matsim.core.scenario.ScenarioUtils.createScenario(), org.matsim.core.events.algorithms.SnapshotGenerator.finish(), org.matsim.core.config.groups.NetworkConfigGroup.getInputFile(), org.matsim.api.core.v01.Scenario.getNetwork(), org.matsim.core.config.Config.getParam(), org.matsim.core.config.groups.GlobalConfigGroup.getRandomSeed(), org.matsim.core.config.Config.global(), org.matsim.core.config.ConfigUtils.loadConfig(), org.matsim.run.Events2Snapshot.loadSnapshotWriters(), org.matsim.core.config.Config.network(), org.matsim.run.Events2Snapshot.parseArguments(), org.matsim.run.Events2Snapshot.prepare(), org.matsim.core.events.MatsimEventsReader.readFile(), and org.matsim.core.gbl.MatsimRandom.reset().

Referenced by org.matsim.run.Events2Snapshot.main().

                                         {
        parseArguments(args);
        Scenario scenario;
        this.config = ConfigUtils.loadConfig(this.configfile);
        MatsimRandom.reset(this.config.global().getRandomSeed());
        scenario = ScenarioUtils.createScenario(this.config);

//      if (((SimulationConfigGroup) this.config.getModule(SimulationConfigGroup.GROUP_NAME)).getSnapshotPeriod() <= 0.0) {
//          System.out.println("The snapshotPeriod must be larger than 0 seconds.");
//          return;
//      }

        this.network = scenario.getNetwork();
        new MatsimNetworkReader(scenario.getNetwork()).readFile(this.config.network().getInputFile());
        prepare();

        if (this.eventsfile == null) {
            this.eventsfile = this.config.getParam("events", "inputFile");
        }
        System.out.println("reading events from " + this.eventsfile);
        File file = new File(this.eventsfile);
        String outputDir = file.getParent() + "/";

        loadSnapshotWriters(outputDir);

        new MatsimEventsReader(this.events).readFile(this.eventsfile);
        this.visualizer.finish();
        System.out.println("done.");
    }

Here is the call graph for this function:

run() [2/2]

void org.matsim.run.Events2Snapshot.run	(	final File	eventsFile,
		final Config	config,
		final Network	network
	)

Starts the conversion of events into snapshot files. Alternative run-method to more easily integrate it into existing code where config, network etc. are already loaded.

Parameters

eventsFile
config
network

Definition at line 152 of file Events2Snapshot.java.

References org.matsim.run.Events2Snapshot.config, org.matsim.core.events.algorithms.SnapshotGenerator.finish(), org.matsim.core.config.Config.getParam(), org.matsim.core.config.groups.QSimConfigGroup.getSnapshotPeriod(), org.matsim.run.Events2Snapshot.loadSnapshotWriters(), org.matsim.run.Events2Snapshot.network, org.matsim.run.Events2Snapshot.prepare(), org.matsim.core.config.Config.qsim(), and org.matsim.core.events.MatsimEventsReader.readFile().

                                                                                       {
        this.eventsfile = eventsFile.getAbsolutePath();
        this.config = config;

        if (this.config.qsim().getSnapshotPeriod() <= 0.0) {
            System.out.println("The snapshotPeriod must be larger than 0 seconds.");
            return;
        }

        this.network = network;

        prepare();

        if (this.eventsfile == null) {
            this.eventsfile = this.config.getParam("events", "inputFile");
        }
        System.out.println("reading events from " + this.eventsfile);
        File file = new File(this.eventsfile);
        String outputDir = file.getParent() + "/";

        loadSnapshotWriters(outputDir);

        try {
            new MatsimEventsReader(this.events).readFile(this.eventsfile);
        }
        catch (OutOfMemoryError e) {
            System.err.println("OutOfMemoryError while reading all events:");
            e.printStackTrace();
            System.err.println("Trying to close visualizer file up to this state, it may not be complete though.");
        }
        this.visualizer.finish();
        System.out.println("done.");
    }

Here is the call graph for this function:

prepare()

void org.matsim.run.Events2Snapshot.prepare ( )

private

Definition at line 187 of file Events2Snapshot.java.

References org.matsim.core.api.experimental.events.EventsManager.addHandler(), org.matsim.core.events.EventsUtils.createEventsManager(), org.matsim.core.config.groups.QSimConfigGroup.getSnapshotPeriod(), and org.matsim.core.config.Config.qsim().

Referenced by org.matsim.run.Events2Snapshot.run().

                           {
        // create events
        this.events = EventsUtils.createEventsManager();

        // create SnapshotGenerator
        this.visualizer = new SnapshotGenerator(this.network, this.config.qsim().getSnapshotPeriod(),
                this.config.qsim());
        this.events.addHandler(this.visualizer);
    }

Here is the call graph for this function:

addExternalSnapshotWriter()

void org.matsim.run.Events2Snapshot.addExternalSnapshotWriter

(

final SnapshotWriter

writer

)

Definition at line 197 of file Events2Snapshot.java.

References org.matsim.run.Events2Snapshot.writer.

                                                                       {
        this.writer = writer;
    }

loadSnapshotWriters()

void org.matsim.run.Events2Snapshot.loadSnapshotWriters ( final String  outputDir )

private

Definition at line 201 of file Events2Snapshot.java.

References org.matsim.core.events.algorithms.SnapshotGenerator.addSnapshotWriter(), org.matsim.core.config.Config.controller(), and org.matsim.core.config.groups.ControllerConfigGroup.getSnapshotFormat().

Referenced by org.matsim.run.Events2Snapshot.run().

                                                             {

        if (this.writer != null) {
            this.visualizer.addSnapshotWriter(this.writer);
        }

        Collection<SnapshotFormat> snapshotFormats = this.config.controller().getSnapshotFormat();

        for( SnapshotFormat snapshotFormat : snapshotFormats ){
            switch( snapshotFormat ){
                case transims: {
                    String snapshotFile = outputDir + "T.veh";
                    this.visualizer.addSnapshotWriter(new TransimsSnapshotWriter(snapshotFile));
                    break; }
                case googleearth:
                    // KML support removed, michalm, may'22
                case otfvis:
                    // this was not filled in when I found it, but I think it should.  kai, feb'20
                case positionevents:
                default:
                    throw new IllegalStateException( "Unexpected value: " + snapshotFormat );
            }
        }
    }

Here is the call graph for this function:

main()

static void org.matsim.run.Events2Snapshot.main ( final String []  args )

static

Definition at line 226 of file Events2Snapshot.java.

References org.matsim.run.Events2Snapshot.run().

                                                 {
        new Events2Snapshot().run(args);
    }

Here is the call graph for this function:

Member Data Documentation

config

Config org.matsim.run.Events2Snapshot.config = null

private

Definition at line 52 of file Events2Snapshot.java.

Referenced by org.matsim.run.Events2Snapshot.run().

network

Network org.matsim.run.Events2Snapshot.network = null

private

Definition at line 53 of file Events2Snapshot.java.

Referenced by org.matsim.run.Events2Snapshot.run().

events

EventsManager org.matsim.run.Events2Snapshot.events = null

private

Definition at line 54 of file Events2Snapshot.java.

visualizer

SnapshotGenerator org.matsim.run.Events2Snapshot.visualizer = null

private

Definition at line 55 of file Events2Snapshot.java.

configfile

String org.matsim.run.Events2Snapshot.configfile = null

private

Definition at line 56 of file Events2Snapshot.java.

eventsfile

String org.matsim.run.Events2Snapshot.eventsfile

private

Definition at line 57 of file Events2Snapshot.java.

writer

SnapshotWriter org.matsim.run.Events2Snapshot.writer = null

private

Definition at line 58 of file Events2Snapshot.java.

Referenced by org.matsim.run.Events2Snapshot.addExternalSnapshotWriter().

---

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

• run/Events2Snapshot.java