Inheritance diagram for encoder:

Collaboration diagram for encoder:

Public Member Functions
	encoder ()

virtual	~encoder ()

virtual size_t	encode (utility::inputStream &in, utility::outputStream &out, utility::progressListener *progress=NULL)=0

virtual size_t	decode (utility::inputStream &in, utility::outputStream &out, utility::progressListener *progress=NULL)=0

const propertySet &	getProperties () const

propertySet &	getProperties ()

virtual const std::vector< string >	getAvailableProperties () const

const propertySet &	getResults () const

virtual size_t	getEncodedSize (const size_t n) const =0

virtual size_t	getDecodedSize (const size_t n) const =0

Protected Member Functions
propertySet &	getResults ()

Protected Member Functions inherited from object
	object ()

	object (const object &)

object &	operator= (const object &)

virtual	~object ()

Detailed Description

Encode/decode data in different encodings.

Constructor & Destructor Documentation

encoder ( )

~encoder ( )

virtual

Member Function Documentation

virtual size_t decode	(	utility::inputStream &	in,
		utility::outputStream &	out,
		utility::progressListener *	progress = `NULL`
	)

pure virtual

Decode data.

Parameters

in	input data (encoded)
out	output stream for decoded data
progress	progress listener, or NULL if you do not want to receive progress notifications

Returns: number of bytes written into output stream

Implemented in b64Encoder, noopEncoder, qpEncoder, and uuEncoder.

virtual size_t encode	(	utility::inputStream &	in,
		utility::outputStream &	out,
		utility::progressListener *	progress = `NULL`
	)

pure virtual

Encode data.

Parameters

in	input data (decoded)
out	output stream for encoded data
progress	progress listener, or NULL if you do not want to receive progress notifications

Returns: number of bytes written into output stream

Implemented in b64Encoder, noopEncoder, qpEncoder, and uuEncoder.

const std::vector< string > getAvailableProperties ( ) const

virtual

Return a list of property names that can be set for this encoder.

Returns: list of property names

Reimplemented in b64Encoder, qpEncoder, and uuEncoder.

Referenced by b64Encoder::getAvailableProperties(), uuEncoder::getAvailableProperties(), and qpEncoder::getAvailableProperties().

virtual size_t getDecodedSize ( const size_t n ) const

pure virtual

Return the encoded size for the specified input (encoded) size.

If the size is not exact, it may be an estimate which should always be larger than the actual decoded size.

Parameters

n	count of input (encoded) bytes

Returns: count of output (decoded) bytes

Implemented in qpEncoder, b64Encoder, uuEncoder, and noopEncoder.

virtual size_t getEncodedSize ( const size_t n ) const

pure virtual

Return the encoded size for the specified input (decoded) size.

If the size is not exact, it may be an estimate which should always be larger than the actual encoded size.

Parameters

n	count of input (decoded) bytes

Returns: count of output (encoded) bytes

Implemented in qpEncoder, b64Encoder, uuEncoder, and noopEncoder.

const propertySet & getProperties ( ) const

Return the properties of the encoder.

Returns: properties of the encoder

Referenced by qpEncoder::decode(), uuEncoder::encode(), b64Encoder::encode(), qpEncoder::encode(), b64Encoder::getEncodedSize(), qpEncoder::getEncodedSize(), and uuEncoder::uuEncoder().

propertySet & getProperties ( )

Return the properties of the encoder.

Returns: properties of the encoder

const propertySet & getResults ( ) const

Return the results returned by this encoder.

Returns: results returned by the encoder

Referenced by uuEncoder::decode().

propertySet & getResults ( )

protected

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

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation