It is an Executor class which uncompresses files of zip format but user should instead use ZipUtils::UnZipArchive() to unzip complete archive or ZipUtils::UnZipFile() to take one file out of zip archive. More...

Inheritance diagram for UnZipper:

[legend]

Public Member Functions
	UnZipper (const char , const char )

bool	isOk () const

od_int64	nrDone () const override

od_int64	totalNr () const override

uiString	uiMessage () const override
	will be message() again in 7.x More...

uiString	uiNrDoneText () const override
	will be nrDoneText() in 7.x More...

Public Member Functions inherited from Executor
	Executor (const char *nm)

virtual	~Executor ()

int	doStep () override

bool	execute () override

bool	go (od_ostream &s, bool isfirst=true, bool islast=true, int delaybtwnstepsinms=0)

bool	go (od_ostream *s=0, bool isfirst=true, bool islast=true, int delaybtwnstepsinms=0)

Public Member Functions inherited from SequentialTask
	SequentialTask (const char *nm=nullptr)

virtual	~SequentialTask ()

bool	execute () override

Public Member Functions inherited from ReportingTask
virtual	~ReportingTask ()

void	getProgress (const ReportingTask &)

Public Member Functions inherited from Task
virtual	~Task ()

virtual void	controlWork (Control)

virtual void	enableWorkControl (bool=true)
	Must be called before execute() More...

virtual uiRetVal	errorWithDetails () const

virtual Control	getState () const

bool	workControlEnabled () const

Public Member Functions inherited from NamedCallBacker
	NamedCallBacker (const char *nm=0)

	NamedCallBacker (const NamedCallBacker &)

virtual Notifier< NamedCallBacker > &	objectToBeDeleted () const

bool	operator== (const NamedCallBacker &oth) const

bool	operator== (const NamedObject &oth) const

Public Member Functions inherited from CallBacker
	CallBacker ()

	CallBacker (const CallBacker &)

virtual	~CallBacker ()

bool	attachCB (const NotifierAccess &, const CallBack &, bool onlyifnew=false) const

bool	attachCB (const NotifierAccess *notif, const CallBack &cb, bool onlyifnew=false) const

void	detachAllNotifiers () const
	Call from the destructor of your inherited object. More...

void	detachCB (const NotifierAccess &, const CallBack &) const

void	detachCB (const NotifierAccess *notif, const CallBack &cb) const

virtual bool	isCapsule () const

bool	isNotifierAttached (const NotifierAccess *) const
	Only for debugging purposes, don't use. More...

void	stopReceivingNotifications () const

virtual CallBacker *	trueCaller ()

Public Member Functions inherited from NamedObject
	NamedObject (const char *nm=nullptr)

	NamedObject (const NamedObject &oth)

virtual	~NamedObject ()

virtual BufferString	getName () const

bool	getNameFromPar (const IOPar &)

const name_type &	name () const override

NamedObject &	operator= (const NamedObject &)

bool	operator== (const NamedObject &oth) const

virtual void	setName (const char *nm)

Public Member Functions inherited from ObjectWithName
virtual	~ObjectWithName ()

bool	hasName (const char *nm) const

bool	hasName (const name_type &nm) const

void	putNameInPar (IOPar &) const

Protected Member Functions
int	nextStep () override

Protected Member Functions inherited from Executor
virtual bool	goImpl (od_ostream *, bool, bool, int)

Protected Member Functions inherited from ReportingTask
	ReportingTask (const char *nm=nullptr)

void	incrementProgress ()

ProgressMeter *	progressMeter () const

void	reportProgressFinished ()

void	reportProgressStarted ()

void	resetProgress ()

void	setProgressMeter (ProgressMeter *) override
	Must be called before execute() More...

void	updateProgressMeter (bool forced=false, std::int64_t *totalnr=0)

void	updateReportedName ()

Protected Member Functions inherited from Task
	Task (const char *nm=nullptr)

virtual bool	shouldContinue ()

Protected Member Functions inherited from NamedCallBacker
void	sendDelNotif () const

Protected Attributes
bool	isok_

int	nrdone_

ZipHandler	ziphd_

Protected Attributes inherited from Task
Control	control_

Threads::ConditionVar *	workcontrolcondvar_

Protected Attributes inherited from NamedCallBacker
Threads::Atomic< bool >	delalreadytriggered_

Notifier< NamedCallBacker >	delnotif_

Protected Attributes inherited from NamedObject
BufferString	name_

Additional Inherited Members
Public Types inherited from Task
enum	Control { Run , Pause , Stop }

Public Types inherited from ObjectWithName
typedef OD::String	name_type

Static Public Member Functions inherited from SequentialTask
static int	ErrorOccurred ()

static int	Finished ()

static int	MoreToDo ()

static int	WarningAvailable ()

Static Public Member Functions inherited from Task
static uiString	stdNrDoneText ()

static uiString	uiStdNrDoneText ()

Static Public Member Functions inherited from CallBacker
static void	createReceiverForCurrentThread ()

static void	removeReceiverForCurrentThread ()

Public Attributes inherited from Executor
Notifier< Executor >	poststep
	Only when MoreToDo will be returned. More...

Notifier< Executor >	prestep

Public Attributes inherited from ReportingTask
Notifier< ReportingTask >	progressUpdated

Detailed Description

It is an Executor class which uncompresses files of zip format but user should instead use ZipUtils::UnZipArchive() to unzip complete archive or ZipUtils::UnZipFile() to take one file out of zip archive.

<>

Constructor & Destructor Documentation

◆ UnZipper()

UnZipper::UnZipper	(	const char *	,
		const char *
	)

Member Function Documentation

◆ isOk()

bool UnZipper::isOk ( ) const

inline

◆ nextStep()

int UnZipper::nextStep ( )

overrideprotectedvirtual

Return values

MoreToDo()	Not finished. Call me again.
Finished()	Nothing more to do.
ErrorOccurred()	Something went wrong.

Note: if function returns a value greater than cMoreToDo(), it should be interpreted as cMoreToDo().

Implements SequentialTask.

◆ nrDone()

od_int64 UnZipper::nrDone ( ) const

overridevirtual

Note: nrDone is only used for displaying progress and will be compared to totalNr to show user how large part of the task that is finished.

Reimplemented from Task.

◆ totalNr()

od_int64 UnZipper::totalNr ( ) const

overridevirtual

Reimplemented from Task.

◆ uiMessage()

uiString UnZipper::uiMessage ( ) const

overridevirtual

will be message() again in 7.x

Reimplemented from Task.

◆ uiNrDoneText()

uiString UnZipper::uiNrDoneText ( ) const

overridevirtual

will be nrDoneText() in 7.x

Reimplemented from Task.

Member Data Documentation

◆ isok_

bool UnZipper::isok_

protected

◆ nrdone_

int UnZipper::nrdone_

protected

◆ ziphd_

ZipHandler UnZipper::ziphd_

protected

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ UnZipper()

Member Function Documentation

◆ isOk()

◆ nextStep()

◆ nrDone()

◆ totalNr()

◆ uiMessage()

◆ uiNrDoneText()

Member Data Documentation

◆ isok_

◆ nrdone_

◆ ziphd_