Product Documentation
Virtuoso Layout Suite SKILL Reference
Product Version IC23.1, November 2023

cphVisitStart

cphVisitStart(
g_physConfigID
t_startMode { PHYSICAL_LEAF | LOGICAL_LEAF | HIERARCHY_PHYSICAL_LEAF
 | HIERARCHY_LOGICAL_LEAF }
[ t_path ]
)
=> t / nil

Description

Starts a visit at the specified occurrence in the specified mode. The start mode defines which nodes are visited, but does not specify the order in which they are visited.

Arguments

g_physConfigID

ID of the physical configuration cellview.

t_startMode

Specifies which types of nodes are to be visited.

  • PHYSICAL_LEAF: Visits only leaf nodes with physical decoration
  • LOGICAL_LEAF: Visits only leaf nodes
  • HIERARCHY_PHYSICAL_LEAF: Visits all nodes except leaf nodes with no physical decoration
  • HIERARCHY_LOGICAL_LEAF: Visits all nodes
The start mode does not specify the order in which nodes are visited.

t_path

Path to a specific occurrence of an instance.

If you do not specify the path, the visit starts at the root node in the hierarchy.

Value Returned

t

The visitor started.

nil

The visitor did not start.

Example

cphVisitStart(physConfigID "PHYSICAL_LEAF")
cphVisitStart(physConfigID "PHYSICAL_LEAF" "I1/I2")

Return to top
 ⠀
X