PlanitMatsimWriterSettings (PLANitAllJavaOnly 0.4.0 API)

java.lang.Object
- org.goplanit.converter.FileBasedConverterWriterSettings
- - org.goplanit.converter.SingleFileBasedConverterWriterSettings
  - - org.goplanit.matsim.util.PlanitMatsimWriterSettings

All Implemented Interfaces:

ConverterWriterSettings

Direct Known Subclasses:

MatsimIntermodalWriterSettings, MatsimZoningWriterSettings, PlanitMatsimWriterModeMappingSettings
```
public abstract class PlanitMatsimWriterSettings
extends SingleFileBasedConverterWriterSettings
implements ConverterWriterSettings
```
Base writer settings class to be used by all available matsim writer settings classes. Contains the output directory and destination country name used

Author:

markr

Field Summary

Fields
Modifier and Type	Field	Description
`protected DecimalFormat`	`decimalFormat`	number of decimals to use, default is Precision.DEFAULT_DECIMAL_FORMAT
`static String`	`DEFAULT_NETWORK_FILE_NAME`	default names used for MATSIM network file that is being generated
`static String`	`DEFAULT_TRANSIT_SCHEDULE_FILE_NAME`	default names used for MATSIM public transport schedule file that is being generated

Fields inherited from class org.goplanit.converter.FileBasedConverterWriterSettings
DEFAULT_COUNTRY, destinationCoordinateReferenceSystem

Constructor Summary

Constructors
Constructor	Description
`PlanitMatsimWriterSettings()`	Default constructor
`PlanitMatsimWriterSettings(String outputDirectory, String outputFileName, String countryName)`	Constructor

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`DecimalFormat`	`getDecimalFormat()`	Collect number of decimals used in writing coordinates
`void`	`setDecimalFormat(DecimalFormat decimalFormat)`	Set number of decimals used in writing coordinates

Methods inherited from class org.goplanit.converter.SingleFileBasedConverterWriterSettings
getFileName, logSettings, reset, 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

Methods inherited from interface org.goplanit.converter.ConverterWriterSettings
reset

- Field Detail
  - decimalFormat
```
protected DecimalFormat decimalFormat
```
    number of decimals to use, default is Precision.DEFAULT_DECIMAL_FORMAT
  - DEFAULT_TRANSIT_SCHEDULE_FILE_NAME
```
public static final String DEFAULT_TRANSIT_SCHEDULE_FILE_NAME
```
    default names used for MATSIM public transport schedule file that is being generated
    
    See Also:
    
    Constant Field Values
  - DEFAULT_NETWORK_FILE_NAME
```
public static final String DEFAULT_NETWORK_FILE_NAME
```
    default names used for MATSIM network file that is being generated
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - PlanitMatsimWriterSettings
```
public PlanitMatsimWriterSettings()
```
    Default constructor
  - PlanitMatsimWriterSettings
```
public PlanitMatsimWriterSettings(String outputDirectory,
                                  String outputFileName,
                                  String countryName)
```
    Constructor
    
    Parameters:
    
    outputDirectory - to use
    
    outputFileName - to use
    
    countryName - to use
- Method Detail
  - getDecimalFormat
```
public DecimalFormat getDecimalFormat()
```
    Collect number of decimals used in writing coordinates
    
    Returns:
    
    number of decimals used
  - setDecimalFormat
```
public void setDecimalFormat(DecimalFormat decimalFormat)
```
    Set number of decimals used in writing coordinates
    
    Parameters:
    
    decimalFormat - format to use