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-2019 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 and 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 and Description
MC3StatisticsMessage(Object simulationRunId, Object senderId, Object receiverId, long messageId, String variableName, Object variableValue)

Method Summary

Modifier and Type	Method and Description
byte[]	createByteArray() Create a byte array of the fields.
static MC3StatisticsMessage	createMessage(Object[] fields, Object intendedReceiverId) Build a message from an Object[] that was received.
Object[]	createObjectArray() Create a Sim0MQ object array of the fields.
static String	getMessageType()
short	getNumberOfPayloadFields() Get the number of payload fields in the message.
String	getVariableName()
Object	getVariableValue()

Methods inherited from class org.sim0mq.message.Sim0MQMessage

check, getMagicNumber, getMessageId, getMessageStatus, getMessageTypeId, getReceiverId, getSenderId, getSimulationRunId

Methods inherited from class java.lang.Object

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

Constructor Detail

MC3StatisticsMessage

public MC3StatisticsMessage(Object simulationRunId,
                            Object senderId,
                            Object receiverId,
                            long messageId,
                            String variableName,
                            Object variableValue)
                     throws Sim0MQException,
                            NullPointerException

Parameters:

simulationRunId - the Simulation run ids can be provided in 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

getMessageType

public static final String getMessageType()

Returns:

messagetype

getNumberOfPayloadFields

public short getNumberOfPayloadFields()

Get the number of payload fields in the message.

Specified by:

getNumberOfPayloadFields in class Sim0MQMessage

Returns:

short; the number of payload fields in the message.

createObjectArray

public Object[] createObjectArray()

Create a Sim0MQ object array of the fields.

Specified by:

createObjectArray in class Sim0MQMessage

Returns:

Object[] a Sim0MQ object array of the fields

createByteArray

public byte[] createByteArray()
                       throws Sim0MQException,
                              org.djutils.serialization.SerializationException

Create a byte array of the fields.

Specified by:

createByteArray in class Sim0MQMessage

Returns:

byte[] a Sim0MQ byte array of the content

Throws:

Sim0MQException - on unknown data type as part of the content

org.djutils.serialization.SerializationException - when the byte array cannot be created, e.g. because the number of bytes does not match

createMessage

public static MC3StatisticsMessage createMessage(Object[] fields,
                                                 Object intendedReceiverId)
                                          throws Sim0MQException

Build a message from an Object[] that was received.

Parameters:

fields - Object[]; the fields in the message

intendedReceiverId - id of the intended receiver

Returns:

a Sim0MQ message

Throws:

Sim0MQException - when number of fields is not correct