IlvPostScriptEncoder Class Reference

Base PostScript encoder class. More...

#include <ilviews/util/psencode.h>

Inheritance diagram for IlvPostScriptEncoder:

List of all members.

Public Member Functions
virtual	~IlvPostScriptEncoder ()
	Destructor.
virtual void	consumeByte (IlUChar byte)=0
	Consumes a byte.
virtual void	consumeBytes (IlUInt count, IlUChar const *bytes)
	Consumes an array of bytes. The default implementation calls consumeByte for each byte in the array.
virtual void	emitByte (IlUChar byte)
	Emits a byte.
virtual void	emitBytes (IlUInt count, IlUChar const *bytes)
	Emits an array of bytes.
virtual void	flush ()
	Flushes the processed data to the output. The default implementation does nothing.
IlvPostScriptEncoder *	getEmitter () const
	Return the emitter.
virtual const char *	getPostScriptDecoderName () const =0
	Returns a string containing the PostScript decoding filter name.
ostream *	getStream () const
	Return the stream used by this instance.
virtual void	init ()
	Initializes the instance. The default implementation does nothing.
void	setEmitter (IlvPostScriptEncoder *emitter)
	Sets the emitter for this encoder.
virtual void	setStream (ostream *stream)
	Sets the output stream used by this instance.
Static Public Member Functions
static IlString	GetFullDecoderString (const IlvPostScriptEncoder *encoder)
	Returns the full string for an encoder. It takes into account the sub filters.
Protected Member Functions
	IlvPostScriptEncoder (ostream *stream=0)
	Constructor.

---

Detailed Description

Base PostScript encoder class.

Library: display

This class allows you to encode binary data to another data representation in a PostScript compatible format. These encoders can only be used when using PostScript Level 2. Encoders can be chained.

See also IlvHexEncoder, IlvASCII85Encoder, IlvRunLengthEncoder, IlvPSDevice, IlvPSColorDevice

---

Constructor & Destructor Documentation

IlvPostScriptEncoder::IlvPostScriptEncoder

(

ostream *

stream = 0

)

[protected]

Constructor.

Initializes a new instance of IlvPostScriptEncoder.

Parameters:

stream

the output stream used by this instance.

---

Member Function Documentation

virtual void IlvPostScriptEncoder::consumeByte

(

IlUChar

byte

)

[pure virtual]

Consumes a byte.

Parameters:

byte

The received byte.

Implemented in IlvASCIIHexEncoder, IlvASCII85Encoder, and IlvRunLengthEncoder.

virtual void IlvPostScriptEncoder::consumeBytes	(	IlUInt	count,
		IlUChar const *	bytes
	)			[virtual]

Consumes an array of bytes. The default implementation calls consumeByte for each byte in the array.

Parameters:

	count	The number of bytes.
	bytes	A pointer to the first element in the array.

virtual void IlvPostScriptEncoder::emitByte

(

IlUChar

byte

)

[virtual]

Emits a byte.

Parameters:

byte

The emitted byte.

virtual void IlvPostScriptEncoder::emitBytes	(	IlUInt	count,
		IlUChar const *	bytes
	)			[virtual]

Emits an array of bytes.

The default implementation calls consumeByte for each byte in the array.

Parameters:

	count	The number of bytes.
	bytes	A pointer to the first element in the array.

IlvPostScriptEncoder* IlvPostScriptEncoder::getEmitter

(

)

const

Return the emitter.

Returns:

The emitter.

static IlString IlvPostScriptEncoder::GetFullDecoderString

(

const IlvPostScriptEncoder *

encoder

)

[static]

Returns the full string for an encoder. It takes into account the sub filters.

Returns:

The string for this encoder.

virtual const char* IlvPostScriptEncoder::getPostScriptDecoderName

(

)

const [pure virtual]

Returns a string containing the PostScript decoding filter name.

Returns:

The name of the PostScript decoding filter.

Implemented in IlvASCIIHexEncoder, IlvASCII85Encoder, and IlvRunLengthEncoder.

ostream* IlvPostScriptEncoder::getStream

(

)

const

Return the stream used by this instance.

Returns:

The stream.

void IlvPostScriptEncoder::setEmitter

(

IlvPostScriptEncoder *

emitter

)

Sets the emitter for this encoder.

Parameters:

emitter

The new emitter.

virtual void IlvPostScriptEncoder::setStream

(

ostream *

stream

)

[virtual]

Sets the output stream used by this instance.

Parameters:

stream

The new output stream.