Package org.sim0mq.message.modelcontroller

Class MC3StatisticsMessage

java.lang.Object

org.sim0mq.message.Sim0MQMessage

org.sim0mq.message.modelcontroller.MC3StatisticsMessage

All Implemented Interfaces:

Serializable

public class MC3StatisticsMessage
extends Sim0MQMessage

StatisticsMessage, MC.3. The Model sends this message as a response to RequestStatistics messages sent by the Federation Manager. It contains one value for a model output statistic.

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	MC3StatisticsMessage.Builder	Builder for the StartFederate Message.

Field Summary

Fields inherited from class org.sim0mq.message.Sim0MQMessage

VERSION

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
String	getVariableName()
Object	getVariableValue()

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

MC3StatisticsMessage

public MC3StatisticsMessage(Object federationId,
 Object senderId,
 Object receiverId,
 Object messageId,
 String variableName,
 Object variableValue)
                     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 - The name of the output variable whose value is requested. That should match with the name in the model.

variableValue - If variableType is scalar, the data type is e.g., an integer, float etc. and the value generated in the model. If variableType is timeseries, the data type is an ‘array’ (type 11-16 or 27/28) or a time series (type 31/32).

Throws:

Sim0MQException - on unknown data type

NullPointerException - when one of the parameters is null

MC3StatisticsMessage

public MC3StatisticsMessage(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

getVariableValue

public Object getVariableValue()

Returns:

variableValue