# 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

# Methods

# Static methods

# Properties details

# Name

The name of the SelectionSetTable object. (Inherited from Object)

// Setter
void SetName( const char * name ) const;

// Getter
spString GetName() const;

// Setter
void SetName(string name);

// Getter
string GetName();

# Setter
None SetName(name: str)

# Getter
str GetName()

# 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().

rid AddItem( const spObject & item ) const;

int AddItem(spObject item);

int AddItem(item: spObject)

# AddObserver

Adds a user-defined observer object to the interface, that will receive events from the interface. (Inherited from Object)

rid AddObserver( const spObserver & observer ) const;

int AddObserver(spObserver observer);

int AddObserver(observer: spObserver)

# AddSelectionSet

Adds a selection set to the table. The returned value is the id of the selection set within the table.

rid AddSelectionSet( const spSelectionSet & selectionSet ) const;

int AddSelectionSet(spSelectionSet selectionSet);

int AddSelectionSet(selectionSet: spSelectionSet)

# Clear

Clears the table, and removes all items. If AddItem is called after Clear, the item ids will start over from 0.

void Clear() const;

void Clear();

None Clear()

# Copy

Clears the current table and copies the items from a source table.

void Copy( const spTable & src ) const;

void Copy(spTable src);

None Copy(src: spTable)

# 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.

spObject FindItem( const char * name ) const;

spObject FindItem(string name);

spObject FindItem(name: str)

# 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.

rid FindItemId( const char * name ) const;

int FindItemId(string name);

int FindItemId(name: str)

# 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.

spSelectionSet FindSelectionSet( const char * name ) const;

spSelectionSet FindSelectionSet(string name);

spSelectionSet FindSelectionSet(name: str)

# 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.

rid FindSelectionSetId( const char * name ) const;

int FindSelectionSetId(string name);

int FindSelectionSetId(name: str)

# GetClass

Get the name of the SelectionSetTable class. (Inherited from Object)

spString GetClass() const;

string GetClass();

str GetClass()

# GetItem

Returns the i:th item, using the id of the item.

spObject GetItem( rid id ) const;

spObject GetItem(int id);

spObject GetItem(id: int)

# 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.

unsigned int GetItemsCount() const;

uint GetItemsCount();

int GetItemsCount()

# GetSelectionSet

Returns the i:th selection set, using the id of the selection set.

spSelectionSet GetSelectionSet( rid id ) const;

spSelectionSet GetSelectionSet(int id);

spSelectionSet GetSelectionSet(id: int)

# GetSelectionSetCount

Returns the number of selection sets in the table.

unsigned int GetSelectionSetCount() const;

uint GetSelectionSetCount();

int GetSelectionSetCount()

# IsA

Returns true if SelectionSetTable is a or is a descendant of the class named as the type parameter. (Inherited from Object)

bool IsA( const char * type ) const;

bool IsA(string type);

bool IsA(type: str)

# IsNull

Returns true if the SelectionSetTable object is invalid. (Inherited from Object)

bool IsNull() const;

bool IsNull();

bool IsNull()

# IsSameObjectAs

Returns true if the SelectionSetTable object is valid. (Inherited from Object)

bool IsSameObjectAs( const spObject & object ) const;

bool IsSameObjectAs(spObject object);

bool IsSameObjectAs(object: spObject)

# NonNull

Returns true if the SelectionSetTable object is valid. (Inherited from Object)

bool NonNull() const;

bool NonNull();

bool NonNull()

# PrintInfo

Prints the content/info of the SelectionSetTable object to the log. (Inherited from Object)

void PrintInfo() const;

void PrintInfo();

None PrintInfo()

# 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.

void RemoveItem( rid id ) const;

void RemoveItem(int id);

None RemoveItem(id: int)

# RemoveNamedSelectionSet

Removes a selection set from the table by name.

void RemoveNamedSelectionSet( const char * name ) const;

void RemoveNamedSelectionSet(string name);

None RemoveNamedSelectionSet(name: str)

# RemoveObserver

Removes a previously added observer object. (Inherited from Object)

void RemoveObserver( rid observerId ) const;

void RemoveObserver(int observerId);

None RemoveObserver(observerId: int)

# RemoveSelectionSet

Removes a selection set from the table by set ID.

void RemoveSelectionSet( rid id ) const;

void RemoveSelectionSet(int id);

None RemoveSelectionSet(id: int)

# SetItem

Sets an item in the table. The id must exist in the table.

void SetItem( rid id , const spObject & item ) const;

void SetItem(int id, spObject item);

None SetItem(id: int, item: spObject)

# 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)

static bool IsClassA( const char * type ) const;

static bool IsClassA(string type);

@staticmethod
bool IsClassA(type: str)

# 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)

static spSelectionSetTable SafeCast( const spObject & object ) const;

static spSelectionSetTable SafeCast(spObject object);

@staticmethod
spSelectionSetTable SafeCast(object: spObject)