org.opentrafficsim.imb.transceiver

Interface Transceiver

All Known Subinterfaces:

EventTransceiver

public interface Transceiver

Relay events between IMB domain and OTS domain.

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

$LastChangedDate: 2015-07-24 02:58:59 +0200 (Fri, 24 Jul 2015) $, @version $Revision: 1147 $, by $Author: averbraeck $, initial version Oct 18, 2016

Author:

Alexander Verbraeck, Peter Knoppers, Wouter Schakel

Method Summary

Modifier and Type	Method and Description
Connector	getConnector() Retrieve the IMB connector.
String	getId() Retrieve the id for the Transceiver channel, e.g.
void	handleMessageFromIMB(String imbEventName, TByteBuffer imbPayload) Handle an IMB message sent to OTS.

Method Detail

getId

String getId()

Retrieve the id for the Transceiver channel, e.g. "GTU" or "Simulator Control".

Returns:

String; the id for the Transceiver channel, e.g. "GTU" or "Simulator Control".

getConnector

Connector getConnector()

Retrieve the IMB connector.

Returns:

Connector the IMB connector.

handleMessageFromIMB

void handleMessageFromIMB(String imbEventName,
                          TByteBuffer imbPayload)
                   throws IMBException

Handle an IMB message sent to OTS.

Parameters:

imbEventName - String; the IMB event name of the message that was received from IMB

imbPayload - TByteBuffer; the packed IMB message payload

Throws:

IMBException - in case the IMB event cannot be handled by this Transceiver