OdDbHostAppProgressMeter Class Reference

#include <DbHostAppProgressMeter.h>

Inheritance diagram for OdDbHostAppProgressMeter:

Public Member Functions
virtual	~OdDbHostAppProgressMeter ()
virtual void	start (const OdString &displayString=OdString::kEmpty)=0
virtual void	stop ()=0
virtual void	meterProgress ()=0
virtual void	setLimit (int max)=0

Detailed Description

This class is the base class for platform specific progress metering within the ODA Platform.

Corresponding C++ library: TD_Db

Remarks

This class receives progress notifications during various database operations such as loading or saving a file.

Calls to an instance of this class will always come in the following order:

1. setLimit (called once).
2. start (called once).
3. meterProgress (called repeatedly).
4. stop (called once).

<group OdDb_Classes>

Definition at line 57 of file DbHostAppProgressMeter.h.

Constructor & Destructor Documentation

~OdDbHostAppProgressMeter()

virtual OdDbHostAppProgressMeter::~OdDbHostAppProgressMeter ( )

virtual

Virtual destructor.

Member Function Documentation

meterProgress()

virtual void OdDbHostAppProgressMeter::meterProgress ( )

pure virtual

Notification function called to increment this ProgressMeter object.

Remarks

The completion percentage may be calculated by dividing the number of times this function is called by the value set by setLimit.

Throwing an exception indicates that the operation associated with this ProgressMeter object should be halted.

Implemented in CFxBIMRevitHostAppProgressMeter.

setLimit()

virtual void OdDbHostAppProgressMeter::setLimit ( int max )

pure virtual

Notification function called to specify the maximum number of times this ProgressMeter object will be incremented.

Parameters

max	[in] Maximum meterProgress calls.

Implemented in CFxBIMRevitHostAppProgressMeter.

start()

virtual void OdDbHostAppProgressMeter::start ( const OdString & displayString = OdString::kEmpty )

pure virtual

Notification function called to initialize this ProgressMeter object.

Parameters

displayString

[in] String to be displayed.

Implemented in CFxBIMRevitHostAppProgressMeter.

stop()

virtual void OdDbHostAppProgressMeter::stop ( )

pure virtual

Notification function called to terminate this ProgressMeter object.

Implemented in CFxBIMRevitHostAppProgressMeter.

---

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

• DbHostAppProgressMeter.h