Package org.sim0mq.message.federationmanager

Class FM1StartFederateMessage.Builder

java.lang.Object

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

org.sim0mq.message.federationmanager.FM1StartFederateMessage.Builder

Enclosing class:

FM1StartFederateMessage

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

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

Copyright (c) 2016-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

Field Summary

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

federationId, messageId, messageTypeId, receiverId, senderId

Constructor Summary

Constructors

Constructor	Description
Builder()	Empty constructor.

Method Summary

Modifier and Type	Method	Description
FM1StartFederateMessage	build()	Build the object.
final FM1StartFederateMessage.Builder	setArgsAfter(String newArgsAfter)
final FM1StartFederateMessage.Builder	setArgsBefore(String newArgsBefore)
final FM1StartFederateMessage.Builder	setDeleteStderr(boolean newDeleteStderr)
final FM1StartFederateMessage.Builder	setDeleteStdout(boolean newDeleteStdout)
final FM1StartFederateMessage.Builder	setDeleteWorkingDirectory(boolean newDeleteWorkingDirectory)
final FM1StartFederateMessage.Builder	setInstanceId(String newInstanceId)
final FM1StartFederateMessage.Builder	setModelPath(String newModelPath)
final FM1StartFederateMessage.Builder	setRedirectStderr(String rewRedirectStderr)
final FM1StartFederateMessage.Builder	setRedirectStdin(String newRedirectStdin)
final FM1StartFederateMessage.Builder	setRedirectStdout(String newRedirectStdout)
final FM1StartFederateMessage.Builder	setSoftwareCode(String newSoftwareCode)
final FM1StartFederateMessage.Builder	setWorkingDirectory(String newWorkingDirectory)

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

setMessageId, setMessageTypeId, setReceiverId, setSenderId, setSimulationRunId

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Empty constructor.

Method Details

setInstanceId

public final FM1StartFederateMessage.Builder setInstanceId(String newInstanceId)

Parameters:

newInstanceId - set instanceId

Returns:

the original object for chaining

setSoftwareCode

public final FM1StartFederateMessage.Builder setSoftwareCode(String newSoftwareCode)

Parameters:

newSoftwareCode - set softwareCode

Returns:

the original object for chaining

setArgsBefore

public final FM1StartFederateMessage.Builder setArgsBefore(String newArgsBefore)

Parameters:

newArgsBefore - set argsBefore

Returns:

the original object for chaining

setModelPath

public final FM1StartFederateMessage.Builder setModelPath(String newModelPath)

Parameters:

newModelPath - set modelPath

Returns:

the original object for chaining

setArgsAfter

public final FM1StartFederateMessage.Builder setArgsAfter(String newArgsAfter)

Parameters:

newArgsAfter - set argsAfter

Returns:

the original object for chaining

setWorkingDirectory

public final FM1StartFederateMessage.Builder setWorkingDirectory(String newWorkingDirectory)

Parameters:

newWorkingDirectory - set workingDirectory

Returns:

the original object for chaining

setRedirectStdin

public final FM1StartFederateMessage.Builder setRedirectStdin(String newRedirectStdin)

Parameters:

newRedirectStdin - set redirectStdin

Returns:

the original object for chaining

setRedirectStdout

public final FM1StartFederateMessage.Builder setRedirectStdout(String newRedirectStdout)

Parameters:

newRedirectStdout - set redirectStdout

Returns:

the original object for chaining

setRedirectStderr

public final FM1StartFederateMessage.Builder setRedirectStderr(String rewRedirectStderr)

Parameters:

rewRedirectStderr - set redirectStderr

Returns:

the original object for chaining

setDeleteWorkingDirectory

public final FM1StartFederateMessage.Builder setDeleteWorkingDirectory(boolean newDeleteWorkingDirectory)

Parameters:

newDeleteWorkingDirectory - set deleteWorkingDirectory

Returns:

the original object for chaining

setDeleteStdout

public final FM1StartFederateMessage.Builder setDeleteStdout(boolean newDeleteStdout)

Parameters:

newDeleteStdout - set deleteStdout

Returns:

the original object for chaining

setDeleteStderr

public final FM1StartFederateMessage.Builder setDeleteStderr(boolean newDeleteStderr)

Parameters:

newDeleteStderr - set deleteStderr

Returns:

the original object for chaining

build

public FM1StartFederateMessage build()
                              throws Sim0MQException,
NullPointerException

Description copied from class: Sim0MQMessage.Builder

Build the object.

Specified by:

build in class Sim0MQMessage.Builder<FM1StartFederateMessage.Builder>

Returns:

the message object from the builder.

Throws:

Sim0MQException - on unknown data type

NullPointerException - when one of the parameters is null