Class keyed_collection

Build Information

Author fmcguirk
Date 2007.10.03 40 at 10:12:24 AM EDT
Outputfile keyed_collection.pvc
Forcelinenumbers false

Properties

PROPERTY count

Methods

FUNCTION add(entityID)

Add a new entity to the collection (use class name plus entity_ID as the key)

ParameterDescription
entityID A reference to an entity object to add to the collection
Returns A simple value to indicate success (0=Failed, 1=Succeeded)
FUNCTION add(key$, entityID)

Add a new entity to the collection

ParameterDescription
key$ The name (maximum length of 50 characters) to be used to access the entity
entityID A reference to an entity object to add to the collection
Returns A simple value to indicate success (0=Failed, 1=Succeeded)
FUNCTION delete(entityID)

Delete an entity from the collection by ID

ParameterDescription
entityID The ID of the entity to delete
Returns A simple value to indicate success (0=Failed, 1=Succeeded)
FUNCTION delete(key$)

Delete an entity from the collection by name

ParameterDescription
key$ The name (maximum length of 50 characters) of the entity to delete
Returns A simple value to indicate success (0=Failed, 1=Succeeded)
FUNCTION item(key$)


Get the entity ID associated with the specified name

ParameterDescription
key$ The name (maximum length of 50 characters) of the entity to locate
Returns A reference to the entity object
FUNCTION item(index)

Get the entity ID associated with the specified index

ParameterDescription
index The name of the entity to locate
Returns A reference to the entity object