FbxUserNotificationFilteredIterator Class Reference
 
 
 
FbxUserNotificationFilteredIterator Class Reference

#include <fbxusernotification.h>


Class 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 459 of file fbxusernotification.h.

List of all members.

Public Member Functions

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

Protected Member Functions

virtual void  BuildFilteredList (FbxUserNotification &pAccumulator)

Protected Attributes

int  mIterator
int  mFilterClass
bool  mNoDetail
FbxUserNotification::EOutputSource  mAccuSrcData
FbxArray< FbxAccumulatorEntry * >  mFilteredAE

Constructor & Destructor Documentation

FbxUserNotificationFilteredIterator ( FbxUserNotification pAccumulator,
int  pFilterClass,
FbxUserNotification::EOutputSource  pSrc = FbxUserNotification::eSequencedDetails,
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 EClass identifiers. An FbxAccumulatorEntry 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 == eAccumulatorEntry and, if set to false, the details of the FbxAccumulatorEntry are also sent to the output devices. If left to its default value, only the description of the FbxAccumulatorEntry is sent.
virtual ~FbxUserNotificationFilteredIterator ( ) [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.

FbxAccumulatorEntry* const First ( )

Get this iterator's first item.

Returns:
NULL if the iterator is empty.
FbxAccumulatorEntry* 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).
FbxAccumulatorEntry* 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 ( FbxUserNotification pAccumulator ) [protected, virtual]

Member Data Documentation

int mIterator [protected]
int mFilterClass [protected]
bool mNoDetail [protected]

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