Package org.opentrafficsim.sim0mq.publisher

Class GtuTransceiver

java.lang.Object
org.opentrafficsim.sim0mq.publisher.AbstractTransceiver
org.opentrafficsim.sim0mq.publisher.AbstractEventTransceiver
org.opentrafficsim.sim0mq.publisher.GtuTransceiver
All Implemented Interfaces:
org.opentrafficsim.base.Identifiable, TransceiverInterface
public class GtuTransceiver extends AbstractEventTransceiver
Transceiver for GTU data.

Copyright (c) 2020-2023 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved.
BSD-style license. See OpenTrafficSim License.

Author:
Alexander Verbraeck, Peter Knoppers, Wouter Schakel

  • Constructor Details

    • GtuTransceiver

      public GtuTransceiver(org.opentrafficsim.core.network.Network network, GtuIdTransceiver gtuIdSource)
      Construct a GtuTransceiver.
      Parameters:
      network - Network; the Network
      gtuIdSource - GtuIdTransceiver; the transceiver that can produce all active GTU ids in the Network

  • Method Details

    • getIdSource

      public final TransceiverInterface getIdSource(int addressLevel, ReturnWrapper returnWrapper) throws Sim0MQException, SerializationException
      Retrieve the TransceiverInterface that can be used to get detailed information about a single object.
      Parameters:
      addressLevel - int; index of the argument in the address fields
      returnWrapper - ReturnWrapper; to be used to report problems
      Returns:
      TransceiverInterface; to be used to get valid values for argument addressLevel, or null if valid values for the argument at index addressLevel can not be obtained through a TransceiverInterface object
      Throws:
      Sim0MQException - when the ReturnWrapper fails
      SerializationException - when the ReturnWrapper fails

    • hasIdSource

      public boolean hasIdSource()
      Report if this transceiver has an id source.
      Returns:
      boolean; true if this transceiver has an id source; false if this transceiver does not have an id source

    • get

      public final Object[] get(Object[] address, ReturnWrapper returnWrapper) throws RemoteException, Sim0MQException, SerializationException
      Retrieve the data.
      Parameters:
      address - Object[]; the address of the data to retrieve
      returnWrapper - ReturnWrapper; to be used to report problems
      Returns:
      Object[]; the retrieved data, or null when no object with the address could be found
      Throws:
      RemoteException - when communication needed to retrieve the data failed
      Sim0MQException - when encoding an error message fails
      SerializationException - when encoding an error message fails

    • toString

      public String toString()
      Overrides:
      toString in class AbstractTransceiver