PlanitDemandsReaderSettings (planit-all 0.3.0 API)

java.lang.Object
- org.goplanit.io.xml.util.PlanitXmlReaderSettings
- - org.goplanit.io.converter.demands.PlanitDemandsReaderSettings

All Implemented Interfaces:: ConverterReaderSettings

public class PlanitDemandsReaderSettings
extends PlanitXmlReaderSettings
implements ConverterReaderSettings

Settings for the PLANit zoning reader

Author:: markr

Field Summary

Fields
Modifier and Type	Field	Description
`protected MacroscopicNetwork`	`referenceNetwork`	Reference network to use when demand relate to network entities
`protected Zoning`	`referenceZoning`	Reference zoning to use when demands relate to zoning entities

Constructor Summary

Constructors
Constructor Description

PlanitDemandsReaderSettings()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected MacroscopicNetwork`	`getReferenceNetwork()`	Collect reference network used
`protected Zoning`	`getReferenceZoning()`	Collect reference zoning used
`void`	`reset()`	be able to reset all settings if needed
`void`	`setReferenceNetwork(MacroscopicNetwork referenceNetwork)`	Set reference network to use
`void`	`setReferenceZoning(Zoning referenceZoning)`	Set reference zoning to use

Methods inherited from class org.goplanit.io.xml.util.PlanitXmlReaderSettings
getInputDirectory, getXmlFileExtension, setInputDirectory, setXmlFileExtension

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - referenceNetwork
```
protected MacroscopicNetwork referenceNetwork
```
    Reference network to use when demand relate to network entities
  - referenceZoning
```
protected Zoning referenceZoning
```
    Reference zoning to use when demands relate to zoning entities
- Constructor Detail
  - PlanitDemandsReaderSettings
```
public PlanitDemandsReaderSettings()
```
- Method Detail
  - getReferenceNetwork
```
protected MacroscopicNetwork getReferenceNetwork()
```
    Collect reference network used
    
    Returns:
    
    reference network
  - getReferenceZoning
```
protected Zoning getReferenceZoning()
```
    Collect reference zoning used
    
    Returns:
    
    reference zoning
  - reset
```
public void reset()
```
    be able to reset all settings if needed
    
    Specified by:
    
    reset in interface ConverterReaderSettings
  - setReferenceNetwork
```
public void setReferenceNetwork(MacroscopicNetwork referenceNetwork)
```
    Set reference network to use
    
    Parameters:
    
    referenceNetwork - to use
  - setReferenceZoning
```
public void setReferenceZoning(Zoning referenceZoning)
```
    Set reference zoning to use
    
    Parameters:
    
    referenceZoning - to use