Package org.opentrafficsim.road.gtu.lane

Interface InternalLaneBasedGtu

    • Method Detail

      • changeLaneInstantaneously

        void changeLaneInstantaneously​(LateralDirectionality laneChangeDirection)
                        throws GtuException
        Change lanes instantaneously.
        Parameters:
        laneChangeDirection - LateralDirectionality; the direction to change to
        Throws:
        GtuException - in case lane change fails

      • initLaneChange

        void initLaneChange​(LateralDirectionality laneChangeDirection)
             throws GtuException
        Register on lanes in target lane.
        Parameters:
        laneChangeDirection - LateralDirectionality; direction of lane change
        Throws:
        GtuException - exception

      • setFinalizeLaneChangeEvent

        void setFinalizeLaneChangeEvent​(SimEventInterface<SimTimeDoubleUnit> event)
        Sets event to finalize lane change.
        Parameters:
        event - SimEventInterface<SimTimeDoubleUnit>; event

      • setInstantaneousLaneChange

        void setInstantaneousLaneChange​(boolean instantaneous)
        Sets whether the GTU perform lane changes instantaneously or not.
        Parameters:
        instantaneous - boolean; whether the GTU perform lane changes instantaneously or not

      • isInstantaneousLaneChange

        boolean isInstantaneousLaneChange()
        Returns whether the GTU perform lane changes instantaneously or not.
        Returns:
        boolean; whether the GTU perform lane changes instantaneously or not

      • positions

        Map<Lane,​Length> positions​(RelativePosition relativePosition,
                                 Time when)
                          throws GtuException
        Return the longitudinal positions of a point relative to this GTU, relative to the center line of the Lanes in which the vehicle is registered.
        Parameters:
        relativePosition - RelativePosition; the position on the vehicle relative to the reference point.
        when - Time; the future time for which to calculate the positions.
        Returns:
        the lanes and the position on the lanes where the GTU will be registered at the time, for the given position of the GTU.
        Throws:
        GtuException - when the vehicle is not on one of the lanes on which it is registered.

      • position

        Length position​(Lane lane,
                RelativePosition relativePosition,
                Time when)
         throws GtuException
        Return the longitudinal position of a point relative to this GTU, relative to the center line of the Lane.
        Parameters:
        lane - Lane; the position on this lane will be returned.
        relativePosition - RelativePosition; the position on the vehicle relative to the reference point.
        when - Time; the future time for which to calculate the positions.
        Returns:
        DoubleScalarAbs<LengthUnit>; the position, relative to the center line of the Lane.
        Throws:
        GtuException - when the vehicle is not on the given lane.

      • fractionalPositions

        Map<Lane,​Double> fractionalPositions​(RelativePosition relativePosition,
                                           Time when)
                                    throws GtuException
        Return the longitudinal positions of a point relative to this GTU, relative to the center line of the Lanes in which the vehicle is registered, as fractions of the length of the lane. This is important when we want to see if two vehicles are next to each other and we compare an 'inner' and 'outer' curve.
        Parameters:
        relativePosition - RelativePosition; the position on the vehicle relative to the reference point.
        when - Time; the future time for which to calculate the positions.
        Returns:
        the lanes and the position on the lanes where the GTU will be registered at the time, for the given position of the GTU.
        Throws:
        GtuException - when the vehicle is not on one of the lanes on which it is registered.

      • fractionalPosition

        double fractionalPosition​(Lane lane,
                          RelativePosition relativePosition,
                          Time when)
                   throws GtuException
        Return the longitudinal position of a point relative to this GTU, relative to the center line of the Lane, as a fraction of the length of the lane. This is important when we want to see if two vehicles are next to each other and we compare an 'inner' and 'outer' curve.
        Parameters:
        lane - Lane; the position on this lane will be returned.
        relativePosition - RelativePosition; the position on the vehicle relative to the reference point.
        when - Time; the future time for which to calculate the positions.
        Returns:
        the fractional relative position on the lane at the given time.
        Throws:
        GtuException - when the vehicle is not on the given lane.

      • addTrigger

        void addTrigger​(Lane lane,
                SimEventInterface<SimTimeDoubleUnit> event)
        Add an event to the list of lane triggers scheduled for this GTU.
        Parameters:
        lane - Lane; the lane on which the event occurs
        event - SimEventInterface<SimTimeDoubleUnit>; SimeEvent<SimTimeDoubleUnit> the event

      • setNoLaneChangeDistance

        void setNoLaneChangeDistance​(Length distance)
        Set distance over which the GTU should not change lane after being created.
        Parameters:
        distance - Length; distance over which the GTU should not change lane after being created

      • laneChangeAllowed

        boolean laneChangeAllowed()
        Returns whether a lane change is allowed.
        Returns:
        whether a lane change is allowed

      • getDesiredSpeed

        Speed getDesiredSpeed()
        This method returns the current desired speed of the GTU. This value is required often, so implementations can cache it.
        Returns:
        Speed; current desired speed

      • getCarFollowingAcceleration

        Acceleration getCarFollowingAcceleration()
        This method returns the current car-following acceleration of the GTU. This value is required often, so implementations can cache it.
        Returns:
        Acceleration; current car-following acceleration

      • getVehicleModel

        default VehicleModel getVehicleModel()
        Returns the vehicle model.
        Returns:
        VehicleModel; vehicle model

      • isBrakingLightsOn

        default boolean isBrakingLightsOn​(Time when)
        The default implementation returns true if the deceleration is larger than a speed-dependent threshold given by:

        c0 * g(v) + c1 + c3*v^2

        where c0 = 0.2, c1 = 0.15 and c3 = 0.00025 (with c2 = 0 implicit) are empirically derived averages, and g(v) is 0 below 25 km/h or 1 otherwise, representing that the engine is disengaged at low speeds.
        Parameters:
        when - Time; time
        Returns:
        boolean; whether the braking lights are on

      • getTurnIndicatorStatus

        TurnIndicatorStatus getTurnIndicatorStatus​(Time time)
        Parameters:
        time - Time; time to obtain the turn indicator status at
        Returns:
        the status of the turn indicator at the given time

      • setTurnIndicatorStatus

        void setTurnIndicatorStatus​(TurnIndicatorStatus turnIndicatorStatus)
                     throws GtuException
        Set the status of the turn indicator.
        Parameters:
        turnIndicatorStatus - TurnIndicatorStatus; the new status of the turn indicator.
        Throws:
        GtuException - when GTUType does not have a turn indicator