EBzip2 Class Reference

#include <ebzip2.h>

Public Member Functions
	EBzip2 ()
	Class constructor. More...
	~EBzip2 ()
	Class destructor. More...
EString &	setFileName (cpStr filename)
	Sets the file name that to be operated on. More...
EString &	getFileName ()
	Gets the file name that to be operated on. More...
cChar	setTerminator (cChar c)
	Sets the line terminator used by readLine(). More...
cChar	getTerminator ()
	Gets the line terminator used by readLine(). More...
Int	getLastError ()
	Gets the last error value that occurred. More...
ULongLong	getBytesIn ()
	The number of uncompressed bytes associated with the file written. More...
ULongLong	getBytesOut ()
	The number of compressed bytes associated with the file written. More...
Bool	isOpen ()
	True - the file is open, False - the file is closed. More...
Void	readOpen (cpStr filename)
	Open the file for reading. More...
Void	writeOpen (cpStr filename)
	Open the file for writing. More...
Void	close ()
	Close the file. More...
Int	read (pUChar pbuf, Int length)
	Read a specified number of decompressed bytes. More...
Int	readLine (pStr pbuf, Int length)
	Read a decompressed line terminated by the supplied terminator. More...
Int	write (pUChar pbuf, Int length)
	Write the specified number of decompressed bytes. More...

Static Public Member Functions
static cpStr	getErrorDesc (Int e)
	Gets the description of the specified error value. More...

Constructor & Destructor Documentation

EBzip2()

EBzip2::EBzip2

(

)

Class constructor.

~EBzip2()

EBzip2::~EBzip2

(

)

Class destructor.

Member Function Documentation

close()

void EBzip2::close

(

)

Close the file.

getBytesIn()

ULongLong EBzip2::getBytesIn ( )

inline

The number of uncompressed bytes associated with the file written.

getBytesOut()

ULongLong EBzip2::getBytesOut ( )

inline

The number of compressed bytes associated with the file written.

getErrorDesc()

cpStr EBzip2::getErrorDesc ( Int  e )

static

Gets the description of the specified error value.

getFileName()

EString& EBzip2::getFileName ( )

inline

Gets the file name that to be operated on.

getLastError()

Int EBzip2::getLastError ( )

inline

Gets the last error value that occurred.

getTerminator()

cChar EBzip2::getTerminator ( )

inline

Gets the line terminator used by readLine().

isOpen()

Bool EBzip2::isOpen ( )

inline

True - the file is open, False - the file is closed.

read()

Int EBzip2::read	(	pUChar	pbuf,
		Int	length
	)

Read a specified number of decompressed bytes.

readLine()

Int EBzip2::readLine	(	pStr	pbuf,
		Int	length
	)

Read a decompressed line terminated by the supplied terminator.

readOpen()

Void EBzip2::readOpen

(

cpStr

filename

)

Open the file for reading.

setFileName()

EString& EBzip2::setFileName ( cpStr  filename )

inline

Sets the file name that to be operated on.

setTerminator()

cChar EBzip2::setTerminator ( cChar  c )

inline

Sets the line terminator used by readLine().

write()

Int EBzip2::write	(	pUChar	pbuf,
		Int	length
	)

Write the specified number of decompressed bytes.

writeOpen()

Void EBzip2::writeOpen

(

cpStr

filename

)

Open the file for writing.

---

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

• /home/vagrant/share/code/epctools/include/epc/ebzip2.h
• /home/vagrant/share/code/epctools/src/ebzip2.cpp