I_Queue (Interface)

Interface for a queue

Extends: I_Collection

Properties

_Values

Type: I_Immutable_List

Gets an immutable list of the items in the queue.

Methods

Clear

Returns: I_Queue

Empties/Clears/Deletes every item in the queue.

Dequeue

Returns: I_Queue

Removes item at the front the queue.

Outputs

Name	Type	Description
`bSuccess`	`BOOL`

Enqueue

Returns: I_Queue

Adds item at the back of the queue.

Inputs

Name	Type	Description
`Item`	`ANY`	Item to store.

Outputs

Name	Type	Description
`bSuccess`	`BOOL`

Enqueue_At_Front

Returns: I_Queue

Adds item at the front of the queue.

Inputs

Name	Type	Description
`Item`	`ANY`	Item to store.

Outputs

Name	Type	Description
`bSuccess`	`BOOL`

Enqueue_Generic

Returns: I_Queue

Adds a generic item at the back of the queue.

Inputs

Name	Type	Description
`Item`	T_Generic	Item to store.
`bAt_Front`	`BOOL`	Enqueues at front if set to TRUE.

Outputs

Name	Type	Description
`bSuccess`	`BOOL`

Get

Returns: I_Queue

Gets the item at the front of the queue.

Inputs

Name	Type	Description
`Item`	`ANY`	Variable to store returned item value

Outputs

Name	Type	Description
`bSuccess`	`BOOL`

Get_Generic

Returns: I_Queue

Gets the item at the front of the queue as a generic.

Outputs

Name	Type	Description
`Item`	T_Generic	Variable to store returned item value
`bSuccess`	`BOOL`

Reverse

Returns: I_Queue

Reverses the order of the items in the queue.

Outputs

Name	Type	Description
`bSuccess`	`BOOL`