org.sim0mq.message.federationmanager

Class FM3SetParameterMessage

java.lang.Object

org.sim0mq.message.Sim0MQMessage

org.sim0mq.message.federationmanager.FM3SetParameterMessage

All Implemented Interfaces:

Serializable

public class FM3SetParameterMessage
extends Sim0MQMessage

SetParameter, FM.3. Message sent by the FederateManager to the Model for setting the parameter values. Parameters are set one by one (but can be a Vector or Matrix).

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

Field Summary

Fields inherited from class org.sim0mq.message.Sim0MQMessage

VERSION

Constructor Summary

Constructors

Constructor and Description
FM3SetParameterMessage(Object simulationRunId, Object senderId, Object receiverId, long messageId, String parameterName, Object parameterValue)

Method Summary

Modifier and Type	Method and Description
byte[]	createByteArray() Create a byte array of the fields.
static FM3SetParameterMessage	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	getParameterName()
Object	getParameterValue()

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

FM3SetParameterMessage

public FM3SetParameterMessage(Object simulationRunId,
                              Object senderId,
                              Object receiverId,
                              long messageId,
                              String parameterName,
                              Object parameterValue)
                       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.

parameterName - String; Name of the parameter to be set. Links to a parameter name in the model

parameterValue - Object; Value of the parameter to be set; can be any of the legal types in djutils-serialization

Throws:

Sim0MQException - on unknown data type

NullPointerException - when one of the parameters is null

Method Detail

getParameterName

public String getParameterName()

Returns:

parameterName

getParameterValue

public Object getParameterValue()

Returns:

parameterValue

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 FM3SetParameterMessage 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