Package org.goplanit.output.adapter

Interface MacroscopicLinkOutputTypeAdapter

All Superinterfaces:

OutputTypeAdapter, UntypedLinkOutputTypeAdapter<MacroscopicLinkSegment>

All Known Implementing Classes:

MacroscopicLinkOutputTypeAdapterImpl, StaticLtmLinkOutputTypeAdapter, TraditionalStaticAssignmentLinkOutputTypeAdapter

public interface MacroscopicLinkOutputTypeAdapter
extends UntypedLinkOutputTypeAdapter<MacroscopicLinkSegment>

Interface defining the methods required for a macroscopic link (segment) output adapter

Author:

gman6028, markr

Method Summary

Modifier and Type	Method	Description
default Optional<Double>	getCapacityPerLanePcuHour(MacroscopicLinkSegment linkSegment)	Returns the value of the capacity per lane
default Optional<String>	getDownstreamNodeExternalId(MacroscopicLinkSegment linkSegment)	Returns the external Id of the downstream node
Optional<Long>	getInfrastructureLayerIdForMode(Mode mode)	collect the infrastructure layer id this mode resides on
Optional<?>	getLinkSegmentOutputPropertyValue(OutputProperty outputProperty, MacroscopicLinkSegment linkSegment, Mode mode, TimePeriod timePeriod)	Return the value of a specified output property of a link segment
default Optional<Long>	getLinkSegmentTypeId(MacroscopicLinkSegment linkSegment)	Return the link segment type id of the current link segment
default Optional<String>	getLinkSegmentTypeName(MacroscopicLinkSegment linkSegment)	Return the link segment type name of the current link segment
default Optional<String>	getLinkSegmentTypeXmlId(MacroscopicLinkSegment linkSegment)	Return the link segment type xml id of the current link segment
default Optional<Double>	getMaximumDensity(MacroscopicLinkSegment linkSegment)	Returns the flow density of the current link
default Optional<Double>	getMaximumSpeed(MacroscopicLinkSegment linkSegment, Mode mode)	Returns the maximum speed through the current 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 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, getPhysicalLinkSegments, getUpstreamNodeExternalId, getUpstreamNodeId, getUpstreamNodeLocation, getUpstreamNodeXmlId

Method Detail

getCapacityPerLanePcuHour

default Optional<Double> getCapacityPerLanePcuHour(MacroscopicLinkSegment linkSegment)
                                            throws PlanItException

Returns the value of the capacity per lane

Parameters:

linkSegment - LinkSegment containing data which may be required

Returns:

the capacity per lane across this link segment

Throws:

PlanItException - thrown if there is an error

getLinkSegmentTypeName

default Optional<String> getLinkSegmentTypeName(MacroscopicLinkSegment linkSegment)
                                         throws PlanItException

Return the link segment type name of the current link segment

Parameters:

linkSegment - the current link segment

Returns:

the link segment type name

Throws:

PlanItException - thrown if there is an error

getLinkSegmentTypeId

default Optional<Long> getLinkSegmentTypeId(MacroscopicLinkSegment linkSegment)
                                     throws PlanItException

Return the link segment type id of the current link segment

Parameters:

linkSegment - the current link segment

Returns:

the link segment type id

Throws:

PlanItException - thrown if there is an error

getLinkSegmentTypeXmlId

default Optional<String> getLinkSegmentTypeXmlId(MacroscopicLinkSegment linkSegment)
                                          throws PlanItException

Return the link segment type xml id of the current link segment

Parameters:

linkSegment - the current link segment

Returns:

the link segment type xml id

Throws:

PlanItException - thrown if there is an error

getMaximumDensity

default Optional<Double> getMaximumDensity(MacroscopicLinkSegment linkSegment)
                                    throws PlanItException

Returns the flow density of the current link

Parameters:

linkSegment - LinkSegment containing data which may be required

Returns:

the flow density of the current link

Throws:

PlanItException - thrown if there is an error

getDownstreamNodeExternalId

default Optional<String> getDownstreamNodeExternalId(MacroscopicLinkSegment linkSegment)
                                              throws PlanItException

Returns the external Id of the downstream node

Specified by:

getDownstreamNodeExternalId in interface UntypedLinkOutputTypeAdapter<MacroscopicLinkSegment>

Parameters:

linkSegment - LinkSegment object containing the required data

Returns:

he external Id of the downstream node

Throws:

PlanItException - thrown if there is an error

getMaximumSpeed

default Optional<Double> getMaximumSpeed(MacroscopicLinkSegment linkSegment,
                                         Mode mode)
                                  throws PlanItException

Returns the maximum speed through the current link segment

Parameters:

linkSegment - MacroscopicLinkSegment object containing the required data

mode - current mode

Returns:

the maximum speed through the current link segment

Throws:

PlanItException - thrown if there is an error

getInfrastructureLayerIdForMode

Optional<Long> getInfrastructureLayerIdForMode(Mode mode)

collect the infrastructure layer id this mode resides on

Parameters:

mode - to collect layer id for

Returns:

infrastructure layer id, null if not found

isFlowPositive

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 is there is flow through this link segment, false if the flow is zero

getLinkSegmentOutputPropertyValue

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

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

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)