NetworkTeleatlasAddSpeedRestrictions.java

Go to the documentation of this file.

/* *********************************************************************** *
 * project: org.matsim.*
 * NetworkTeleatlasAddSpeedRestrictions.java
 *                                                                         *
 * *********************************************************************** *
 *                                                                         *
 * copyright       : (C) 2008 by the members listed in the COPYING,        *
 *                   LICENSE and WARRANTY file.                            *
 * email           : info at matsim dot org                                *
 *                                                                         *
 * *********************************************************************** *
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *   See also COPYING, LICENSE and WARRANTY file                           *
 *                                                                         *
 * *********************************************************************** */

package org.matsim.core.network.algorithms;

import java.io.FileInputStream;

import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
import org.geotools.data.shapefile.dbf.DbaseFileReader;
import org.matsim.api.core.v01.Id;
import org.matsim.api.core.v01.network.Link;
import org.matsim.api.core.v01.network.Network;
import org.matsim.core.api.internal.NetworkRunnable;
import org.matsim.core.network.io.NetworkReaderTeleatlas;
import org.matsim.core.utils.io.IOUtils;

public final class NetworkTeleatlasAddSpeedRestrictions implements NetworkRunnable {

    // member variables

    private final static Logger log = LogManager.getLogger(NetworkTeleatlasAddSpeedRestrictions.class);

    private final String srDbfFileName;

    private static final String SR_ID_NAME = "ID";
    private static final String SR_SPEED_NAME = "SPEED";
    private static final String SR_VALDIR_NAME = "VALDIR";
    private static final String SR_VERIFIED_NAME = "VERIFIED";

    // constructors

    public NetworkTeleatlasAddSpeedRestrictions(final String srDbfFileName) {
        log.info("init " + this.getClass().getName() + " module...");
        this.srDbfFileName = srDbfFileName;
        log.info("done.");
    }

    // run method

    @Override
    public void run(final Network network) {
        try {
            run2(network);
        } catch (Exception e) {
            throw new RuntimeException(e);
        }
    }

