Package org.goplanit.output.property

Class LinkSegmentCostOutputProperty

java.lang.Object

org.goplanit.output.property.OutputProperty

org.goplanit.output.property.LinkSegmentCostOutputProperty

All Implemented Interfaces:

Comparable<OutputProperty>

public final class LinkSegmentCostOutputProperty
extends OutputProperty

Link segment cost property. For now the cost is expressed in hours by default.

Author:

markr

Field Summary

Fields

Modifier and Type	Field	Description
static String	NAME

Constructor Summary

Constructors

Constructor	Description
LinkSegmentCostOutputProperty()

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
DataType	getDataType()	Returns the data type of the output property
Unit	getDefaultUnit()	Returns the units of the output property
String	getName()	Returns the name of the output property
OutputPropertyType	getOutputPropertyType()	Return the value of the OutputProperty enumeration for this property
boolean	supportsUnitOverride()	An output property can be allowed to deviate from its default unit.

Methods inherited from class org.goplanit.output.property.OutputProperty

compareTo, equals, getOverrideUnit, hashCode, isUnitOverride, of, of, setUnitOverride

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

LinkSegmentCostOutputProperty

public LinkSegmentCostOutputProperty()

Method Detail

supportsUnitOverride

public boolean supportsUnitOverride()

An output property can be allowed to deviate from its default unit. In which case an override unit is to be made available. By default an output property is not allowed to deviate. So derived implementations must override this method to ensure it returns true if it does support this feature.

Overrides:

supportsUnitOverride in class OutputProperty

Returns:

true when allowed, false otherwise

getName

public String getName()

Returns the name of the output property

Specified by:

getName in class OutputProperty

Returns:

name of the output property

getDefaultUnit

public Unit getDefaultUnit()

Returns the units of the output property

Specified by:

getDefaultUnit in class OutputProperty

Returns:

units of the output property

getDataType

public DataType getDataType()

Returns the data type of the output property

Specified by:

getDataType in class OutputProperty

Returns:

data type of the output property

getOutputPropertyType

public OutputPropertyType getOutputPropertyType()

Return the value of the OutputProperty enumeration for this property

Specified by:

getOutputPropertyType in class OutputProperty

Returns:

the value of the OutputProperty enumeration for this property

getColumnPriority

public 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

Specified by:

getColumnPriority in class OutputProperty

Returns:

the column priority