Uses of Class
org.planit.time.TimePeriod

Packages that use TimePeriod

Package	Description
org.planit.cost.physical.initial	Initial Physical Cost objects
org.planit.demands	Classes which manage traveler demands
org.planit.input	Top-level input classes and interfaces
org.planit.io.output.formatter	PLANit IO output formatter package
org.planit.output	output writer related classes
org.planit.output.adapter	Output Adapter and Output Type Adapter classes and interfaces
org.planit.output.formatter	output formatter related classes
org.planit.output.property	Output property objects which represent quantities which can be reported in the output
org.planit.project	PLANit project classes
org.planit.time	Contains the definition of the TimePeriod object
org.planit.trafficassignment	Traffic assignment classes
org.planit.trafficassignment.builder	Traffic assignment builder classes

Uses of TimePeriod in org.planit.cost.physical.initial

Fields in org.planit.cost.physical.initial declared as TimePeriod

Modifier and Type	Field	Description
protected TimePeriod	InitialLinkSegmentCostPeriod.timePeriod	The time period which this initial cost object applies to.

Methods in org.planit.cost.physical.initial that return TimePeriod

Modifier and Type	Method	Description
TimePeriod	InitialLinkSegmentCostPeriod.getTimePeriod()

Methods in org.planit.cost.physical.initial with parameters of type TimePeriod

Modifier and Type	Method	Description
void	InitialLinkSegmentCostPeriod.setTimePeriod(TimePeriod timePeriod)

Uses of TimePeriod in org.planit.demands

Methods in org.planit.demands that return TimePeriod

Modifier and Type	Method	Description
TimePeriod	Demands.TimePeriods.createAndRegisterNewTimePeriod(long externalId, String description, long startTimeSeconds, long durationSeconds)	Factory method to create and register a new time period on the demands
TimePeriod	Demands.TimePeriods.getFirst()	Collect the first registered time period.
TimePeriod	Demands.TimePeriods.getTimePeriodByExternalId(Object externalId)	Retrieve a TimePeriod by its external Id This method is not efficient, since it loops through all the registered time periods in order to find the required time period.
TimePeriod	Demands.TimePeriods.getTimePeriodByExternalId(Object externalId, boolean convertToLong)	Retrieve a TimePeriod by its external Id This method has the option to convert the external Id parameter into a long value, to find the time period when time period objects use long values for external ids.
TimePeriod	Demands.TimePeriods.getTimePeriodById(long id)	Retrieve a time period by its id

Methods in org.planit.demands that return types with arguments of type TimePeriod

Modifier and Type	Method	Description
SortedSet<TimePeriod>	Demands.TimePeriods.asSortedSetByStartTime()	Returns a set of all registered time periods sorted by the start time, i.e., the way th time period is comparable
Iterator<TimePeriod>	Demands.TimePeriods.iterator()	Iterator for time periods (non-sorted)

Methods in org.planit.demands with parameters of type TimePeriod

Modifier and Type	Method	Description
ODDemandMatrix	Demands.get(Mode mode, TimePeriod timePeriod)	Get an ODDemand by mode and time period
Set<Mode>	Demands.getRegisteredModesForTimePeriod(TimePeriod timePeriod)	Get modes registered for the given time period
ODDemandMatrix	Demands.registerODDemand(TimePeriod timePeriod, Mode mode, ODDemandMatrix odDemandMatrix)	Register provided odDemand
protected void	Demands.TimePeriods.registerTimePeriod(TimePeriod timePeriod)	Register a time period

Uses of TimePeriod in org.planit.input

Methods in org.planit.input that return TimePeriod

Modifier and Type	Method	Description
TimePeriod	InputBuilderListener.getTimePeriodByExternalId(Object externalId)	Return the time period for a specified external Id

Methods in org.planit.input with parameters of type TimePeriod

Modifier and Type	Method	Description
boolean	InputBuilderListener.addTimePeriodToExternalIdMap(Object externalId, TimePeriod timePeriod)	Stores a time period by its external Id

Uses of TimePeriod in org.planit.io.output.formatter

Methods in org.planit.io.output.formatter with parameters of type TimePeriod

