Views
Foundation Package API Reference Guide
Product Documentation:
Views Documentation Home
List of all members | Public Member Functions | Static Public Member Functions | Protected Member Functions
IlvPostScriptEncoder Class Referenceabstract

Base PostScript encoder class. More...

#include <ilviews/util/psencode.h>

Inheritance diagram for IlvPostScriptEncoder:
IlvASCII85Encoder IlvASCIIHexEncoder IlvRunLengthEncoder

Public Member Functions

virtual void consumeByte (IlUChar byte)=0
 Consumes a byte. More...
 
virtual void consumeBytes (IlUInt count, IlUChar const *bytes)
 Consumes an array of bytes. More...
 
virtual void emitByte (IlUChar byte)
 Emits a byte. More...
 
virtual void emitBytes (IlUInt count, IlUChar const *bytes)
 Emits an array of bytes. More...
 
virtual void flush ()
 Flushes the processed data to the output. More...
 
IlvPostScriptEncodergetEmitter () const
 Return the emitter. More...
 
virtual const char * getPostScriptDecoderName () const =0
 Returns a string containing the PostScript decoding filter name. More...
 
std::ostream * getStream () const
 Return the stream used by this instance. More...
 
virtual void init ()
 Initializes the instance. More...
 
void setEmitter (IlvPostScriptEncoder *emitter)
 Sets the emitter for this encoder. More...
 
virtual void setStream (std::ostream *stream)
 Sets the output stream used by this instance. More...
 

Static Public Member Functions

static IlString GetFullDecoderString (const IlvPostScriptEncoder *pse)
 Returns the full string for an encoder. More...
 

Protected Member Functions

 IlvPostScriptEncoder (std::ostream *stream=0)
 Initializes a new instance IlvPostScriptEncoder instance. More...
 

Detailed Description

Base PostScript encoder class.

Library: xviews or winviews or mviews (mutually exclusive)

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::IlvPostScriptEncoder ( std::ostream *  stream = 0)
protected

Initializes a new instance IlvPostScriptEncoder instance.

Parameters
streamthe output stream used by this instance.

Member Function Documentation

◆ consumeByte()

virtual void IlvPostScriptEncoder::consumeByte ( IlUChar  byte)
pure virtual

Consumes a byte.

Parameters
byteThe received byte.

Implemented in IlvRunLengthEncoder, IlvASCII85Encoder, and IlvASCIIHexEncoder.

◆ consumeBytes()

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
countThe number of bytes.
bytesA pointer to the first element in the array.

◆ emitByte()

virtual void IlvPostScriptEncoder::emitByte ( IlUChar  byte)
virtual

Emits a byte.

Parameters
byteThe emitted byte.

◆ emitBytes()

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
countThe number of bytes.
bytesA pointer to the first element in the array.

◆ flush()

virtual void IlvPostScriptEncoder::flush ( )
virtual

Flushes the processed data to the output.

The default implementation does nothing.

Reimplemented in IlvRunLengthEncoder, IlvASCII85Encoder, and IlvASCIIHexEncoder.

◆ getEmitter()

IlvPostScriptEncoder* IlvPostScriptEncoder::getEmitter ( ) const

Return the emitter.

Returns
The emitter.

◆ GetFullDecoderString()

static IlString IlvPostScriptEncoder::GetFullDecoderString ( const IlvPostScriptEncoder pse)
static

Returns the full string for an encoder.

It takes into account the sub filters.

Parameters
pseA pointer to the PostScript encoder.
Returns
The string for this encoder.

◆ getPostScriptDecoderName()

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 IlvRunLengthEncoder, IlvASCII85Encoder, and IlvASCIIHexEncoder.

◆ getStream()

std::ostream* IlvPostScriptEncoder::getStream ( ) const

Return the stream used by this instance.

Returns
The stream.

◆ init()

virtual void IlvPostScriptEncoder::init ( )
virtual

Initializes the instance.

The default implementation does nothing.

Reimplemented in IlvRunLengthEncoder, IlvASCII85Encoder, and IlvASCIIHexEncoder.

◆ setEmitter()

void IlvPostScriptEncoder::setEmitter ( IlvPostScriptEncoder emitter)

Sets the emitter for this encoder.

Parameters
emitterThe new emitter.

◆ setStream()

virtual void IlvPostScriptEncoder::setStream ( std::ostream *  stream)
virtual

Sets the output stream used by this instance.

Parameters
streamThe new output stream.