Class NetworkLocation


  • public final class NetworkLocation
    extends Object
    Represents a specific location/position along a transportation network source feature.
    Since:
    100.0.0
    See Also:
    Stop.getNetworkLocation()
    • Constructor Detail

      • NetworkLocation

        public NetworkLocation()
        Creates an instance of NetworkLocation.
        Since:
        100.0.0
    • Method Detail

      • getSourceObjectPosition

        public SourceObjectPosition getSourceObjectPosition()
        Gets information about how the position of the Stop relates to the underlying source feature in the network dataset.
        Returns:
        the source object position. Returns a non-null source object position if it was not set.
        Since:
        100.0.0
      • setSourceObjectPosition

        public void setSourceObjectPosition​(SourceObjectPosition sourceObjectPosition)
        Sets the position of network element on the network source.
        Parameters:
        sourceObjectPosition - source object position
        Throws:
        IllegalArgumentException - if sourceObjectPosition is null
        Since:
        100.0.0
      • isOnRightSideOfSource

        public boolean isOnRightSideOfSource()
        Indicates if the Stop is on the right side of the source feature.
        Returns:
        true if the Stop is located on the right side of the source feature, false otherwise
        Since:
        100.0.0
      • setOnRightSideOfSource

        public void setOnRightSideOfSource​(boolean onRightSideOfSource)
        Sets if the Stop is on the right side of the source feature.
        Parameters:
        onRightSideOfSource - true if the Stop is located on the right side of the source feature, false otherwise
        Since:
        100.0.0
      • getSourceName

        public String getSourceName()
        Gets the name of the network source.
        Returns:
        the source name. Returns an empty string by default
        Since:
        100.0.0
      • setSourceName

        public void setSourceName​(String sourceName)
        Sets the name of the network source.
        Parameters:
        sourceName - source name. It can be empty. Null is treated as an empty string
        Since:
        100.0.0