Product Documentation
Virtuoso Studio Design Environment SKILL Reference
Product Version IC23.1, November 2023

dbCreateTextDisplay 

dbCreateTextDisplay( 
d_associateId 
d_ownerId 
txl_layerPurpose
l_displayFlags 
l_point 
t_just 
t_orient 
t_font 
x_height 
[ g_isDrafted [ g_isOverbar [ g_isVisible [ g_isNameVisible [ g_isValueVisible [ t_attrOrParamName [ g_isParamAssoc ] ] ] ] ] ] ] 
) 
=> d_textDisplay / nil

Description

Creates a text display object.

TextDisplays are associated with design objects so that graphical applications can display text strings representing attributes and properties of the associated object. The owner and associate of a text display are usually the same but they can be different.  For example, a text display may be “owned” by an instance, but may be “associated” with a label in the master of that instance.

TextDisplays cannot be “associated” with objects in other cellviews unless the TextDisplay is “owned” by an instance or Mosaic of that cellview.

Arguments

d_associateId

Associate of the text display. This can be a label in a master cellview, a property, or a dbObject whose attribute t_attrName is to be displayed. However, not all attributes of objects can be displayed with a textDisplay. Like labels, properties and attributes of master cellviews and terminals can be the associates of text displays that you create in the cellview where that master is instantiated. Such text display objects are called cross-cellview text displays.

Some of the attributes that can be displayed using text display include:

  • Terminals: "name", "hasPins", "numBits"
  • Nets: "name", "sigType","isGlobal", "isEmpty", "numBits"
  • InstTerm: "name"
  • Inst/Mosaic: "name","libName", "cellName", "viewName", "numBits", "width", "isBound"
  • Cellview: "libName", "cellName", "viewName", "cellType", "lastSavedTime"
  • Labels: The values of labels can be displayed with a text display.

d_ownerId

Owner of the text display. This can be any database object except properties or groups.

txl_layerPurpose

Name, number, or a list of layer or layer-purpose pair.

For more information, see Database Access Function Argument Types.

l_displayFlags

Display characteristics of the label associate that are to be overridden by the text display. For properties and for attribute associates, every display characteristic must be specified; therefore, t must be specified here, followed by a specification for each of the display characteristics listed below.

l_point

Origin of the text display. This must be specified for properties and for object attribute associates.

For more information, see Database Access Function Argument Types.

t_just

Justification string for the text display. This must be specified for properties and for object attribute associates.

For more information, see Database Access Function Argument Types.

t_orient

Orientation string for the text display. This must be specified for properties and for object attribute associates.

For more information, see dbIsId.

t_font

Font style string for the text display. This must be specified for properties and for object attribute associates.

For more information, see Database Access Function Argument Types.

x_height

Height of the text display that must be given as a positive number. This must be specified for properties and for object attribute associates.

g_isDrafted

Specifies whether or not drafting is set for the text display. The default is nil.

g_isOverbar

Specifies whether or not over-bar is set for the text display. The default is nil.

g_isVisible

Specifies whether or not the text display is visible. The default is t.
When g_isVisible is set to t, g_isNameVisible and g_isValueVisible cannot be set to nil. For example, if a user tries to set (g_isVisible g_isNameVisible g_isValueVisible) to (t nil nil), a warning is issued, and g_isValueVisible is set to t.

g_isNameVisible

Specifies whether or not the property or attribute name is visible. The default is t. This argument applies only to a text display with a property or attribute as its associate.

g_isValueVisible

Specifies whether or not the property or attribute value is visible. The default is t. This argument applies only to a text display with a property or attribute as its associate.

t_attrOrParamName

Name of the attribute or the CDF parameter of the associate object specified in d_associateId.

g_isParamAssoc

Specifies whether or not t_attrOrParamName is a CDF parameter name. The default is nil.

Value Returned

d_textDisplay

The dbObject of the text display.

nil

The text display is not created.

Examples

In this example, the owner is an instance and the associate is a label:

inst = dbFindAnyInstByName(cv "I0")
tdMaster = dbOpenCellViewByType("tranTst" "iopin" "symbolr")
assoc = car(setof(i tdMaster~>shapes i~>objType == "label" && i~>theLabel =="[@terminalName]"))
obj = dbCreateTextDisplay(assoc inst 229:237 t -10:0 "lowerLeft" "R0" "stick" 1 t nil t t t "mylabel" nil)
obj~>assocType
"labelAssocType"
obj~>text
"[@terminalName]"
obj~>xy
(-11.4375 0.375)

Related Topics

Database Access Function Argument Types

Object Creation and Retrieval Functions


Return to top
 ⠀
X