CContentWriteIterator Class Reference

#include <CContentIterator.h>

Inheritance diagram for CContentWriteIterator:

Public Member Functions
	CContentWriteIterator (CContentIterator &iterator)
void	SetIterator (CContentIterator *iterator)
void	BeginList (ListType listType)
void	EndList ()
void	CreateClassID (ClassID id)
uint32	CloseClassID (ClassID id)
void	CreateImplementationID (ImplementationID id)
uint32	CloseImplementationID (ImplementationID id)
void	AbortID ()
void	Reset ()
IPMStream *	QueryContentStream ()
int32	GetOriginPosition () const
Public Member Functions inherited from IContentWriteIterator
virtual	~IContentWriteIterator ()

Additional Inherited Members
Public Types inherited from IContentWriteIterator
enum	ListType {   kNoList, kAttributeList16, kAttributeList32, kAttributeBossList1616,   kAttributeBossList1632, kAttributeBossList3216, kAttributeBossList3232 }

Detailed Description

This class provides a generic implementation of the IContentWriteIterator interface. It uses an aggregated instance of CContentIterator to perform the actual work.

The individual methods are not documented here, they correspond exactly to those documented for IContentWriteIterator.

See Also

IContentWriteIterator

CContentIterator

Member Function Documentation

void CContentWriteIterator::AbortID ( )

inlinevirtual

Used as an alternative to CloseClassID() or CloseImplementationID() if the Conversion Manager decides to delete the data rather than convert it.

Implements IContentWriteIterator.

void CContentWriteIterator::BeginList ( ListType  listType )

inlinevirtual

Called when starting a nested list of classes or implementations.

Parameters

listType

IN The type of nested list we are creating.

Implements IContentWriteIterator.

uint32 CContentWriteIterator::CloseClassID ( ClassID  id )

inlinevirtual

Called when data output for a particular class is complete.

Parameters

id	IN The final class ID (may be different that the value passed to CreateClassID() if the class was renumbered during conversion).

Returns

The number of bytes of class data that were written.

Implements IContentWriteIterator.

uint32 CContentWriteIterator::CloseImplementationID ( ImplementationID  id )

inlinevirtual

Called when data output for a particular implementation is complete.

Parameters

id	IN The final implementation ID (may be different that the value passed to CreateImplementationID() if the implementation was renumbered during conversion).

Returns

The number of bytes of implementation data that were written.

Implements IContentWriteIterator.

void CContentWriteIterator::CreateClassID ( ClassID  id )

inlinevirtual

Called when starting data output for a particular class.

Parameters

id	IN The class ID.

Implements IContentWriteIterator.

void CContentWriteIterator::CreateImplementationID ( ImplementationID  id )

inlinevirtual

Called when starting data output for a particular implementation.

Parameters

id	IN The implementation ID.

Implements IContentWriteIterator.

void CContentWriteIterator::EndList ( )

inlinevirtual

Called when a nested list is complete.

Implements IContentWriteIterator.

int32 CContentWriteIterator::GetOriginPosition ( ) const

inlinevirtual

Returns the initial position of the output stream associated with this iterator. That is – the stream's position at the time the iterator was bound to it.

Returns

The original stream position.

Implements IContentWriteIterator.

IPMStream* CContentWriteIterator::QueryContentStream ( )

inlinevirtual

Returns an interface pointer to the iterator's associated output stream. The interface is add-refed prior to returning the pointer.

Returns

The stream pointer.

Implements IContentWriteIterator.

void CContentWriteIterator::Reset ( )

inlinevirtual

Called when the Conversion Manager is finished with this iterator. The iterator should flushing pending output, release cached resources, etc.

Implements IContentWriteIterator.