Package org.opentrafficsim.sim0mq.publisher

Class SimulatorStateTransceiver

java.lang.Object

org.opentrafficsim.sim0mq.publisher.AbstractTransceiver

org.opentrafficsim.sim0mq.publisher.SimulatorStateTransceiver

All Implemented Interfaces:

org.opentrafficsim.base.Identifiable, TransceiverInterface

public class SimulatorStateTransceiver
extends AbstractTransceiver

Transceiver for simulator state change events.

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

Peter Knoppers

Field Summary

Fields

Modifier and Type	Field	Description
(package private) EventProducerInterface	eventMultiplexer	Multiplexes SimulatorInterface.START_EVENT and SimulatorInterface.STOP_EVENT.
static TimedEventType	SIMULATOR_STATE_CHANGED	The event that will be emitted for either the START_EVENT or the STOP_EVENT.

Constructor Summary

Constructors

Constructor	Description
SimulatorStateTransceiver(org.opentrafficsim.core.dsol.OTSSimulatorInterface simulator)	Construct a new SimulatorStateTransceiver.

Method Summary

Modifier and Type	Method	Description
Object[]	get(Object[] address, ReturnWrapper returnWrapper)	Retrieve the data.
LookupEventProducerInterface	getLookupEventProducerInterface()	Retrieve the event LookupEventProducerInterface.

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

getAddressFields, getId, getResultFields, toString, verifyMetaData

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opentrafficsim.sim0mq.publisher.TransceiverInterface

getIdSource, hasIdSource

Field Detail

eventMultiplexer

final EventProducerInterface eventMultiplexer

Multiplexes SimulatorInterface.START_EVENT and SimulatorInterface.STOP_EVENT.

SIMULATOR_STATE_CHANGED

public static final TimedEventType SIMULATOR_STATE_CHANGED

The event that will be emitted for either the START_EVENT or the STOP_EVENT.

Constructor Detail

SimulatorStateTransceiver

public SimulatorStateTransceiver(org.opentrafficsim.core.dsol.OTSSimulatorInterface simulator)
                          throws RemoteException

Construct a new SimulatorStateTransceiver.

Parameters:

simulator - OTSSimulatorInterface; the simulator

Throws:

RemoteException - on network error

Method Detail

get

public 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

getLookupEventProducerInterface

public LookupEventProducerInterface getLookupEventProducerInterface()

Retrieve the event LookupEventProducerInterface.

Returns:

EventProducerInterface; the event multiplexer