LaneGTUIdTransceiver.java

package org.opentrafficsim.sim0mq.publisher;

import org.djunits.Throw;
import org.djutils.immutablecollections.ImmutableList;
import org.djutils.metadata.MetaData;
import org.djutils.metadata.ObjectDescriptor;
import org.djutils.serialization.SerializationException;
import org.opentrafficsim.core.gtu.GTU;
import org.opentrafficsim.core.network.Link;
import org.opentrafficsim.core.network.OTSNetwork;
import org.opentrafficsim.road.gtu.lane.LaneBasedGTU;
import org.opentrafficsim.road.network.lane.CrossSectionElement;
import org.opentrafficsim.road.network.lane.CrossSectionLink;
import org.opentrafficsim.road.network.lane.Lane;
import org.sim0mq.Sim0MQException;

/**
 * Transceiver for the ids of the GTUs on a link.
 * <p>
 * Copyright (c) 2020-2022 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved. <br>
 * BSD-style license. See <a href="http://opentrafficsim.org/docs/current/license.html">OpenTrafficSim License</a>.
 * </p>
 * @author <a href="http://www.tbm.tudelft.nl/averbraeck">Alexander Verbraeck</a>
 * @author <a href="http://www.tudelft.nl/pknoppers">Peter Knoppers</a>
 * @author <a href="http://www.transport.citg.tudelft.nl">Wouter Schakel</a>
 */
public class LaneGTUIdTransceiver extends AbstractTransceiver
{
    /** The network. */
    private final OTSNetwork network;

    /**
     * Construct a GTUIdTransceiver.
     * @param network OTSNetwork; the OTS network
     */
    public LaneGTUIdTransceiver(final OTSNetwork network)
    {
        super("Lane GTU id transceiver",
                new MetaData("Link id, lane id", "Link id, lane id",
                        new ObjectDescriptor[] { new ObjectDescriptor("Link id", "Link id", String.class),
                                new ObjectDescriptor("Lane id", "Lane id", String.class) }),
                new MetaData("String array", "String array filled with all currently valid GTU ids on the lane",
                        new ObjectDescriptor[] { new ObjectDescriptor("String array",
                                "String array filled with all currently valid GTU ids on the lane", String[].class) }));
        Throw.whenNull(network, "Network may not be null");
        this.network = network;
    }

    /** {@inheritDoc} */
    @Override
    public final Object[] get(final Object[] address, final ReturnWrapper returnWrapper)
            throws Sim0MQException, SerializationException
    {
        String bad = verifyMetaData(getAddressFields(), address);
        if (bad != null)
        {
            returnWrapper.nack("Bad address; need id of a link and id of a CrossSectionElement");
            return null;
        }
        Link link = this.network.getLink((String) address[0]);
        if (null == link || (!(link instanceof CrossSectionLink)))
        {
            returnWrapper.nack("Network does not contain a link with id " + address[0]);
            return null;
        }
        CrossSectionLink csl = (CrossSectionLink) link;
        CrossSectionElement cse = csl.getCrossSectionElement((String) address[1]);
        if (null == cse)
        {
            returnWrapper.nack("Link " + address[0] + " does not contain a cross section element with id " + address[1]);
            return null;
        }
        if (!(cse instanceof Lane))
        {
            returnWrapper.nack("CrossSectionElement " + address[1] + " of link with id " + address[0] + ", is not a lane");
            return null;
        }
        Lane lane = (Lane) cse;
        ImmutableList<LaneBasedGTU> gtus = lane.getGtuList();
        Object[] result = new Object[gtus.size()];
        int nextIndex = 0;
        for (GTU gtu : gtus)
        {
            result[nextIndex++] = gtu.getId();
        }
        return result;
    }

    /** {@inheritDoc} */
    @Override
    public String toString()
    {
        return "LaneGTUIdTransceiver [network=" + this.network + ", super=" + super.toString() + "]";
    }

}