Package org.goplanit.converter.demands

Interface DemandsReader

All Superinterfaces:

ConverterEntity, ConverterReader<Demands>

All Known Implementing Classes:

PlanitDemandsReader, TntpDemandsReader

public interface DemandsReader
extends ConverterReader<Demands>

Interface to read a PLANit demands

Author:

markr

Method Summary

Modifier and Type	Method	Description
Zoning	getReferenceZoning()	each demands reader is expected to ensure that its demand relates to a zoning this reference zoning can be obtained (after reading is complete).
default String	getTypeDescription()	short description (one word capitals) of this reader for logging purposes

Methods inherited from interface org.goplanit.converter.ConverterEntity

reset

Methods inherited from interface org.goplanit.converter.ConverterReader

getSettings, read

Method Detail

getReferenceZoning

Zoning getReferenceZoning()

each demands reader is expected to ensure that its demand relates to a zoning this reference zoning can be obtained (after reading is complete). the converter uses this to avoid the user having to manually transfer this zoning to the writer which also requires this same zoning consistency This is what this method enables

Returns:

referenceZoning to supply demands writer with (after invoking ConverterReader.read()

getTypeDescription

default String getTypeDescription()

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

Specified by:

getTypeDescription in interface ConverterEntity

Returns:

description