Model
The internal constructor for creating model elements. A model element is some construct that is an element of a model. Model elements are added to the main model when they are constructed by supplying a parent model element. The constructed model element becomes a child to the parent in the model element hierarchy. This constructor is internal because of the interaction with the class Model, which serves as the parent to all model elements.
Parameters
an optional name. If not provided, then a name is provided automatically by using the class type of the element and a unique number.
Inheritors
Constructors
The main constructor for creating model elements. A model element is some construct that is an element of a model. Model elements are added to the main model when they are constructed by supplying a parent model element. The constructed model element becomes a child to the parent in the model element hierarchy.
Types
A convenience base class for creating event actions associated with the model element. The class has the ability to schedule its action.
An interface used to implement the actions associated with event logic within the simulation.
Uses the builder pattern to create and schedule the event and the action that is associated with the event
A Comparator for comparing model elements based on getId()
QObject can be used as a base class for objects that need to be placed in queues on a regular basis. A QObject can be in one and only one Queue at a time. An arbitrary object can be associated with the QObject. The user is responsible for managing the type of the attached object.
A set of constants for indicating model element status to observers of basic model element changes
A convenience base class for creating event actions associated with the model element. The class has the ability to schedule its action according to a repeating time between events.
A definition of default time unit conversions. MILLISECOND = 1.0, SECOND = 1000.0, MINUTE = 60SECOND, HOUR = 60MINUTE, DAY = 24HOUR, WEEK = 7DAY, MONTH = 30.0DAY, YEAR = 365DAY
A Tagging interface to force the builder to specify time timeUnits after calling the in() method.
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
A global uniform random number source
The length of time from the start of the simulation to the warm-up event. Sets the length of the warm-up for this model element.
A flag to control if 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 if the model element participates in monte carlo actions.
A collection containing the first level children of this model element
Gets the number of model elements contained by the model element.
the parent of this 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.
A reference to the TimedUpdate event.
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.
A reference to the warm-up 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 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
This method should be overridden by subclasses that need actions performed after an experiment has been completed It is called after all replications are done and can be used to collect data from the model element, etc.
This method should be overridden by subclasses that need actions performed after each replication. It is called after replicationEnded() has been called.
This method should be overridden by subclasses that need logic to be performed prior to an experiment. The beforeExperiment method allows model elements to be set up prior to the first replication within an experiment. It is called once before any replications occur.
This method should be overridden by subclasses that need actions performed prior to each replication. It is called prior to each replication and can be used to initialize the model element. It is called before initialize() is called.
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 provided collection carrying all the Counters that are contained by any model elements within this model element. In other words, any Counters that are in the model element hierarchy below this model element.
Gets all model elements that are contained within this model element in parent-child order within the hierarchy
Fills up the provided collection carrying all the RandomElementIfc and subclasses of RandomElementIfc that are contained by any model elements within this model element. In other words, any RandomElementIfc instances that are in the model element hierarchy below this model element.
Fills up the provided collection carrying all the response variables that are contained by any model elements within this model element. In other words, any response variables that are in the model element hierarchy below this model element.
Fills up the provided collection carrying all the variables that are contained by any model elements within this model element. In other words, any variables that are in the model element hierarchy below this model element.
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.
Fills up the provided collection carrying the Counters that are contained only by this model element
A list containing the (child) model elements of only this model element
Fills up the provided collection carrying only the random variables associated carrying this element
Fills up the provided collection carrying the response variables that are contained only by this model element
Fills up the provided collection carrying only the variables associated carrying this element
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
This method should be overridden by subclasses that need actions performed to initialize prior to a replication. It is called once before each replication occurs if the model element wants initialization. It is called after beforeReplication() is called
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
This method should be overridden by subclasses that need actions performed after before replication. It is called after beforeReplication but prior to afterReplication() and can be used to perform pure monte-carlo (non-event type) simulations carrying the model element
Notify the observers
This method should be overridden by subclasses that need to register conditional actions prior to a replication with the executive. It is called once before each replication, right after the method initialize() is called. The user can use the executive property to access the Executive
This method should be overridden by subclasses that need actions performed when a model element is removed from a model
This method should be overridden by subclasses that need actions performed when the replication ends and prior to the calling of afterReplication(). It is called when each replication ends and can be used to collect data from the model element, etc.
Creates an EventScheduler which can be used to create and schedule events on the simulation calendar reactingWith a fluency pattern.
Allows event actions to be scheduled by model elements
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.
Causes the current replication to stop processing events.
This method should be overridden by subclasses that need actions performed at each timed update event during each replication. It is called for each timed update during each replication if the model element reacts to timed update actions.
The update method can be called at reactor defined points to indicate that the model element has been changed in some fashion that the update status observers need notification. This method ensures that each contained model element that requires an update action will perform its actions.