Modifier and Type	Method	Description
protected void	PlanItOutputFormatter.writeGeneralResultsForCurrentTimePeriod(OutputConfiguration outputConfiguration, OutputTypeConfiguration outputTypeConfiguration, OutputTypeEnum currentOutputType, OutputAdapter outputAdapter, Set<Mode> modes, TimePeriod timePeriod, int iterationIndex)	Write General results for the current time period to the CSV file
protected void	PlanItOutputFormatter.writeLinkResultsForCurrentTimePeriod(OutputConfiguration outputConfiguration, OutputTypeConfiguration outputTypeConfiguration, OutputTypeEnum currentOutputType, OutputAdapter outputAdapter, Set<Mode> modes, TimePeriod timePeriod, int iterationIndex)	Write link results for the current time period to the CSV file
protected void	PlanItOutputFormatter.writeOdResultsForCurrentTimePeriod(OutputConfiguration outputConfiguration, OutputTypeConfiguration outputTypeConfiguration, OutputTypeEnum currentOutputType, OutputAdapter outputAdapter, Set<Mode> modes, TimePeriod timePeriod, int iterationIndex)	Write Origin-Destination results for the time period to the CSV file
protected void	PlanItOutputFormatter.writePathResultsForCurrentTimePeriod(OutputConfiguration outputConfiguration, OutputTypeConfiguration outputTypeConfiguration, OutputTypeEnum currentOutputType, OutputAdapter outputAdapter, Set<Mode> modes, TimePeriod timePeriod, int iterationIndex)	Write Path results for the time period to the CSV file
protected void	PlanItOutputFormatter.writeSimulationResultsForCurrentTimePeriod(OutputConfiguration outputConfiguration, OutputTypeConfiguration outputTypeConfiguration, OutputTypeEnum currentOutputType, OutputAdapter outputAdapter, Set<Mode> modes, TimePeriod timePeriod, int iterationIndex)	Write Simulation results for the current time period to the CSV file

Uses of TimePeriod in org.planit.output

Methods in org.planit.output with parameters of type TimePeriod

Modifier and Type	Method	Description
void	OutputManager.persistOutputData(TimePeriod timePeriod, Set<Mode> modes, boolean converged)	Persist the output data for all registered output types

Uses of TimePeriod in org.planit.output.adapter

Methods in org.planit.output.adapter with parameters of type TimePeriod

Modifier and Type	Method	Description
protected Object	OutputTypeAdapterImpl.getCommonPropertyValue(OutputProperty outputProperty, Mode mode, TimePeriod timePeriod)	Returns the value of properties which are common to all output type adapters
Object	LinkOutputTypeAdapter.getLinkOutputPropertyValue(OutputProperty outputProperty, LinkSegment linkSegment, Mode mode, TimePeriod timePeriod, double timeUnitMultiplier)	Return the value of a specified output property of a link segment
Object	LinkOutputTypeAdapterImpl.getLinkOutputPropertyValue(OutputProperty outputProperty, LinkSegment linkSegment, Mode mode, TimePeriod timePeriod, double timeUnitMultiplier)	Return the value of a specified output property of a link segment The DENSITY case should never be called for TraditionalStaticAssignment.
Object	TraditionalStaticAssignmentLinkOutputTypeAdapter.getLinkOutputPropertyValue(OutputProperty outputProperty, LinkSegment linkSegment, Mode mode, TimePeriod timePeriod, double timeUnitMultiplier)	Return the value of a specified output property of a link segment
Object	ODOutputTypeAdapter.getODOutputPropertyValue(OutputProperty outputProperty, ODMatrixIterator odMatrixIterator, Mode mode, TimePeriod timePeriod, double timeUnitMultiplier)	Returns the specified output property values for the current cell in the OD Matrix Iterator
Object	ODOutputTypeAdapterImpl.getODOutputPropertyValue(OutputProperty outputProperty, ODMatrixIterator odMatrixIterator, Mode mode, TimePeriod timePeriod, double timeUnitMultiplier)	Returns the specified output property values for the current cell in the OD Matrix Iterator
Object	RouteOutputTypeAdapter.getRouteOutputPropertyValue(OutputProperty outputProperty, ODRouteIterator odRouteIterator, Mode mode, TimePeriod timePeriod, RouteIdType pathOutputType)	Returns the specified output property values for the current cell in the ODPathIterator
Object	RouteOutputTypeAdapterImpl.getRouteOutputPropertyValue(OutputProperty outputProperty, ODRouteIterator odRouteIterator, Mode mode, TimePeriod timePeriod, RouteIdType routeOutputType)	Returns the specified output property values for the current cell in the ODPathIterator

Uses of TimePeriod in org.planit.output.formatter

Methods in org.planit.output.formatter with parameters of type TimePeriod

