DualAccelerationStep.java

package org.opentrafficsim.road.gtu.lane.tactical.following;

import java.io.Serializable;

import org.djunits.value.vdouble.scalar.Acceleration;
import org.djunits.value.vdouble.scalar.Time;

/**
 * Container for two instances of an AccelerationStep. One for the GTU that is deciding its move (the leader); one for the GTU
 * that will/would be the (new) follower of that GTU.
 * <p>
 * Copyright (c) 2013-2024 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved. <br>
 * BSD-style license. See <a href="https://opentrafficsim.org/docs/license.html">OpenTrafficSim License</a>.
 * </p>
 * @author <a href="https://tudelft.nl/staff/p.knoppers-1">Peter Knoppers</a>
 */
public class DualAccelerationStep implements Serializable
{
    /** */
    private static final long serialVersionUID = 20150311L;

    /** AccelerationStep for the leader. */
    private final AccelerationStep leaderAccelerationStep;

    /** AccelerationStep for the (new) follower. */
    private final AccelerationStep followerAccelerationStep;

    /**
     * Create a new DualAccelerationStep.
     * @param leaderAccelerationStep AccelerationStep; the acceleration and time step size for the leader
     * @param followerAccelerationStep AccelerationStep; the acceleration and time step size for the (new) follower
     */
    public DualAccelerationStep(final AccelerationStep leaderAccelerationStep, final AccelerationStep followerAccelerationStep)
    {
        this.leaderAccelerationStep = leaderAccelerationStep;
        this.followerAccelerationStep = followerAccelerationStep;
    }

    /**
     * Retrieve the AccelerationStep for the leader GTU.
     * @return AccelerationStep; the acceleration and time step size for the leader
     */
    public final AccelerationStep getLeaderAccelerationStep()
    {
        return this.leaderAccelerationStep;
    }

    /**
     * Retrieve the AccelerationStep for the (new) follower GTU.
     * @return AccelerationStep; the acceleration and time step size for the (new) follower
     */
    public final AccelerationStep getFollowerAccelerationStep()
    {
        return this.followerAccelerationStep;
    }

    /**
     * Return the acceleration of the leader.
     * @return DoubleScalar&lt;AccelerationUnit&gt;; the acceleration of the leader
     */
    public final Acceleration getLeaderAcceleration()
    {
        return getLeaderAccelerationStep().getAcceleration();
    }

    /**
     * Return the acceleration of the follower.
     * @return DoubleScalar&lt;AccelerationUnit&gt;; the acceleration of the follower
     */
    public final Acceleration getFollowerAcceleration()
    {
        return getFollowerAccelerationStep().getAcceleration();
    }

    /**
     * Return the time up to which the result of the leader is valid.
     * @return DoubleScalar&lt;TimeUnit&gt;; the time up to which the result of the leader is valid
     */
    public final Time getLeaderValidUntil()
    {
        return getLeaderAccelerationStep().getValidUntil();
    }

    /**
     * Return the time up to which the result of the follower is valid.
     * @return DoubleScalar&lt;TimeUnit&gt;; the time up to which the result of the follower is valid
     */
    public final Time getFollowerValidUntil()
    {
        return getFollowerAccelerationStep().getValidUntil();
    }

    /** {@inheritDoc} */
    @Override
    public final String toString()
    {
        return "Follower: " + getFollowerAccelerationStep() + ", Leader: " + getLeaderAccelerationStep();
    }

}