oaEnumPropIter Class Reference
Detailed Description
The oaEnumPropIter class implements a special case iterator. This class returns enumeration values of an oaEnumProp object.
The intended usage of oaEnumPropIter is shown in the following example:
oaEnumPropIter iter(enumProp->getEnums());
oaString enum;
while (iter.getNext(enum)) { ... }
Constructor & Destructor Documentation
| oaEnumPropIter::oaEnumPropIter |
( |
oaEnumIterState * |
iterIn |
) |
[inline] |
|
|
|
This function constructs a new oaEnumPropIter object. The argument is generally created implicitly by casting an oaEnumCollection that was returned by oaEnumProp::getEnums() as shown in the class description. |
| oaEnumPropIter::oaEnumPropIter |
( |
oaEnumPropIter & |
iterIn |
) |
[inline] |
|
|
|
This function constructs a new oaEnumPropIter class and iterates over the same set of objects as the oaEnumPropIter handed in. The new iterator starts at the beginning of the collection.
- Parameters:
-
| iterIn | The iterator value to use |
|
| oaEnumPropIter::~oaEnumPropIter |
( |
|
) |
[inline] |
|
|
|
This function destroys this oaEnumPropIter. |
Member Function Documentation
|
|
This function returns an oaString that contains the name of the next enumeration value in the list of valid enum values for the property. This function returns false when there are no more objects to return.
- Parameters:
-
| enumV | The name of the next enumeration value in the list of enums |
|
| oaEnumPropIter & oaEnumPropIter::operator= |
( |
oaEnumPropIter & |
iterIn |
) |
[inline] |
|
|
|
This is the assignment operator for the VerilogNS class. It copies the state of iterIn to this enumPropIter.
- Parameters:
-
| iterIn | rhs oaEnumPropIter to assign to this enumPropIter |
|
| void oaEnumPropIter::reset |
( |
|
) |
[inline] |
|
|
|
This function restarts the iterator. The next call to getNext() for this oaEnumPropIter 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.