Modifier and Type	Method	Description
protected String	FileOutputFormatter.generateOutputFileName(String outputDirectory, String nameRoot, String nameExtension, TimePeriod timePeriod, OutputType outputType, long runId)	Generates the name of an output file.
protected String	FileOutputFormatter.generateOutputFileName(String outputDirectory, String nameRoot, String nameExtension, TimePeriod timePeriod, OutputType outputType, long runId, int iteration)	Generates the name of an output file.
MemoryOutputIterator	MemoryOutputFormatter.getIterator(Mode mode, TimePeriod timePeriod, Integer iterationIndex, OutputType outputType)	Returns a MemoryOutputIterator for the contents of the specified MultiKeyPlanItData map
Object	MemoryOutputFormatter.getOutputDataValue(Mode mode, TimePeriod timePeriod, Integer iterationIndex, OutputType outputType, OutputProperty outputProperty, Object[] keyValues)	Get a specified data value
void	BaseOutputFormatter.persist(TimePeriod timePeriod, Set<Mode> modes, OutputConfiguration outputConfiguration, OutputTypeConfiguration outputTypeConfiguration, OutputAdapter outputAdapter)	Write data to output file
void	OutputFormatter.persist(TimePeriod timePeriod, Set<Mode> modes, OutputConfiguration outputConfiguration, OutputTypeConfiguration outputTypeConfiguration, OutputAdapter outputAdapter)	Persist the output data based on the passed in configuration and adapter (contained in the configuration)
protected abstract void	BaseOutputFormatter.writeGeneralResultsForCurrentTimePeriod(OutputConfiguration outputConfiguration, OutputTypeConfiguration outputTypeConfiguration, OutputTypeEnum currentOutputType, OutputAdapter outputAdapter, Set<Mode> modes, TimePeriod timePeriod, int iterationIndex)	Write General results for the current time period to the CSV file
protected void	MemoryOutputFormatter.writeGeneralResultsForCurrentTimePeriod(OutputConfiguration outputConfiguration, OutputTypeConfiguration outputTypeConfiguration, OutputTypeEnum currentOutputType, OutputAdapter outputAdapter, Set<Mode> modes, TimePeriod timePeriod, int iterationIndex)	Write General results for the current time period to the CSV file
protected abstract void	BaseOutputFormatter.writeLinkResultsForCurrentTimePeriod(OutputConfiguration outputConfiguration, OutputTypeConfiguration outputTypeConfiguration, OutputTypeEnum currentOutputType, OutputAdapter outputAdapter, Set<Mode> modes, TimePeriod timePeriod, int iterationIndex)	Write link results for the current time period to the CSV file
protected void	MemoryOutputFormatter.writeLinkResultsForCurrentTimePeriod(OutputConfiguration outputConfiguration, OutputTypeConfiguration outputTypeConfiguration, OutputTypeEnum currentOutputType, OutputAdapter outputAdapter, Set<Mode> modes, TimePeriod timePeriod, int iterationIndex)	Write link results for the current time period to Map in memory
protected PlanItException	CsvFileOutputFormatter.writeLinkResultsForCurrentTimePeriodToCsvPrinter(OutputConfiguration outputConfiguration, OutputTypeConfiguration outputTypeConfiguration, OutputTypeEnum currentOutputType, OutputAdapter outputAdapter, Set<Mode> modes, TimePeriod timePeriod, org.apache.commons.csv.CSVPrinter csvPrinter)	Write output values to the Link CSV file for the current iteration
protected abstract void	BaseOutputFormatter.writeOdResultsForCurrentTimePeriod(OutputConfiguration outputConfiguration, OutputTypeConfiguration outputTypeConfiguration, OutputTypeEnum currentOutputType, OutputAdapter outputAdapter, Set<Mode> modes, TimePeriod timePeriod, int iterationIndex)	Write Origin-Destination results for the time period to the CSV file
protected void	MemoryOutputFormatter.writeOdResultsForCurrentTimePeriod(OutputConfiguration outputConfiguration, OutputTypeConfiguration outputTypeConfiguration, OutputTypeEnum currentOutputType, OutputAdapter outputAdapter, Set<Mode> modes, TimePeriod timePeriod, int iterationIndex)	Write Origin-Destination results for the time period to the Map in memory
protected PlanItException	CsvFileOutputFormatter.writeOdResultsForCurrentTimePeriodToCsvPrinter(OutputConfiguration outputConfiguration, OutputTypeConfiguration outputTypeConfiguration, OutputTypeEnum currentOutputType, OutputAdapter outputAdapter, Set<Mode> modes, TimePeriod timePeriod, org.apache.commons.csv.CSVPrinter csvPrinter)	Write output values to the OD CSV file for the current iteration
protected abstract void	BaseOutputFormatter.writePathResultsForCurrentTimePeriod(OutputConfiguration outputConfiguration, OutputTypeConfiguration outputTypeConfiguration, OutputTypeEnum currentOutputType, OutputAdapter outputAdapter, Set<Mode> modes, TimePeriod timePeriod, int iterationIndex)	Write OD Path results for the time period to the CSV file
protected void	MemoryOutputFormatter.writePathResultsForCurrentTimePeriod(OutputConfiguration outputConfiguration, OutputTypeConfiguration outputTypeConfiguration, OutputTypeEnum currentOutputType, OutputAdapter outputAdapter, Set<Mode> modes, TimePeriod timePeriod, int iterationIndex)	Write Path results for the time period to the CSV file
protected PlanItException	CsvFileOutputFormatter.writePathResultsForCurrentTimePeriodToCsvPrinter(OutputConfiguration outputConfiguration, OutputTypeConfiguration outputTypeConfiguration, OutputTypeEnum currentOutputType, OutputAdapter outputAdapter, Set<Mode> modes, TimePeriod timePeriod, org.apache.commons.csv.CSVPrinter csvPrinter)	Write output values to the Path CSV file for the current iteration
protected abstract void	BaseOutputFormatter.writeSimulationResultsForCurrentTimePeriod(OutputConfiguration outputConfiguration, OutputTypeConfiguration outputTypeConfiguration, OutputTypeEnum currentOutputType, OutputAdapter outputAdapter, Set<Mode> modes, TimePeriod timePeriod, int iterationIndex)	Write Simulation results for the current time period to the CSV file
protected void	MemoryOutputFormatter.writeSimulationResultsForCurrentTimePeriod(OutputConfiguration outputConfiguration, OutputTypeConfiguration outputTypeConfiguration, OutputTypeEnum currentOutputType, OutputAdapter outputAdapter, Set<Mode> modes, TimePeriod timePeriod, int iterationIndex)	Write Simulation results for the current time period to the CSV file

