Event
Constructors
This class allows for the periodic generation of events similar to that achieved by "Create" modules in simulation languages. This class works in conjunction with the GeneratorActionIfc, which is used to listen and react to the events that are generated by this class.
Types
Properties
A flag to control if 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 if the model element reacts to before experiment actions.
A flag to control if the model element reacts to before replication actions.
Indicates the current status of the model element for observers of ModelElement.Status
Can be used to supply logic to invoke when the generator's ending time is finite and the generator is turned off.
The time to stop generating for the current replication
The number of events currently generated during the replication
Determines the priority of the event generator's events The default is DEFAULT_PRIORITY - 1 A lower number implies higher priority.
The action for the events for generation
Used to set the ending time when the generator is initialized at the start of each replication.
A flag to control if the model element reacts to initialization actions
Controls the maximum number of events to be used to initialize each replication. The time between events cannot evaluate to a constant value of 0.0 if the maximum number of events is infinite (Long.MAX_VALUE). Uses the current value for initial time between events
Sets the time between events and the maximum number of events to be used to initialize each replication. The time between events cannot evaluate to a constant value of 0.0. The maximum number of events is kept at its current value, which by default is Long.Max_Value. Note that setting the initial time between events does not affect the random variable governing the time of the first event.
true if an event is scheduled to occur for the generator
Whether the generator has been suspended
the left traversal count for pre-order traversal of the model element tree
A long representing the maximum number of events for the generator. Sets the maximum number of events for the generator. Must not be infinite (Long.MAX_VALUE) if the current time between events is 0.0. This only controls the current replication.
Returns a string representation of the model element and its child model elements. Useful for realizing the model element hierarchy.
A flag to control if the model element participates in monte carlo actions.
Gets the number of model elements contained by the model element.
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 if the model element reacts to end replication actions.
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.
This flag controls whether the generator starts automatically when initialized at the beginning of a replication. By default, this option is true. If it is changed then it remains at the set value until changed again.
The time between events for the current replication
The time interval between TimedUpdate events. The default is zero, indicating no timed update
Specifies whether this model element participates in the time update event specified by its parent
Specifies the havingPriority of this model element's timed update event.
Controls the random variable representing the time until the first event that is used at the beginning of each replication to generate the time until the first event. This change becomes effective at the beginning of the next replication to execute
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 is 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
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.
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 the 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
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.
Often the time of the first event and the time between events is the same distribution. This property causes both initialTimeUntilFirstEvent and initialTimeBtwEvents to be set to the same random variable.
Sets the initialization option of all model elements (children) contained by this model element.
Sets the time between events and the maximum number of events to be used to initialize each replication. These parameters are dependent. The time between events cannot evaluate to a constant value of 0.0 if the maximum number of events is infinite (Long.MAX_VALUE)
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 time between events and the maximum number of events for the generator. These two parameters are dependent. The time between events cannot always evaluate to 0.0 if the maximum number of events is infinite (Long.MAX_VALUE). This method only changes these parameters for the current replication. The changes take effect when the next event is generated. If current number of events that have been generated is greater than or equal to the supplied maximum number of events, the generator will be turned off.
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.
This method turns the generator off, the next scheduled generation event will NOT occur, i.e. this method will also cancel a previously scheduled generation event if one exists. No future events will be scheduled after turning off the generator
If the generator was not started upon initialization at the beginning of a replication, then this method can be used to start the generator