Package org.sim0mq.message.federationmanager

Class FM6RequestStatisticsMessage

java.lang.Object

org.sim0mq.message.Sim0MQMessage

org.sim0mq.message.federationmanager.FM6RequestStatisticsMessage

All Implemented Interfaces:

Serializable

public class FM6RequestStatisticsMessage
extends Sim0MQMessage

RequestStatistics, FM.6. Message sent by the Federation Manager to collect the output.

Copyright (c) 2019-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	FM6RequestStatisticsMessage.Builder	Builder for the RequestStatistics Message.

Field Summary

Fields inherited from class org.sim0mq.message.Sim0MQMessage

VERSION

Constructor Summary

Constructors

Constructor	Description
FM6RequestStatisticsMessage(Object[] objectArray)
FM6RequestStatisticsMessage(Object federationId, Object senderId, Object receiverId, Object messageId, String variableName)

Method Summary

Modifier and Type	Method	Description
String	getVariableName()

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

FM6RequestStatisticsMessage

public FM6RequestStatisticsMessage(Object federationId,
 Object senderId,
 Object receiverId,
 Object messageId,
 String variableName)
                            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.

variableName - String; The name of the output variable whose value is requested. That should match with the name in the model. For a tallied variable, several statistics are possible, e.g., average, variance, minimum, maximum, time series, etc. The name should clearly indicate what the Model Controller expects and what the model should produce.

Throws:

Sim0MQException - on unknown data type

NullPointerException - when one of the parameters is null

FM6RequestStatisticsMessage

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

Parameters:

objectArray - Object[]; Full message object array

Throws:

Sim0MQException - on unknown data type

NullPointerException - when one of the parameters is null

Method Details

getVariableName

public String getVariableName()

Returns:

variableName