Package org.goplanit.converter.demands

Interface DemandsWriter

All Superinterfaces:

ConverterEntity, ConverterWriter<Demands>

All Known Implementing Classes:

PlanitDemandsWriter

public interface DemandsWriter
extends ConverterWriter<Demands>

Interface to write a PLANit demands to disk

Author:

markr

Method Summary

Modifier and Type	Method	Description
Zoning	getReferenceZoning()
default String	getTypeDescription()	short description (one word capitals) of this reader for logging purposes
void	setReferenceZoning(Zoning referenceZoning)	each demands writer is expected to ensure that its demand relate to a zoning this reference zoning can be set.

Methods inherited from interface org.goplanit.converter.ConverterEntity

reset

Methods inherited from interface org.goplanit.converter.ConverterWriter

getIdMapperType, getSettings, setIdMapperType, write

Method Detail

setReferenceZoning

void setReferenceZoning(Zoning referenceZoning)

each demands writer is expected to ensure that its demand relate to a zoning this reference zoning can be set. To avoid the user having to do this manualy when using a converter, the converter will do this for the user. This in turn requires a mechanism on each demands writer to provide the reference zoning to the demands writer. This is what this method does.

Parameters:

referenceZoning - to supply demands writer with (before invoking ConverterWriter.write(Object)

getReferenceZoning

Zoning getReferenceZoning()

getTypeDescription

default String getTypeDescription()

short description (one word capitals) of this reader for logging purposes

Specified by:

getTypeDescription in interface ConverterEntity

Returns:

description