Package org.goplanit.tntp.converter.network

Class TntpNetworkReaderSettings

java.lang.Object

org.goplanit.tntp.converter.network.TntpNetworkReaderSettings

All Implemented Interfaces:

ConverterReaderSettings

public class TntpNetworkReaderSettings
extends Object
implements ConverterReaderSettings

Settings for Tntp network reader

Author:

gman, markr

Field Summary

Fields

Modifier and Type	Field	Description
static Pair<Double,TimeUnits>	DEFAULT_TIME_PERIOD_DURATION	default time period duration is set to 1 hour

Constructor Summary

Constructors

Constructor	Description
TntpNetworkReaderSettings()

Method Summary

Modifier and Type	Method	Description
double	getCapacityPeriodDuration()
TimeUnits	getCapacityPeriodUnits()
String	getCoordinateReferenceSystem()
double	getDefaultMaximumSpeed()
TimeUnits	getFreeFlowTravelTimeUnits()
LengthUnits	getLengthUnits()
String	getNetworkFile()
Map<NetworkFileColumnType,Integer>	getNetworkFileColumns()
String	getNodeCoordinateFile()
SpeedUnits	getSpeedUnits()
void	logSettings()	Log relevant settings
void	reset()	be able to reset all settings if needed
void	setCapacityPeriod(Number duration, TimeUnits units)	Determine how the capacity is defined in terms of units, e.g., 1, TimeUnits.Hour reflects that capacity is given in PCU volume per (1) hour.
void	setCoordinateReferenceSystem(String coordinateReferenceSystem)
void	setDefaultMaximumSpeed(Number defaultMaximumSpeed)
void	setFreeFlowTravelTimeUnits(TimeUnits freeFlowTravelTimeUnits)	Identify how to interpret the free flow travel time column units in the input file
void	setLengthUnits(LengthUnits lengthUnits)
void	setNetworkFile(String networkFile)
void	setNetworkFileColumns(Map<NetworkFileColumnType,Integer> networkFileColumns)
void	setNodeCoordinateFile(String nodeCoordinateFile)
void	setSpeedUnits(SpeedUnits speedUnits)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_TIME_PERIOD_DURATION

public static Pair<Double,TimeUnits> DEFAULT_TIME_PERIOD_DURATION

default time period duration is set to 1 hour

Constructor Detail

TntpNetworkReaderSettings

public TntpNetworkReaderSettings()

Method Detail

reset

public void reset()

be able to reset all settings if needed

Specified by:

reset in interface ConverterReaderSettings

logSettings

public void logSettings()

Log relevant settings

Specified by:

logSettings in interface ConverterReaderSettings

getNetworkFileColumns

public Map<NetworkFileColumnType,Integer> getNetworkFileColumns()

setNetworkFileColumns

public void setNetworkFileColumns(Map<NetworkFileColumnType,Integer> networkFileColumns)

getSpeedUnits

public SpeedUnits getSpeedUnits()

setSpeedUnits

public void setSpeedUnits(SpeedUnits speedUnits)

getLengthUnits

public LengthUnits getLengthUnits()

setLengthUnits

public void setLengthUnits(LengthUnits lengthUnits)

getCapacityPeriodUnits

public TimeUnits getCapacityPeriodUnits()

getCapacityPeriodDuration

public double getCapacityPeriodDuration()

setCapacityPeriod

public void setCapacityPeriod(Number duration,
                              TimeUnits units)

Determine how the capacity is defined in terms of units, e.g., 1, TimeUnits.Hour reflects that capacity is given in PCU volume per (1) hour.

Parameters:

duration - duration of the time period for expressing capacity in the unit provided

units - unit to use for the time period duration

getDefaultMaximumSpeed

public double getDefaultMaximumSpeed()

setDefaultMaximumSpeed

public void setDefaultMaximumSpeed(Number defaultMaximumSpeed)

getNetworkFile

public String getNetworkFile()

setNetworkFile

public void setNetworkFile(String networkFile)

getNodeCoordinateFile

public String getNodeCoordinateFile()

setNodeCoordinateFile

public void setNodeCoordinateFile(String nodeCoordinateFile)

getCoordinateReferenceSystem

public String getCoordinateReferenceSystem()

setCoordinateReferenceSystem

public void setCoordinateReferenceSystem(String coordinateReferenceSystem)

getFreeFlowTravelTimeUnits

public TimeUnits getFreeFlowTravelTimeUnits()

setFreeFlowTravelTimeUnits

public void setFreeFlowTravelTimeUnits(TimeUnits freeFlowTravelTimeUnits)

Identify how to interpret the free flow travel time column units in the input file

Parameters:

freeFlowTravelTimeUnits - to use