Package org.opentrafficsim.sim0mq.publisher

Interface TransceiverInterface

All Superinterfaces:

Identifiable

All Known Implementing Classes:

AbstractEventTransceiver, AbstractIdTransceiver, AbstractTransceiver, CrossSectionElementTransceiver, GTUIdTransceiver, GTUTransceiver, LaneGTUIdTransceiver, LinkGTUIdTransceiver, LinkIdTransceiver, LinkTransceiver, NodeIdTransceiver, NodeTransceiver, Publisher, SimulatorStateTransceiver

public interface TransceiverInterface
extends Identifiable

Transceivers with machine interpretable description of address and result types. A transceiver converts DSOL events to Sim0MQ messages and Sim0MQ messages to DJUTILS event (un-)subscriptions, or DSOL events.

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.

$LastChangedDate: 2020-02-13 11:08:16 +0100 (Thu, 13 Feb 2020) $, @version $Revision: 6383 $, by $Author: pknoppers $,

Author:

Alexander Verbraeck, Peter Knoppers

Method Summary

Modifier and Type	Method	Description
Object[]	get(Object[] address, ReturnWrapper returnWrapper)	Retrieve the data.
MetaData	getAddressFields()	Specification of arguments needed in a request.
default TransceiverInterface	getIdSource(int addressLevel, ReturnWrapper returnWrapper)	Retrieve the TransceiverInterface that can be used to get detailed information about a single object.
MetaData	getResultFields()	Report the specification of a result of the transceiver.
default boolean	hasIdSource()	Report if this transceiver has an id source.

Methods inherited from interface org.opentrafficsim.base.Identifiable

getId

Method Detail

getAddressFields

MetaData getAddressFields()

Specification of arguments needed in a request.

Returns:

MetaData; the specification of arguments needed in a request

getIdSource

default 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:

SerializationException - when the ReturnWrapper fails

Sim0MQException - when the ReturnWrapper fails

hasIdSource

default 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

getResultFields

MetaData getResultFields()

Report the specification of a result of the transceiver.

Returns:

MetaData; the specification of a result from the transceiver

get

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

SerializationException - when encoding an error message fails

Sim0MQException - when encoding an error message fails