Time
This class addresses the problem of collecting simulation responses by period. A typical use case involves the reporting of statistics over fixed time periods, such as hourly, daily, monthly, yearly, etc. A time series response divides the simulated time horizon into sequential periods, with the periods marking the time frame over which performance is observed. Users specify which responses will be tabulated by providing Response, TWResponse, or Counter instances. Then for each period during the simulation horizon, the response over the period is recorded into a series of records, constituting a time series for the response. For Response and TWResponse instances, the recorded response represents the average of the variable during the period. For Counter instances, the total count during the period is recorded. This data is recorded for every response, for every period, for each replication. The response or counter information is recorded at the end of each completed period. The number of periods to collect must be supplied.
This class does not react to warm up events. That is, periods observed prior to the warmup event will contain data that was observed during the warmup period. The standard usage for this class is likely not within an infinite horizon (steady-state) context. However, if you do not want data collected during warmup periods, then specify the default start time for the time series to be greater than or equal to the specified warmup period length using the defaultStartTime property. The default starting time of the first period is at time 0.0.
The collected responses are not automatically shown in console output. However, the data can be accessed via a reference to the class or by using a KSLDatabase.
Parameters
the parent model element for the time series response.
the length of time for the period. This must be greater than zero.
A set of responses to observe for each period. This set may be empty only if the counters set is not empty.
A set of counters to observe for each period. This set may be empty only if the responses set is not empty.
This option indicates that within memory statistics will be defined to collect statistics across the periods for each replication. This will result in statistics for each period for each response. The default is false.
the name of the model element
Constructors
Properties
A flag to control whether the model element reacts to after experiment actions.
A flag to control whether the model element reacts to after replication actions.
A flag to control whether the model element reacts to before experiment actions.
A flag to control whether the model element reacts to before replication actions.
The counters associated with the time series response.
Indicates the current status of the model element for observers of ModelElement.Status
The default time that the first period will start. By default, it is zero.
A flag to control whether the model element reacts to initialization actions
the left traversal count for pre-order traversal of the model element tree
Returns a string representation of the model element and its child model elements. Useful for realizing the model element hierarchy.
A flag to control whether the model element participates in monte carlo actions.
Gets the number of model elements contained by this model elements.
Counts the number of periods collected
The length (in base time units) for the period
Indicates the previous status of the model element for observers of ModelElement.Status This allows the transition to be noted by observers
A flag to control whether the model element reacts to end replication actions.
The responses associated with the time series response.
the right traversal count for pre-order traversal of the model element tree
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.
The time interval between TimedUpdate events. The default is zero, indicating no timed update
Specifies whether this model element participates in time update event specified by its parent
Specifies the havingPriority of this model element's timed update event.
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
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.
Specifies the priority of this model element's warm up event.
Functions
If the acrossRepStatisticsOption option is true, then this function returns the across replication statistics for each period for the specified counter. If the counter is not associated with the time series collector, then an empty map is returned.
If the acrossRepStatisticsOption option is true, then this function returns the across replication statistics for each period for the specified response. If the response is not associated with the time series collector, then an empty map is returned.
Returns a data frame of the across replication statistics by period where the statistics are computed replications.
Returns a list of the across replication statistics by period where the statistics are computed replications.
Returns all time series period data as a data frame for responses and counters
Returns all time series period data as a list for responses and counters
If the collection has been scheduled to start or has started, this function cancels any further collection.
Cancels the timed update event for this model element.
Cancels the warm-up event for this model element.
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.
Provides a data frame representation of the counter period data for the counter or an empty data frame if the counter is not collected.
Provides a data frame representation of the counter period data for the counter or an empty data frame if the counter is not collected.
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.
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.
This method returns the planned time for the warm-up for this model element.
Fills a StringBuilder carrying the model element names in the order that they will be initialized
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.
Checks if current status is the supplied status
Checks if a timed update event has been scheduled for this model element
Checks if a warm-up event has been scheduled for this model element
Returns the value of a 1 millisecond time interval in terms of the base time unit
Provides a data frame representation of the response period data for the response or an empty data frame if the response is not collected.
Provides a data frame representation of the response period data for the response or an empty data frame if the response is not collected.
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.
Sets the initialization option of all model elements (children) contained by this model element.
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
Sets the timed update option flag of all model elements (children) contained by this model element.
Sets the warm-up option flag of all model elements (children) contained by this model element.