oaAntennaData Class Reference


Public Methods

 oaAntennaData (const oaAntennaModel &processIn=oacDefaultAntennaModel)
 oaAntennaData (const oaAntennaData &dataIn)
 ~oaAntennaData ()
oaAntennaData & operator= (const oaAntennaData &dataIn)
const oaAntennaModel & getModel () const
void setModel (const oaAntennaModel &modelIn)
const oaAntennaAreaArray & gate () const
const oaAntennaAreaArray & diff () const
const oaAntennaAreaArray & partialMetal () const
const oaAntennaAreaArray & partialMetalSide () const
const oaAntennaAreaArray & partialCut () const
const oaAntennaAreaArray & maxCAR () const
const oaAntennaAreaArray & maxSideCAR () const
const oaAntennaAreaArray & maxCutCAR () const
oaAntennaAreaArray & gate ()
oaAntennaAreaArray & diff ()
oaAntennaAreaArray & partialMetal ()
oaAntennaAreaArray & partialMetalSide ()
oaAntennaAreaArray & partialCut ()
oaAntennaAreaArray & maxCAR ()
oaAntennaAreaArray & maxSideCAR ()
oaAntennaAreaArray & maxCutCAR ()
void setGate (const oaAntennaAreaArray &gate)
void setDiff (const oaAntennaAreaArray &diff)
void setPartialMetal (const oaAntennaAreaArray &partialMetal)
void setPartialMetalSide (const oaAntennaAreaArray &partialMetalSide)
void setPartialCut (const oaAntennaAreaArray &partialCut)
void setMaxCAR (const oaAntennaAreaArray &maxCAR)
void setMaxSideCAR (const oaAntennaAreaArray &maxSideCAR)
void setMaxCutCAR (const oaAntennaAreaArray &maxCutCAR)

Detailed Description

The oaAntennaData class implements on object for holding antenna data for a particular antennaModel.

The oaAntennaData class implements an object for holding oaAntennaData for a particular antenna process model.

Antenna data consists of a set of oaAntennaAreaArrays for gate area, diffusion area, partial metal area, partial metal side area, partial cut area, maximum cumulative area ratio (CAR), maximum side CAR, and maximum cut CAR.

Antenna data can be associated with terminals in the database (refer to oaTerm). The antenna data associated with a terminal is the partial results for a given wire that can be used to determine if it is following the antenna rules specified in the technology data (see oaAntennaRule).

// Added Gendox Member Function Docs: oaAntennaData // //

>>>>>>>>>>>> YOU ARE HERE <<<<<<<<<<<<<<<<<

Developer: Insert alias after completing above tasks: The antenna data on terminals are passed up the hierarchy as wires are constructed hierarchically, so the routing on the next level of hierarchy can be adjusted if the wire is violating the antenna rule.

Constructor & Destructor Documentation

oaAntennaData::oaAntennaData (  const oaAntennaModel &    modelIn = oacDefaultAntennaModel ) 
 

This function constructs an oaAntennaData object, initializing it with the specified modelIn antennaModel.

Parameters:
modelIn an optional oaAntennaModel wrapper object for an enumerated process model value; if not specified, a default oacDefaultAntennaModel value is used.

oaAntennaData::oaAntennaData (  const oaAntennaData &    dataIn ) 
 

This is the copy constructor for an oaAntennaData object. It constructs a a copy of the specified dataIn oaAntennaData object.

Parameters:
dataIn the oaAntennaData object to copy

oaAntennaData::~oaAntennaData (    ) 
 

This is the destructor of an oaAntennaData object.

Member Function Documentation

oaAntennaAreaArray & oaAntennaData::diff (    )  [inline]
 

This function is deprecated. Use the oaAntennaData::setDiff function instead.

This non-const version of the diff() function, which returns a reference to its oaAntennaAreaArray of diffusion values, allows users to set the oaAntennaAreaArray of diffusion values on this oaAntennaData object.

modelconst oaAntennaAreaArray & oaAntennaData::diff (    )  const [inline]
 

This const version of the diff() function, allows users to get the oaAntennaAreaArray of diffusion values of this oaAntennaData object.

oaAntennaAreaArray & oaAntennaData::gate (    )  [inline]
 

This function is deprecated. Use the oaAntennaData::setGate function instead.

This non-const version of the gate() function, which returns a reference to its oaAntennaAreaArray of gate values, allows users to set the oaAntennaAreaArray of gate values on this oaAntennaData object.

const oaAntennaAreaArray & oaAntennaData::gate (    )  const [inline]
 

This const version of the gate() function allows users to get the oaAntennaAreaArray of gates values of this oaAntennaData object.

const oaAntennaModel & oaAntennaData::getModel (    )  const [inline]
 

This function gets the oaAntennaModel of this oaAntennaData object by returning a const reference to its oaAntennaModel.

oaAntennaAreaArray & oaAntennaData::maxCAR (    )  [inline]
 

This non-const version of the maxCAR() function, which returns a reference to its oaAntennaAreaArray of maximum cumulative area ratio (maxCAR) values, allows users to set the oaAntennaAreaArray of maxCAR values on this oaAntennaData object.

This function is deprecated. Use the oaAntennaData::setMaxCAR function instead.

const oaAntennaAreaArray & oaAntennaData::maxCAR (    )  const [inline]
 

This const version of the maxCAR() function allows users to get the oaAntennaAreaArray of maximum cumulative area ratio (maxCAR) values of this oaAntennaData object.

oaAntennaAreaArray & oaAntennaData::maxCutCAR (    )  [inline]
 

This function is deprecated. Use the oaAntennaData::setMaxCutCAR function instead.

This non-const version of the maxCutCAR() function, which returns a reference to its oaAntennaAreaArray of maximum cut cumulative area ratio (maxCutCAR) values, allows users to set the oaAntennaAreaArray of maxCutCAR values on this oaAntennaData object.

