Murl Engine Lua Addon API  Version 1.0 beta
Murl.Index.String

A generic index template class for moveable objects eg. structs or fundamental data types like UInt32, Real, etc.

See IndexBase class for all index methods.
The index class stores a number of (not necessarily unique) keys in a hash table.
The index class works for moveable objects only, use ObjectIndex class for storing non-moveable objects.
This class is based on the NTL Index container, see http://www.ultimatepp.org


Table members

Inherited


Murl.IndexBase.StringArrayStringStdHashString

Functions


Murl.Index.String.new()

The default constructor. Create an empty index object.

Murl.Index.String new()

Returns
Murl.Index.String

Murl.Index.String.new(item)

Construct an index containing a single item.

Murl.Index.String new(String item)

Parameters
itemThe item.
Returns
Murl.Index.String

Murl.Index.String.new(item1, item2)

Construct an index containing two items.

Murl.Index.String new(String item1, String item2)

Parameters
item1The first item.
item2The second item.
Returns
Murl.Index.String

Murl.Index.String.new(item1, item2, item3)

Construct an index containing three items.

Murl.Index.String new(String item1, String item2, String item3)

Parameters
item1The first item.
item2The second item.
item3The third item.
Returns
Murl.Index.String

Murl.Index.String.new(array)

Constructor taking an array.

Murl.Index.String new(Murl.Array.String array)

Parameters
arrayThe array object to copy.
Returns
Murl.Index.String

Murl.Index.String.new(index)

The copy constructor.

Murl.Index.String new(Murl.Index.String index)

Parameters
indexThe index object to copy.
Returns
Murl.Index.String


Methods


Pop()

Remove the last item.

String Pop()

Returns
String The the removed item.