Overview   Class List   Class Hierarchy   Class Members   Functions & Constants   Defines   Header Files  

uima::CASIterator Class Reference

List of all members.

Public Member Functions

 ~CASIterator (void)
 Destructor.
bool hasNext (void)
 Checks if there are more CASes to be returned by the iterator.
CASnext (void)
 Gets the next CAS from the iterator.
void release (void)
 Releases any CASes owned by this CasIterator.

Protected Member Functions

 CASIterator (AnalysisEngine *pEngine)
 Constructor Creates the specified number of CAS instances based on CAS definition as specified in the TAE specifier.


Constructor & Destructor Documentation

uima::CASIterator::CASIterator ( AnalysisEngine pEngine  )  [protected]

Constructor Creates the specified number of CAS instances based on CAS definition as specified in the TAE specifier.

uima::CASIterator::~CASIterator ( void   ) 

Destructor.


Member Function Documentation

bool uima::CASIterator::hasNext ( void   ) 

Checks if there are more CASes to be returned by the iterator.

Returns:
true if there are more CASes to be returned, false if not

CAS& uima::CASIterator::next ( void   ) 

Gets the next CAS from the iterator.

Returns:
a pointer to a CAS.

void uima::CASIterator::release ( void   ) 

Releases any CASes owned by this CasIterator.

You only need to call this method if you stop using a CasIterator before you have iterated all the way through.


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

Generated on Mon Oct 1 11:15:08 2012 for UIMACPP API by  doxygen 1.5.6