oaCell Class Reference

Inheritance diagram for oaCell:

oaDMContainer oaDMObject oaObject


Public Methods

void destroy ()
void getName (oaScalarName &name) const
void getName (const oaNameSpace &ns, oaString &out) const
oaCollection< oaCellView, oaCell > getCellViews () const

Static Public Methods

oaCell * find (const oaLib *lib, const oaScalarName &name)
oaCell * get (const oaLib *lib, const oaScalarName &name)

Public Types

enum  { dtIndex = oacCellDataType }

Detailed Description

The oaCell class implements an OpenAccess library cell object.

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

Note: The oaCell function descriptions indicate if library access is required for the called function. If the access type must be write access, this requirement also is noted.

For more information on library access, see Library Access in the detailed description for oaLib and OpenAccess 2.2 Libraries and Design Management in the Programmers Guide.

Member Function Documentation

void oaCell::destroy (    ) 
 

This function destroys this oaCell.

This function requires write access to the library associated with this object (through a call to oaLib::getAccess). An oacLibAccessDenied exception is thrown if write access to the library does not exist.

For more information on library access, see Library Access in the detailed description for oaLib and OpenAccess 2.2 Libraries and Design Management in the Programmers Guide.

Exceptions:
oacLibAccessDenied 

oaCell * oaCell::find (  const oaLib *    lib,
const oaScalarName &    name
)  [static]
 

This function finds and returns the cell with the specified name if it exists. If not found, NULL is returned.

This function requires access to the library associated with this object (through a call to oaLib::getAccess). An oacLibAccessDenied exception is thrown if access to the library does not exist.

For more information on library access, see Library Access in the detailed description for oaLib and OpenAccess 2.2 Libraries and Design Management in the Programmers Guide.

Exceptions:
oacLibAccessDenied 

oaCell * oaCell::get (  const oaLib *    lib,
const oaScalarName &    name
)  [static]
 

This function finds and returns the cell with the specified name if it exists. If not found, it is created, and the new cell is returned.

This function requires write access to the library associated with this object (through a call to oaLib::getAccess). An oacLibAccessDenied exception is thrown if write access to the library does not exist.

For more information on library access, see Library Access in the detailed description for oaLib and OpenAccess 2.2 Libraries and Design Management in the Programmers Guide.

Exceptions:
oacLibAccessDenied 

oaCollection< oaCellView, oaCell > oaCell::getCellViews (    )  const
 

This function returns a collection of the cellViews which are defined using this cell.

This function requires access to the library associated with this object (through a call to oaLib::getAccess). An oacLibAccessDenied exception is thrown if access to the library does not exist.

For more information on library access, see Library Access in the detailed description for oaLib and OpenAccess 2.2 Libraries and Design Management in the Programmers Guide.

Exceptions:
oacLibAccessDenied 

void * oaCell::getName (  const oaNameSpace &    ns,
oaString &    out
)  const
 

This function returns the name of this cell in the specified namespace.

void * oaCell::getName (  oaScalarName &    name )  const
 

This function returns the name of this cell.

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.