RiverSoftAVG Products Help

Zoom Window Out
Larger Text | Smaller Text
Hide Page Header
Show Expanding Text
Printable Version
Send Mail Feedback
Save Permalink URL

Navigation: Code Documentation > RSCommon > GLists > Classes

TGQueue Class

TGQueue maintains a first-in first-out array, or queue, of objects. Use a TGQueue object to store and maintain a first-in first-out list.

To use the class properly as a queue, use the GLists.TGQueue.Push(TObject) and GLists.TGQueue.Pop methods, not Add or Items.

Note
The TGQueue manages the nodes of the list and will ensure nodes get freed.

Namespace: GLists

	Name	Description
	Count	Returns the number of nodes in the linked list. (Inherited from GLists.TGCustomLinkedList.)
	Empty	Returns true if the linked list is empty. (Inherited from GLists.TGCustomLinkedList.)
	EndOfList	Returns true when the last accessed node has been returned. (Inherited from GLists.TGCustomLinkedList.)
	Head	Specifies the first node in the linked list. (Inherited from GLists.TGCustomLinkedList.)
	Item	Represents property Item.
	LastAccessedIndex	Caches the index of the last node accessed. This helps speeds up subsequent calls to Item or Node properties. (Inherited from GLists.TGCustomLinkedList.)
	LastAccessedNode	Caches the last node accessed. This helps speeds up subsequent calls to Item or Node properties. (Inherited from GLists.TGCustomLinkedList.)
	Next	Moves the internal Node to the next node in the linked list (Inherited from GLists.TGCustomLinkedList.)
	Node[Integer]	Returns the the node at the specified position in the list. (Inherited from GLists.TGCustomLinkedList.)
	OnChange	Represents property OnChange.
	Tail	Specifies the last node in the linked list. (Inherited from GLists.TGCustomLinkedList.)
	Top	Returns the object at the front of the queue. Call Top to access the queue without removing an item. Top returns the next item in the queue (that is, the earliest item added). To remove an item from the queue, call GLists.TGQueue.Pop.
	UpdateCount	Represents property UpdateCount. (Inherited from GLists.TGCustomLinkedList.)

Top

Name

Description

public method

Add(TObject)

Creates a new node in the linked list and sets its Item property to the input object.

Add returns the node created.

public method

AddLinkedList(TGCustomLinkedList)

Appends the input linked list to the end of the current linked list. (Inherited from GLists.TGCustomLinkedList.)

public method

AddNode(TSQNode)

Adds the input node to the end of the linked list. (Inherited from GLists.TGCustomLinkedList.)

public method

Assign(TPersistent)

Represents method Assign(TPersistent). (Inherited from GLists.TGCustomLinkedList.)

public method

BeginUpdate

Defers OnChange events until EndUpdate is called.

BeginUpdate and EndUpdate work in tandem to defer change events to speed processing. Use BeginUpdate to defer change events until an equal number of EndUpdate calls occurs.

protected method

Change

Represents method Change. (Inherited from GLists.TGCustomLinkedList.)

public method

Clear

Empties the linked list

Note
Items associated with nodes are not freed.

public method

Delete(TSQNode)

Deletes the specified node from the linked list. (Inherited from GLists.TGCustomLinkedList.)

public method

EndUpdate

Reenables OnChange events after BeginUpdate has been called.

BeginUpdate and EndUpdate work in tandem to defer change events to speed processing. Use BeginUpdate to defer change events until an equal number of EndUpdate calls occurs.

public method

Find(TSQNode)

Find returns the Node before ANode i.e., whose Next field points to
ANode. If Find returns the Node itself then Node is the Head node (Inherited from GLists.TGCustomLinkedList.)

public method

FindItem(TObject)

FindItem returns the node whose Item property equals the input object.

If the item cannot be found, the method returns nil.

public method

GetEnumerator

Returns an enumerator for iterating over the linked list. (Inherited from GLists.TGCustomLinkedList.)

protected method

GetNode(Integer)

Represents method GetNode(Integer). (Inherited from GLists.TGCustomLinkedList.)

public method

IndexOfItem(TObject)

Returns the position of the node (0 = head) whose Item property equals the input object.

If the item cannot be found, the method returns -1.

public method

Insert(TSQNode,TSQNode)

Inserts the input ANode into the linked list. The node is inserted before the BeforeNode (i.e., ANode.Next := BeforeNode). (Inherited from GLists.TGCustomLinkedList.)

public method

NewNode

Creates a new node. The new node is not added to the linked list. (Inherited from GLists.TGCustomLinkedList.)

public method

Pop

Removes and returns the item at the front of the queue. Call Pop to retrieve an item from the queue. Pop removes the next item from the queue (that is, the earliest item added), then returns the object of the deleted item.

To access the queue without removing an item, call GLists.TGQueue.Top .

public method

Push(TObject)

Adds an item to the end of the queue. Call Push to add an item to the queue.

To retrieve items added with Push, call GLists.TGQueue.Pop or GLists.TGQueue.Top .

public method

Reset

Resets the iteration node to the head of the list. (Inherited from GLists.TGCustomLinkedList.)

protected method

SetNode(Integer,TSQNode)

Represents method SetNode(Integer,TSQNode). (Inherited from GLists.TGCustomLinkedList.)

Top

RiverSoftAVG Products Help

Reference