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

vfoCreateObstruction

vfoCreateObstructions(
g_obj
d_instId
layerPurposePair
obstructionShapeData
[ @rest l_args ]
) 
=> t / nil

Description

Creates obstruction or tunnel on a given instance that has an associated fluid shape. A tunnel helps you to cut a specific layer-purpose of a guard ring device for connectivity purpose. There are four types of tunneling mechanisms—Path, Rectangle, Polygon, and Overlapping Shape. For procedural details about creating tunnels using GUI, refer to the Creating a Tunnel Through a Fluid Guard Ring section in the Editing Fluid Guard Rings chapter of the Virtuoso Fluid Guard Ring User Guide. Note: To remove any existing obstructions, use the vfoDeleteObstruction SKILL function.

Arguments

g_obj

An instance of the vfoAbstractClass SKILL++ class or any of its subclasses.

d_instId

The instance ID on which the operation is invoked.

layerPurposePair

The layer-purpose pair on which the obstruction needs to be created.

obstructionShapeData

The information of the fluid shape associated to the instance on which the obstruction needs to be created. It can be specified either as a SKILL++ object of the vfoShapeData class or a simple point list in case of FGRs. The shape data points are in the design coordinates. The specified obstructionShapeData argument is transformed before creating the obstruction.

l_args

List of optional arguments that can be passed to the function.

While creating an obstruction on an FGR instance that has overlapping fluid shapes, use the l_args argument to define the spacing parameters to increase the size of the shape data points specified with the obstructionShapeData argument. In this case, the SKILL function definition is equivalent to selecting the Overlapping Shape radio button on the Create Tunnel in Fluid Object form.

Value Returned

t

The obstruction was created successfully.

nil

The obstruction could not be created.

Example


Return to top
 ⠀
X