    private void run2(final Network network) throws Exception {
        log.info("running " + this.getClass().getName() + " module...");
        try (FileInputStream fis = new FileInputStream(this.srDbfFileName)) {
            DbaseFileReader r = new DbaseFileReader(fis.getChannel(), true, IOUtils.CHARSET_WINDOWS_ISO88591);
            // getting header indices
            int srIdNameIndex = -1;
            int srSpeedNameIndex = -1;
            int srValDirNameIndex = -1;
            int srVerifiedNameIndex = -1;
            for (int i=0; i<r.getHeader().getNumFields(); i++) {
                if (r.getHeader().getFieldName(i).equals(SR_ID_NAME)) { srIdNameIndex = i; }
                if (r.getHeader().getFieldName(i).equals(SR_SPEED_NAME)) { srSpeedNameIndex = i; }
                if (r.getHeader().getFieldName(i).equals(SR_VALDIR_NAME)) { srValDirNameIndex = i; }
                if (r.getHeader().getFieldName(i).equals(SR_VERIFIED_NAME)) { srVerifiedNameIndex = i; }
            }
            if (srIdNameIndex < 0) { throw new NoSuchFieldException("Field name '"+SR_ID_NAME+"' not found."); }
            if (srSpeedNameIndex < 0) { throw new NoSuchFieldException("Field name '"+SR_SPEED_NAME+"' not found."); }
            if (srValDirNameIndex < 0) { throw new NoSuchFieldException("Field name '"+SR_VALDIR_NAME+"' not found."); }
            if (srVerifiedNameIndex < 0) { throw new NoSuchFieldException("Field name '"+SR_VERIFIED_NAME+"' not found."); }
            log.trace("  FieldName-->Index:");
            log.trace("    "+SR_ID_NAME+"-->"+srIdNameIndex);
            log.trace("    "+SR_SPEED_NAME+"-->"+srSpeedNameIndex);
            log.trace("    "+SR_VALDIR_NAME+"-->"+srValDirNameIndex);
            log.trace("    "+SR_VERIFIED_NAME+"-->"+srVerifiedNameIndex);
    
            int srCnt = 0;
            int srIgnoreCnt = 0;
            while (r.hasNext()) {
                Object[] entries = r.readEntry();
                int verified = Integer.parseInt(entries[srVerifiedNameIndex].toString());
                // assign only verfied speed restricitons
                if (verified == 1) {
                    int valdir = Integer.parseInt(entries[srValDirNameIndex].toString());
                    String id = entries[srIdNameIndex].toString();
                    if (valdir == 1) {
                        // Valid in Both Directions
                        Link ftLink = network.getLinks().get(Id.create(id+"FT", Link.class));
                        Link tfLink = network.getLinks().get(Id.create(id+"TF", Link.class));
                        if ((ftLink == null) || (tfLink == null)) { log.trace("  linkid="+id+", valdir="+valdir+": at least one link not found. Ignoring and proceeding anyway..."); srIgnoreCnt++; }
                        else {
                            double speed = Double.parseDouble(entries[srSpeedNameIndex].toString())/3.6;
                            // assigning speed restriction only if given freespeed is higher
                            if (speed < ftLink.getFreespeed()) { ftLink.setFreespeed(speed); srCnt++; } else { srIgnoreCnt++; }
                            if (speed < tfLink.getFreespeed()) { tfLink.setFreespeed(speed); srCnt++; } else { srIgnoreCnt++; }
                        }
                    }
                    else if (valdir == 2) {
                        // Valid Only in Positive Direction
                        Link ftLink = network.getLinks().get(Id.create(id+"FT", Link.class));
                        if (ftLink == null) { log.trace("  linkid="+id+", valdir="+valdir+": link not found. Ignoring and proceeding anyway..."); srIgnoreCnt++; }
                        else {
                            double speed = Double.parseDouble(entries[srSpeedNameIndex].toString())/3.6;
                            // assigning speed restriction only if given freespeed is higher
                            if (speed < ftLink.getFreespeed()) { ftLink.setFreespeed(speed); srCnt++; } else { srIgnoreCnt++; }
                        }
                    }
                    else if (valdir == 3) {
                        // Valid Only in Negative Direction
                        Link tfLink = network.getLinks().get(Id.create(id+"TF", Link.class));
                        if (tfLink == null) { log.trace("  linkid="+id+", valdir="+valdir+": link not found. Ignoring and proceeding anyway..."); srIgnoreCnt++; }
                        else {
                            double speed = Double.parseDouble(entries[srSpeedNameIndex].toString())/3.6;
                            // assigning speed restriction only if given freespeed is higher
                            if (speed < tfLink.getFreespeed()) { tfLink.setFreespeed(speed); srCnt++; } else { srIgnoreCnt++; }
                        }
                    }
                    else { throw new IllegalArgumentException("linkid="+id+": valdir="+valdir+" not known."); }
                }
            }
            log.info("  "+srCnt+" links with restricted speed assigned.");
            log.info("  "+srIgnoreCnt+" speed restrictions ignored (while verified = 1).");
            log.info("done.");
            r.close();
        }
    }

    // print methods

    public final void printInfo(final String prefix) {
        System.out.println(prefix+"configuration of "+this.getClass().getName()+":");
        System.out.println(prefix+"  speed restrictions:");
        System.out.println(prefix+"    srDbfFileName:    "+this.srDbfFileName);
        System.out.println(prefix+"    SR_ID_NAME:       "+SR_ID_NAME);
        System.out.println(prefix+"    SR_SPEED_NAME:    "+SR_SPEED_NAME);
        System.out.println(prefix+"    SR_VALDIR_NAME:   "+SR_VALDIR_NAME);
        System.out.println(prefix+"    SR_VERIFIED_NAME: "+SR_VERIFIED_NAME);
        System.out.println(prefix+"done.");
    }
}