oaStepperMap Class Reference

Inheritance diagram for oaStepperMap:

oaWaferObject oaObject


Public Methods

void destroy ()
void getStepperName (oaString &stepperName) const
oaImage * getImage () const
oaBoolean hasImage () const
oaBoolean hasPoints () const
void setStepperName (const oaString &value)
void setImage (oaImage *image)
void addPoint (const oaPoint &point)
void removePoint (const oaPoint &point)
oaBoolean hasPoint (const oaPoint &point) const
void getPoints (oaPointArray &stepPoints) const

Static Public Methods

oaStepperMap * create (oaWaferDesc *waferDesc, const oaString &stepperName)
oaStepperMap * find (const oaWaferDesc *waferDesc, const oaString &name)

Public Types

enum  { dtIndex = oacStepperMapWaferDataType }

Detailed Description

The oaStepperMap class implements an object that specifies where to step reticle images across a silicon wafer.

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

Member Function Documentation

void oaStepperMap::addPoint (  const oaPoint &    point ) 
 

This function adds a step point to this stepperMap. A step point specifies where the associate image should be applied.

Parameters:
point Specifies a step point to associate with this stepperMap.

oaStepperMap * oaStepperMap::create (  oaWaferDesc *    waferDesc,
const oaString &    stepperName
)  [static]
 

This function creates a stepper map with the specified name.

Parameters:
waferDesc The wafer description to associate the stepperMap with
stepperName The name of the wafer stepping machine

void oaStepperMap::destroy (    ) 
 

This function destroys this stepper map, removing it from the database.

oaStepperMap * oaStepperMap::find (  const oaWaferDesc *    waferDesc,
const oaString &    name
)  [static]
 

This function searches the wafer description for a stepper map with the given name. A pointer to the stepper map is returned if found. Otherwise, NULL is returned.

Parameters:
waferDesc The wafer description to search
name The stepper name to locate

oaImage * oaStepperMap::getImage (    )  const
 

This function returns the image associated with this stepperMap. NULL is returned if no image is associated with the stepperMap yet.

void oaStepperMap::getPoints (  oaPointArray &    stepPoints )  const
 

This returns the collection of step points associated with this stepperMap. The points are placed in the given point array stepPoints.

Parameters:
stepPoints The array of step points returned by this function

void oaStepperMap::getStepperName (  oaString &    stepperName )  const
 

This function returns the stepper name associated with this stepper map in the provided string.

Parameters:
stepperName The string the stepperMap name is returned in

oaBoolean oaStepperMap::hasImage (    )  const
 

This function returns a boolean indicating whether an image has been associated with this stepperMap.

oaBoolean oaStepperMap::hasPoint (  const oaPoint &    point )  const
 

This function returns a boolean indicating whether the specified point is a step point associated with this stepperMap.

Parameters:
point The step point to search for

oaBoolean oaStepperMap::hasPoints (    )  const
 

This function returns a boolean indicating whether step points have been assigned to this stepperMap.

void oaStepperMap::removePoint (  const oaPoint &    point ) 
 

This function removes the specified step point from this stepperMap.

Parameters:
point The step point to remove from this stepperMap.

void oaStepperMap::setImage (  oaImage *    image ) 
 

This function sets the image to use with this stepperMap.

Parameters:
image A pointer to an oaImage to use with this stepperMap

void oaStepperMap::setStepperName (  const oaString &    stepperName ) 
 

This function changes the stepper name of this stepper map. The new name is in the provided string.

Parameters:
stepperName The new stepper name

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.