---

HBCI::ProgressMonitor Class Reference

Interface class to show the progress of an action in HBCIAPI. More...

#include <progressmonitor.h>

Inheritance diagram for HBCI::ProgressMonitor:

[legend]List of all members.

Public Methods
	ProgressMonitor ()
virtual	~ProgressMonitor ()
virtual void	transactionStarted (TransProgressType type, string const &descr, int jobs)
	This method is called before starting a transaction.
virtual void	transactionFinished ()
	This method is called after a transaction has finished.
virtual void	jobStarted (JobProgressType type, const string &descr, int actions)
	This method is called before a job starts.
virtual void	jobFinished ()
	This method is called after a job finished.
virtual void	actionStarted (ActionProgressType type, const string &descr)
	This method is called before an action starts.
virtual void	actionFinished ()
	This method is called after an action finshed.
virtual void	logMessage (const string &msg)
	DEPRECATED. This method is not used inside OpenHBCI.

---

Detailed Description

Interface class to show the progress of an action in HBCIAPI.

This class is used to show the progress of an action. It dumps the messages to stderr, so if you really want to use this class you should inherit this one and overload the methods. One object of this class sits in HBCIAPI and is therefore used for all progress reports.

Author:

Martin Preuss<martin@libchipcard.de>

---

Constructor & Destructor Documentation

HBCI::ProgressMonitor::ProgressMonitor (    )  [inline]

virtual HBCI::ProgressMonitor::~ProgressMonitor (    )  [inline, virtual]

---

Member Function Documentation

virtual void HBCI::ProgressMonitor::actionFinished (    )  [virtual]

This method is called after an action finshed. Tells this class that an action finished, i.e. the current action is done. A derived class can use this to advance the current job's progress bar, or to write the message "done" into the appropriate line of its progress report window. Author: Martin Preuss<martin@aquamaniac.de> Reimplemented in HBCI::ProgressMonitorCB.

virtual void HBCI::ProgressMonitor::actionStarted (  ActionProgressType    type, const string &    descr )  [virtual]

This method is called before an action starts. Tells this class that an action starts, and what action is to be performed now. A derived class can use this to show what is currently done. If you do not plan to give any kind of report to the user then you have to overload this method with your version just doing nothing. The default version of this method writes a short description to stderr (for now, I guess I will later make this method do nothing. So it is generally a good idea to overload this method). Author: Martin Preuss<martin@aquamaniac.de> Parameters: type  Constant describing the type of action that is performed. descr  short description of what is to be done (like "sending data to server"). Reimplemented in HBCI::ProgressMonitorCB.

virtual void HBCI::ProgressMonitor::jobFinished (    )  [virtual]

This method is called after a job finished. Tells this class that the current job is finished. A derived class can use this to advance the transactions progress bar. Author: Martin Preuss<martin@aquamaniac.de> Reimplemented in HBCI::ProgressMonitorCB.

virtual void HBCI::ProgressMonitor::jobStarted (  JobProgressType    type, const string &    descr, int    actions )  [virtual]

This method is called before a job starts. A derived class can use this to show in its progress window what is currently done. Each job has one or more actions to perform, like sending data to the server, receiving data from the server etc. If you do not plan to give any kind of report to the user then you have to overload this method with your version just doing nothing. The default version of this method writes a short description to stderr (for now, I guess I will later make this method do nothing. So it is generally a good idea to overload this method). Author: Martin Preuss<martin@aquamaniac.de> Parameters: type  Constant describing the type of action that is performed. descr  short description of the job (like "Get Balance") actions  number of actions this job performs. This might be used to draw a progress bar for a job. Reimplemented in HBCI::ProgressMonitorCB.

virtual void HBCI::ProgressMonitor::logMessage (  const string &    msg )  [virtual]

DEPRECATED. This method is not used inside OpenHBCI. This method was meant to be called to log a message, but it is not used from inside OpenHBCI. It may or may not disappear in future releases. The only method to log messages in OpenHBCI is the HBCI::Interactor::msgStateResponse() method. The default version of this method writes a short description to stderr (for now, I guess I will later make this method do nothing.). Author: Martin Preuss<martin@aquamaniac.de> Parameters: msg  msg to show Reimplemented in HBCI::ProgressMonitorCB.

virtual void HBCI::ProgressMonitor::transactionFinished (    )  [virtual]

This method is called after a transaction has finished. This method tells this class that the transaction is finished. A derived class can use this to show the message "finished" in the transaction window. Author: Martin Preuss<martin@aquamaniac.de> Reimplemented in HBCI::ProgressMonitorCB.

virtual void HBCI::ProgressMonitor::transactionStarted (  TransProgressType    type, string const &    descr, int    jobs )  [virtual]

This method is called before starting a transaction. An example is when the outbox is executed: Before really doing so, the HBCI::API calls this method to give this class the opportunity to initialize a progress report. If you do not plan to give any kind of report to the user then you have to overload this method with your version just doing nothing. The default version of this method writes a short description to stderr (for now, I guess I will later make this method do nothing. So it is generally a good idea to overload this method). Author: Martin Preuss<martin@aquamaniac.de> Parameters: type  Constant describing the type of action that is performed. descr  short description about what is to be done jobs  number of jobs to be performed. For example API::executeQueue gives here the number of jobs in the outbox plus the number of customers affected multiplied by 2. This is because when connecting to an institute we have two other additional jobs to perform: opening the dialog and closing the dialog. Reimplemented in HBCI::ProgressMonitorCB.

---

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

• progressmonitor.h

---