Package org.goplanit.tntp.converter.zoning

Class TntpZoningReader

java.lang.Object

org.goplanit.converter.BaseReaderImpl<Zoning>

org.goplanit.tntp.converter.zoning.TntpZoningReader

All Implemented Interfaces:

ConverterEntity, ConverterReader<Zoning>, ZoningReader

public class TntpZoningReader
extends BaseReaderImpl<Zoning>
implements ZoningReader

Zoning reader component for TNTP data format

Author:

gman, markr

Field Summary

Fields inherited from class org.goplanit.converter.BaseReaderImpl

sourceIdTrackerMap

Constructor Summary

Constructors

Constructor	Description
TntpZoningReader(String networkFileLocation)	Constructor

Method Summary

Modifier and Type	Method	Description
TntpZoningReaderSettings	getSettings()	any settings to configure the reader can be configured by collecting these settings
Zoning	read()	parse the network based on the configuration of the implementing class to yield a PLANit network
void	reset()	reset the reader to allow for marking unnecessary resources for garbage collection

Methods inherited from class org.goplanit.converter.BaseReaderImpl

getBySourceId, getSourceIdContainer, initialiseSourceIdMap, initialiseSourceIdMap, registerBySourceId, registerBySourceId

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.zoning.ZoningReader

getTypeDescription

Constructor Detail

TntpZoningReader

public TntpZoningReader(String networkFileLocation)
                 throws PlanItException

Constructor

Parameters:

networkFileLocation - to parse zoning from (included in network for TNTP)

Throws:

PlanItException - thrown if error

Method Detail

getSettings

public TntpZoningReaderSettings getSettings()

any settings to configure the reader can be configured by collecting these settings

Specified by:

getSettings in interface ConverterReader<Zoning>

Returns:

the settings to configrue the reader

read

public Zoning read()
            throws PlanItException

parse the network based on the configuration of the implementing class to yield a PLANit network

Specified by:

read in interface ConverterReader<Zoning>

Returns:

parsed network

Throws:

PlanItException - thrown if error

reset

public void reset()

reset the reader to allow for marking unnecessary resources for garbage collection

Specified by:

reset in interface ConverterEntity