AP_NormalisedEventIterator Struct Reference

AP_NormalisedEventIterator. More...

#include <NormalisedEvent.h>

Public Attributes
void *	reserved
	Pointer to private internal data. More...
struct AP_NormalisedEventIterator_Functions *	functions
	Function table of iterator operations. More...

Detailed Description

AP_NormalisedEventIterator.

External (client-visible) interface to a normalised event iterator object. The AP_NormalisedEventIterator struct contains a table of function pointers, declared in the AP_NormalisedEventIterator_Functions struct above. The implementation of these functions is private. Users of the iterator should invoke functions on it as in the following example (iterator is of type AP_NormalisedEventIterator*):

b = iterator->functions->valid(iterator);

Note that an iterator is only valid as long as the underlying normalised event remains unchanged. Any iterators on a given event should be deleted as soon as any operation is performed that might change the contents of the event object.

Member Data Documentation

functions

struct AP_NormalisedEventIterator_Functions* AP_NormalisedEventIterator::functions

Function table of iterator operations.

See documentation for AP_NormalisedEventIterator_Functions for details.

reserved

void* AP_NormalisedEventIterator::reserved

Pointer to private internal data.

---

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

• NormalisedEvent.h