Uses of TimePeriod in org.planit.output.property

Methods in org.planit.output.property with parameters of type TimePeriod

Modifier and Type	Method	Description
static Object	TimePeriodExternalIdOutputProperty.getTimePeriodExternalId(TimePeriod timePeriod)	Returns the current time period external Id
static long	TimePeriodIdOutputProperty.getTimePeriodId(TimePeriod timePeriod)	Returns the current time period Id

Uses of TimePeriod in org.planit.project

Methods in org.planit.project with parameters of type TimePeriod

Modifier and Type	Method	Description
InitialLinkSegmentCostPeriod	CustomPlanItProject.createAndRegisterInitialLinkSegmentCost(PhysicalNetwork network, String fileName, TimePeriod timePeriod)	Create and register initial link segment costs from a (single) file and register it to the provided time period
InitialLinkSegmentCostPeriod	PlanItProjectInput.createAndRegisterInitialLinkSegmentCost(PhysicalNetwork network, String fileName, TimePeriod timePeriod)	Create and register initial link segment costs from a (single) file for each time period

Uses of TimePeriod in org.planit.time

Methods in org.planit.time with parameters of type TimePeriod

Modifier and Type	Method	Description
int	TimePeriod.compareTo(TimePeriod o)	Compare this object with another TimePeriod object Comparison is based on start time and duration

Uses of TimePeriod in org.planit.trafficassignment

Fields in org.planit.trafficassignment with type parameters of type TimePeriod

Modifier and Type	Field	Description
protected Map<TimePeriod,InitialLinkSegmentCost>	TrafficAssignment.initialLinkSegmentCostByTimePeriod	Map storing InitialLinkSegmentCost objects for each time period

Methods in org.planit.trafficassignment with parameters of type TimePeriod

Modifier and Type	Method	Description
void	TrafficAssignment.setInitialLinkSegmentCost(TimePeriod timePeriod, InitialLinkSegmentCost initialLinkSegmentCost)	Set the initial link segment cost for a specified time period, otherwise revert to the general initial link segment cost (if any)

Uses of TimePeriod in org.planit.trafficassignment.builder

Methods in org.planit.trafficassignment.builder with parameters of type TimePeriod

Modifier and Type	Method	Description
void	TrafficAssignmentBuilder.registerInitialLinkSegmentCost(TimePeriod timePeriod, InitialLinkSegmentCost initialLinkSegmentCost)	Register the initial link segment cost for a specified time period