oaSiteDef Class Reference

Inheritance diagram for oaSiteDef:

oaTechObject oaObject oaArraySiteDef oaScalarSiteDef


Public Methods

void destroy ()
void getName (oaString &name) const
oaSiteDefType getSiteDefType () const
oaUInt4 getWidth () const
oaUInt4 getHeight () const
oaBoolean isSymmetricInX () const
oaBoolean isSymmetricInY () const
oaBoolean isSymmetricInRot () const
void setType (oaSiteDefType type)
void setSymmetricInX (oaBoolean val)
void setSymmetricInY (oaBoolean val)
void setSymmetricInRot (oaBoolean val)
oaCollection< oaRowHeader, oaSiteDef > getUsedIn () const

Static Public Methods

oaSiteDef * find (const oaTech *tech, const oaString &name)
oaSiteDef * find (const oaTech *tech, const oaString &name, oaBoolean local)

Public Types

enum  { dtIndex = oacSiteDefDataType }

Detailed Description

The oaSiteDef class defines a site where you can place cells in a row. A site has a type, symmetry and other information allowing for the specification of placeable objects within a row.

The site can be either a simple oaScalarSiteDef, which has width and height information, or an oaArraySiteDef, which has a pattern of scalar siteDefs.

The oaSiteDef class can be observed by deriving from oaObserver<oaSiteDef>.

Member Function Documentation

void oaSiteDef::destroy (    ) 
 

This function destroys this siteDef, removing it from the technology database.

oaSiteDef * oaSiteDef::find (  const oaTech *    tech,
const oaString &    name,
oaBoolean    local
)  [static]
 

This function searches for a siteDef with the specified name. The local argument specifies whether (if true) to look only in the specified technology database or (if false) to look in the specified technology database and all of its referenced databases. If found, the siteDef is returned, otherwise NULL is returned.

Refer to Incremental Technology Databases in the Using Technology Databases section of the Programmers Guide for more information about referenced tech databases.

Parameters:
tech The technology database to search
name The siteDef name to find
local Specifies whether (if true) to look only in the specified technology database or (if false) to look in the specified technology database and all of its referenced databases.

oaSiteDef * oaSiteDef::find (  const oaTech *    tech,
const oaString &    name
)  [static]
 

This function searches the specified technology database for a siteDef with the specified name. If the specified technology database references other technology databases, those are searched as well and the first matching siteDef is returned. To find a siteDef in the current technology database only, refer to the find function that accepts the local argument.

If found, the function returns the siteDef value. Otherwise, NULL is returned.

Parameters:
tech The technology database to search
name The siteDef to find

oaUInt4 oaSiteDef::getHeight (    )  const
 

This function returns the height of the siteDef. For array siteDefs, the height is calculated from its list of scalar siteDefs and their transformations. If any of the scalar siteDefs cannot be found by name an exception is thrown.

Exceptions:
oacSiteDefNotFound 

void oaSiteDef::getName (  oaString &    name )  const
 

This function returns the name of the siteDef.

oaSiteDefType oaSiteDef::getSiteDefType (    )  const
 

This function returns the type of the siteDef.

oaCollection oaSiteDef::getUsedIn (    )  const
 

This function returns a collection of rowHeaders in all designs that refer to this siteDef object.

oaUInt4 oaSiteDef::getWidth (    )  const
 

This function returns the width of the siteDef. For array siteDefs, the width is calculated from its list of scalar siteDefs and their transformations. If any of the scalar siteDefs cannot be found by name an exception is thrown.

Exceptions:
oacSiteDefNotFound 

oaBoolean oaSiteDef::isSymmetricInRot (    )  const
 

This function returns true if the siteDef is symmetrical in rotation.

oaBoolean oaSiteDef::isSymmetricInX (    )  const
 

This function returns true if the siteDef is symmetrical in the X direction.

oaBoolean oaSiteDef::isSymmetricInY (    )  const
 

This function returns true if the siteDef is symmetrical in the Y direction.

void oaSiteDef::setSymmetricInRot (  oaBoolean    val ) 
 

This function returns sets the siteDef symmetrical in rotation.

void oaSiteDef::setSymmetricInX (  oaBoolean    val ) 
 

This function sets the siteDef symmetrical in the X direction.

void oaSiteDef::setSymmetricInY (  oaBoolean    val ) 
 

This function sets the siteDef symmetrical in the Y direction.

void oaSiteDef::setType (  oaSiteDefType    type ) 
 

This function sets the type of the siteDef.

Member Enumeration Documentation

anonymous enum
 

Enumeration values:
dtIndex 

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.