mdlIObject IsHalfOfPair

Determines if an object is a half of a pair.

Syntax

mdlIObject_handle IsHalfOfPair

Application

MotionView Tcl Query

Description

This command determines if an object is a half of a pair (or not). Any Pair entity has two children data members "l" and "r", which stand for left and right respectively. If an object handle is a handle from a "l" or "r" data member of any Pair, this command returns true.

Example

To check to see if an object is a half of a pair:

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 InterpretEntity pt_handle PointPair pt_1 "\"Point Pair 1\""
myModelName Evaluate
pt_handle IsHalfOfPair
pt_handle ReleaseHandle;
myModelName GetChildHandle pt_handle pt_1.l
pt_handle IsHalfOfPair
pt_handle ReleaseHandle;
myModelName ReleaseHandle
myClientName ReleaseHandle
myWindowName ReleaseHandle
myPageName ReleaseHandle
myProjectName ReleaseHandle
mySessionName ReleaseHandle

Errors

Returns true if the object is one half of a pair, or false if it is not. If there is an error, an error code will be returned.