SIMPOL Documentation

queue

Description

Type Tags

None

Object Value

Objects of type queue have no value, and it is an error to try to get or set this value.

queue.new()

Description

Prototype

queue.new ( queue me, integer max, boolean endless )

Parameters

ParameterDefault valueType nameDescription
meNonequeue
max.infinteger
endless.falseboolean

Properties

PropertyTypeDescription
_type(*)
__type(*)
_privatequeueprivate
addfunction
clearfunction
endlessboolean
getfunction
getcountfunction
isemptyfunction
removefunction
typetype

Methods

add()

Description

Prototype

queuevar.add ( queue me, type(*) item )

Parameters
ParameterDefault valueType nameDescription
meNonequeue
itemNonetype(*)

clear()

Description

Prototype

queuevar.clear ( queue me )

Parameters
ParameterDefault valueType nameDescription
meNonequeue

get()

Description

Prototype

queuevar.get ( queue me, integer index )

Parameters
ParameterDefault valueType nameDescription
meNonequeue
indexNoneinteger

getcount()

Description

Prototype

queuevar.getcount ( queue me )

Parameters
ParameterDefault valueType nameDescription
meNonequeue

isempty()

Description

Prototype

queuevar.isempty ( queue me )

Parameters
ParameterDefault valueType nameDescription
meNonequeue

remove()

Description

Prototype

queuevar.remove ( queue me )

Parameters
ParameterDefault valueType nameDescription
meNonequeue