oaAnalysisLib Class Reference

Inheritance diagram for oaAnalysisLib:

oaTechObject oaObject


Public Methods

void destroy ()
void getName (oaString &name) const
void getFormat (oaString &format) const
void getFileName (oaScalarName &fileName) const
void getCellName (oaScalarName &cellName) const
void getViewName (oaScalarName &viewName) const
void setFormat (const oaString &format)
void setFileName (const oaScalarName &fileName)
void setCellName (const oaScalarName &cellName)
void setViewName (const oaScalarName &viewName)
oaCollection< oaOpPoint, oaAnalysisLib > getOpPoints () const

Static Public Methods

oaAnalysisLib * create (oaTech *tech, const oaString &name, const oaString &format, const oaScalarName *fileName, const oaScalarName *cellName=NULL, const oaScalarName *viewName=NULL)
oaAnalysisLib * find (const oaTech *tech, const oaString &name)
oaAnalysisLib * find (const oaTech *tech, const oaString &name, oaBoolean local)

Detailed Description

The oaAnalysisLib class defines a relationship between an analysis library (which is external to OpenAccess) and a set of oaOpPoint objects corresponding to operating points defined in that analysis library.

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

Member Function Documentation

oaAnalysisLib * oaAnalysisLib::create (  oaTech *    tech,
const oaString &    name,
const oaString &    format,
const oaScalarName *    fileName,
const oaScalarName *    cellName = NULL,
const oaScalarName *    viewName = NULL
)  [static]
 

This function creates an oaAnalysisLib object with the specified name, format, fileName, and optional cellName and viewName.

Exceptions:
oacAnalysisLibNameExists 

void oaAnalysisLib::destroy (    ) 
 

This function destroys this oaAnalysisLib object, removing it from the technology database.

oaAnalysisLib * oaAnalysisLib::find (  const oaTech *    tech,
const oaString &    name,
oaBoolean    local
)  [static]
 

This function searches for an analysisLib with the specified name. The local argument specifies whether (if true) to look only in the specified technology database or (if false) to look in the specified technology database and all of its referenced databases. If found, a pointer to the analysisLib object is returned, otherwise NULL is returned.

Refer to Incremental Technology Databases in the Using Technology Databases section of the Programmers Guide for more information about referenced tech databases.

Parameters:
tech Technology database from which to start the search for the analysis library
name Name of the analysis library to search for
local Specifies whether (if true) to look only in the specified technology database or (if false) to look in the specified technology database and all of its referenced databases.

oaAnalysisLib * oaAnalysisLib::find (  const oaTech *    tech,
const oaString &    name
)  [static]
 

This function searches the specified technology database for an oaAnalysisLib object with the specified name. If the specified technology database references other technology databases, those are searched as well and the first matching analysis library is returned. To find an analysis library in the current technology database only, refer to the find function that accepts the local argument.

If found, a pointer to the oaAnalysisLib object is returned. Otherwise, NULL is returned.

Refer to Incremental Technology Databases in the Using Technology Databases section of the Programmers Guide for more information about referenced tech databases.

Parameters:
tech Technology database from which to start the search for the analysis library
name Name of the analysis library to search for

void oaAnalysisLib::getCellName (  oaScalarName &    cellName )  const
 

This function gets the cellName of this oaAnalysisLib object. An empty name is returned if the cellName of this oaAnalysisLib object is not set.

void oaAnalysisLib::getFileName (  oaScalarName &    fileName )  const
 

This function gets the fileName of this oaAnalysisLib object.

void oaAnalysisLib::getFormat (  oaString &    format )  const
 

This function gets the format of this analysisLib object.

Parameters:
format The format of this analysisLib object.

void oaAnalysisLib::getName (  oaString &    name )  const
 

This function gets the name of this oaAnalysisLib object.

oaCollection oaAnalysisLib::getOpPoints (    )  const
 

This function returns a collection of operating points in this oaAnalysisLib object.

void oaAnalysisLib::getViewName (  oaScalarName &    viewName )  const
 

This function gets the viewName of this oaAnalysisLib object. An empty name is returned if the viewName of this oaAnalysisLib object is not set.

void oaAnalysisLib::setCellName (  const oaScalarName &    cellName ) 
 

This function sets the cellName of this oaAnalysisLib object to the specified value.

void oaAnalysisLib::setFileName (  const oaScalarName &    fileName ) 
 

This function sets the fileName of this oaAnalysisLib object to the specified value.

void oaAnalysisLib::setFormat (  const oaString &    format ) 
 

This function sets the format of this oaAnalysisLib object to the specified value.

void oaAnalysisLib::setViewName (  const oaScalarName &    viewName ) 
 

This function sets the viewName of this oaAnalysisLib object to the specified value.

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.