oaAnalysisPoint Class Reference

Inheritance diagram for oaAnalysisPoint:

oaDesignObject oaObject


Public Methods

void destroy ()
void setName (const oaString &name)
void getName (oaString &name) const
oaCollection< oaAnalysisOpPoint, oaAnalysisPoint > getAnalysisOpPoints () const

Static Public Methods

oaAnalysisPoint * create (oaDesign *design, const oaString &name)
oaAnalysisPoint * find (const oaDesign *design, const oaString &name)

Public Types

enum  { dtIndex = oacAnalysisPointDataType }
enum  { domain = oacNoDomain }

Detailed Description

The oaAnalysisPoint class represents a set of oaAnalysisOpPoints. Each oaAnalysisOpPoint corresponds to a oaOpPoint used for analysis of some of the instances in the design. Collectively, these oaOpPoints allow a consistent analysis (such as best-case or worst-case) across the whole design.

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

Member Function Documentation

oaAnalysisPoint * oaAnalysisPoint::create (  oaDesign *    design,
const oaString &    name
)  [static]
 

This function creates a new analysisPoint in the specified design with the specified name. The name can be the name of the tool that owns this analysis point.

Parameters:
design pointer to design in which to create this oaAnalysisPoint object
name name of the analysis point
Exceptions:
oacAnalysisPointNameExists 
oacCannotCreateParasiticsOnPcell 

void oaAnalysisPoint::destroy (    ) 
 

This function deletes this analysis point.

oaAnalysisPoint * oaAnalysisPoint::find (  const oaDesign *    design,
const oaString &    name
)  [static]
 

This function searches in the specified design for an analysis point with the specified name. If the analysis point is found, it is returned. NULL is returned if the analysis point cannot be found.

Parameters:
design pointer to design in which to search
name name of analysis point to find

oaCollection< oaAnalysisOpPoint, oaAnalysisPoint > oaAnalysisPoint::getAnalysisOpPoints (    )  const
 

This function returns the collection of oaAnalysisOpPoints associated with this oaAnalysisPoint.

void oaAnalysisPoint::getName (  oaString &    name )  const
 

This function gets the name of this analysis point.

Parameters:
name returned name of this analysis point

void oaAnalysisPoint::setName (  const oaString &    name ) 
 

This function sets the name of this analysis point.

Parameters:
name input name to set on this analysis point
Exceptions:
oacAnalysisPointNameExists 

Member Enumeration Documentation

anonymous enum
 

Enumeration values:
dtIndex 

anonymous enum
 

Enumeration values:
domain 

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.