Package org.goplanit.tntp.converter.demands

Class TntpDemandsReaderSettings

java.lang.Object

org.goplanit.tntp.converter.demands.TntpDemandsReaderSettings

All Implemented Interfaces:

ConverterReaderSettings

public class TntpDemandsReaderSettings
extends Object
implements ConverterReaderSettings

Settings for the TNTP demands reader

• demand file location: mandatory, no default
• timePeriodDuration: optional, default 1 hour

Author:

markr

Field Summary

Fields

Modifier and Type	Field	Description
static Pair<Double,TimeUnits>	DEFAULT_START_TIME_PERIOD_8AM	default start time of time period since midnight is set to 8:00 hours
static Pair<Double,TimeUnits>	DEFAULT_TIME_PERIOD_DURATION	default time period duration is set to 1 hour

Constructor Summary

Constructors

Constructor	Description
TntpDemandsReaderSettings()	Default constructor
TntpDemandsReaderSettings(String demandFileLocation)	Constructor
TntpDemandsReaderSettings(String demandFileLocation, double duration, TimeUnits durationUnit)	Constructor

Method Summary

Modifier and Type	Method	Description
String	getDemandFileLocation()
double	getStartTimeSinceMidNight()
TimeUnits	getStartTimeSinceMidNightUnit()
double	getTimePeriodDuration()
TimeUnits	getTimePeriodDurationUnit()
void	logSettings()	Log the current settings
void	reset()	be able to reset all settings if needed
void	setDemandFileLocation(String demandFileLocation)
void	setStartTimeSinceMidnight(Number startTime, TimeUnits startTimeUnit)
void	setTimePeriodDuration(Number duration, TimeUnits durationUnit)
protected boolean	validateSettings()	Validate settings

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_TIME_PERIOD_DURATION

public static Pair<Double,TimeUnits> DEFAULT_TIME_PERIOD_DURATION

default time period duration is set to 1 hour

DEFAULT_START_TIME_PERIOD_8AM

public static Pair<Double,TimeUnits> DEFAULT_START_TIME_PERIOD_8AM

default start time of time period since midnight is set to 8:00 hours

Constructor Detail

TntpDemandsReaderSettings

public TntpDemandsReaderSettings()

Default constructor

TntpDemandsReaderSettings

public TntpDemandsReaderSettings(String demandFileLocation)

Constructor

Parameters:

demandFileLocation - to use

TntpDemandsReaderSettings

public TntpDemandsReaderSettings(String demandFileLocation,
                                 double duration,
                                 TimeUnits durationUnit)

Constructor

Parameters:

demandFileLocation - to use

duration - to use

durationUnit - to use

Method Detail

validateSettings

protected boolean validateSettings()

Validate settings

Returns:

true when valid, false otherwise

logSettings

public void logSettings()

Log the current settings

Specified by:

logSettings in interface ConverterReaderSettings

reset

public void reset()

be able to reset all settings if needed

Specified by:

reset in interface ConverterReaderSettings

getDemandFileLocation

public String getDemandFileLocation()

setDemandFileLocation

public void setDemandFileLocation(String demandFileLocation)

setTimePeriodDuration

public void setTimePeriodDuration(Number duration,
                                  TimeUnits durationUnit)

getTimePeriodDuration

public double getTimePeriodDuration()

getTimePeriodDurationUnit

public TimeUnits getTimePeriodDurationUnit()

setStartTimeSinceMidnight

public void setStartTimeSinceMidnight(Number startTime,
                                      TimeUnits startTimeUnit)

getStartTimeSinceMidNight

public double getStartTimeSinceMidNight()

getStartTimeSinceMidNightUnit

public TimeUnits getStartTimeSinceMidNightUnit()