org.matsim.run.NetworkCleaner Class Reference

Public Member Functions
void	run (final String inputNetworkFile, final String outputNetworkFile)
void	run (final String[] args)

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

Private Member Functions
void	printUsage ()

Detailed Description

Reads a network from file and "cleans" it to ensure the network is suited for simulation. Currently, it is ensured that every link can be reached by every other link.

Author

mrieser

Definition at line 39 of file NetworkCleaner.java.

Member Function Documentation

printUsage()

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

private

Definition at line 41 of file NetworkCleaner.java.

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

                              {
        System.out.println();
        System.out.println("NetworkCleaner");
        System.out.println("Reads a network-file and \"cleans\" it. Currently, it performs the following");
        System.out.println("steps to ensure a network is suited for simulation:");
        System.out.println(" - ensure every link can be reached by every other link. It looks for the");
        System.out.println("   biggest cluster of connected nodes and links and removes all other elements.");
        System.out.println();
        System.out.println("usage: NetworkCleaner [OPTIONS] input-network-file output-network-file");
        System.out.println();
        System.out.println("Options:");
        System.out.println("-h, --help:     Displays this message.");
        System.out.println();
        System.out.println("----------------");
        System.out.println("2008, matsim.org");
        System.out.println();
    }

run() [1/2]

void org.matsim.run.NetworkCleaner.run	(	final String	inputNetworkFile,
		final String	outputNetworkFile
	)

Runs the network cleaning algorithms over the network read in from inputNetworkFile and writes the resulting ("cleaned") network to the specified file.

Parameters

inputNetworkFile	filename of the network to be handled
outputNetworkFile	filename where to write the cleaned network to

Definition at line 65 of file NetworkCleaner.java.

References org.matsim.core.config.ConfigUtils.createConfig(), org.matsim.core.scenario.ScenarioUtils.createScenario(), org.matsim.api.core.v01.Scenario.getNetwork(), org.matsim.core.network.algorithms.NetworkCleaner.run(), and org.matsim.core.network.io.NetworkWriter.write().

Referenced by org.matsim.run.NetworkCleaner.main(), and org.matsim.run.NetworkCleaner.run().

                                                                                   {
        final Scenario scenario = ScenarioUtils.createScenario(ConfigUtils.createConfig());
        final Network network = scenario.getNetwork();
        new MatsimNetworkReader(scenario.getNetwork()).readFile(inputNetworkFile);

        new org.matsim.core.network.algorithms.NetworkCleaner().run(network);

        new NetworkWriter(network).write(outputNetworkFile);
    }

Here is the call graph for this function:

run() [2/2]

void org.matsim.run.NetworkCleaner.run

(

final String []

args

)

Runs the network cleaning algorithms over the network read in from the argument list, and writing the resulting network out to a file again

Parameters

args	args[0] filename of the network to be handled, args[1] filename where to write the cleaned network to

Definition at line 81 of file NetworkCleaner.java.

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

                                         {
        if (args.length == 0) {
            System.out.println("Too few arguments.");
            printUsage();
            System.exit(1);
        }
        Iterator<String> argIter = new ArgumentParser(args).iterator();
        String arg = argIter.next();
        if (arg.equals("-h") || arg.equals("--help")) {
            printUsage();
            System.exit(0);
        } else {
            String inputFile = arg;
            if (!argIter.hasNext()) {
                System.out.println("Too few arguments.");
                printUsage();
                System.exit(1);
            }
            String outputFile = argIter.next();
            if (argIter.hasNext()) {
                System.out.println("Too many arguments.");
                printUsage();
                System.exit(1);
            }
            run(inputFile, outputFile);
        }
    }

Here is the call graph for this function:

main()

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

static

Definition at line 109 of file NetworkCleaner.java.

References org.matsim.run.NetworkCleaner.run().

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

Here is the call graph for this function:

---

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

• run/NetworkCleaner.java