oaTextDisplayIter Class Reference
Detailed Description
The oaTextDisplayIter class implements a special case iterator. This class returns textDisplays of an oaTextDisplayCollection.
The following example shows the suggested usage of oaTextDisplayIter:
oaTextDisplayIter iter(textDisplay->getTextDisplays());
oaTextDisplay *td;
while (td = iter.getNext()) { ... }
Constructor & Destructor Documentation
| oaTextDisplayIter::oaTextDisplayIter |
( |
oaTextDisplayIterState * |
iterIn |
) |
[inline] |
|
|
|
This function constructs a new oaTextDisplayIter object according to the base collection type.
- Parameters:
-
| iterIn | The iterator value to use |
|
| oaTextDisplayIter::oaTextDisplayIter |
( |
oaTextDisplayIter & |
iterIn |
) |
|
|
|
|
This function constructs a new oaTextDisplayIter class and iterates over the same set of objects as the specified oaTextDisplayIter iterator. The new iterator starts at the beginning of the collection.
- Parameters:
-
| iterIn | The iterator value to use |
|
| oaTextDisplayIter::~oaTextDisplayIter |
( |
|
) |
[inline] |
|
|
|
This function destroys this oaTextDisplayIter object, cleaning up members owned by this text display iterator object. |
Member Function Documentation
|
|
This function returns a pointer to the next object in the collection that is being iterated. The function switches on the iterator type to determine which function to call on the container. This function returns NULL when there are no more objects to return. |
| oaTextDisplayIter & oaTextDisplayIter::operator= |
( |
const oaTextDisplayIter & |
iterIn |
) |
|
|
|
|
This is the assignment operator for the oaTextDisplayIter class. It copies the state of iterIn to this oaTextDisplayIter.
- Parameters:
-
| iterIn | rhs oaTextDisplayIter to assign to this oaTextDisplayIter |
|
| void oaTextDisplayIter::reset |
( |
|
) |
[inline] |
|
|
|
This function restarts the iterator. The function switches on the iterator type to determine which function to call on the container. The next call to getNext() for this oaTextDisplayIter returns the first object in the collection. |
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.
