Rolist – BrightSign Object Reference Manual (FW 5.1) User Manual
Page 35
27
roList
This object functions as a general-purpose, doubly linked list. It can be used as a container for arbitrary-length lists of
BrightSign Objects. The array operator
[ ] can be used to access any element in an ordered list.
The ifList interface provides the following:
•
Count() As Integer: Returns the number of elements in the list.
•
ResetIndex() As Boolean: Resets the current index or position in the list to the head element.
•
AddTail(obj As Object) As Void: Adds a typed value to the tail of the list.
•
AddHead(obj As Object) As Void: Adds a typed value to the head of the list.
•
RemoveIndex() As Object: Removes an entry from the list at the current index or position and increments the
index or position in the list. It returns Invalid when the end of the list is reached.
•
GetIndex() As Object: Retrieves an entry from the list at the current index or position and increments the
index or position in the list. It returns Invalid when the end of the list is reached.
•
RemoveTail() As Object: Removes the entry at the tail of the list.
•
RemoveHead() As Object: Removes the entry at the head of the list.
•
GetTail() As Object: Retrieves the entry at the tail of the list and keeps the entry in the list.
•
GetHead() As Object: Retrieves the entry at the head of the list and keeps the entry in the list.
•
Clear(): Removes all elements from the list.
The ifEnum interface provides the following:
•
Reset(): Resets the position to the first element of enumeration.
•
Next() As Dynamic: Returns the typed value at the current position and increment position.
•
IsNext() As Boolean: Returns True if there is a next element.
•
IsEmpty() As Boolean: Returns True if there is not a next element.