Class 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-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
    • Constructor Detail

      • 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
    • Method Detail

      • getVariableName

        public String getVariableName()
        Returns:
        variableName
      • getVariableValue

        public Object getVariableValue()
        Returns:
        variableValue