Package org.sim0mq.message.federatestarter

Class FS2FederateStartedMessage

java.lang.Object

org.sim0mq.message.Sim0MQMessage

org.sim0mq.message.federatestarter.FS2FederateStartedMessage

All Implemented Interfaces:

Serializable

public class FS2FederateStartedMessage
extends Sim0MQMessage

FederateStarted, FS.2. Message sent by the Federate Starter to the Federation Manager in response to message FM.1.

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

Author:

Alexander Verbraeck

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FS2FederateStartedMessage.Builder	Builder for the FederateStarted Message.

Field Summary

Fields inherited from class org.sim0mq.message.Sim0MQMessage

VERSION

Constructor Summary

Constructors

Constructor	Description
FS2FederateStartedMessage(Object[] objectArray)
FS2FederateStartedMessage(Object federationId, Object senderId, Object receiverId, Object messageId, Object instanceId, String status, int modelPort, String error)

Method Summary

Modifier and Type	Method	Description
String	getError()
Object	getInstanceId()
int	getModelPort()
String	getStatus()

Methods inherited from class org.sim0mq.message.Sim0MQMessage

check, createByteArray, createObjectArray, decode, decodeToArray, encodeReplyUTF16, encodeReplyUTF8, encodeUTF16, encodeUTF8, getFederationId, getMagicNumber, getMessageId, getMessageTypeId, getNumberOfPayloadFields, getReceiverId, getSenderId, isBigEndian, listPayload, print

Methods inherited from class java.lang.Object

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

Constructor Details

FS2FederateStartedMessage

public FS2FederateStartedMessage(Object federationId,
 Object senderId,
 Object receiverId,
 Object messageId,
 Object instanceId,
 String status,
 int modelPort,
 String error)
                          throws Sim0MQException,
NullPointerException

Parameters:

federationId - the federation id can be coded using different types. Examples are two 64-bit longs indicating a UUID, or a String with a UUID number, a String with meaningful identification, or a short or an int with a simulation run number.

senderId - The sender id can be used to send back a message to the sender at some later time.

receiverId - The receiver id can be used to check whether the message is meant for us, or should be discarded (or an error can be sent if we receive a message not meant for us).

messageId - The unique message number is meant to confirm with a callback that the message has been received correctly. The number is unique for the sender, so not globally within the federation.

instanceId - The sender id of the model that was started or had an error while starting. This is exactly the same as the instanceId sent by the Federation Manager in the StartFederate message.

status - A string that refers to the model status. Four options: "started", "running", "ended", "error".

modelPort - The model port number. We use an int in Java due to the fact there is no unsigned short.

error - Optional. If there is an error, the error message is sent as well. Otherwise this field is an empty string.

Throws:

Sim0MQException - on unknown data type

NullPointerException - when one of the parameters is null

FS2FederateStartedMessage

public FS2FederateStartedMessage(Object[] objectArray)
                          throws Sim0MQException,
NullPointerException

Parameters:

objectArray - Object[]; the fields that constitute the message

Throws:

Sim0MQException - on unknown data type

NullPointerException - when one of the parameters is null

Method Details

getInstanceId

public Object getInstanceId()

Returns:

instanceId

getStatus

public String getStatus()

Returns:

status

getModelPort

public int getModelPort()

Returns:

modelPort

getError

public String getError()

Returns:

error