Package 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-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	FM3SetParameterMessage.Builder	Builder for the SetParameter Message.

Field Summary

Fields inherited from class org.sim0mq.message.Sim0MQMessage

VERSION

Constructor Summary

Constructors

Constructor	Description
FM3SetParameterMessage(Object[] objectArray)
FM3SetParameterMessage(Object federationId, Object senderId, Object receiverId, Object messageId, String parameterName, Object parameterValue)

Method Summary

Modifier and Type	Method	Description
String	getParameterName()
Object	getParameterValue()

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

FM3SetParameterMessage

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

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

FM3SetParameterMessage

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

getParameterName

public String getParameterName()

Returns:

parameterName

getParameterValue

public Object getParameterValue()

Returns:

parameterValue