Adding Rail to FlagEncoderFactory

[Maxim_Pudov]

Hi, everyone.
I’ve created a RailFlagEnoder for railroads. It is quite simple but works well. Do you think it is worth making a PR?

package com.graphhopper.routing.util;
import com.graphhopper.reader.ReaderNode;
import com.graphhopper.reader.ReaderRelation;
import com.graphhopper.reader.ReaderWay;
import com.graphhopper.util.PMap;
public class RailFlagEncoder extends AbstractFlagEncoder {
    private static final int DEFAULT_SPEED = 100;
    public RailFlagEncoder(PMap properties) {
        super(5, 5, 0);
        this.properties = properties;
        intendedValues.add("railway");
        intendedValues.add("train");
    }
    @Override
    public long acceptWay(ReaderWay way) {
        String railwayValue = way.getTag("railway");
        if (railwayValue == null) {
            if (way.hasTag("route", intendedValues)) {
                return acceptBit | ferryBit;
            }
            return 0;
        }
        if (!"rail".equals(railwayValue)) {
            return 0;
        }
        return acceptBit;
    }
    @Override
    public long handleRelationTags(ReaderRelation relation, long oldRelationFlags) {
        return oldRelationFlags;
    }
    @Override
    public String toString() {
        return "rail";
    }
    protected double getSpeed(ReaderWay way) {
        return DEFAULT_SPEED;
    }
    @Override
    public long handleNodeTags(ReaderNode node) {
        return 0;
    }
    @Override
    public long handleWayTags( ReaderWay way, long allowed, long relationCode )
    {
        if (!isAccept(allowed))
            return 0;
        long flags = 0;
        if (!isFerry(allowed)) {
            // get assumed speed
            double speed = getSpeed(way);
            speed = applyMaxSpeed(way, speed);
            flags = setSpeed(0, speed);
            if (way.hasTag("oneway", oneways) || way.hasTag("junction", "roundabout")) {
                if (way.hasTag("oneway", "-1"))
                    flags |= backwardBit;
                else
                    flags |= forwardBit;
            } else
                flags |= directionBitMask;
        } else {
            double ferrySpeed = getFerrySpeed(way);
            flags = setSpeed(flags, ferrySpeed);
            flags |= directionBitMask;
        }
        return flags;
    }
    @Override
    public int defineWayBits(int index, int shift) {
        // first two bits are reserved for route handling in superclass
        shift = super.defineWayBits(index, shift);
        speedEncoder = new EncodedDoubleValue("Speed", shift, speedBits, speedFactor, DEFAULT_SPEED, DEFAULT_SPEED);
        return shift + speedBits;
    }
    @Override
    public int getVersion() {
        return 1;
    }
}

Link to the full commit

[softwareengel]

@Maxim_Pudov

graphhopper.routing.util;

import com.graphhopper.util.PMap;
import com.graphhopper.reader.ReaderNode;
import com.graphhopper.reader.ReaderRelation;
import com.graphhopper.reader.ReaderWay;
import com.graphhopper.routing.util.AbstractFlagEncoder;
import com.graphhopper.routing.util.EncodedDoubleValue;

public class RailFlagEncoder extends AbstractFlagEncoder {

	public RailFlagEncoder(PMap properties) {
		super(5, 5, 0);
		this.properties = properties;
		intendedValues.add("railway");
		intendedValues.add("train");
	}

	@Override
    public long acceptWay( ReaderWay way )
    {
        String railwayValue = way.getTag("railway");
        if (railwayValue == null)
        {
        	if(way.hasTag("route", intendedValues)) {
        		 return acceptBit | ferryBit;
        	}
            return 0;
        }

        if (!"rail".equals(railwayValue))
        {
        	return 0;
        }

        return acceptBit;
    }

	@Override
    public long handleRelationTags( ReaderRelation relation, long oldRelationFlags )
    {
        return oldRelationFlags;
    }
	
    @Override
    public String toString()
    {
        return "rail";
    }
    
    protected double getSpeed( ReaderWay way )
    {
        /*String railwayValue = way.getTag("railway");
        Integer speed = 100;
        if (speed == null)
            throw new IllegalStateException("rail, no speed found for:" + railwayValue);*/
        return 100;
    }

    @Override
	public long handleNodeTags( ReaderNode node )
    {
        return 0;
    }

    @Override
    public long handleWayTags( ReaderWay way, long allowed, long relationCode )
    {
    	if (!isAccept(allowed))
            return 0;

    	long flags = 0;
    	if (!isFerry(allowed)) {
            // get assumed speed from highway type
        	double speed = getSpeed(way);
            speed = applyMaxSpeed(way, speed);
            
            flags = setSpeed(0, speed);

            if (way.hasTag("oneway", oneways) || way.hasTag("junction", "roundabout")) {
                if (way.hasTag("oneway", "-1"))
                    flags |= backwardBit;
                else
                    flags |= forwardBit;
            } else
                flags |= directionBitMask;

        } else {
        	double ferrySpeed = getFerrySpeed(way, 20, 20, 20);
            flags = setSpeed(flags, ferrySpeed);
            flags |= directionBitMask;
        }

        return flags;
    }
    
    @Override
    public int defineWayBits( int index, int shift )
    {
        // first two bits are reserved for route handling in superclass
        shift = super.defineWayBits(index, shift);
        speedEncoder = new EncodedDoubleValue("Speed", shift, speedBits, speedFactor, 100, 100);
        return shift + speedBits;
    }

	@Override
	public int getVersion() {
		return 1;
	}    
}

Hi,
this looks interesting and I try this out but
“getFerrySpeed” ist not defined …
Regards
VOlker

[Maxim_Pudov]

I’ve updated the code sample and added a link for the full commit as well.

[softwareengel]

thanks - I will try it soon…