geCreateMarker

geCreateMarker( 
d_dbobjectId 
t_severity 
t_owner 
t_reason 
t_displayText 
)
=> d_shapeId / nil 

Description

Creates a box-shaped marker whose size and position are determined by the software.

The marker shape is placed on the marker layer with error purpose if t_severity is error. Otherwise, the marker shape is placed on the marker layer with warning purpose. If d_dbobjectId is a cellview, the marker shape is a box at the lower-left corner of the cellview. Otherwise, the marker shape is a box that surrounds the object d_dbobjectId as described below and glues the marker to the object.

figId	The bounding box of the shape is used for the marker.
instId	The bounding box of the instance is used for the marker.
instHeaderId	The bounding box of the first instance for the instance header is used for the marker.
instTermId	The bounding box of the figure representing the first pin found on the instance terminal is used. If no pin exists on the instance terminal, a generic box at the origin of the instance is used.
netId	The bounding box of the figures attached to the net is used for the marker. If no figures exist on the net, a generic box in the lower left corner of the design is used.
pinId	The bounding box of the figure representing the pin is used for the marker.
termId	The bounding box of the figure representing the first pin found on the terminal is used. If no pin exists on the terminal, a generic box in the lower left corner of the design is used.

After the marker is created, the t_owner, t_reason, and t_displayText values are stored as properties on the marker. The t_owner value identifies the tool that identified the problem and is creating the marker. The t_reason value is the warning/error message that describes the problem causing the marker. The t_displayText value is a brief warning/error message that is displayed with the marker shape.

Arguments

d_dbobjectId	Database ID of the cellview to contain the marker.
t_severity	Severity of the marker. Valid Values: warning, error
t_owner	Owner of the marker. Valid values include any valid owner name.
t_reason	Reason for the violation.
t_displayText	Text associated with the marker.

Value Returned

d_shapeId	The shape representing the marker, if the marker is created.
nil	The marker is not created.

Examples

Creates a marker in the cellview cell2. The marker severity is warning and the marker owner is PDV. physical rule violation is the reason for the marker. Mytext is displayed with the marker. Returns the database ID of the marker shape.

geCreateMarker( cell2 "warning" "PDV" "physical rule violation" "mytext" )

Related Topics

Marker Functions

Return to top