Index
All Classes and Interfaces|All Packages
A
- AbstractEventTransceiver - Class in org.opentrafficsim.sim0mq.publisher
-
Transceiver for DJUNITS events.
- AbstractEventTransceiver(String, MetaData, EventType) - Constructor for class org.opentrafficsim.sim0mq.publisher.AbstractEventTransceiver
-
Construct a new AbstractEventTransceiver.
- AbstractIdTransceiver - Class in org.opentrafficsim.sim0mq.publisher
-
Common code for id transceivers that use an empty address.
- AbstractIdTransceiver(Network, String) - Constructor for class org.opentrafficsim.sim0mq.publisher.AbstractIdTransceiver
-
Construct a GtuIdTransceiver.
- AbstractTransceiver - Class in org.opentrafficsim.sim0mq.publisher
-
Common code for most implementations of TranceiverInterface.
- AbstractTransceiver(String, MetaData, MetaData) - Constructor for class org.opentrafficsim.sim0mq.publisher.AbstractTransceiver
-
Construct a new AbstractTransceiver.
- ack(String) - Method in interface org.opentrafficsim.sim0mq.publisher.ReturnWrapper
-
Signal successful execution of a request.
C
- constructResultFields(EventType) - Static method in class org.opentrafficsim.sim0mq.publisher.AbstractEventTransceiver
-
Construct a Sim0MQ MetaData object that corresponds to the MetaData of DJUTILS EventType.
- CrossSectionElementTransceiver - Class in org.opentrafficsim.sim0mq.publisher
-
Transceiver for CrossSectionElement data.
- CrossSectionElementTransceiver(Network) - Constructor for class org.opentrafficsim.sim0mq.publisher.CrossSectionElementTransceiver
-
Construct a new CrossSectionElementTransceiver for an OTS network.
D
- dataClassName() - Method in class org.opentrafficsim.sim0mq.publisher.EventSerializer
- deSerialize(byte[], Pointer, EndianUtil) - Method in class org.opentrafficsim.sim0mq.publisher.EventSerializer
E
- encodeReplyAndTransmit(Boolean, Object[]) - Method in interface org.opentrafficsim.sim0mq.publisher.ReturnWrapper
-
Encode a String reply and transmit it while patching the message type id field by adding a vertical bar and a suffix.
- encodeReplyAndTransmit(Boolean, Object[]) - Method in class org.opentrafficsim.sim0mq.publisher.ReturnWrapperImpl
-
Encode a String reply and transmit it while patching the message type id field by adding a vertical bar and a suffix.
- encodeReplyAndTransmit(Boolean, String) - Method in interface org.opentrafficsim.sim0mq.publisher.ReturnWrapper
-
Encode a String reply and transmit it.
- encodeReplyAndTransmit(Object[]) - Method in interface org.opentrafficsim.sim0mq.publisher.ReturnWrapper
-
Encode a String reply and transmit it.
- encodeReplyAndTransmit(String) - Method in interface org.opentrafficsim.sim0mq.publisher.ReturnWrapper
-
Encode a String reply and transmit it.
- equals(Object) - Method in class org.opentrafficsim.sim0mq.publisher.ReturnWrapperImpl
- eventMultiplexer - Variable in class org.opentrafficsim.sim0mq.publisher.SimulatorStateTransceiver
-
Multiplexes SimulatorInterface.START_EVENT and SimulatorInterface.STOP_EVENT.
- EventMultiplexer - Class in org.opentrafficsim.sim0mq.publisher
-
Create a subscription to SimulatorInterface.START_EVENT and SimulatorInterface.STOP_EVENT and emit a SIMULATOR_STATE_CHANGED event for each.
- EventMultiplexer(OtsSimulatorInterface) - Constructor for class org.opentrafficsim.sim0mq.publisher.EventMultiplexer
- EventSerializer<E extends org.djutils.event.Event> - Class in org.opentrafficsim.sim0mq.publisher
-
Convert one Event into an equivalent Sim0MQ Message, or back.
- EventSerializer(EventType) - Constructor for class org.opentrafficsim.sim0mq.publisher.EventSerializer
-
Construct a new EventSerializer for the specified
EventType
. - executeCommand(String, String, Object[], ReturnWrapperImpl) - Method in class org.opentrafficsim.sim0mq.publisher.Publisher
-
Execute one command.
- executeCommand(String, SubscriptionHandler.Command, Object[], ReturnWrapper) - Method in class org.opentrafficsim.sim0mq.publisher.Publisher
-
Execute one command.
- executeCommand(SubscriptionHandler.Command, Object[], ReturnWrapper) - Method in class org.opentrafficsim.sim0mq.publisher.SubscriptionHandler
-
Execute one command.
F
- fieldType() - Method in class org.opentrafficsim.sim0mq.publisher.EventSerializer
G
- get(Object[], ReturnWrapper) - Method in class org.opentrafficsim.sim0mq.publisher.AbstractIdTransceiver
-
Retrieve the data.
- get(Object[], ReturnWrapper) - Method in class org.opentrafficsim.sim0mq.publisher.CrossSectionElementTransceiver
-
Retrieve the data.
- get(Object[], ReturnWrapper) - Method in class org.opentrafficsim.sim0mq.publisher.GtuTransceiver
-
Retrieve the data.
- get(Object[], ReturnWrapper) - Method in class org.opentrafficsim.sim0mq.publisher.LaneGtuIdTransceiver
-
Retrieve the data.
- get(Object[], ReturnWrapper) - Method in class org.opentrafficsim.sim0mq.publisher.LinkGtuIdTransceiver
-
Retrieve the data.
- get(Object[], ReturnWrapper) - Method in class org.opentrafficsim.sim0mq.publisher.LinkTransceiver
-
Retrieve the data.
- get(Object[], ReturnWrapper) - Method in class org.opentrafficsim.sim0mq.publisher.NodeTransceiver
-
Retrieve the data.
- get(Object[], ReturnWrapper) - Method in class org.opentrafficsim.sim0mq.publisher.Publisher
-
Retrieve the data.
- get(Object[], ReturnWrapper) - Method in class org.opentrafficsim.sim0mq.publisher.SimulatorStateTransceiver
-
Retrieve the data.
- get(Object[], ReturnWrapper) - Method in class org.opentrafficsim.sim0mq.publisher.SubscriptionHandler
-
Retrieve a data collection.
- get(Object[], ReturnWrapper) - Method in interface org.opentrafficsim.sim0mq.publisher.TransceiverInterface
-
Retrieve the data.
- GET_ADDRESS_META_DATA - Enum constant in enum class org.opentrafficsim.sim0mq.publisher.SubscriptionHandler.Command
-
Get the address meta data.
- GET_COMMANDS - Enum constant in enum class org.opentrafficsim.sim0mq.publisher.SubscriptionHandler.Command
-
Get the set of implemented commands (must - itself - always be implemented).
- GET_CURRENT - Enum constant in enum class org.opentrafficsim.sim0mq.publisher.SubscriptionHandler.Command
-
Get current set (if a collection), c.q. state (if properties of one object).
- GET_LIST - Enum constant in enum class org.opentrafficsim.sim0mq.publisher.SubscriptionHandler.Command
-
Get the output of the IdSource.
- GET_RESULT_META_DATA - Enum constant in enum class org.opentrafficsim.sim0mq.publisher.SubscriptionHandler.Command
-
Get the result meta data.
- getAddressFields() - Method in class org.opentrafficsim.sim0mq.publisher.AbstractTransceiver
-
Specification of arguments needed in a request.
- getAddressFields() - Method in interface org.opentrafficsim.sim0mq.publisher.TransceiverInterface
-
Specification of arguments needed in a request.
- getAddressMetaData() - Method in interface org.opentrafficsim.sim0mq.publisher.LookupEventProducer
-
Return a MetaData object that can be used to verify the correctness of an address for the
lookup
method. - getId() - Method in class org.opentrafficsim.sim0mq.publisher.AbstractTransceiver
- getId() - Method in interface org.opentrafficsim.sim0mq.publisher.IncomingDataHandler
-
Obtain a descriptive name of the IncomingDataHandler.
- getId() - Method in class org.opentrafficsim.sim0mq.publisher.SubscriptionHandler
-
Retrieve the id of this SubscriptionHandler.
- getIdSource(int, ReturnWrapper) - Method in class org.opentrafficsim.sim0mq.publisher.GtuTransceiver
-
Retrieve the TransceiverInterface that can be used to get detailed information about a single object.
- getIdSource(int, ReturnWrapper) - Method in class org.opentrafficsim.sim0mq.publisher.LinkTransceiver
-
Retrieve the TransceiverInterface that can be used to get detailed information about a single object.
- getIdSource(int, ReturnWrapper) - Method in class org.opentrafficsim.sim0mq.publisher.NodeTransceiver
-
Retrieve the TransceiverInterface that can be used to get detailed information about a single object.
- getIdSource(int, ReturnWrapper) - Method in class org.opentrafficsim.sim0mq.publisher.Publisher
-
Retrieve the TransceiverInterface that can be used to get detailed information about a single object.
- getIdSource(int, ReturnWrapper) - Method in interface org.opentrafficsim.sim0mq.publisher.TransceiverInterface
-
Retrieve the TransceiverInterface that can be used to get detailed information about a single object.
- getKey() - Method in interface org.opentrafficsim.sim0mq.publisher.IncomingDataHandler
-
Obtain the key that is used to identify incoming data destined for this IncomingDataHandler, (this key should appear in field 5 of the Sim0MQ messages).
- getListTransceiver() - Method in class org.opentrafficsim.sim0mq.publisher.SubscriptionHandler
-
Retrieve the list transceiver (only for testing).
- getLookupEventProducer() - Method in class org.opentrafficsim.sim0mq.publisher.SimulatorStateTransceiver
-
Retrieve the event LookupEventProducer.
- getNetwork() - Method in class org.opentrafficsim.sim0mq.publisher.AbstractIdTransceiver
-
Retrieve the network.
- getNumberOfDimensions() - Method in class org.opentrafficsim.sim0mq.publisher.EventSerializer
- getResultFields() - Method in class org.opentrafficsim.sim0mq.publisher.AbstractTransceiver
-
Report the specification of a result of the transceiver.
- getResultFields() - Method in interface org.opentrafficsim.sim0mq.publisher.TransceiverInterface
-
Report the specification of a result of the transceiver.
- getSet() - Method in class org.opentrafficsim.sim0mq.publisher.AbstractIdTransceiver
-
Retrieve the set of names of objects that can be individually subscribed to.
- getSet() - Method in class org.opentrafficsim.sim0mq.publisher.GtuIdTransceiver
-
Retrieve the set of names of objects that can be individually subscribed to.
- getSet() - Method in class org.opentrafficsim.sim0mq.publisher.LinkIdTransceiver
-
Retrieve the set of names of objects that can be individually subscribed to.
- getSet() - Method in class org.opentrafficsim.sim0mq.publisher.NodeIdTransceiver
-
Retrieve the set of names of objects that can be individually subscribed to.
- GtuIdTransceiver - Class in org.opentrafficsim.sim0mq.publisher
-
Transceiver for GTU ids.
- GtuIdTransceiver(Network) - Constructor for class org.opentrafficsim.sim0mq.publisher.GtuIdTransceiver
-
Construct a GtuIdTransceiver.
- GtuTransceiver - Class in org.opentrafficsim.sim0mq.publisher
-
Transceiver for GTU data.
- GtuTransceiver(Network, GtuIdTransceiver) - Constructor for class org.opentrafficsim.sim0mq.publisher.GtuTransceiver
-
Construct a GtuTransceiver.
H
- handleIncomingData(Object[]) - Method in interface org.opentrafficsim.sim0mq.publisher.IncomingDataHandler
-
Process incoming data.
- hashCode() - Method in class org.opentrafficsim.sim0mq.publisher.ReturnWrapperImpl
- hasIdSource() - Method in class org.opentrafficsim.sim0mq.publisher.GtuTransceiver
-
Report if this transceiver has an id source.
- hasIdSource() - Method in class org.opentrafficsim.sim0mq.publisher.LinkTransceiver
-
Report if this transceiver has an id source.
- hasIdSource() - Method in class org.opentrafficsim.sim0mq.publisher.NodeTransceiver
-
Report if this transceiver has an id source.
- hasIdSource() - Method in class org.opentrafficsim.sim0mq.publisher.Publisher
-
Report if this transceiver has an id source.
- hasIdSource() - Method in interface org.opentrafficsim.sim0mq.publisher.TransceiverInterface
-
Report if this transceiver has an id source.
I
- IncomingDataHandler - Interface in org.opentrafficsim.sim0mq.publisher
-
Interface for handlers of incoming data and commands that are not directly processed by the Publisher.
L
- LaneGtuIdTransceiver - Class in org.opentrafficsim.sim0mq.publisher
-
Transceiver for the ids of the GTUs on a link.
- LaneGtuIdTransceiver(Network) - Constructor for class org.opentrafficsim.sim0mq.publisher.LaneGtuIdTransceiver
-
Construct a GtuIdTransceiver.
- LinkGtuIdTransceiver - Class in org.opentrafficsim.sim0mq.publisher
-
Transceiver for the ids of the GTUs on a link.
- LinkGtuIdTransceiver(Network) - Constructor for class org.opentrafficsim.sim0mq.publisher.LinkGtuIdTransceiver
-
Construct a GtuIdTransceiver.
- LinkIdTransceiver - Class in org.opentrafficsim.sim0mq.publisher
-
Transceiver for Link ids.
- LinkIdTransceiver(Network) - Constructor for class org.opentrafficsim.sim0mq.publisher.LinkIdTransceiver
-
Construct a new LinkIdTransceiver.
- LinkTransceiver - Class in org.opentrafficsim.sim0mq.publisher
-
Transceiver for Link data.
- LinkTransceiver(Network, LinkIdTransceiver) - Constructor for class org.opentrafficsim.sim0mq.publisher.LinkTransceiver
-
Construct a new LinkTransceiver.
- listRequestMetaData() - Method in class org.opentrafficsim.sim0mq.publisher.SubscriptionHandler
-
Report what payload is required to retrieve a list of all elements, or data and what format a result would have.
- listResultMetaData() - Method in class org.opentrafficsim.sim0mq.publisher.SubscriptionHandler
-
Report what the payload format of the result of the list transceiver.
- lookup(Object[], ReturnWrapper) - Method in interface org.opentrafficsim.sim0mq.publisher.LookupEventProducer
-
Find the EventProducerInterface with the given address.
- lookupCommand(String) - Static method in class org.opentrafficsim.sim0mq.publisher.SubscriptionHandler
-
Convert a String representing a Command into that Command.
- LookupEventProducer - Interface in org.opentrafficsim.sim0mq.publisher
-
Object that can find the EventProducer object for an address.
- lookupIncomingDataHandler(String) - Method in class org.opentrafficsim.sim0mq.publisher.Publisher
-
Find the IncomingDataHandler for a particular key.
N
- nack(String) - Method in interface org.opentrafficsim.sim0mq.publisher.ReturnWrapper
-
Signal failure of execution of a request.
- network - Variable in class org.opentrafficsim.sim0mq.publisher.Publisher
-
The OTS network.
- NodeIdTransceiver - Class in org.opentrafficsim.sim0mq.publisher
-
Transceiver for Node ids.
- NodeIdTransceiver(Network) - Constructor for class org.opentrafficsim.sim0mq.publisher.NodeIdTransceiver
-
Construct a new LinkIdTransceiver.
- NodeTransceiver - Class in org.opentrafficsim.sim0mq.publisher
-
Transceiver for Node data.
- NodeTransceiver(Network, NodeIdTransceiver) - Constructor for class org.opentrafficsim.sim0mq.publisher.NodeTransceiver
-
Construct a new NodeTransceiver.
- notify(Event) - Method in class org.opentrafficsim.sim0mq.publisher.EventMultiplexer
- notify(Event) - Method in class org.opentrafficsim.sim0mq.publisher.Subscription
O
- org.opentrafficsim.sim0mq.publisher - package org.opentrafficsim.sim0mq.publisher
-
Make the DSOL pub/sub events of OTS available through Sim0MQ.
P
- Publisher - Class in org.opentrafficsim.sim0mq.publisher
-
Publish all available transceivers for an OTS network to a Sim0MQ master and handle its requests.
- Publisher(Network) - Constructor for class org.opentrafficsim.sim0mq.publisher.Publisher
-
Construct a Publisher for an OTS network with no additional subscription handlers.
- Publisher(Network, List<SubscriptionHandler>, List<IncomingDataHandler>) - Constructor for class org.opentrafficsim.sim0mq.publisher.Publisher
-
Construct a Publisher for an OTS network.
R
- ReturnWrapper - Interface in org.opentrafficsim.sim0mq.publisher
-
The ReturnWrapper interface enforces implementation of the encodeReplyAndTransmit method
- ReturnWrapperImpl - Class in org.opentrafficsim.sim0mq.publisher
-
Container for all data needed to reply (once, or multiple times) to a Sim0MQ request.
- ReturnWrapperImpl(ZContext, byte[], Map<Long, ZMQ.Socket>, AtomicInteger) - Constructor for class org.opentrafficsim.sim0mq.publisher.ReturnWrapperImpl
-
Construct a new ReturnWrapper.
- ReturnWrapperImpl(ZContext, Object[], Map<Long, ZMQ.Socket>) - Constructor for class org.opentrafficsim.sim0mq.publisher.ReturnWrapperImpl
-
Construct a new ReturnWrapper.
S
- sendToMaster(byte[]) - Method in class org.opentrafficsim.sim0mq.publisher.ReturnWrapperImpl
-
Central portal to send a message to the master.
- serialize(Event, byte[], Pointer, EndianUtil) - Method in class org.opentrafficsim.sim0mq.publisher.EventSerializer
- serializeWithPrefix(Event, byte[], Pointer, EndianUtil) - Method in class org.opentrafficsim.sim0mq.publisher.EventSerializer
- SIMULATOR_STATE_CHANGED - Static variable in class org.opentrafficsim.sim0mq.publisher.SimulatorStateTransceiver
-
The event that will be emitted for either the START_EVENT or the STOP_EVENT.
- SimulatorStateTransceiver - Class in org.opentrafficsim.sim0mq.publisher
-
Transceiver for simulator state change events.
- SimulatorStateTransceiver(OtsSimulatorInterface) - Constructor for class org.opentrafficsim.sim0mq.publisher.SimulatorStateTransceiver
-
Construct a new SimulatorStateTransceiver.
- size(Event) - Method in class org.opentrafficsim.sim0mq.publisher.EventSerializer
- sizeWithPrefix(Event) - Method in class org.opentrafficsim.sim0mq.publisher.EventSerializer
- SUBSCRIBE_TO_ADD - Enum constant in enum class org.opentrafficsim.sim0mq.publisher.SubscriptionHandler.Command
-
Subscribe to add events.
- SUBSCRIBE_TO_CHANGE - Enum constant in enum class org.opentrafficsim.sim0mq.publisher.SubscriptionHandler.Command
-
Subscribe to change events.
- SUBSCRIBE_TO_REMOVE - Enum constant in enum class org.opentrafficsim.sim0mq.publisher.SubscriptionHandler.Command
-
Subscribe to remove events.
- Subscription - Class in org.opentrafficsim.sim0mq.publisher
-
Handles one subscription.
- Subscription(ReturnWrapper) - Constructor for class org.opentrafficsim.sim0mq.publisher.Subscription
-
Construct a new Subscription.
- SubscriptionHandler - Class in org.opentrafficsim.sim0mq.publisher
-
Data collection that can be listed and has subscription to change events.
- SubscriptionHandler(String, TransceiverInterface, LookupEventProducer, EventType, EventType, EventType, SubscriptionHandler) - Constructor for class org.opentrafficsim.sim0mq.publisher.SubscriptionHandler
-
Create a new SubscriptionHandler.
- SubscriptionHandler.Command - Enum Class in org.opentrafficsim.sim0mq.publisher
-
The commands that a SubscriptionHandler understands.
- subscriptionHandlerMap - Variable in class org.opentrafficsim.sim0mq.publisher.Publisher
-
Map Publisher names to the corresponding Publisher object.
- subscriptionOptions() - Method in class org.opentrafficsim.sim0mq.publisher.SubscriptionHandler
-
Return the set of supported commands.
T
- toString() - Method in class org.opentrafficsim.sim0mq.publisher.AbstractTransceiver
- toString() - Method in class org.opentrafficsim.sim0mq.publisher.CrossSectionElementTransceiver
- toString() - Method in class org.opentrafficsim.sim0mq.publisher.GtuIdTransceiver
- toString() - Method in class org.opentrafficsim.sim0mq.publisher.GtuTransceiver
- toString() - Method in class org.opentrafficsim.sim0mq.publisher.LaneGtuIdTransceiver
- toString() - Method in class org.opentrafficsim.sim0mq.publisher.LinkGtuIdTransceiver
- toString() - Method in class org.opentrafficsim.sim0mq.publisher.LinkIdTransceiver
- toString() - Method in class org.opentrafficsim.sim0mq.publisher.LinkTransceiver
- toString() - Method in class org.opentrafficsim.sim0mq.publisher.NodeIdTransceiver
- toString() - Method in class org.opentrafficsim.sim0mq.publisher.NodeTransceiver
- toString() - Method in class org.opentrafficsim.sim0mq.publisher.ReturnWrapperImpl
- toString() - Method in class org.opentrafficsim.sim0mq.publisher.SubscriptionHandler
- TransceiverInterface - Interface in org.opentrafficsim.sim0mq.publisher
-
Transceivers with machine interpretable description of address and result types.
U
- UNSUBSCRIBE_FROM_ADD - Enum constant in enum class org.opentrafficsim.sim0mq.publisher.SubscriptionHandler.Command
-
Unsubscribe to add events.
- UNSUBSCRIBE_FROM_CHANGE - Enum constant in enum class org.opentrafficsim.sim0mq.publisher.SubscriptionHandler.Command
-
Unsubscribe to change events.
- UNSUBSCRIBE_FROM_REMOVE - Enum constant in enum class org.opentrafficsim.sim0mq.publisher.SubscriptionHandler.Command
-
Unsubscribe to remove events.
V
- valueOf(String) - Static method in enum class org.opentrafficsim.sim0mq.publisher.SubscriptionHandler.Command
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class org.opentrafficsim.sim0mq.publisher.SubscriptionHandler.Command
-
Returns an array containing the constants of this enum class, in the order they are declared.
- verifyMetaData(MetaData, Object[]) - Static method in class org.opentrafficsim.sim0mq.publisher.AbstractTransceiver
-
Verify the composition of an Object[].
All Classes and Interfaces|All Packages