Class FS5FederatesKilledMessage
- java.lang.Object
-
- org.sim0mq.message.Sim0MQMessage
-
- org.sim0mq.message.federatestarter.FS5FederatesKilledMessage
-
- All Implemented Interfaces:
Serializable
public class FS5FederatesKilledMessage extends Sim0MQMessage
FederatesKilled, FS.5. Message sent by the Federate Starter to the Federation Manager in response to message FM.9.Copyright (c) 2016-2020 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
FS5FederatesKilledMessage.Builder
Builder for the FederateStarted Message.
-
Field Summary
-
Fields inherited from class org.sim0mq.message.Sim0MQMessage
VERSION
-
-
Constructor Summary
Constructors Constructor Description FS5FederatesKilledMessage(Object[] objectArray)
FS5FederatesKilledMessage(Object federationId, Object senderId, Object receiverId, Object messageId, boolean status, String error)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description String
getError()
boolean
isStatus()
-
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
-
-
-
-
Constructor Detail
-
FS5FederatesKilledMessage
public FS5FederatesKilledMessage(Object federationId, Object senderId, Object receiverId, Object messageId, boolean status, 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.status
- boolean; success or failure of killing all models.error
- If there is an error, the error message is sent as well. Otherwise this field is an empty string.- Throws:
Sim0MQException
- on unknown data typeNullPointerException
- when one of the parameters is null
-
FS5FederatesKilledMessage
public FS5FederatesKilledMessage(Object[] objectArray) throws Sim0MQException, NullPointerException
- Parameters:
objectArray
- Object[]; the fields that constitute the message- Throws:
Sim0MQException
- on unknown data typeNullPointerException
- when one of the parameters is null
-
-
Method Detail
-
isStatus
public boolean isStatus()
- Returns:
- status
-
getError
public String getError()
- Returns:
- error
-
-