Package nl.tudelft.simulation.dsol.experiment

Interface Treatment<T extends Number & Comparable<T>>

Type Parameters:
T - the simulation time type to be able to implement a comparator on the simulation time.
All Superinterfaces:
Serializable
All Known Implementing Classes:
Experiment, ExperimentReplication, ExperimentRunControl, Replication, RunControl, SingleReplication
public interface Treatment<T extends Number & Comparable<T>> extends Serializable
The Treatment is the interface that indicates that you can retrieve the simulation start time, end time, and warmup period, as well as an id and description of the simulation run or replication.

Copyright (c) 2023-2024 Delft University of Technology, Jaffalaan 5, 2628 BX Delft, the Netherlands. All rights reserved. See for project information https://djutils.org. The DJUTILS project is distributed under a three-clause BSD-style license, which can be found at https://djutils.org/docs/license.html.
Author:
Alexander Verbraeck

  • Method Summary

    Modifier and Type
    Method
    Description
    default String
    getDescription()
    Return the description of this replication.
    default T
    getEndTime()
    Return the absolute end time of the simulation.
    default String
    getId()
    Return the id of this replication.
    RunControl<T>
    getRunControl()
    Return the RunControl object that contains the treatment information.
    default T
    getRunLength()
    Return the run length of this replication in relative units.
    default T
    getStartTime()
    Return the absolute start time of the simulation.
    default T
    getWarmupPeriod()
    Return the warmup period of this replication in relative units.
    default T
    getWarmupTime()
    Return the absolute moment when the warmup event will take place.
    default void
    setDescription(String description)
    Sets the description of this replication.

  • Method Details

    • getRunControl

      RunControl<T> getRunControl()
      Return the RunControl object that contains the treatment information.
      Returns:
      RunControl; the RunControl object that contains the treatment information

    • getId

      default String getId()
      Return the id of this replication.
      Returns:
      String; the id of this replication

    • setDescription

      default void setDescription(String description)
      Sets the description of this replication.
      Parameters:
      description - String; the description of this replication

    • getDescription

      default String getDescription()
      Return the description of this replication.
      Returns:
      String; the description of this replication

    • getRunLength

      default T getRunLength()
      Return the run length of this replication in relative units.
      Returns:
      T; the runLength.

    • getWarmupPeriod

      default T getWarmupPeriod()
      Return the warmup period of this replication in relative units.
      Returns:
      T; the warmup period.

    • getStartTime

      default T getStartTime()
      Return the absolute start time of the simulation.
      Returns:
      T; the absolute start time of the simulation

    • getEndTime

      default T getEndTime()
      Return the absolute end time of the simulation.
      Returns:
      T; the absolute end time of the simulation

    • getWarmupTime

      default T getWarmupTime()
      Return the absolute moment when the warmup event will take place.
      Returns:
      T; the absolute moment when the warmup event will take place