oaFrame Class Reference

Inheritance diagram for oaFrame:

oaWaferObject oaObject


Public Methods

void destroy ()
void getName (oaString &name) const
void getBoundaryBox (oaBox &boundaryBox) const
void setName (const oaString &name)
void setBoundaryBox (const oaBox &boundaryBox)
oaCollection< oaFrameInst, oaFrame > getFrameInsts () const
oaCollection< oaDesignInst, oaFrame > getDesignInsts () const

Static Public Methods

oaFrame * create (oaWafer *wafer, const oaString &name, const oaBox &boundaryBox)
oaFrame * find (const oaWafer *wafer, const oaString &name)

Public Types

enum  { dtIndex = oacFrameWaferDataType }

Detailed Description

The oaFrame class defines a non-printing area into which a series of frame or design instances are placed. Frames are hierarchical so that in a shuttle-style (multi-project chip) reticle, a lower-level frame can be used to organize the number of different die instances into a larger component, and then a top-level frame can be used to organize the shuttle die into the NxN locations on the reticle.

An oaFrame defines a polygonal boundary. Two coincident and three collinear points are illegal, and if detected, cause an exception to be thrown. You can use oaPointArray::compress() to remove these combinations.

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

Member Function Documentation

oaFrame * oaFrame::create (  oaWafer *    wafer,
const oaString &    name,
const oaBox &    boundaryBox
)  [static]
 

This function creates a frame in the specified wafer with the given name and boundary. The specified boundary is checked to verify that there are at least three points and no collinear or coincident points. This function throws an exception if a frame with the specified name already exists in the specified wafer.

Parameters:
wafer The wafer in which to create the frame
name The name of the frame to create
boundaryBox The frame boundary box
Exceptions:
oacFrameAlreadyExists 

void oaFrame::destroy (    ) 
 

This function destroys this frame, removing it from the database.

oaFrame * oaFrame::find (  const oaWafer *    wafer,
const oaString &    name
)  [static]
 

This function searches the specified wafer for a frame with the specified name. A pointer to the frame is returned if found, otherwise, NULL is returned.

Parameters:
wafer The wafer to search
name The name of the frame to find

void oaFrame::getBoundaryBox (  oaBox &    boundaryBox )  const
 

This function returns the boundary box of this frame in the given boundaryBox argument.

Parameters:
boundaryBox The boundary box of the oaFrame to return

oaCollection< oaDesignInst, oaFrame > oaFrame::getDesignInsts (    )  const
 

This function returns the collection of designInsts associated with this frame.

oaCollection< oaFrameInst, oaFrame > oaFrame::getFrameInsts (    )  const
 

This function returns the collection of frameInsts associated with this frame.

void oaFrame::getName (  oaString &    name )  const
 

This function returns the name of this frame.

Parameters:
name The oaString to return the name in

void oaFrame::setBoundaryBox (  const oaBox &    boundaryBox ) 
 

This function changes the boundary box of this frame to the specified boundaryBox.

Parameters:
boundaryBox The boundary box to set

void oaFrame::setName (  const oaString &    name ) 
 

This function sets the name of this frame to the specified name. An exception is thrown if another frame has the specified name.

Parameters:
name The name to give to this frame
Exceptions:
oacFrameAlreadyExists 

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.