1 package org.sim0mq.message.federationmanager;
2
3 import org.sim0mq.Sim0MQException;
4 import org.sim0mq.message.Sim0MQMessage;
5
6 /**
7 * SimStart, FM.4. Message sent by the Federation Manager to start the simulation.
8 * <p>
9 * Copyright (c) 2019-2024 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved. <br>
10 * BSD-style license. See <a href="http://sim0mq.org/docs/current/license.html">Sim0MQ License</a>.
11 * </p>
12 * @author <a href="http://www.tbm.tudelft.nl/averbraeck">Alexander Verbraeck</a>
13 */
14 public class FM4SimStartMessage extends Sim0MQMessage
15 {
16 /** the unique message id. */
17 private static final String MESSAGETYPE = "FM.4";
18
19 /** */
20 private static final long serialVersionUID = 20190712L;
21
22 /**
23 * @param federationId the federation id can be coded using different types. Examples are two 64-bit longs indicating a
24 * UUID, or a String with a UUID number, a String with meaningful identification, or a short or an int with a
25 * simulation run number.
26 * @param senderId The sender id can be used to send back a message to the sender at some later time.
27 * @param receiverId The receiver id can be used to check whether the message is meant for us, or should be discarded (or an
28 * error can be sent if we receive a message not meant for us).
29 * @param messageId The unique message number is meant to confirm with a callback that the message has been received
30 * correctly. The number is unique for the sender, so not globally within the federation.
31 * @throws Sim0MQException on unknown data type
32 * @throws NullPointerException when one of the parameters is null
33 */
34 public FM4SimStartMessage(final Object federationId, final Object senderId, final Object receiverId, final Object messageId)
35 throws Sim0MQException, NullPointerException
36 {
37 super(true, federationId, senderId, receiverId, MESSAGETYPE, messageId, null);
38 }
39
40 /**
41 * @param objectArray Object[]; Full message object array
42 * @throws Sim0MQException on unknown data type
43 * @throws NullPointerException when one of the parameters is null
44 */
45 public FM4SimStartMessage(final Object[] objectArray) throws Sim0MQException, NullPointerException
46 {
47 super(objectArray, 0, MESSAGETYPE);
48 }
49
50 /**
51 * Builder for the SimStart Message. Can string setters together, and call build() at the end to build the actual message.
52 * <p>
53 * Copyright (c) 2019-2024 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved.
54 * <br>
55 * BSD-style license. See <a href="http://sim0mq.org/docs/current/license.html">Sim0MQ License</a>.
56 * </p>
57 * @author <a href="http://www.tbm.tudelft.nl/averbraeck">Alexander Verbraeck</a>
58 */
59 public static class Builder extends Sim0MQMessage.Builder<FM4SimStartMessage.Builder>
60 {
61 /**
62 * Empty constructor.
63 */
64 public Builder()
65 {
66 // nothing to do.
67 }
68
69 @Override
70 public FM4SimStartMessage build() throws Sim0MQException, NullPointerException
71 {
72 return new FM4SimStartMessage(this.federationId, this.senderId, this.receiverId, this.messageId);
73 }
74
75 }
76 }