Class: TTextChunkIteratorReference

Declaration: BreakWord.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

None.

Inherited By:

None.

Purpose:

A monomorphic class that references a TTextChunkIterator; that is, it is a class used to reference TTextChunkIterators for the purpose of streaming them to different address spaces, either locally or on remote systems. After being streamed back in TTextChunkIterator references call TTextChunkIteratorReference::IsValid and take the proper action if this function returns false.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

This class should not be derived.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TTextChunkIteratorReference::IsValid

virtual bool IsValid ()

Interface Category:

API.

Purpose:

Returns the status of the particular TTextChunkIteratorReference object.

Calling Context:

Called after streaming in a TTextChunkIteratorReference object to make sure it is valid.

Parameters:

Takes no parameters.

Return Value:

Returns true if the TTextChunkIteratorReference is valid.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TTextChunkIteratorReference::CreateTextChunkIterator

virtual TTextChunkIterator * CreateTextChunkIterator (const TText * text, const TInsertionOffset & ip =TTextChunkIterator :: kInitialInsertionOffset)

Interface Category:

API.

Purpose:

Creates a TTextChunkIterator object from an iterator reference.

Calling Context:

Called to create a TTextChunkIterator object.

Parameters:

const TText * text -A pointer to the text to be iterated over.
const TInsertionOffset & ip =TTextChunkIterator:: kInitialInsertionOffset-The initial starting point for the iterator. The default value is the first insertion point of the text.

Return Value:

A pointer to a TTextChunkIterator object.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TTextChunkIteratorReference::operator=

virtual TTextChunkIteratorReference & operator =(const TTextChunkIteratorReference &)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

const TTextChunkIteratorReference & -The source object for the assignment.

Return Value:

A non-const reference to the left-hand side object.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TTextChunkIteratorReference::operator!=

virtual bool operator != (const TTextChunkIteratorReference &) const

Interface Category:

API.

Purpose:

Compares two objects for inequality.

Calling Context:

Called to compare two objects.

Parameters:

const TTextChunkIteratorReference & -The object to compare with this object.

Return Value:

Returns true if the objects are not equal.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TTextChunkIteratorReference::operator==

virtual bool operator ==(const TTextChunkIteratorReference &) const

Interface Category:

API.

Purpose:

Compares two objects for equality.

Calling Context:

Called to compare two objects.

Parameters:

const TTextChunkIteratorReference & -The object to compare with this object.

Return Value:

Returns true if the objects are equal.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TTextChunkIteratorReference::~TTextChunkIteratorReference

virtual ~ TTextChunkIteratorReference ()

Interface Category:

API.

Purpose:

Destructor.

Calling Context:

Called to destroy an object.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TTextChunkIteratorReference::TTextChunkIteratorReference

TTextChunkIteratorReference ()
TTextChunkIteratorReference (const TTextChunkIteratorReference &)

Interface Category:

API.

Purpose:

Default constructor.
Copy constructor.

Calling Context:

Called by the stream-in operators.
Called to copy an object.

Parameters:

Takes no parameters.
const TTextChunkIteratorReference & -The object to copy.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TTextChunkIteratorReference::operator<<=

virtual TStream & operator <<= (TStream & fromWhere)

Interface Category:

API.

Purpose:

Stream-in operator.

Calling Context:

Called to stream in data.

Parameters:

TStream & fromWhere -The stream the object is streamed in from.

Return Value:

Returns a reference to the stream the object streams itself in from.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TTextChunkIteratorReference::operator>>=

virtual TStream & operator >>=(TStream & toWhere)

Interface Category:

API.

Purpose:

Stream-out operator.

Calling Context:

Called to stream out data.

Parameters:

TStream & toWhere -The stream the object is streamed out to.

Return Value:

Returns a reference to the stream the object streams itself out to.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Click the icon to mail questions or corrections about this material to Taligent personnel.