BT_RLP_TokenIteratorFactory Class Reference

RLP Token Iterator Factory. More...

#include <bt_rlp_token_iterator.h>

List of all members.

Public Member Functions

virtual BT_RLP_TokenIteratorCreateIterator (BT_RLP_Context const *context)=0
 Returns a new iterator.
virtual void Destroy ()=0
 Destroys a factory.
virtual bool GetReturnCompoundComponents () const =0
 Returns the setting for compound components.
virtual bool GetReturnReadings () const =0
 Returns the setting for readings.
virtual void SetReturnCompoundComponents (bool flag)=0
 Specifies whether iterators should return compound components.
virtual void SetReturnReadings (bool flag)=0
 Specifies whether iterators should return readings.

Static Public Member Functions

static
BT_RLP_TokenIteratorFactory
Create ()
 Creates a token factory iterator.


Detailed Description

This class provides a factory to create objects of type BT_RLP_Token_Iterator. To use these classes, create a factory object and then call into it to set the parameters for the iterator(s) that you need. Call CreateIterator with a BT_RLP_Context to get an iterator that reflects the current settings of the factory.

You must destroy the factory by calling the Destroy method; we do not provide a public destructor to avoid issues with operator new/delete on some platforms.


Member Function Documentation

static BT_RLP_TokenIteratorFactory* BT_RLP_TokenIteratorFactory::Create (  )  [static]

The iterator is created with the default properties.

Returns:
The factory. This will return 0 only if operator new is incapable of allocation memory for the factory.

virtual BT_RLP_TokenIterator* BT_RLP_TokenIteratorFactory::CreateIterator ( BT_RLP_Context const *  context  )  [pure virtual]

This members returns a new token iterator object. The new object will iterate over the tokens of the supplied context.

Parameters:
context The context to iterate over.

virtual void BT_RLP_TokenIteratorFactory::SetReturnCompoundComponents ( bool  flag  )  [pure virtual]

This member specifies whether iterators from this factory will retrieve and return compound components.

Parameters:
flag Whether the iterators should read out and return compound components.

virtual void BT_RLP_TokenIteratorFactory::SetReturnReadings ( bool  flag  )  [pure virtual]

This member specifies whether iterators from this factory will retrieve and return readings.

Parameters:
flag Whether the iterators should read out and return readings.


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

Copyright © 2004-2008 Basis Technology Corporation. All Rights Reserved.