Class Facility

    • Constructor Detail

      • Facility

        public Facility​(Point point)
        Creates an instance of facility.
        Parameters:
        point - location of the facility
        Throws:
        java.lang.IllegalArgumentException - if point is null
        Since:
        100.1.0
    • Method Detail

      • getName

        public java.lang.String getName()
        Gets the name that was set for this facility.
        Returns:
        the name of facility. Default value is an empty string
        Since:
        100.1.0
        See Also:
        setName(String)
      • setName

        public void setName​(java.lang.String name)
        Sets the name for this facility.
        Parameters:
        name - facility's name. Null is treated as an empty string
        Since:
        100.1.0
        See Also:
        getName()
      • setCurbApproach

        public void setCurbApproach​(CurbApproach curbApproach)
        Sets the direction from which a vehicle may arrive at or depart from the facility. For example, a school bus must approach and depart a school from its door side so that students entering/exiting the bus will not have to cross the street.
        Parameters:
        curbApproach - curb approach
        Throws:
        java.lang.IllegalArgumentException - if curbApproach is null
        Since:
        100.1.0
        See Also:
        getCurbApproach()
      • getNetworkLocation

        public NetworkLocation getNetworkLocation()
        Gets the facility's location in the underlying transportation network.
        Returns:
        the network location. Returns null by default
        Since:
        100.1.0
        See Also:
        setNetworkLocation(NetworkLocation)
      • setNetworkLocation

        public void setNetworkLocation​(NetworkLocation networkLocation)
        Sets the facility's location in the underlying transportation network.
        Parameters:
        networkLocation - network location. It can be null
        Since:
        100.1.0
        See Also:
        getNetworkLocation()
      • getDistanceToNetworkLocation

        public double getDistanceToNetworkLocation()
        Gets the distance to the network location in meters.
        Returns:
        the distance to the network location in meters. Returns NaN by default
        Since:
        100.1.0
      • getGeometry

        public Point getGeometry()
        Gets the location the facility should be placed on the map.
        Returns:
        the geometry
        Since:
        100.1.0
      • getAddedCost

        public double getAddedCost​(java.lang.String attributeName)
        Gets the added cost that was set for this facility.
        Parameters:
        attributeName - attribute name. It can be empty. Null is treated as an empty string
        Returns:
        the added cost. Returns 0 if it was not set
        Since:
        100.1.0
      • setAddedCost

        public void setAddedCost​(java.lang.String attributeName,
                                 double addedCost)
        Sets the added cost for this facility.
        Parameters:
        attributeName - attribute name. It can be empty. Null is treated as an empty string
        addedCost - added cost
        Since:
        100.1.0
      • getCurrentBearing

        public double getCurrentBearing()
        Gets the current bearing in degrees, measured clockwise from true north. Typical values are 0 to 360 or NaN, negative values will have 360 added to them (e.g. -15 => 345), values greater than 360 will have 360 subtracted from them (e.g. 385 => 25). For this property to be used, the bearing tolerance must also be set.
        Returns:
        the current bearing
        Since:
        100.7.0
        See Also:
        setCurrentBearing(double)
      • setCurrentBearing

        public void setCurrentBearing​(double currentBearing)
        Sets the current bearing in degrees, measured clockwise from true north. Typical values are 0 to 360 or NaN, negative values will have 360 added to them (e.g. -15 => 345), values greater than 360 will have 360 subtracted from them (e.g. 385 => 25). For this property to be used, the bearing tolerance must also be set.
        Parameters:
        currentBearing - the new value for current bearing
        Since:
        100.7.0
        See Also:
        getCurrentBearing()
      • getCurrentBearingTolerance

        public double getCurrentBearingTolerance()
        Gets the current bearing tolerance in degrees. Valid values are 0 to 180 or NaN.
        Returns:
        the current bearing tolerance
        Since:
        100.7.0
      • setCurrentBearingTolerance

        public void setCurrentBearingTolerance​(double currentBearingTolerance)
        Sets the current bearing tolerance in degrees. Valid values are 0 to 180 or NaN.
        Parameters:
        currentBearingTolerance - the new value for current bearing tolerance
        Throws:
        java.lang.IllegalArgumentException - if currentBearingTolerance is out of range
        Since:
        100.7.0
      • getNavigationLatency

        public double getNavigationLatency()
        Gets the navigation latency in seconds.
        Returns:
        navigation latency in seconds
        Since:
        100.7.0
        See Also:
        setNavigationLatency(double)
      • setNavigationLatency

        public void setNavigationLatency​(double navigationLatency)
        Sets the navigation latency in seconds.
        Parameters:
        navigationLatency - the new value for navigation latency
        Since:
        100.7.0
        See Also:
        getNavigationLatency()
      • getNavigationSpeed

        public double getNavigationSpeed()
        Gets the navigation speed in meters per second.
        Returns:
        navigation speed in meters per second
        Since:
        100.7.0
        See Also:
        setNavigationSpeed(double)
      • setNavigationSpeed

        public void setNavigationSpeed​(double navigationSpeed)
        Sets the navigation speed in meters per second.
        Parameters:
        navigationSpeed - the new value for navigation speed
        Since:
        100.7.0
        See Also:
        getNavigationSpeed()