org.sim0mq.message.federationmanager

Class SimRunControlMessage.Builder

java.lang.Object

org.sim0mq.message.Sim0MQMessage.Builder<SimRunControlMessage.Builder>

org.sim0mq.message.federationmanager.SimRunControlMessage.Builder

Enclosing class:

SimRunControlMessage

public static class SimRunControlMessage.Builder
extends Sim0MQMessage.Builder<SimRunControlMessage.Builder>

Builder for the SimRunControl Message. Can string setters together, and call build() at the end to build the actual message.

Copyright (c) 2016-2017 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved.
BSD-style license. See Sim0MQ License.

$LastChangedDate: 2015-07-24 02:58:59 +0200 (Fri, 24 Jul 2015) $, @version $Revision: 1147 $, by $Author: averbraeck $, initial version Apr 22, 2017

Author:

Alexander Verbraeck

Field Summary

Fields inherited from class org.sim0mq.message.Sim0MQMessage.Builder

messageId, messageStatus, messageTypeId, receiverId, senderId, simulationRunId

Constructor Summary

Constructors

Constructor and Description
Builder() Empty constructor.

Method Summary

Modifier and Type	Method and Description
Sim0MQMessage	build() Build the object.
SimRunControlMessage.Builder	setNumberReplications(int newNumberReplications)
SimRunControlMessage.Builder	setOffsetTime(org.djunits.value.vdouble.scalar.Duration newOffsetTime)
SimRunControlMessage.Builder	setOffsetTime(org.djunits.value.vfloat.scalar.FloatDuration newOffsetTime)
SimRunControlMessage.Builder	setOffsetTime(Number newOffsetTime)
SimRunControlMessage.Builder	setRunTime(org.djunits.value.vdouble.scalar.Duration newRunTime)
SimRunControlMessage.Builder	setRunTime(org.djunits.value.vfloat.scalar.FloatDuration newRunTime)
SimRunControlMessage.Builder	setRunTime(Number newRunTime)
SimRunControlMessage.Builder	setSpeed(double newSpeed)
SimRunControlMessage.Builder	setStreamMap(Map<Object,Long> newStreamMap)
SimRunControlMessage.Builder	setWarmupTime(org.djunits.value.vdouble.scalar.Duration newWarmupTime)
SimRunControlMessage.Builder	setWarmupTime(org.djunits.value.vfloat.scalar.FloatDuration newWarmupTime)
SimRunControlMessage.Builder	setWarmupTime(Number newWarmupTime)

Methods inherited from class org.sim0mq.message.Sim0MQMessage.Builder

setMessageId, setMessageStatus, setMessageTypeId, setReceiverId, setSenderId, setSimulationRunId

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Empty constructor.

Method Detail

setRunTime

public final SimRunControlMessage.Builder setRunTime(Number newRunTime)

Parameters:

newRunTime - set runTime

Returns:

the original object for chaining

setRunTime

public final SimRunControlMessage.Builder setRunTime(org.djunits.value.vdouble.scalar.Duration newRunTime)

Parameters:

newRunTime - set runTime

Returns:

the original object for chaining

setRunTime

public final SimRunControlMessage.Builder setRunTime(org.djunits.value.vfloat.scalar.FloatDuration newRunTime)

Parameters:

newRunTime - set runTime

Returns:

the original object for chaining

setWarmupTime

public final SimRunControlMessage.Builder setWarmupTime(Number newWarmupTime)

Parameters:

newWarmupTime - set warmupTime

Returns:

the original object for chaining

setWarmupTime

public final SimRunControlMessage.Builder setWarmupTime(org.djunits.value.vdouble.scalar.Duration newWarmupTime)

Parameters:

newWarmupTime - set warmupTime

Returns:

the original object for chaining

setWarmupTime

public final SimRunControlMessage.Builder setWarmupTime(org.djunits.value.vfloat.scalar.FloatDuration newWarmupTime)

Parameters:

newWarmupTime - set warmupTime

Returns:

the original object for chaining

setOffsetTime

public final SimRunControlMessage.Builder setOffsetTime(Number newOffsetTime)

Parameters:

newOffsetTime - set offsetTime

Returns:

the original object for chaining

setOffsetTime

public final SimRunControlMessage.Builder setOffsetTime(org.djunits.value.vdouble.scalar.Duration newOffsetTime)

Parameters:

newOffsetTime - set offsetTime

Returns:

the original object for chaining

setOffsetTime

public final SimRunControlMessage.Builder setOffsetTime(org.djunits.value.vfloat.scalar.FloatDuration newOffsetTime)

Parameters:

newOffsetTime - set offsetTime

Returns:

the original object for chaining

setSpeed

public final SimRunControlMessage.Builder setSpeed(double newSpeed)

Parameters:

newSpeed - set speed

Returns:

the original object for chaining

setNumberReplications

public final SimRunControlMessage.Builder setNumberReplications(int newNumberReplications)

Parameters:

newNumberReplications - set numberReplications

Returns:

the original object for chaining

setStreamMap

public final SimRunControlMessage.Builder setStreamMap(Map<Object,Long> newStreamMap)

Parameters:

newStreamMap - set streamMap

Returns:

the original object for chaining

build

public Sim0MQMessage build()
                    throws Sim0MQException,
                           NullPointerException

Build the object.

Specified by:

build in class Sim0MQMessage.Builder<SimRunControlMessage.Builder>

Returns:

the message object from the builder.

Throws:

Sim0MQException - on unknown data type

NullPointerException - when one of the parameters is null