Queue Properties

Read and Write Only Properties

The Queue properties that are editable through the Visual Logic Set Value editor are:
Image

Sets the image used for the Queue to any image located in the Graphics, Images menu option.

Example:

Set Queue1.Image = "BlueB": where BlueB exists as an image.

Note the Inverted Commas around the name of the image.

Index

Sets the Index number of the Queue to a value other than the default value.

Example:

Set Queue1.Index = 5

Initial Contents

Sets the Start Up contents of the Queue.

Example:

Set Queue1.Initial Contents = 10: places 10 items into the store at the start of each run.

Max Size

Sets the Capacity of the Queue. Set this value to -1 when the Queue has an infinite capacity.

Example:

Set Queue1.Max Size = 10: sets the capacity of the store to 10.

Min Wait Time

Sets the Minimum Wait Time property.

Example:

Set Queue1.Min Wait Time = 5: each item will wait 5 minutes before being released from the Queue.

Name

Allows the name of the Queue to be changed or accessed.

Example:

Set Queue1.Name = "Change the Name": changes the name to whatever is inside the inverted commas.
Set Var1 = Queue1.Name: sets a text Global Data Item to contain the name of the Queue.

Other Cost

This property can be utilised to add further cost details to your income statement.

Example:

Set Queue 1. Other Costs = 2000: sets an additional cost of 2000 to the Queue in the Finance Report.

Other Revenue

This property can be utilised to add revenue details to your income statement for a Queue.

Example:

Set Queue 1. Other Revenue = Queue 1.Count Contents*5: sets an additional revenue of 5 for every Work Item in the
Queue at the time of execution to the Finance Report.

Shelf Life

Sets the Shelf Life of the Queue. Use this with an Expired Only Activity.

Example:

Set Queue1.Shelf Life = 5: sets the maximum amount of time each item can remain in the Queue.

Selected

Sets whether the Queue is selected onscreen or not.

1 = Selected
0 = Not selected

 Set Queue1.Selected = 0

Results Collection Mode

Allows control over the collection of results for specific object through Visual Logic.

1 = Results Collection on
0 = Results Collection off

Example:

Set Queue 1.Results Collection Mode = 1

Travel and Contents

Returns the number of items currently in and on their way to the store. This include any item traveling on a transit link to the store and items currently in the store.

Example:

Set Var1 = Queue1.Travel and Contents.

Read Only Properties

Count Contents

Returns the number of Work Items currently located on the Queue.

Example:

Set Var1 = Queue1.Count Contents

In Count

Returns the number of incoming routes to the Queue.

Example:

Set Var1 = Queue1.In Count: Sets Var1 to the number routes that are connected to the Queue.

Out Count

Returns the number of Outgoing routes from the Queue.

Example:

Set Var1 = Queue.Out Count: Sets Var1 to the number routes that are connected from the Queue.

Unique ID

Gets Simul8's internal Unique Number that identifies every object - you can be sure it is different for all objects. It never changes once an object is in a simulation

See Also