HistoricalVariable

class HistoricalVariable(parent: ModelElement, val pathToFile: Path, val arrayOption: Boolean = true, val stoppingOption: StoppingOption = StoppingOption.STOP, val stopValue: Double = Double.MAX_VALUE, defaultValue: GetValueIfc? = null, name: String? = null) : ModelElement, GetValueIfc, PreviousValueIfc

A historical variable returns values read from a file. These variables might be used in place of a RandomVariable to supply data values into a simulation model. The user must supply a valid path to the file pathToFile. The file should be a text file with a single column of double values, each value on a new row. All values in the file must be convertable to instances of Double.

The array option arrayOption indicates if the contents of the file are read into an array upon creation of the instance. Consider using this option when the number of values can comfortably fit into memory. This avoids having an open file and should permit faster access to the values at the cost of increased memory requirements. The default for the array option is true. The file is closed immediately after reading all the values into the array.

If the array option is false, then values are read from the file during the execution of the simulation. The implication is that the file remains open during the simulation. The file will be opened automatically when the simulation experiment starts and closed automatically when the simulation experiment ends.

The user must specify what to do when there are no more values available in the stream via the end stream option stoppingOption. There are four options available:

REPEAT: When the end of values is detected, the values will automatically repeat with the next value returning to the first value available in the file.

STOP: When the end of values is detected, logic provided via the function stopAction will be executed. The default action is to stop the current replication and cause no future replications to be executed. By providing a stop action function, the user may provide more specific actions that can occur when there are no more values in the stream. The value of stopValue will be returned as the last value. The default stopping value is Double.MAX_VALUE. The STOP option is the default behavior.

USE_LAST: When the end of values is detected, the last value from the file will be repeatedly returned for any future requests for values.

USE_DEFAULT: When the end of values is detected, the values will be returned from the supplied instance of the parameter defaultValue. In the case of specifying USE_DEFAULT, the user must supply an instance of the GetValueIfc interface to supply the values. If USE_DEFAULT is not specified, a default value is optional.

Constructors

Link copied to clipboard
constructor(parent: ModelElement, pathToFile: Path, arrayOption: Boolean = true, stoppingOption: StoppingOption = StoppingOption.STOP, stopValue: Double = Double.MAX_VALUE, defaultValue: GetValueIfc? = null, name: String? = null)

Properties

Link copied to clipboard

A flag to control whether the model element reacts to after experiment actions.

Link copied to clipboard

A flag to control whether the model element reacts to after replication actions.

Link copied to clipboard
val arrayOption: Boolean = true
Link copied to clipboard

A flag to control whether the model element reacts to before experiment actions.

Link copied to clipboard

A flag to control whether the model element reacts to before replication actions.

Link copied to clipboard

Indicates the current status of the model element for observers of ModelElement.Status

Link copied to clipboard
open override val id: Int
Link copied to clipboard

A flag to control whether the model element reacts to initialization actions

Link copied to clipboard
open override var label: String?
Link copied to clipboard

the left traversal count for pre-order traversal of the model element tree

Link copied to clipboard

the model that contains this element

Link copied to clipboard

Returns a string representation of the model element and its child model elements. Useful for realizing the model element hierarchy.

Link copied to clipboard

A flag to control whether the model element participates in monte carlo actions.

Link copied to clipboard
override val name: String
Link copied to clipboard

Gets the number of model elements contained by this model elements.

Link copied to clipboard
Link copied to clipboard

Indicates the previous status of the model element for observers of ModelElement.Status This allows the transition to be noted by observers

Link copied to clipboard
open override var previousValue: Double

The previous value from the sequence of values a double representing the last value in the sequence

Link copied to clipboard

A flag to control whether the model element reacts to end replication actions.

Link copied to clipboard

the right traversal count for pre-order traversal of the model element tree

Link copied to clipboard

The spatial model associated with this model element. By default, each model element uses its parent model element's spatial model unless changed via this property. This changes the spatial model for this model element and no others.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

The current simulation time

