oaSteiner Class Reference

Inheritance diagram for oaSteiner:

oaConnFig oaFig oaBlockObject oaDesignObject oaObject


Public Methods

oaLayerHeader * getLayerHeader () const
oaLayerNum getLayerNum () const
void setBBox (const oaBox &bBox)
void setLayerNum (oaLayerNum layer)
oaCollection< oaRoute, oaSteiner > getConnRoutes () const

Static Public Methods

oaSteiner * create (oaBlock *block, const oaBox &bBox, oaLayerNum layer=oacAnyLayerNum)

Public Types

enum  { dtIndex = oacSteinerDataType }

Detailed Description

The oaSteiner class is used to represent a logical object that facilitates the branching of a wire. oaSteiner objects are figures which can be associated with a layer and can have net connectivity. oaSteiner objects also qualify as objects that can connect to an oaRoute object either at its begin or end and allow clients to access the collection of routes fanning out or fanning in from/to it.

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

Member Function Documentation

oaSteiner * oaSteiner::create (  oaBlock *    block,
const oaBox &    bBox,
oaLayerNum    layer = oacAnyLayerNum
)  [static]
 

This function creates an oaSteiner object in the specified 'block' with the specified 'bBox' and having the specified 'layer'. The layer specification is optional and a steiner may not have any associated layer.

Parameters:
block The block in which this oaSteiner object is created
bBox The bBox to be used for this steiner object
layer The layer this steiner needs to be associated with, if any
Returns:
A pointer to the oaSteiner object created

oaCollection oaSteiner::getConnRoutes (    )  const
 

This function returns a collection of routes connected to this steiner. Each route in the collection has this steiner as its connection object, either at its begin or its end.

oaLayerHeader * oaSteiner::getLayerHeader (    )  const
 

This function returns a pointer to the oaLayerHeader object that represents the layer associated with the steiner object. A NULL value is returned if the steiner is not associated with any layer.

oaLayerNum oaSteiner::getLayerNum (    )  const
 

This function returns the layer number of the layer that may be associated with this steiner. An oacAnyLayerNum value is returned if the steiner is not associated with any layer.

void oaSteiner::setBBox (  const oaBox &    bBox ) 
 

This function updates the bBox of the steiner object to be the specified 'bBox'.

Parameters:
bBox The new bBox for the steiner

void oaSteiner::setLayerNum (  oaLayerNum    layer ) 
 

This function updates the layer of the steiner object to be the specified 'layer'. The steiner object will also get associated to the corresponding oaLayerHeader object if the specified 'layer' value is not oacAnyLayerNum. The steiner also gets disassociated from any earlier oaLayerHeader object it may have been related to, if any, before the new layer assignment is made.

Parameters:
layer The layer number for the layer to be associated with the steiner

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.