Package org.goplanit.matsim.converter

Class MatsimZoningWriterSettings

java.lang.Object

org.goplanit.converter.FileBasedConverterWriterSettings

org.goplanit.converter.SingleFileBasedConverterWriterSettings

org.goplanit.matsim.util.PlanitMatsimWriterSettings

org.goplanit.matsim.converter.MatsimZoningWriterSettings

All Implemented Interfaces:

ConverterWriterSettings

public class MatsimZoningWriterSettings
extends PlanitMatsimWriterSettings

Settings specific to writing the zoning related output in MATSim format (pt)

Author:

markr

Field Summary

Fields

Modifier and Type	Field	Description
static boolean	DEFAULT_GENERATE_MATRIX_BASED_PT_ROUTER_FILES	Default setting for generating files required to run MATSim matrix based pt router
protected boolean	generateMatrixBasedPtRouterFiles	While persisting generate the input files for the MATSim PtMatrixRouter contribution as per MATSim matrix based Pt router
static boolean	PT_BLOCKING_AT_STOP_DEFAULT	default value aligned with MATSim default
protected boolean	ptBlockingAtStopFacility	flag indicating the default for whether transit routes are blocking at their stop facilities
protected MacroscopicNetwork	referenceNetwork	the reference network this zoning is supposed to be compatible with

Fields inherited from class org.goplanit.matsim.util.PlanitMatsimWriterSettings

decimalFormat, DEFAULT_NETWORK_FILE_NAME, DEFAULT_TRANSIT_SCHEDULE_FILE_NAME

Fields inherited from class org.goplanit.converter.FileBasedConverterWriterSettings

DEFAULT_COUNTRY, destinationCoordinateReferenceSystem

Constructor Summary

Constructors

Constructor	Description
MatsimZoningWriterSettings()	Default constructor using default output file name and Global country name
MatsimZoningWriterSettings(String countryName)	Default constructor
MatsimZoningWriterSettings(String outputDirectory, String countryName)	Constructor
MatsimZoningWriterSettings(String outputDirectory, String outputFileName, String countryName)	Constructor
MatsimZoningWriterSettings(String outputDirectory, String outputFileName, String countryName, MacroscopicNetwork referenceNetwork)	Constructor

Method Summary

Modifier and Type	Method	Description
protected MacroscopicNetwork	getReferenceNetwork()	Collect the reference network used
boolean	isGenerateMatrixBasedPtRouterFiles()	Collect the flag indicating if MATSim matrix based pt routing is supported by generating its files
boolean	isPtBlockingAtStopFacility()
void	logSettings()	Log settings
void	reset()	Reset content
void	setGenerateMatrixBasedPtRouterFiles(boolean generateMatrixBasedPtRouterFiles)	Set the flag to indicate if MATSim matrix based pt routing is to be supported by generating its files
void	setPtBlockingAtStopFacility(boolean ptBlockingAtStopFacility)	when set to true all transit lines by default will be blocking at their stop facilities
void	setReferenceNetwork(MacroscopicNetwork referenceNetwork)	Set the reference network to use when mapping zoning entities to network entities

Methods inherited from class org.goplanit.matsim.util.PlanitMatsimWriterSettings

getDecimalFormat, setDecimalFormat

Methods inherited from class org.goplanit.converter.SingleFileBasedConverterWriterSettings

getFileName, setFileName, validate

Methods inherited from class org.goplanit.converter.FileBasedConverterWriterSettings

getCountry, getDestinationCoordinateReferenceSystem, getOutputDirectory, setCountry, setDestinationCoordinateReferenceSystem, setOutputDirectory

Methods inherited from class java.lang.Object

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

Field Detail

referenceNetwork

protected MacroscopicNetwork referenceNetwork

the reference network this zoning is supposed to be compatible with

generateMatrixBasedPtRouterFiles

protected boolean generateMatrixBasedPtRouterFiles

While persisting generate the input files for the MATSim PtMatrixRouter contribution as per MATSim matrix based Pt router

ptBlockingAtStopFacility

protected boolean ptBlockingAtStopFacility

flag indicating the default for whether transit routes are blocking at their stop facilities

DEFAULT_GENERATE_MATRIX_BASED_PT_ROUTER_FILES

public static final boolean DEFAULT_GENERATE_MATRIX_BASED_PT_ROUTER_FILES

Default setting for generating files required to run MATSim matrix based pt router

See Also:

Constant Field Values

PT_BLOCKING_AT_STOP_DEFAULT

public static final boolean PT_BLOCKING_AT_STOP_DEFAULT

default value aligned with MATSim default

See Also:

Constant Field Values

Constructor Detail

MatsimZoningWriterSettings

public MatsimZoningWriterSettings()

Default constructor using default output file name and Global country name

MatsimZoningWriterSettings

public MatsimZoningWriterSettings(String countryName)

Default constructor

Parameters:

countryName - to use

MatsimZoningWriterSettings

public MatsimZoningWriterSettings(String outputDirectory,
                                  String countryName)

Constructor

Parameters:

outputDirectory - to use

countryName - to use

MatsimZoningWriterSettings

public MatsimZoningWriterSettings(String outputDirectory,
                                  String outputFileName,
                                  String countryName)

Constructor

Parameters:

outputDirectory - to use

outputFileName - to use

countryName - to use

MatsimZoningWriterSettings

public MatsimZoningWriterSettings(String outputDirectory,
                                  String outputFileName,
                                  String countryName,
                                  MacroscopicNetwork referenceNetwork)

Constructor

Parameters:

outputDirectory - to use

outputFileName - to use

countryName - to use

referenceNetwork - to use

Method Detail

logSettings

public void logSettings()

Log settings

Overrides:

logSettings in class SingleFileBasedConverterWriterSettings

getReferenceNetwork

protected MacroscopicNetwork getReferenceNetwork()

Collect the reference network used

Returns:

reference network

setReferenceNetwork

public void setReferenceNetwork(MacroscopicNetwork referenceNetwork)

Set the reference network to use when mapping zoning entities to network entities

Parameters:

referenceNetwork - to use

isGenerateMatrixBasedPtRouterFiles

public boolean isGenerateMatrixBasedPtRouterFiles()

Collect the flag indicating if MATSim matrix based pt routing is supported by generating its files

Returns:

flag, when true activated when false not activated

setGenerateMatrixBasedPtRouterFiles

public void setGenerateMatrixBasedPtRouterFiles(boolean generateMatrixBasedPtRouterFiles)

Set the flag to indicate if MATSim matrix based pt routing is to be supported by generating its files

Parameters:

generateMatrixBasedPtRouterFiles - when true activate, when false do not

reset

public void reset()

Reset content

Specified by:

reset in interface ConverterWriterSettings

Overrides:

reset in class SingleFileBasedConverterWriterSettings

isPtBlockingAtStopFacility

public boolean isPtBlockingAtStopFacility()

Returns:

is pt blocking flag

setPtBlockingAtStopFacility

public void setPtBlockingAtStopFacility(boolean ptBlockingAtStopFacility)

when set to true all transit lines by default will be blocking at their stop facilities

Parameters:

ptBlockingAtStopFacility - set flag