oaSubNetwork Class Reference

Inheritance diagram for oaSubNetwork:

oaDesignObject oaObject


Public Methods

void destroy ()
oaParasiticNetwork * getParasiticNetwork () const
oaFig * getFig () const
void getName (oaString &name) const
void setName (const oaString &name)
void setFig (oaFig *fig)
oaCollection< oaNode, oaSubNetwork > getNodes () const
oaCollection< oaDevice, oaSubNetwork > getDevices () const

Static Public Methods

oaSubNetwork * create (oaParasiticNetwork *network, const oaString &name)
oaSubNetwork * find (const oaParasiticNetwork *network, const oaString &name)

Public Types

enum  { dtIndex = oacSubNetworkDataType }
enum  { domain = oacNoDomain }

Detailed Description

The oaSubNetwork class identifies a subset of the nodes and devices within a full oaParasiticNetwork.

The oaSubNetwork class can be used to represent the relationship between a set of nodes and devices and the corresponding route element or shape. Nodes can appear in multiple subNetworks for such cases as a wire connecting to a via or several wires connecting at an oaSteiner point. Although it is possible for a device to appear in multiple subNetworks, this is generally undesirable because it is not possible to determine what portion of the device's value lies within each subNetwork.

When a subNetwork contains multiple nodes and devices, their positions within the corresponding route element or shape can be specified using oaNode::setLocation().

Undo, properties, and groups are not supported for oaSubNetwork. Extensions on oaSubNetwork (and interPointer extensions that refer to an oaSubNetwork) are accessible only while the oaSubNetwork is loaded.

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

Member Function Documentation

oaSubNetwork * oaSubNetwork::create (  oaParasiticNetwork *    network,
const oaString &    name
)  [static]
 

This function creates a subNetwork with the specified name within the specified network. If network is a partition, the subNetwork can only refer to nodes and devices in network or its ancestors.

Exceptions:
oacSubNetworkNameExists 

void oaSubNetwork::destroy (    ) 
 

This function destroys this subNetwork. The nodes and devices to which the subNetwork refers are not affected.

oaSubNetwork * oaSubNetwork::find (  const oaParasiticNetwork *    network,
const oaString &    name
)  [static]
 

This function finds and returns the subNetwork with the specified name.

oaCollection oaSubNetwork::getDevices (    )  const
 

This function returns a collection containing the devices to which this subNetwork refers.

oaFig * oaSubNetwork::getFig (    )  const
 

This function returns the fig associated with this subNetwork. If this subNetwork is not associated with a fig, NULL is returned.

void oaSubNetwork::getName (  oaString &    name )  const
 

This function returns the name of this subNetwork.

oaCollection oaSubNetwork::getNodes (    )  const
 

This function returns a collection containing the nodes to which this subNetwork refers.

oaParasiticNetwork * oaSubNetwork::getParasiticNetwork (    )  const
 

This function returns the parasiticNetwork to which this subNetwork belongs.

void oaSubNetwork::setFig (  oaFig *    fig ) 
 

This function sets the fig that this subNetwork represents, which must be a shape or a via.

Parameters:
fig The figure to associate with this subNetwork
Exceptions:
oacObjectNetworkNotInSameDomain 
oacSubNetworkNotShapeOrVia 

void oaSubNetwork::setName (  const oaString &    name ) 
 

This function sets the name of this subNetwork.

Exceptions:
oacSubNetworkNameExists 

Member Enumeration Documentation

anonymous enum
 

Enumeration values:
dtIndex 

anonymous enum
 

Enumeration values:
domain 

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.