cphSetStopList

cphSetStopList(
g_physConfigID
t_stopList
)
=> t / nil

Description

Sets the physical stop view list for the physical configuration view associated with the specified ID. The list specifies the view names that are used to determine the corresponding physical view for a given logical view. When traversing a hierarchy, Configure Physical Hierarchy uses the first view it encounters with one of the specified names.

Arguments

g_physConfigID	ID of the physical configuration cellview.
t_stopList	List of physical view names used to determine the corresponding physical view for a given logical view. When traversing a hierarchy, Configure Physical Hierarchy stops when it encounters a view with one of the specified names. Separate each name with a space and enclose the list in quotation marks.

Value Returned

t	The physical stop view list was set.
nil	The physical stop view list was not set.

Example

This example retrieves the physical configuration ID for the current Configure Physical Hierarchy window and sets the physical stop view list for the physical configuration view associated with that ID.

let( (win cph)
          win = hiGetCurrentWindow();  assuming CPH is the current window
          if(win then
             cph = cphGetWinConfig(win)
             if(cph then
                  cphSetStopList(cph "abstract layout")
             )
          )
     )
 

Return to top