oaInstPropDisplay Class Reference

Inheritance diagram for oaInstPropDisplay:

oaTextDisplay oaShape oaPinFig oaConnFig oaFig oaBlockObject oaDesignObject oaObject


Public Methods

oaProp * getMasterProp () const
oaInst * getInst () const
oaBoolean isBound () const

Static Public Methods

oaInstPropDisplay * create (oaInst *inst, oaProp *masterProp, oaLayerNum layerNum, oaPurposeNum purposeNum, const oaPoint &origin, oaTextAlign alignment, oaOrient orient, oaFont font, oaDist height, oaTextDisplayFormat format=oacNameTextDisplayFormat, oaBoolean overbar=false, oaBoolean visible=true, oaBoolean drafting=true)

Detailed Description

The oaInstPropDisplay is a shape similar to an oaText object, except that it presents a string that is the value of the specified oaProp on the master of the oaInst to which it is attached. Whenever the value of the oaProp changes, calling the getText function on this oaInstPropDisplay object returns the updated text string that represents the master's oaProp value.

The oaInstPropDisplay is contained in the design that contains the attached oaInst object.

Member Function Documentation

oaInstPropDisplay * oaInstPropDisplay::create (  oaInst *    inst,
oaProp *    masterProp,
oaLayerNum    layerNum,
oaPurposeNum    purposeNum,
const oaPoint &    origin,
oaTextAlign    alignment,
oaOrient    orient,
oaFont    font,
oaDist    height,
oaTextDisplayFormat    format = oacNameTextDisplayFormat,
oaBoolean    overbar = false,
oaBoolean    visible = true,
oaBoolean    drafting = true
)  [static]
 

This function creates an instPropDisplay object for the specified prop object in the specified instance's master.

Parameters:
inst The oaInst object with which this textDisplay is associated
masterProp The property associated with this instPropDisplay object
layerNum The layer number for this textDisplay
purposeNum The purpose number for this textDisplay
origin The origin point of this textDisplay shape
alignment The alignment related to the origin
orient The orientation of this textDisplay shape
font The font used to display textDisplay shape
height The height of this display
format The format used to create the textDisplay
overbar Specifies if this textDisplay has an overbar; the default is false
visible Specifies if this textDisplay is actually displayed; the default is true
drafting Specifies the drafting of this textDisplay shape; the default is true
Note: The instance's master must be able to open for this function to succeed.

Exceptions:
oacNoMasterForTextDisplay 
oacPropNotOnInstanceMaster 

oaInst * oaInstPropDisplay::getInst (    )  const
 

This function returns the instance associated with this instPropDisplay object.

oaProp * oaInstPropDisplay::getMasterProp (    )  const
 

This function returns the property associated with this instPropDisplay object.

oaBoolean oaInstPropDisplay::isBound (    )  const
 

This function returns a boolean value that indicates if instance property display is currently bound.

The documentation for this class was generated from the following files:

Return to top of page




Copyright © 2002 - 2010 Cadence Design Systems, Inc.
All Rights Reserved.