Package org.goplanit.tntp.converter.demands

Class TntpDemandsReader

java.lang.Object

org.goplanit.converter.BaseReaderImpl<Demands>

org.goplanit.tntp.converter.demands.TntpDemandsReader

All Implemented Interfaces:

ConverterEntity, ConverterReader<Demands>, DemandsReader

public class TntpDemandsReader
extends BaseReaderImpl<Demands>
implements DemandsReader

Demands 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
TntpDemandsReader(String demandFileLocation)	Constructor

Method Summary

Modifier and Type	Method	Description
TntpDemandsReaderSettings	getSettings()	any settings to configure the reader can be configured by collecting these settings
Demands	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.demands.DemandsReader

getTypeDescription

Constructor Detail

TntpDemandsReader

public TntpDemandsReader(String demandFileLocation)
                  throws PlanItException

Constructor

Parameters:

demandFileLocation - location of demands file to parse

Throws:

PlanItException - thrown if error

Method Detail

getSettings

public TntpDemandsReaderSettings getSettings()

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

Specified by:

getSettings in interface ConverterReader<Demands>

Returns:

the settings to configrue the reader

read

public Demands 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<Demands>

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