oaPhysicalLayer Class Reference

Inheritance diagram for oaPhysicalLayer:

oaLayer oaTechObject oaObject


Public Methods

oaMaterial getMaterial () const
oaPrefRoutingDir getPrefRoutingDir () const
oaUInt4 getMaskNumber () const
oaDist getManufacturingGrid () const
oaPhysicalLayer * getLayerAbove (oaMaterial material) const
oaPhysicalLayer * getLayerBelow (oaMaterial material) const
oaCollection< oaLayer, oaTech > getLayerAbove (const oaTech *tech, oaMaterial material, oaBoolean local=false) const
oaCollection< oaLayer, oaTech > getLayerBelow (const oaTech *tech, oaMaterial material, oaBoolean local=false) const
void getExcludedLayers (oaLayerNameArray &excludedLayerNames) const
oaBoolean hasExcludedLayers () const
void setMaterial (oaMaterial material)
void setPrefRoutingDir (oaPrefRoutingDir dir)
void setMaskNumber (oaUInt4 number)
void setManufacturingGrid (oaDist grid)
void resetManufacturingGrid ()
void setExcludedLayers (const oaLayerNameArray &excludedLayerNames)
void unsetExcludedLayers ()

Static Public Methods

oaPhysicalLayer * create (oaTech *tech, const oaString &name, oaLayerNum number, oaMaterial material=oacOtherMaterial, oaUInt4 maskNumber=oacUnsetMaskNumber)
oaPhysicalLayer * find (const oaTech *tech, const oaString &name)
oaPhysicalLayer * find (const oaTech *tech, oaLayerNum number)
oaPhysicalLayer * find (const oaTech *tech, const oaString &name, oaBoolean local)
oaPhysicalLayer * find (const oaTech *tech, oaLayerNum number, oaBoolean local)

Detailed Description

The oaPhysicalLayer class defines a physical layer that is referenced when creating physical design data.

Member Function Documentation

oaPhysicalLayer * oaPhysicalLayer::create (  oaTech *    tech,
const oaString &    name,
oaLayerNum    number,
oaMaterial    material = oacOtherMaterial,
oaUInt4    maskNumber = oacUnsetMaskNumber
)  [static]
 

This function creates a layer with the specified name and number. Any layer number in the set of unsigned four byte integers is a valid layer number.

Note: This function will bind any layer headers or LPPHeaders in open designs that reference the specified layer number.

An exception is thrown if this function is called to create a layer with a number or name that already exists or if the layer name is excluded from the specified tech.

Parameters:
tech The technology database in which to create the layer
name The name of the layer to create
number The number of the layer to create
material The material type of the layer to create
maskNumber The mask number of the layer to create
Exceptions:
oacLayerNameExists 
oacLayerNumberExists 
oacLayerIsExcluded 

oaPhysicalLayer * oaPhysicalLayer::find (  const oaTech *    tech,
oaLayerNum    number,
oaBoolean    local
)  [static]
 

This function searches the specified technology database for a physical layer with the specified number. The local argument specifies whether (if true) to look only in the specified technology database or (if false) to search the specified technology database and all of its referenced technology databases. If the layer is found, a pointer to the layer 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 The technology database to search
number The layer number to find
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.

Reimplemented from oaLayer.

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

This function searches the specified technology database looking for a physical layer 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 the layer is found, a pointer to the layer 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 The technology database to search
name The layer name to find
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.

Reimplemented from oaLayer.

oaPhysicalLayer * oaPhysicalLayer::find (  const oaTech *    tech,
oaLayerNum    number
)  [static]
 

This function searches the specified technology database for a physical layer with the specified number. If the specified technology database references other technology databases, those are searched as well and the first matching layer is returned. To find a layer in the current technology database only, refer to the find function that accepts the local argument.

If the function finds the specified layer, the function returns a pointer to the oaLayer object. Otherwise, the function returns NULL.

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

Parameters:
tech The technology database to search
number The layer number to find

Reimplemented from oaLayer.

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

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

If the function finds the specified layer, the function returns a pointer to the oaLayer object. Otherwise, the function returns NULL.

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

Parameters:
tech The technology database to search
name The layer name to find

Reimplemented from oaLayer.

void oaPhysicalLayer::getExcludedLayers (  oaLayerNameArray &    excludedLayerNames )  const
 

This function returns the list of layer names that are excluded for this physical layer.

Parameters:
excludedLayerNames The returned list of excluded layer names.

oaCollection< oaLayer, oaTech > oaPhysicalLayer::getLayerAbove (  const oaTech *    tech,
oaMaterial    material,
oaBoolean    local = false
)  const
 

