KFbxUserNotificationFilteredIterator Class Reference

#include <kfbxusernotification.h>

List of all members.


Detailed Description

This class iterates through the accumulated messages depending on the configuration flags (filter).

The iterator keeps a local copy of the data extracted from the accumulator.

Definition at line 500 of file kfbxusernotification.h.


Public Member Functions

  KFbxUserNotificationFilteredIterator (KFbxUserNotification &pAccumulator, int pFilterClass, KFbxUserNotification::OutputSource pSrc=KFbxUserNotification::eSEQUENCED_DETAILS, bool pNoDetail=true)
  Constructor.
virtual  ~KFbxUserNotificationFilteredIterator ()
int  GetNbItems () const
  Returns the number of elements contained in this iterator.
void  Reset ()
  Put the iterator in its reset state.
AccumulatorEntry *const  First ()
  Get this iterator's first item.
AccumulatorEntry *const  Previous ()
  Get this iterator's previous item.
AccumulatorEntry *const  Next ()
  Get this iterator's next item.

Protected Member Functions

virtual void  BuildFilteredList (KFbxUserNotification &pAccumulator)

Protected Attributes

int  mIterator
int  mFilterClass
bool  mNoDetail
KFbxUserNotification::OutputSource  mAccuSrcData
KArrayTemplate
< AccumulatorEntry * > 
mFilteredAE

Constructor & Destructor Documentation

KFbxUserNotificationFilteredIterator ( KFbxUserNotification pAccumulator,
int  pFilterClass,
KFbxUserNotification::OutputSource  pSrc = KFbxUserNotification::eSEQUENCED_DETAILS,
bool  pNoDetail = true  
)

Constructor.

Parameters:
pAccumulator  This reference is only used during construction for retrieving the data required to fill the iterator.
pFilterClass  The bitwise combination of the AEClass identifiers. An AccumulatorEntry element is copied from the accumulator if its Class matches one of the bits of this flag.
pSrc  Specify which data format is extracted from the accumulator.
pNoDetail  This parameter is used ONLY if pSrc == eACCUMULATOR_ENTRY and, if set to false, the details of the AccumulatorEntry are also sent to the output devices. If left to its default value, only the description of the AccumulatorEntry is sent.

virtual ~KFbxUserNotificationFilteredIterator (  )  [virtual]

Member Function Documentation

int GetNbItems (  )  const

Returns the number of elements contained in this iterator.

void Reset (  ) 

Put the iterator in its reset state.

AccumulatorEntry* const First (  ) 

Get this iterator's first item.

Returns:
NULL if the iterator is empty.

AccumulatorEntry* const Previous (  ) 

Get this iterator's previous item.

Returns:
NULL if the iterator reached the beginning (or is empty).
Remarks:
This method will also return NULL if it is called before or immediately after a call to First() and reset the iterator to its reset state (meaning that a call to First() is mandatory to be able to iterate again).

AccumulatorEntry* const Next (  ) 

Get this iterator's next item.

Returns:
NULL if the iterator reached the end (or is empty).
Remarks:
This method will also return NULL if it is called while the iterator is in its reset state (called before First() or after a preceding call to Previous() reached beyond the beginning).

virtual void BuildFilteredList ( KFbxUserNotification pAccumulator  )  [protected, virtual]

Member Data Documentation

int mIterator [protected]

Definition at line 555 of file kfbxusernotification.h.

int mFilterClass [protected]

Definition at line 556 of file kfbxusernotification.h.

bool mNoDetail [protected]

Definition at line 557 of file kfbxusernotification.h.

Definition at line 558 of file kfbxusernotification.h.

Definition at line 559 of file kfbxusernotification.h.

KFbxUserNotificationFilteredIterator KFbxUserNotificationFilteredIterator KFbxUserNotificationFilteredIterator KFbxUserNotificationFilteredIterator KFbxUserNotificationFilteredIterator KFbxUserNotificationFilteredIterator KFbxUserNotificationFilteredIterator KFbxUserNotificationFilteredIterator KFbxUserNotificationFilteredIterator KFbxUserNotificationFilteredIterator
KFbxUserNotificationFilteredIterator KFbxUserNotificationFilteredIterator KFbxUserNotificationFilteredIterator KFbxUserNotificationFilteredIterator KFbxUserNotificationFilteredIterator KFbxUserNotificationFilteredIterator KFbxUserNotificationFilteredIterator KFbxUserNotificationFilteredIterator KFbxUserNotificationFilteredIterator KFbxUserNotificationFilteredIterator