oaAreaBoundary Class Reference

Inheritance diagram for oaAreaBoundary:

oaBoundary oaFig oaBlockObject oaDesignObject oaObject


Public Methods

void getName (oaString &name) const
void setName (const oaString &name)

Static Public Methods

oaAreaBoundary * create (oaBlock *block, const oaString &name, const oaPointArray &points, const oaString *edgeNames=NULL)
oaAreaBoundary * create (oaBlock *block, const oaPointArray &points, const oaString *edgeNames=NULL)
oaAreaBoundary * find (const oaBlock *block, const oaString &name)
oaAreaBoundary * create (oaBlock *block, const oaString &name, const oaPointArray &points, const oaStringArray &edgeNames)
oaAreaBoundary * create (oaBlock *block, const oaPointArray &points, const oaStringArray &edgeNames)

Detailed Description

The oaAreaBoundary class represents a generic boundary in a physical block. This class is used to indicate a region of a block for various purposes defined by a design methodology. For example, it might be an area that is intended to follow a given design style, or an area with a particular supply voltage.

Area boundaries are named and there can be multiple area boundaries in a given oaBlock.

Member Function Documentation

oaAreaBoundary * oaAreaBoundary::create (  oaBlock *    block,
const oaPointArray &    points,
const oaStringArray &    edgeNames
)  [static]
 

This function creates a new area boundary object in the specified block with the specified location and edge names. The specified points pointArray is checked to verify that there are at least three points and no collinear or coincident points.

Note that the number of edge names must be equal to the number of points or an oacBoundaryInvalidEdgeNames exception is thrown.

This form of the create function automatically generates a name for the new boundary, with the format B__%d, where d is an integer that makes this name unique among the boundaries of the block.

If the boundary edgeNames array is empty, the edges are automatically named using the form EDGE_n, where n starts at zero and increments by one for each edge.

Note: The order of the points actually set on the oaAreaBoundary is not guaranteed to be the same as the order of points passed to the create() function. Consequently, the order of points returned by a subsequent oaAreaBoundary::getPoints() may be different from the order of points specified in points.

Parameters:
block A pointer to the block in which to create the oaAreaBoundary object.
points An oaPointArray of points that describe this boundary.
edgeNames A pointer to an array of boundary edge names or an empty array.
Exceptions:
oacBoundaryHasExtraPoints 
oacBoundaryTooFewPoints 
oacBoundaryInvalidEdgeNames 

oaAreaBoundary * oaAreaBoundary::create (  oaBlock *    block,
const oaString &    name,
const oaPointArray &    points,
const oaStringArray &    edgeNames
)  [static]
 

This function creates a new area boundary object in the specified block with the specified attributes. With this form of the create() function, the caller supplies a name that must be unique for all boundaries in this block. if a boundary with the specified name already exists in the specified block, this function throws an exception. The specified points pointArray is checked to verify that there are at least three points and no collinear or coincident points. For more information on coincident and collinear points, see oaPointArray::compress(). Note that the number of edge names must be equal to the number of points or an oacBoundaryInvalidEdgeNames exception is thrown.

If the boundary edgeNames array is empty, the edges are automatically named using the form EDGE_n, where n starts at zero and increments by one for each edge.

Note: The order of the points actually set on the oaAreaBoundary is not guaranteed to be the same as the order of points passed to the create() function. Consequently, the order of points returned by a subsequent oaAreaBoundary::getPoints() may be different from the order of points specified in points.

Parameters:
block Block in which to create the area boundary.
name Name of the area boundary.
points Array of points that describe this boundary.
edgeNames Array of boundary edge names or an empty array.
Exceptions:
oacBoundaryHasExtraPoints 
oacBoundaryTooFewPoints 
oacBoundaryNameExists 
oacBoundaryInvalidEdgeNames 

oaAreaBoundary * oaAreaBoundary::create (  oaBlock *    block,
const oaPointArray &    points,
const oaString *    edgeNames = NULL
)  [static]
 

This function is deprecated. Refer to the create function that takes a reference to an oaStringArray for edgeNames.

This function creates a new area boundary object in the specified block with the specified location and edge names. The specified points pointArray is checked to verify that there are at least three points and no collinear or coincident points.

Note that the number of edge names is assumed to be equal to the number of points.

This form of the create function automatically generates a name for the new boundary, with the format B__%d, where d is an integer that makes this name unique among the boundaries of the block.

If the boundary edgeNames are not supplied, the edges are automatically named, using the form EDGE_n, where n starts at zero and increments by one for each edge.

Note: The order of the points actually set on the oaAreaBoundary is not guaranteed to be the same as the order of points passed to the create() function. Consequently, the order of points returned by a subsequent oaAreaBoundary::getPoints() may be different from the order of points specified in points.

Parameters:
block A pointer to block in which to create the oaAreaBoundary object.
points An oaPointArray of points that describe this boundary.
edgeNames A pointer to an array of boundary edge names.
Exceptions:
oacBoundaryHasExtraPoints 
oacBoundaryTooFewPoints 

oaAreaBoundary * oaAreaBoundary::create (  oaBlock *    block,
const oaString &    name,
const oaPointArray &    points,
const oaString *    edgeNames = NULL
)  [static]
 

This function is deprecated. Refer to the create function that takes a reference to an oaStringArray for edgeNames.

This function creates a new area boundary object in the specified block with the specified attributes. With this form of the create() function, the caller supplies a name that must be unique for all boundaries in this block. if a boundary with the specified name already exists in the specified block, this function throws an exception. The specified points pointArray is checked to verify that there are at least three points and no collinear or coincident points. For more information on coincident and collinear points, see oaPointArray::compress().

Note that the number of edge names is assumed to be equal to the number of points.

If the boundary edgeNames are not supplied, the edges are automatically named, using the form EDGE_n, where n starts at zero and increments by one for each edge.

Note: The order of the points actually set on the oaAreaBoundary is not guaranteed to be the same as the order of points passed to the create() function. Consequently, the order of points returned by a subsequent oaAreaBoundary::getPoints() may be different from the order of points specified in points.

Parameters:
block A Pointer to block in which to create the oaAreaBoundary object.
name The name of the area boundary.
points An oaPointArray of points that describe this boundary.
edgeNames A pointer to an array of boundary edge names.
Exceptions:
oacBoundaryHasExtraPoints 
oacBoundaryTooFewPoints 
oacBoundaryNameExists 

oaAreaBoundary * oaAreaBoundary::find (  const oaBlock *    block,
const oaString &    name
)  [static]
 

This function searches the specified block for an area boundary with the specified name. A pointer to the boundary is returned if found, otherwise NULL is returned.

Parameters:
block A pointer to the block to search.
name The name of boundary to find.

void oaAreaBoundary::getName (  oaString &    name )  const
 

This function fills in name with the name of this boundary.

Parameters:
name The returned name of this boundary.

void oaAreaBoundary::setName (  const oaString &    name ) 
 

This function sets the name of this boundary to the specified name.

Parameters:
name The input name of boundary to set.
Exceptions:
oacBoundaryNameExists 

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.