This function returns a collection of layers with mask numbers greater than this layer with the specified material type. The tech defines the context of the graph of incremental technology databases in which to query this layer.

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

Parameters:
tech The technology database to search. This should be the most derived technology database in the graph of incremental technology databases.
material An oaMaterialEnum type that represents the type of material for this layer.
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.
Exceptions:
oacLayerNotInReferencedTech 

oaPhysicalLayer * oaPhysicalLayer::getLayerAbove (  oaMaterial    material )  const
 

This function is deprecated and is retained to ensure compatibility with previous versions of OpenAccess. Use the getLayerAbove function overload that returns a collection instead.

This function returns the next layer with a mask number greater than this layer with the specified material type.

If there is more than one physical layer for the mask number greater than this layer, an arbitrary one of those layers is returned.

oaCollection< oaLayer, oaTech > oaPhysicalLayer::getLayerBelow (  const oaTech *    tech,
oaMaterial    material,
oaBoolean    local = false
)  const
 

This function returns a collection of layers with mask numbers lower than this layer with the specified material type. The tech defines the context of the graph of incremental technology databases in which to query this layer.

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

Parameters:
tech The technology database to search. This should be the most derived technology database in the graph of incremental technology databases.
material An oaMaterialEnum type that represents the type of material for this layer.
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.
Exceptions:
oacLayerNotInReferencedTech 

oaPhysicalLayer * oaPhysicalLayer::getLayerBelow (  oaMaterial    material )  const
 

This function is deprecated and is retained to ensure compatibility with previous versions of OpenAccess. Use the getLayerBelow function overload that returns a collection instead.

This function returns the next layer with a mask number less than this layer with the specified material type.

If there is more than one physical layer for the mask number less than this layer, an arbitrary one of those layers is returned.

oaUInt4 oaPhysicalLayer::getManufacturingGrid (    )  const
 

This function gets the manufacturing grid for this layer. The manufacturing grid represents the minimum resolution that can be used to create objects on any purpose using the specified layer. If the manufacturing grid value for this layer has not been set i.e. zero, the default manufacturing grid value for the technology database to which this layer belongs is returned.

oaUInt4 oaPhysicalLayer::getMaskNumber (    )  const
 

This function gets the maskNumber of this layer. The maskNumber represents the order of layers in the manufacturing process.

oaMaterial oaPhysicalLayer::getMaterial (    )  const
 

This function gets the material of this layer. The material is an oaMaterialEnum type that represents the type of material for this layer.

oaPrefRoutingDir oaPhysicalLayer::getPrefRoutingDir (    )  const
 

This function gets the preferred routing direction of this layer.

oaBoolean oaPhysicalLayer::hasExcludedLayers (    )  const
 

This function returns true if this physical layer has a list of excluded layers specified.

void oaPhysicalLayer::resetManufacturingGrid (    ) 
 

This function resets the manufacturingGrid for this layer. The default manufacturing grid value specified for the technology database to which this layer belongs shall apply for this layer after the reset.

void oaPhysicalLayer::setExcludedLayers (  const oaLayerNameArray &    excludedLayerNames ) 
 

This function sets the excluded layers list on the physical layer. Excluded layers cannot exist in the same graph of tech databases in which this physical layer is defined. The specified excludedLayerNames list replaces any existing list for this layer.

For more information, refer to Excluding Incompatible Layers in the Using Technology Databases section of the Programmers Guide.

Parameters:
excludedLayerNames The list of excluded layer names
Exceptions:
oacExcludedLayerAlreadyExists 

void oaPhysicalLayer::setManufacturingGrid (  oaDist    grid ) 
 

This function sets the manufacturing grid for this layer. The manufacturing grid represents the minimum resolution that can be used to create objects on any purpose using the specified layer. The new grid value will override any default technology manufacturing grid value that may have been applied for for this physical layer.

Parameters:
grid The new value of the manufacturing grid to apply

void oaPhysicalLayer::setMaskNumber (  oaUInt4    number ) 
 

This function sets the maskNumber for this layer. The maskNumber represents the order of layers in the manufacturing process.

void oaPhysicalLayer::setMaterial (  oaMaterial    material ) 
 

This function sets the material of this layer. The material is an oaMaterialEnum type that represents the type of material for this layer.

void oaPhysicalLayer::setPrefRoutingDir (  oaPrefRoutingDir    dir ) 
 

This function sets the preferred routing direction for this layer.

void oaPhysicalLayer::unsetExcludedLayers (    ) 
 

This function clears the excluded layers list for this physical layer.

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.