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:

Identifiable, TransceiverInterface

public class GTUTransceiver
extends AbstractEventTransceiver

Transceiver for GTU data.

Copyright (c) 2020-2020 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 Summary

Constructors

Constructor	Description
GTUTransceiver(OTSNetwork network, GTUIdTransceiver gtuIdSource)	Construct a GTUTransceiver.

Method Summary

Modifier and Type	Method	Description
Object[]	get(Object[] address, ReturnWrapper returnWrapper)	Retrieve the data.
TransceiverInterface	getIdSource(int addressLevel, ReturnWrapper returnWrapper)	Retrieve the TransceiverInterface that can be used to get detailed information about a single object.
boolean	hasIdSource()	Report if this transceiver has an id source.
String	toString()

Methods inherited from class org.opentrafficsim.sim0mq.publisher.AbstractEventTransceiver

constructResultFields

Methods inherited from class org.opentrafficsim.sim0mq.publisher.AbstractTransceiver

getAddressFields, getId, getResultFields, verifyMetaData

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

GTUTransceiver

public GTUTransceiver(OTSNetwork 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 Detail

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