Package org.planit.output.property

Class IterationIndexOutputProperty

java.lang.Object

org.planit.output.property.BaseOutputProperty

org.planit.output.property.IterationIndexOutputProperty

All Implemented Interfaces:

Comparable<BaseOutputProperty>

public final class IterationIndexOutputProperty
extends BaseOutputProperty

Field Summary

Fields

Modifier and Type	Field	Description
static String	NAME

Constructor Summary

Constructors

Constructor	Description
IterationIndexOutputProperty()

Method Summary

Modifier and Type	Method	Description
OutputPropertyPriority	getColumnPriority()	Gets the column priority of the output property in output files The lower the column priority value of a property, the further to the left it is placed in the output file
static int	getIterationIndex(TrafficAssignment trafficAssignment)	Returns the current iteration index
String	getName()	Returns the name of the output property
OutputProperty	getOutputProperty()	Return the value of the OutputProperty enumeration for this property
Type	getType()	Returns the data type of the output property
Units	getUnits()	Returns the units of the output property

Methods inherited from class org.planit.output.property.BaseOutputProperty

compareTo, convertToBaseOutputProperty, convertToBaseOutputProperty, equals, hashCode

Methods inherited from class java.lang.Object

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

Field Detail

NAME

public static final String NAME

See Also:

Constant Field Values

Constructor Detail

IterationIndexOutputProperty

public IterationIndexOutputProperty()

Method Detail

getName

public String getName()

Description copied from class: BaseOutputProperty

Returns the name of the output property

Specified by:

getName in class BaseOutputProperty

Returns:

name of the output property

getUnits

public Units getUnits()

Description copied from class: BaseOutputProperty

Returns the units of the output property

Specified by:

getUnits in class BaseOutputProperty

Returns:

units of the output property

getType

public Type getType()

Description copied from class: BaseOutputProperty

Returns the data type of the output property

Specified by:

getType in class BaseOutputProperty

Returns:

data type of the output property

getOutputProperty

public OutputProperty getOutputProperty()

Description copied from class: BaseOutputProperty

Return the value of the OutputProperty enumeration for this property

Specified by:

getOutputProperty in class BaseOutputProperty

Returns:

the value of the OutputProperty enumeration for this property

getColumnPriority

public OutputPropertyPriority getColumnPriority()

Description copied from class: BaseOutputProperty

Gets the column priority of the output property in output files The lower the column priority value of a property, the further to the left it is placed in the output file

Specified by:

getColumnPriority in class BaseOutputProperty

Returns:

the column priority

getIterationIndex

public static int getIterationIndex(TrafficAssignment trafficAssignment)
                             throws PlanItException

Returns the current iteration index

Parameters:

trafficAssignment - TrafficAssignment containing data which may be required

Returns:

the current iteration index

Throws:

PlanItException - thrown if there is an error