class
SelectionSetTable
SelectionSetTable keeps a table of SelectionSet. Note that the table will make sure that the names of objects added are unique within the table, and will rename objects with non-unique names.
Properties
Property | Description |
---|---|
Name | The name of the SelectionSetTable object. (Inherited from Object) |
Methods
Method | Description |
---|---|
AddItem | Adds an item to the table. The returned value is the id of the item within the table, which can be used to retrieve the item using GetItem(). (Inherited from Table) |
AddObserver | Adds a user-defined observer object to the interface, that will receive events from the interface. (Inherited from Object) |
AddSelectionSet | Adds a selection set to the table. The returned value is the id of the selection set within the table. |
Clear | Clears the table, and removes all items. If AddItem is called after Clear, the item ids will start over from 0. (Inherited from Table) |
Copy | Clears the current table and copies the items from a source table. (Inherited from Table) |
FindItem | Finds a named item in the table. If multiple items have the same name, the first will be returned. If no item was found, null will be returned. (Inherited from Table) |
FindItemId | Finds the id of an item in the table, using the name. If multiple items have the same name, the first will be returned. If no item was found, the return will be -1. (Inherited from Table) |
FindSelectionSet | Finds a selection set in the table, using the name. If multiple selection sets have the same name, the first match will be returned. If the selection set was not found, null will be returned. |
FindSelectionSetId | Finds the id of a selection set in the table, using the name. If multiple selection sets have the same name, the first will be returned. If the selection set was not found, the return will be -1. |
GetClass | Get the name of the SelectionSetTable class. (Inherited from Object) |
GetItem | Returns the i:th item, using the id of the item. (Inherited from Table) |
GetItemsCount | The number of item id:s in the table. If an item has been removed, using RemoveItem, the id is still counted in this method. GetIdsCount also equals the id that will be applied to the next item added to the table. (Inherited from Table) |
GetSelectionSet | Returns the i:th selection set, using the id of the selection set. |
GetSelectionSetCount | Returns the number of selection sets in the table. |
IsA | Returns true if SelectionSetTable is a or is a descendant of the class named as the type parameter. (Inherited from Object) |
IsNull | Returns true if the SelectionSetTable object is invalid. (Inherited from Object) |
IsSameObjectAs | Returns true if the SelectionSetTable object is valid. (Inherited from Object) |
NonNull | Returns true if the SelectionSetTable object is valid. (Inherited from Object) |
PrintInfo | Prints the content/info of the SelectionSetTable object to the log. (Inherited from Object) |
RemoveItem | Removes an item, and invalidates the id. The id will not point at a valid item, until Clear is called and new items are added up until the id. (Inherited from Table) |
RemoveNamedSelectionSet | Removes a selection set from the table by name. |
RemoveObserver | Removes a previously added observer object. (Inherited from Object) |
RemoveSelectionSet | Removes a selection set from the table by set ID. |
SetItem | Sets an item in the table. The id must exist in the table. (Inherited from Table) |
Static methods
Method | Description |
---|---|
IsClassA | Returns true if the class is a or is a descendant of the class named as the type parameter. (Inherited from Object) |
SafeCast | SafeCast makes sure the input object is of a class that can be cast into spSelectionSetTable, and if this is the case, returns the object cast into spSelectionSetTable. (Inherited from Object) |
Properties details
Name
The name of the SelectionSetTable object. (Inherited from Object)
Methods details
AddItem
Adds an item to the table. The returned value is the id of the item within the table, which can be used to retrieve the item using GetItem().
AddObserver
Adds a user-defined observer object to the interface, that will receive events from the interface. (Inherited from Object)
AddSelectionSet
Adds a selection set to the table. The returned value is the id of the selection set within the table.
Clear
Clears the table, and removes all items. If AddItem is called after Clear, the item ids will start over from 0.
Copy
Clears the current table and copies the items from a source table.
FindItem
Finds a named item in the table. If multiple items have the same name, the first will be returned. If no item was found, null will be returned.
FindItemId
Finds the id of an item in the table, using the name. If multiple items have the same name, the first will be returned. If no item was found, the return will be -1.
FindSelectionSet
Finds a selection set in the table, using the name. If multiple selection sets have the same name, the first match will be returned. If the selection set was not found, null will be returned.
FindSelectionSetId
Finds the id of a selection set in the table, using the name. If multiple selection sets have the same name, the first will be returned. If the selection set was not found, the return will be -1.
GetClass
Get the name of the SelectionSetTable class. (Inherited from Object)
GetItem
Returns the i:th item, using the id of the item.
GetItemsCount
The number of item id:s in the table. If an item has been removed, using RemoveItem, the id is still counted in this method. GetIdsCount also equals the id that will be applied to the next item added to the table.
GetSelectionSet
Returns the i:th selection set, using the id of the selection set.
GetSelectionSetCount
Returns the number of selection sets in the table.
IsA
Returns true if SelectionSetTable is a or is a descendant of the class named as the type parameter. (Inherited from Object)
IsNull
Returns true if the SelectionSetTable object is invalid. (Inherited from Object)
IsSameObjectAs
Returns true if the SelectionSetTable object is valid. (Inherited from Object)
NonNull
Returns true if the SelectionSetTable object is valid. (Inherited from Object)
PrintInfo
Prints the content/info of the SelectionSetTable object to the log. (Inherited from Object)
RemoveItem
Removes an item, and invalidates the id. The id will not point at a valid item, until Clear is called and new items are added up until the id.
RemoveNamedSelectionSet
Removes a selection set from the table by name.
RemoveObserver
Removes a previously added observer object. (Inherited from Object)
RemoveSelectionSet
Removes a selection set from the table by set ID.
SetItem
Sets an item in the table. The id must exist in the table.
Static methods details
IsClassA
Returns true if the class is a or is a descendant of the class named as the type parameter. (Inherited from Object)
SafeCast
SafeCast makes sure the input object is of a class that can be cast into spSelectionSetTable, and if this is the case, returns the object cast into spSelectionSetTable. (Inherited from Object)