poISelectionSet GetList

Retrieves the list of all entity IDs on the current selection set.

Syntax

selectionSet_handle GetListpool_name

Application

HyperView Tcl Query

Description

This command returns a list of IDs for all entities in the selection set matching the argument pool_name. If no pool name was specified, all IDs are listed.

Return values can either be a list of IDs of all entities matching the specified pool name or if no pool name was specified, a list of all entity IDs included in the selection set. This list may be very large.

Inputs

pool_name (Optional): If not set, all entity IDs are listed, otherwise only the IDs for the entities matching the specified pool name are listed.

Example

To create a selection set containing all elements, make it visible in the graphic area, and use GetPoolList and GetList to retrieve a list of IDs:

hwi OpenStack
hwi GetSessionHandle session_handle
session_handle GetProjectHandle project_handle
project_handle GetPageHandle page_handle [project_handle GetActivePage]
page_handle GetWindowHandle window_handle [page_handle GetActiveWindow]
window_handle GetClientHandle client_handle
client_handle GetModelHandle model_handle [client_handle GetActiveModel]
model_handle AddSelectionSet element
puts "Current selection sets: [model_handle GetSelectionSetList]\n"

model_handle GetSelectionSetHandle selection_set_handle 1
selection_set_handle SetLabel "OurElementSelectionSet"
selection_set_handle Add all

puts "Pool List: "
selection_set_handle GetPoolList
puts "GetList without argument:"
selection_set_handle GetList

set poolOne [lindex [selection_set_handle GetPoolList] 0]
puts "GetList with first pool name as argument:"
selection_set_handle GetList $poolOne


hwi CloseStack

Errors

This command should not return any errors. If the pool_name does not exist, an empty list is returned.