oaFrameInst Class Reference

Inheritance diagram for oaFrameInst:

oaWaferObject oaObject


Public Methods

void destroy ()
void getName (oaString &name) const
oaFrame * getMaster () const
oaFloat getMag () const
void getOrigin (oaPoint &origin) const
oaOrient getOrient () const
void getTransform (oaTransform &xform) const
oaWaferObject * getOwner () const
void setName (const oaString &name)
void setOrigin (const oaPoint &origin)
void setOrient (oaOrient orient)
void setTransform (const oaTransform &xform)
void setMag (oaFloat mag)

Static Public Methods

oaFrameInst * create (oaReticle *reticle, oaFrame *master, const oaString &name, oaFloat mag, const oaTransform &xform)
oaFrameInst * create (oaFrame *frame, oaFrame *master, const oaString &name, oaFloat mag, const oaTransform &xform)
oaFrameInst * find (const oaWafer *wafer, const oaString &name)

Public Types

enum  { dtIndex = oacFrameInstWaferDataType }

Detailed Description

An oaFrameInst is an instance of an oaFrame in its parent which is either another oaFrame, or an oaReticle. They provide a means where a hierarchy of oaFrames can be used to layout the contents of an oaReticle. At the bottom of this hierarchy will be oaDesignInst objects that refer to oaDesign databases that contain the actual geometry that will be printed on the oaReticle.

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

Member Function Documentation

oaFrameInst * oaFrameInst::create (  oaFrame *    frame,
oaFrame *    master,
const oaString &    name,
oaFloat    mag,
const oaTransform &    xform
)  [static]
 

This function creates an oaDesignInst object in the specified frame with the specified attributes.

Parameters:
frame The frame object from which this frame instance is instantiated
master The master frame
name The name of the frame instance
mag The magnification
xform The transformation
Exceptions:
oacFrameInstAlreadyExists 
oacFrameInstOwnerAndMasterDiffWafer 
oacFrameInstOwnerAndMasterAreSame 

oaFrameInst * oaFrameInst::create (  oaReticle *    reticle,
oaFrame *    master,
const oaString &    name,
oaFloat    mag,
const oaTransform &    xform
)  [static]
 

This function creates an oaFrameInst object in the specified reticle with the specified attributes.

Parameters:
reticle The reticle object from which this frame instance is instantiated
master The master frame
name The name of the frame instance
mag The magnification
xform The transformation
Exceptions:
oacFrameInstAlreadyExists 
oacFrameInstOwnerAndMasterDiffWafer 

void oaFrameInst::destroy (    ) 
 

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

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

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

Parameters:
wafer The wafer to search
name The frame instance name to find

oaFloat oaFrameInst::getMag (    )  const
 

This function returns the magnification of this frame instance

oaFrame * oaFrameInst::getMaster (    )  const
 

This function returns the master frame of this frame instance.

void oaFrameInst::getName (  oaString &    name )  const
 

This function returns the name of this frame instance in the given name argument.

Parameters:
name The name to be filled out with the name of this frame instance

oaOrient oaFrameInst::getOrient (    )  const
 

This function returns the orientation of this frame instance.

void oaFrameInst::getOrigin (  oaPoint &    origin )  const
 

This function fills out 'origin' with the origin of this frame instance.

Parameters:
origin The origin to be filled out

oaWaferObject * oaFrameInst::getOwner (    )  const
 

This function returns a pointer to object that owns this frame instance. The owning object can be either an oaReticle or an oaFrame

void oaFrameInst::getTransform (  oaTransform &    xform )  const
 

This function fills out 'xform' with the transform of this frame instance.

Parameters:
xform The transform to be filled out

void oaFrameInst::setMag (  oaFloat    mag ) 
 

This function sets the magnification of this frame instance to the specified value.

Parameters:
mag The new magnification

void oaFrameInst::setName (  const oaString &    name ) 
 

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

Parameters:
name The new name of the frame instance
Exceptions:
oacFrameInstAlreadyExists 

void oaFrameInst::setOrient (  oaOrient    orient ) 
 

This function sets the orientation for this frame instance.

Parameters:
orient The new orientation

void oaFrameInst::setOrigin (  const oaPoint &    origin ) 
 

This function sets the origin value for this frame instance.

Parameters:
origin The new origin

void oaFrameInst::setTransform (  const oaTransform &    xform ) 
 

This function sets the transform for this frame instance.

Parameters:
xform The new transform

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.