oaInstAttrDisplay Class Reference

Inheritance diagram for oaInstAttrDisplay:

oaTextDisplay oaShape oaPinFig oaConnFig oaFig oaBlockObject oaDesignObject oaObject


Public Methods

void getText (const oaNameSpace &ns, oaString &text) const
oaInst * getInst () const
oaDesignAttrType getMasterAttribute () const
oaBoolean isBound () const

Static Public Methods

oaInstAttrDisplay * create (oaInst *inst, oaDesignAttrType masterAttribute, 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 oaInstAttrDisplay is a shape similar to an oaText object, except that it presents a string that is the value of the specified attribute of the master of the oaInst to which it is attached. Whenever the value of the master's attribute changes, calling the getText function on this oaInstAttrDisplay object returns the updated text string that represents the new value of the master's attribute.

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

Member Function Documentation

oaInstAttrDisplay * oaInstAttrDisplay::create (  oaInst *    inst,
oaDesignAttrType    masterAttribute,
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 instAttrDisplay object for the specified attribute that is on the specified instance's master.

Parameters:
inst The oaInst object with which this textDisplay is associated
masterAttribute The attribute associated with this attrDisplay 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 textDisplay
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: You must be able to open the instance's master for this function to succeed.

Exceptions:
oacInvalidTextDisplayCopy 
oacPropNotOnInstanceMaster 

oaInst * oaInstAttrDisplay::getInst (    )  const
 

This function returns the instance associated with this instAttrDisplay object.

oaUInt4 oaInstAttrDisplay::getMasterAttribute (    )  const
 

This function returns the attribute referenced by this attrDisplay object.

void oaInstAttrDisplay::getText (  const oaNameSpace &    ns,
oaString &    text
)  const
 

This function returns the value of this attribute display according to the specified nameSpace. The nameSpace is valid only for name type attributes.

oaBoolean oaInstAttrDisplay::isBound (    )  const
 

This function returns a boolean that indicates if this attribute 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.