oaVCVersionIter Class Reference


Public Methods

 oaVCVersionIter (const oaVCVersionIter &iter)
 ~oaVCVersionIter ()
oaVCVersionIter & operator= (const oaVCVersionIter &iter)
oaVCVersion getNext ()
void reset ()

Detailed Description

The oaVCVersionIter is used to iterate a collection of oaVCVersions.

Constructor & Destructor Documentation

oaVCVersionIter::oaVCVersionIter (  const oaVCVersionIter &    iter ) 
 

This is the copy constructor for the oaVCVersionIter class.

Parameters:
iter oaVCVersionIter to copy.

oaVCVersionIter::~oaVCVersionIter (    ) 
 

This is the destructor for the oaVCVersionIter class.

Member Function Documentation

oaVCVersion oaVCVersionIter::getNext (    ) 
 

This function returns the next oaVCVersion object of this iterator. If there are no more objects, a NULL oaVCVersion (with a NULL IVersion interface) is returned. To determine if the iteration is terminated, do one of the following:

  • Compare the returned object to a NULL oaVCVersion object.
  • Check the referenced version of the returned object by calling oaVCVersion::getRaw() to see if a NULL pointer is returned.

oaVCVersionIter & oaVCVersionIter::operator= (  const oaVCVersionIter &    iter ) 
 

This is the assignment operator for the oaVCVersionIter class. It copies the data of the specified iter oaVCVersionIter to this oaVCVersionIter.

Parameters:
iter rhs oaVCVersionIter to assign to this VC version iter.

void oaVCVersionIter::reset (    ) 
 

This function resets the iterator such that a subsequent getNext() will get the first entry in the set.

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.