oaMemNetIter Class Reference

Inheritance diagram for oaMemNetIter:

oaBaseMemNetIter


Public Methods

 oaMemNetIter (const oaMemNetCollection &cl)
 oaMemNetIter (const oaMemNetIter &iterIn)
oaNetgetNext (oaUInt4 &arg)

Detailed Description

The oaMemNetIter class implements a special case iterator. This class returns member oaNets of an oaMemNetCollection. A collection of member nets is all those nets of whom the current net is a member. Because all nets are members of themselves, this iterator will always return at least one net.

For example, a collection of member nets for net a would contain all of the following nets:

The member net index is returned in the getNext() function. This index indicates the member position of the specified net in the collection. For the example above, the iterator would return the following values:

This particular collection and iterator are primarily for those applications that want to traverse single-bit connectivity.


Constructor & Destructor Documentation

oaMemNetIter::oaMemNetIter const oaMemNetCollection &    cl [inline]
 

This function constructs a new oaMemNetIter object according to the specified memNet collection cl.

Parameters:
cl The specified oaMemNetCollection object

oaMemNetIter::oaMemNetIter const oaMemNetIter &    iterIn [inline]
 

This function constructs a new oaMemNetIter class and iterates over the same set of objects as the specified oaMemNetIter iterator. The new iterator starts at the beginning of the collection.

Parameters:
iterIn The iterator value to use


Member Function Documentation

oaNet * oaMemNetIter::getNext oaUInt4 &    arg [inline]
 

This function returns a pointer to the next object in the collection that is being iterated. NULL is returned when there are no more objects to return.

Parameters:
arg The member index of the current net in the returned net

Reimplemented from oaBaseMemNetIter.


The documentation for this class was generated from the following files:

Return to top of page