Package nl.tudelft.simulation.dsol.experiment

Class ExperimentRunControl<T extends Number & Comparable<T>>

java.lang.Object

nl.tudelft.simulation.dsol.experiment.RunControl<T>

nl.tudelft.simulation.dsol.experiment.ExperimentRunControl<T>

Type Parameters:

T - the simulation time type to be able to implement a comparator on the simulation time.

All Implemented Interfaces:

Serializable, Treatment<T>

public class ExperimentRunControl<T extends Number & Comparable<T>>
extends RunControl<T>

ExperimentRunControl.java.

Copyright (c) 2021-2024 Delft University of Technology, Jaffalaan 5, 2628 BX Delft, the Netherlands. All rights reserved. See for project information DSOL Manual. The DSOL project is distributed under a three-clause BSD-style license, which can be found at DSOL License.

Author:

Alexander Verbraeck

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
ExperimentRunControl(String id, T startTime, T warmupPeriod, T runLength, int numberOfReplications)	Construct an object with off-line run control information for an experiment.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
int	getNumberOfReplications()	Return the total number of replications to execute.
int	hashCode()
String	toString()

Methods inherited from class nl.tudelft.simulation.dsol.experiment.RunControl

getDescription, getEndTime, getId, getRunControl, getStartTime, getWarmupTime, setDescription

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface nl.tudelft.simulation.dsol.experiment.Treatment

getRunLength, getWarmupPeriod

Constructor Details

ExperimentRunControl

public ExperimentRunControl(String id,
 T startTime,
 T warmupPeriod,
 T runLength,
 int numberOfReplications)

Construct an object with off-line run control information for an experiment.

Parameters:

id - String; the id of the run control that will be used as the id for the replication; should be unique within the experiment.

startTime - T; the start time of the simulation.

warmupPeriod - T; the warmup period, included in the runlength (!)

runLength - T; the total length of the run, including the warm-up period.

numberOfReplications - int; the number of replications to execute

Throws:

NullPointerException - when id, startTime, warmupPeriod or runLength is null

IllegalArgumentException - when warmup period is negative, or run length is zero or negative, or when the warmup time is longer than or equal to the runlength, or when number of replications is zero or negative

Method Details

getNumberOfReplications

public int getNumberOfReplications()

Return the total number of replications to execute.

Returns:

int; the total number of replications to execute

hashCode

public int hashCode()

Overrides:

hashCode in class RunControl<T extends Number & Comparable<T>>

equals

public boolean equals(Object obj)

Overrides:

equals in class RunControl<T extends Number & Comparable<T>>

toString

public String toString()

Overrides:

toString in class RunControl<T extends Number & Comparable<T>>