poISelectionSet GetSize

Retrieves the number of entities of the current selection set.

Syntax

selectionSet_handle GetSize

Application

HyperView Tcl Query

Description

This command returns the number of entities of the selection set. The return value can be any number. GetError on Session should be used to check for any errors as shown in the following example.

Example

To create a selection set containing all nodes, make it visible in the graphic area, and use GetSize to retrieve the number of entities in the current selection set:

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 node
puts "Current selection sets: [model_handle GetSelectionSetList]\n"

model_handle GetSelectionSetHandle selection_set_handle 1
selection_set_handle SetLabel "OurNodeSelectionSet"
selection_set_handle Add all
set number_of_entities [selection_set_handle GetSize]
if { [session_handle GetError] != "" } {
    puts "Error occurred!"
} {

    puts "Current selection set ID: [selection_set_handle GetID]"
    puts "   Label: [selection_set_handle GetLabel]"
    puts "   Size:  [selection_set_handle GetSize] [selection_set_handle GetType]s"
    puts "   Default color:      [selection_set_handle GetColor]"
    puts "   Default visibility: [selection_set_handle GetVisibility]"
    puts "----------------------"

    selection_set_handle SetVisibility true
    puts "   Current visibility: [selection_set_handle GetVisibility]"
}
hwi CloseStack

Errors

If the selection set handle is not retrievable, this command returns an HW_Error. Use GetError on Session as shown in the example above.