com.graphhopper.routing.util

Class EncodedValue

java.lang.Object

com.graphhopper.routing.util.EncodedValue

Direct Known Subclasses:

EncodedDoubleValue

public class EncodedValue
extends Object

Encapsulates a bit-encoded value.

Author:

Nop

Field Summary

Fields

Modifier and Type	Field and Description
protected long	defaultValue
protected double	factor
protected long	mask
protected long	shift

Constructor Summary

Constructors

Constructor and Description
EncodedValue(String name, int shift, int bits, double factor, long defaultValue, int maxValue) Define a bit-encoded value
EncodedValue(String name, int shift, int bits, double factor, long defaultValue, int maxValue, boolean allowZero)

Method Summary

Modifier and Type	Method and Description
protected void	checkValue(long value)
int	getBits()
double	getFactor()
long	getMaxValue()
String	getName()
long	getValue(long flags)
long	setDefaultValue(long flags)
long	setValue(long flags, long value)
long	swap(long flags, EncodedValue otherEncoder) Swap the contents controlled by this value encoder with the given value.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

shift

protected final long shift

mask

protected final long mask

factor

protected final double factor

defaultValue

protected final long defaultValue

Constructor Detail

EncodedValue

public EncodedValue(String name,
                    int shift,
                    int bits,
                    double factor,
                    long defaultValue,
                    int maxValue)

Define a bit-encoded value

Parameters:

name - Description for debugging

shift - bit index of this value

bits - number of bits reserved

factor - scaling factor for stored values

defaultValue - default value

maxValue - default maximum value

EncodedValue

public EncodedValue(String name,
                    int shift,
                    int bits,
                    double factor,
                    long defaultValue,
                    int maxValue,
                    boolean allowZero)

Method Detail

checkValue

protected void checkValue(long value)

setValue

public long setValue(long flags,
                     long value)

getName

public String getName()

getValue

public long getValue(long flags)

getBits

public int getBits()

getFactor

public double getFactor()

setDefaultValue

public long setDefaultValue(long flags)

getMaxValue

public long getMaxValue()

swap

public long swap(long flags,
                 EncodedValue otherEncoder)

Swap the contents controlled by this value encoder with the given value.

Returns:

the new flags