mdlIObject BeginChildFastGet

Obtains a list for a particular entity type and then later obtains a handle for one of its child objects.

Syntax

mdlIObject_handle BeginChildFastGet show_folders, show_datamembers, show_references, (filter)

Application

MotionView Tcl Query

Description

This command obtains a list for a particular entity type and then later obtains a handle for one of its child objects.
Note: The GetNumberOfChildren and GetChildHandleByIdx commands can be used in context of BeginChildFastGet/EndChildFastGet to obtain the number of children and their corresponding handles.

Inputs

show_folders
True
If you want to build folders into the list, for example, the Points folder and Bodies folder will appear in the browser.
show_datamembers
True
Enables data members to be shown.
False
Will cause data members to be skipped over.
show_references
True
Enables reference data members to be shown, otherwise they are hidden.
filter
Used for filtering objects into the list. For example, if you type "Points", you will pass "Point" into the list, or if you want just points and bodies, you can type "Point/Body".
Valid filter types are:
"system" "pointpair"
"point" "vectorpair"
"vector" "bodypair"
"body" "markerpair"
"marker" "datasetpair"
"dataset" "optionpair"
"option" "formpair"
"form" "templatepair"
"template" "curvepair"
"curve" "solverarraypair"
"solverarray" "solvervariablepair"
"solvervariable" "solverstringpair"
"solverstring" "jointpair"
"joint" "couplerpair"
"coupler" "bushingpair"
"bushing" "springdamperpair"
"springdamper" "beampair"
"beam" "polybeampair"
"polybeam" "forcepair"
"force" "motionpair"
"motion" "controlsisopair"
"controlsiso" "solverdiffequationpair"
"solverdiffequation" "outputpair"
"output"

Example

To get the list of children on the model:
hwi OpenStack
hwi GetSessionHandle mySessionName 
mySessionName GetProjectHandle myProjectName 
set activePageNum [myProjectName GetActivePage]
myProjectName GetPageHandle myPageName $activePageNum
set activeWinNum [myPageName GetActiveWindow]
myPageName GetWindowHandle myWindowName $activeWinNum
myWindowName GetClientHandle myClientName 
myClientName GetModelHandle myModelName 
myModelName BeginChildFastGet False True True ""
myModelName GetNumberOfChildren
for { set idx 1 } { $idx <= [myModelName GetNumberOfChildren] } {incr idx } {
   myModelName GetChildHandleByIdx child_handle $idx;
   puts "[child_handle GetVarname]";
   child_handle ReleaseHandle;
}
myModelName EndChildFastGet;
myModelName ReleaseHandle
myClientName ReleaseHandle
myWindowName ReleaseHandle
myPageName ReleaseHandle
myProjectName ReleaseHandle
mySessionName ReleaseHandle
hwi CloseStack

Errors

Returns 0 if successful, otherwise an error code.