oaClusterBoundary Class Reference

Inheritance diagram for oaClusterBoundary:

oaBoundary oaFig oaBlockObject oaDesignObject oaObject


Public Methods

oaCluster * getCluster () const
void getName (oaString &name) const
void setName (const oaString &name)

Static Public Methods

oaClusterBoundary * create (oaCluster *cluster, const oaString &name, const oaPointArray &points, const oaString *edgeNames=NULL)
oaClusterBoundary * create (oaCluster *cluster, const oaPointArray &points, const oaString *edgeNames=NULL)
oaClusterBoundary * find (const oaCluster *cluster, const oaString &name)
oaClusterBoundary * create (oaCluster *cluster, const oaString &name, const oaPointArray &points, const oaStringArray &edgeNames)
oaClusterBoundary * create (oaCluster *cluster, const oaPointArray &points, const oaStringArray &edgeNames)

Detailed Description

The oaClusterBoundary class indicates an area in which the contents of a specific cluster should be placed. Each oaClusterBoundary is attached to a specific oaCluster object. An oaCluster may have multiple oaClusterBoundary objects attached to it, in which case the contents of the cluster may be placed in any of its boundaries. An oaClusterBoundary must have a unique name with respect to all Boundaries in a given design.

Member Function Documentation

oaClusterBoundary * oaClusterBoundary::create (  oaCluster *    cluster,
const oaPointArray &    points,
const oaStringArray &    edgeNames
)  [static]
 

This function creates a new cluster boundary object in the specified cluster with the specified attributes. A name for the new cluster boundary is automatically generated, with the default name prefix B__%d, d referring to a unique integer. 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.

Note: The order of the points actually set on the oaClusterBoundary 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 oaClusterBoundary::getPoints() may be different from the order of points specified in points.

Parameters:
cluster The cluster in which to create the boundary.
points The array of points.
edgeNames The array of edge names or an empty array.
Exceptions:
oacBoundaryHasExtraPoints 
oacBoundaryTooFewPoints 
oacBoundaryInvalidEdgeNames 

oaClusterBoundary * oaClusterBoundary::create (  oaCluster *    cluster,
const oaString &    name,
const oaPointArray &    points,
const oaStringArray &    edgeNames
)  [static]
 

This function creates a new cluster boundary object in the specified cluster with the specified attributes.

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.

Note: The order of the points actually set on the oaClusterBoundary 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 oaClusterBoundary::getPoints() may be different from the order of points specified in points.

Parameters:
cluster The cluster in which to create the boundary.
name The name for the boundary.
points The array of points.
edgeNames The array of edge names or an empty array.
Exceptions:
oacBoundaryNameExists 
oacBoundaryHasExtraPoints 
oacBoundaryTooFewPoints 
oacBoundaryInvalidEdgeNames 

oaClusterBoundary * oaClusterBoundary::create (  oaCluster *    cluster,
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 cluster boundary object in the specified cluster with the specified attributes. A name for the new cluster boundary is automatically generated, with the default name prefix B__%d, d referring to a unique integer.

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

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

Note: The order of the points actually set on the oaClusterBoundary 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 oaClusterBoundary::getPoints() may be different from the order of points specified in points.

Exceptions:
oacBoundaryHasExtraPoints 
oacBoundaryTooFewPoints 

oaClusterBoundary * oaClusterBoundary::create (  oaCluster *    cluster,
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 cluster boundary object in the specified cluster with the specified attributes.

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

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

Note: The order of the points actually set on the oaClusterBoundary 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 oaClusterBoundary::getPoints() may be different from the order of points specified in points.

Exceptions:
oacBoundaryNameExists 
oacBoundaryHasExtraPoints 
oacBoundaryTooFewPoints 

oaClusterBoundary * oaClusterBoundary::find (  const oaCluster *    cluster,
const oaString &    name
)  [static]
 

This function searches the design of the specified cluster for a cluster boundary with the specified name. The boundary is returned if found. Otherwise, NULL is returned.

oaCluster * oaClusterBoundary::getCluster (    )  const
 

This function returns the cluster of this boundary.

void oaClusterBoundary::getName (  oaString &    name )  const
 

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

void oaClusterBoundary::setName (  const oaString &    name ) 
 

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

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.