const oaAntennaAreaArray & oaAntennaData::maxCutCAR (    )  const [inline]
 

This const version of the maxCutCAR() function allows users to get the oaAntennaAreaArray of maximum cut cumulative area ratio (maxCutCAR) values of this oaAntennaData object.

oaAntennaAreaArray & oaAntennaData::maxSideCAR (    )  [inline]
 

This function is deprecated. Use the oaAntennaData::setMaxSideCAR function instead.

This non-const version of the maxSideCAR() function, which returns a reference to its oaAntennaAreaArray of maximum side cumulative area ratio (maxSideCAR) values, allows users to set the oaAntennaAreaArray of maxSideCAR values on this oaAntennaData object.

const oaAntennaAreaArray & oaAntennaData::maxSideCAR (    )  const [inline]
 

This const version of the maxSideCAR() function allows users to get the oaAntennaAreaArray of maximum side cumulative area ratio (maxSideCAR) values of this oaAntennaData object.

oaAntennaData & oaAntennaData::operator= (  const oaAntennaData &    dataIn ) 
 

This is the assignment operator of the oaAntennaData class. It sets the antenna data in dataIn on this oaAntennaData object.

Parameters:
dataIn rhs oaAntennaData to assign to this antennaData

oaAntennaAreaArray & oaAntennaData::partialCut (    )  [inline]
 

This function is deprecated. Use the oaAntennaData::setPartialCut function instead.

This non-const version of the partialCut() function, which returns a reference to its oaAntennaAreaArray of partial cut values, allows users to set the oaAntennaAreaArray of partial cut values on this oaAntennaData object.

const oaAntennaAreaArray & oaAntennaData::partialCut (    )  const [inline]
 

This const version of the partialCut() function allows users to get the oaAntennaAreaArray of partial cut values of this oaAntennaData object.

oaAntennaAreaArray & oaAntennaData::partialMetal (    )  [inline]
 

This function is deprecated. Use the oaAntennaData::setPartialMetal function instead.

This non-const version of the partialMetal() function, which returns a reference to its oaAntennaAreaArray of partial metal values, allows users to set the oaAntennaAreaArray of partial metal values on this oaAntennaData object.

const oaAntennaAreaArray & oaAntennaData::partialMetal (    )  const [inline]
 

This const version of the partialMetal() function allows users to get the oaAntennaAreaArray of partial metal values of this oaAntennaData object.

oaAntennaAreaArray & oaAntennaData::partialMetalSide (    )  [inline]
 

This function is deprecated. Use the oaAntennaData::setPartialMetalSide function instead.

This non-const version of the partialMetalSide() function, which returns a reference to its oaAntennaAreaArray of partial metal side values, allows users to set the oaAntennaAreaArray of partial metal side values on this oaAntennaData object.

const oaAntennaAreaArray & oaAntennaData::partialMetalSide (    )  const [inline]
 

This const version of the partialMetalSide() function allows users to get the oaAntennaAreaArray of partial metal side values of this oaAntennaData object.

void oaAntennaData::setDiff (  const oaAntennaAreaArray &    diff )  [inline]
 

This function sets the oaAntennaAreaArray of diffusion values of this oaAntennaData object.

Parameters:
diff The oaAntennaAreaArray of diffusion values.

void oaAntennaData::setGate (  const oaAntennaAreaArray &    gate )  [inline]
 

This function sets the oaAntennaAreaArray of gate values of this oaAntennaData object.

Parameters:
gate The oaAntennaAreaArray of gate values.

void oaAntennaData::setMaxCAR (  const oaAntennaAreaArray &    maxCAR )  [inline]
 

This function sets the oaAntennaAreaArray of maximum cumulative area ratio (maxCAR) values of this oaAntennaData object.

Parameters:
maxCAR The oaAntennaAreaArray of maximum cumulative area ratio (maxCAR) values.

void oaAntennaData::setMaxCutCAR (  const oaAntennaAreaArray &    maxCutCAR )  [inline]
 

This function sets the oaAntennaAreaArray of maximum cut cumulative area ratio (maxCutCAR) values of this oaAntennaData object.

Parameters:
maxCutCAR The maximum cut cumulative area ratio (maxCutCAR) values.

void oaAntennaData::setMaxSideCAR (  const oaAntennaAreaArray &    maxSideCAR )  [inline]
 

This function sets the oaAntennaAreaArray of maximum side cumulative area ratio (maxSideCAR) values of this oaAntennaData object.

Parameters:
maxSideCAR The oaAntennaAreaArray of maximum side cumulative area ratio (maxSideCAR) values.

void oaAntennaData::setModel (  const oaAntennaModel &    modelIn )  [inline]
 

This function sets the antennaModel for this oaAntennaData object.

Parameters:
modelIn oaAntennaModel to set on this oaAntennaData object

void oaAntennaData::setPartialCut (  const oaAntennaAreaArray &    partialCut )  [inline]
 

This function sets the oaAntennaAreaArray of partial cut values of this oaAntennaData object.

Parameters:
partialCut The oaAntennaAreaArray of partial cut values.

void oaAntennaData::setPartialMetal (  const oaAntennaAreaArray &    partialMetal )  [inline]
 

This function sets the oaAntennaAreaArray of partial metal values on this oaAntennaData object.

Parameters:
partialMetal The oaAntennaAreaArray of partial metal values.

void oaAntennaData::setPartialMetalSide (  const oaAntennaAreaArray &    partialMetalSide )  [inline]
 

This function sets the oaAntennaAreaArray of partial metal side values on this oaAntennaData object.

Parameters:
partialMetalSide The oaAntennaAreaArray of partial metal side values.

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.