Link copied to clipboard

The time interval between TimedUpdate events. The default is zero, indicating no timed update

Link copied to clipboard

Specifies whether this model element participates in time update event specified by its parent

Link copied to clipboard

Specifies the havingPriority of this model element's timed update event.

Link copied to clipboard
open val value: Double
Link copied to clipboard

Indicates whether the warm-up action occurred sometime during the simulation for this model element. False indicates that the warm-up action has not occurred

Link copied to clipboard

Specifies if this model element will be warmed up when the warmup action occurs for its parent. The warm-up flag indicates whether this model element will be warmed up when its parent warm up event/action occurs. The default value for all model elements is true. A value of true implies that the model element allows its parent's warm up event to call the warm-up action. A value of false implies that the model element does not allow its parent's warm up event to call the warm-up action. False does not necessarily mean that the model element will not be warmed up. It may, through the use of the lengthOfWarmUp property, have its own warm up event and action.

Link copied to clipboard

Specifies the priority of this model element's warm up event.

Functions

Link copied to clipboard

Cancels the timed update event for this model element.

Link copied to clipboard

Cancels the warm-up event for this model element.

Link copied to clipboard

Checks if this model element or any model element directly above this model element in the hierarchy of model elements all the way until the top Model participates in the warm-up action.

Link copied to clipboard
fun day(): Double

Returns the value of a 1-day time interval in terms of the base time unit

Link copied to clipboard

Find the first parent that has its own warm up event this guarantees that all elements below the found model element do not have their own warm-up event. A model element that has its own warm up event also opts out of the warm-up action. If the returned parent is the Model, then all are controlled by the model (unless they opt out). Elements can opt out and not have their own warm-up event. Thus, they have no warm up at all.

Link copied to clipboard

Fills up the supplied StringBuilder carrying a string representation of the model element and its child model elements Useful for realizing the model element hierarchy.

Link copied to clipboard

This method returns the planned time for the warm-up for this model element.

Link copied to clipboard
fun hour(): Double

Returns the value of a 1-hour time interval in terms of the base time unit

Link copied to clipboard

Fills a StringBuilder carrying the model element names in the order that they will be initialized

Link copied to clipboard

Checks if a warm-up event is scheduled for any model element directly above this model element in the hierarchy of model elements all the way until the top Model.

Link copied to clipboard

Checks if current status is the supplied status

Link copied to clipboard

Checks if a timed update event has been scheduled for this model element

Link copied to clipboard

Checks if a warm-up event has been scheduled for this model element

Link copied to clipboard

Returns the value of a 1 millisecond time interval in terms of the base time unit

Link copied to clipboard
fun minute(): Double

Returns the value of a 1-minute time interval in terms of the base time unit. For example, if the time unit is set to hours, then minute() should return 0.0166 (TIME_UNIT_MINUTE/TIME_UNIT_HOUR)

Link copied to clipboard
fun second(): Double

Returns the value of a 1-second time interval in terms of the base time unit

Link copied to clipboard

Sets the after experiment option of all model elements (children) contained by this model element.

Sets the after replication flag of all model elements (children) contained by this model element.

Sets the before experiment option of all model elements (children) contained by this model element.

Sets the before replication flag of all model elements (children) contained by this model element.

Link copied to clipboard

Sets the initialization option of all model elements (children) contained by this model element.

Link copied to clipboard

Sets the monte carlo option flag of all model elements (children) contained by this model element.

Sets the end replication option flag of all model elements (children) contained by this model element. Determines whether the replicationEnded() method will be called

Link copied to clipboard

Sets the timed update option flag of all model elements (children) contained by this model element.

Link copied to clipboard

Sets the warm-up option flag of all model elements (children) contained by this model element.

Link copied to clipboard
open override fun toString(): String

Includes the model name, the id, the model element name, the parent name, and parent id

Link copied to clipboard
open override fun value(): Double

This method simply returns the value.

Link copied to clipboard
fun week(): Double

Returns the value of a 1-week time interval in terms of the base time unit