Factory:org.bzdev.devqsim.WaitTaskQueueFactory
Parameter Types
(optional keytype)
(value type)
Range RV Mode Add/Set
canRelease
Release-Capable Flag
boolean N/A false set
True if the queue can be released; false if not
deletePolicy
Delete Policy
org.bzdev.devqsim.QueueDeletePolicy N/A false set
Policy for handling deletion of a queue (MUST_BE_EMPTY, NEVER, WHEN_EMPTY)
This parameter's value is an enumeration whose type is org.bzdev.devqsim.QueueDeletePolicy. The enumeration constants are
  • MUST_BE_EMPTY - the queue must be empty and not processing any more elements before it can be deleted.
  • WHEN_EMPTY - the queue will not accept new entries after the delete() method is called, with the actual deletion postponed until the queue is empty.
  • NEVER - the queue may not be deleted.
The default is WHEN_EMPTY.
releasePolicy
Release Policy
org.bzdev.devqsim.TaskQueue.ReleasePolicy N/A false set
Policy for releasing canceled events (CANCEL_AS_RELEASED, CANCELS_IGNORED, or REPLACE_CANCELS)
This parameter's value is an enumeration constant whose type is org.bzdev.devqsim.TaskQueue.ReleasePolicy. A release policy describes how the count of the number of entries that may be released from a queue are treated as entries are removed from the queue. A release is in progress starting with a call to one of the release-initiation methods: forceRelease, release, releaseUpTo, or forceReleaseUpTo. A release ends when the release count becomes zero or when the the method clearReleaseCount has been called. The values for this parameter are as follows:
  • CANCELS_IGNORED - after a call to a release-initiation method, newly canceled events do not change the number of events that will be released.
  • CANCELS_AS_RELEASED - after a call to a release-initiation method, newly canceled events will be counted as released events.
  • REPLACE_CANCELS - after a call to a release-initiation method, when an event is processed, newly added events replace newly canceled events, and the difference is counted as released events. The counts of newly added and newly canceled events are reset to zero every time an event on the queue is processed successfully. This policy is intended for cases in which existing events are canceled and new ones added at the same time.
The default is CANCELS_IGNORED.
timeline
Timeline
int N/A false add
Timeline entries (use only to clear)
This is an integer-keyed set of values that define changes in an object's configuration. Subclasses may provide additional timeline parameters.
timeline.time
Time
int
java.lang.Double
[-∞, ∞] false set
The time for a timeline entry
This parameter must be provided if a timeline entry exists. The units are those used by the double-precession time unit for the simulation (for animations, this is generally seconds).
timeline.traceSetMode
TraceSet Mode
int
org.bzdev.devqsim.TraceSetMode
N/A false set
The trace-set mode for a timeline entry
This parameter indicates how the trace sets associated with a timeline entry should be interpreted. The values are an enumeration whose type is org.bzdev.devqsim.TraceSetMode and are used as follows:
  • KEEP - keep the existing trace sets, adding additional ones specified by the parameter timeline.traceSets.
  • REMOVE - remove the trace sets specified by the parameter timeline.traceSets.
  • REPLACE - remove all existing trace sets and replace those with the ones specified by the timeline.traceSets parameter.
timeline.traceSets
Trace Sets
int
org.bzdev.devqsim.TraceSet
N/A false add
The trace sets for a timeline entry
This parameter represents a set of TraceSet objects (the three-argument add method is used to add entries). How the entries are interpreted depends on the trace set mode for this timeline entry.
traceSets
Trace Sets
org.bzdev.devqsim.TraceSet N/A false add
A set of TraceSet objects, used for tracing
This parameter provides a set of TraceSets a SimObject will use for tracing. One should use the add and remove factory methods as this parameter refers to a set of values.