Package org.goplanit.assignment.traditionalstatic

Class TraditionalStaticAssignmentLinkOutputTypeAdapter

java.lang.Object

org.goplanit.output.adapter.OutputTypeAdapterImpl

org.goplanit.output.adapter.UntypedLinkOutputTypeAdapterImpl<MacroscopicLinkSegment>

org.goplanit.output.adapter.MacroscopicLinkOutputTypeAdapterImpl

org.goplanit.assignment.traditionalstatic.TraditionalStaticAssignmentLinkOutputTypeAdapter

All Implemented Interfaces:

MacroscopicLinkOutputTypeAdapter, OutputTypeAdapter, UntypedLinkOutputTypeAdapter<MacroscopicLinkSegment>

public class TraditionalStaticAssignmentLinkOutputTypeAdapter
extends MacroscopicLinkOutputTypeAdapterImpl

Adapter providing access to the data of the TraditionalStaticAssignment class relevant for link outputs without exposing the internals of the traffic assignment class itself

Author:

markr

Field Summary

Fields inherited from class org.goplanit.output.adapter.OutputTypeAdapterImpl

outputType

Constructor Summary

Constructors

Constructor	Description
TraditionalStaticAssignmentLinkOutputTypeAdapter(OutputType outputType, TrafficAssignment trafficAssignment)	Constructor

Method Summary

Modifier and Type	Method	Description
protected TraditionalStaticAssignment	getAssignment()	Access the assignment
Optional<?>	getLinkSegmentOutputPropertyValue(OutputProperty outputProperty, MacroscopicLinkSegment linkSegment, Mode mode, TimePeriod timePeriod)	Return the value of a specified output property of a link segment
Optional<Boolean>	isFlowPositive(MacroscopicLinkSegment linkSegment, Mode mode)	Returns true if there is a flow through the current specified link segment for the specified mode

Methods inherited from class org.goplanit.output.adapter.MacroscopicLinkOutputTypeAdapterImpl

getInfrastructureLayerIdForMode, getPhysicalLinkSegments

Methods inherited from class org.goplanit.output.adapter.UntypedLinkOutputTypeAdapterImpl

getLinkSegmentOutputPropertyValue

Methods inherited from class org.goplanit.output.adapter.OutputTypeAdapterImpl

createConvertedUnitsValue, getIterationIndexForSubOutputType, getOutputType, getOutputTypeIndependentPropertyValue

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.goplanit.output.adapter.MacroscopicLinkOutputTypeAdapter

getCapacityPerLanePcuHour, getDownstreamNodeExternalId, getLinkSegmentTypeId, getLinkSegmentTypeName, getLinkSegmentTypeXmlId, getMaximumDensity, getMaximumSpeed

Methods inherited from interface org.goplanit.output.adapter.OutputTypeAdapter

getIterationIndexForSubOutputType, getOutputType

Methods inherited from interface org.goplanit.output.adapter.UntypedLinkOutputTypeAdapter

getDownstreamNodeId, getDownstreamNodeLocation, getDownstreamNodeXmlId, getLength, getLinkSegmentExternalId, getLinkSegmentId, getLinkSegmentOutputPropertyValue, getLinkSegmentXmlId, getNumberOfLanes, getUpstreamNodeExternalId, getUpstreamNodeId, getUpstreamNodeLocation, getUpstreamNodeXmlId

Constructor Detail

TraditionalStaticAssignmentLinkOutputTypeAdapter

public TraditionalStaticAssignmentLinkOutputTypeAdapter(OutputType outputType,
                                                        TrafficAssignment trafficAssignment)

Constructor

Parameters:

outputType - the output type for the current persistence

trafficAssignment - the traffic assignment used to provide the data

Method Detail

getAssignment

protected TraditionalStaticAssignment getAssignment()

Access the assignment

Overrides:

getAssignment in class OutputTypeAdapterImpl

Returns:

the assignment

isFlowPositive

public Optional<Boolean> isFlowPositive(MacroscopicLinkSegment linkSegment,
                                        Mode mode)

Returns true if there is a flow through the current specified link segment for the specified mode

Parameters:

linkSegment - specified link segment

mode - specified mode

Returns:

true if there is flow through this link segment, false if the flow is zero

getLinkSegmentOutputPropertyValue

public Optional<?> getLinkSegmentOutputPropertyValue(OutputProperty outputProperty,
                                                     MacroscopicLinkSegment linkSegment,
                                                     Mode mode,
                                                     TimePeriod timePeriod)

Return the value of a specified output property of a link segment

Specified by:

getLinkSegmentOutputPropertyValue in interface MacroscopicLinkOutputTypeAdapter

Overrides:

getLinkSegmentOutputPropertyValue in class MacroscopicLinkOutputTypeAdapterImpl

Parameters:

outputProperty - the specified output property

linkSegment - the specified link segment

mode - the current mode

timePeriod - the current time period

Returns:

the value of the specified output property (or an Exception if an error occurs)