Remove (ModelNodes)


Description

Removes an item from a ModelNodes collection.

Syntax

someModelNodes.Remove(indexNode, indexState)

 

Parameter Description
someModelNodes a ModelNodes collection.
indexNode An integer, or a string, or a object specifying the index of the Node to remove. Integer indexes are zero-based, meaning the first item in the collection has index 0. A string index is valid only if the string is the name of an Node in the collection. An Node is valid only if it in the collection.
indexState Optional. An integer, or a string, or a object specifying the index of a State within the States collection of the Node. Any distributions that used the node as a parent, will use this state instead. If no state is given, the first state is used.

Remark

When a Model object is removed from the ModelNodes collections, it becomes a "zombie". With one exception, if you try to use a zombie, you'll get an error message. The one exception is that the ExistingKey method can test if a zombie is a member of the collection.

Return Value

None.

Example

See: Collections and Maps: an Overview

Applies To

ModelNodes