vfoDeleteObstruction

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

Description

Deletes the obstruction or tunnel on a given instance that has an associated fluid shape. This SKILL function is equivalent to healing. For procedural details about healing an obstruction using GUI, refer to the Healing a Fluid Guard Ring section in the Editing Fluid Guard Rings chapter of the Virtuoso Fluid Guard Ring User Guide. Note: To create an obstruction, use the vfoCreateObstruction 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 list of layer-purpose pairs from which the obstruction needs to be deleted.
obstructionShapeData
	The information of the fluid shape associated to the instance from which the obstruction needs to be deleted. The following possible values can be specified: `nil`: Deletes all the obstructions. This does not consider the specified layer purpose pair and deletes all the obstructions. `point`: Deletes the obstructions at that specific point. With this value, you need to specify the list of layer purpose pairs from which the obstruction needs to be removed. `bbox`: Deletes the obstruction overlapping the given bbox. With this value, you need to specify the list of layer purpose pairs from which the obstruction needs to be removed. `polygon`: Deletes the obstruction overlapping the given polygon. With this value, you need to specify the list of layer purpose pairs from which the obstruction needs to be removed.
l_args	List of optional arguments that can be passed to the function. Currently, the `@rest` l_args argument cannot be used while deleting an obstruction from an FGR instance. It has been provided for the flexibility of performing any user-defined processing if you had previously used the vfoCreateObstruction SKILL function.

Value Returned

`t`	The obstruction was deleted successfully.
`nil`	The obstruction could not be deleted.

Example

Assume, inst is the fluid Pcell instance that needs to be healed by removing the obstructions:

obj = vfoAllocateProtocolObj(inst)

Then, the following examples show the different ways of using the vfoDeleteObstruction SKILL function:

Removes all the keepouts of the instance:

"vfoDeleteObstruction(obj inst list("Metal1" "drawing") nil)

Removes all the keepouts at point, pt, of the layer purpose pair:

"vfoDeleteObstruction(obj inst list(list("Oxide" "drawing") list("Metal1" "drawing")) list(pt))

Removes all the keepouts at bbox, b, of the layer purpose pair. The bbox should be completely inside the keepout region.
```
"vfoDeleteObstruction(obj inst list(list("Oxide" "drawing") list("Metal1" "drawing")) b)
```
Removes all the keepouts at point list, ptList, of any polygon (more than two points) of the layer purpose pair. The polygon points should be completely inside the keepout region.
```
"vfoDeleteObstruction(obj inst list(list("Oxide" "drawing") list("Metal1" "drawing")) ptList)
```

Return to top

Virtuoso Layout Suite SKILL ReferenceProduct Version IC23.1, November 2023