Public Types | Public Member Functions | Protected Member Functions | List of all members
ibase::CDelegatedProgressManager Class Reference

Progress manager delegating cumulated progress result to another manager. More...

#include <CDelegatedProgressManager.h>

Inheritance diagram for ibase::CDelegatedProgressManager:
ibase::IProgressManager istd::IChangeable istd::IPolymorphic istd::IPolymorphic iqtgui::CProgressManagerGuiComp

Public Types

enum  ChangeFlags { CF_SESSIONS_NUMBER = 0x8621d0, CF_PROGRESS_CHANGED }
 
- Public Types inherited from istd::IChangeable
enum  ChangeFlags {
  CF_ACF_INTERNAL = 0, CF_ALL_DATA, CF_ANY, CF_DESTROYING,
  CF_DELEGATED, CF_NO_UNDO
}
 Data model change notification flags. More...
 
enum  SupportedOperations {
  SO_NONE = 0, SO_OBSERVE = 1 << 0, SO_COPY = 1 << 1, SO_CLONE = 1 << 2,
  SO_COMPARE = 1 << 3, SO_RESET = 1 << 4
}
 Flags for supported operations. More...
 
enum  CompatibilityMode { CM_STRICT, CM_WITHOUT_REFS, CM_WITH_REFS, CM_CONVERT }
 Control how relationship betweeen objects are interpreted. More...
 

Public Member Functions

 CDelegatedProgressManager ()
 Create progress manager without slave manager. More...
 
 CDelegatedProgressManager (IProgressManager *slaveManagerPtr, const QByteArray &progressId, const QString &description, bool isCancelable=false)
 Create progress manager with slave manager. More...
 
virtual ~CDelegatedProgressManager ()
 
double GetCumulatedProgress () const
 
virtual int BeginProgressSession (const QByteArray &progressId, const QString &description, bool isCancelable=false)
 Begin progress report session. More...
 
virtual void EndProgressSession (int sessionId)
 Close progress report session. More...
 
virtual void OnProgress (int sessionId, double currentProgress)
 Callback function for a progress event. More...
 
virtual bool IsCanceled (int sessionId) const
 Check if this processing operation should be canceled. More...
 
- Public Member Functions inherited from istd::IPolymorphic
virtual ~IPolymorphic ()
 
- Public Member Functions inherited from istd::IChangeable
virtual int GetSupportedOperations () const
 Get set of flags for supported operations. More...
 
virtual bool CopyFrom (const IChangeable &object, CompatibilityMode mode=CM_WITHOUT_REFS)
 Copy this object from another one. More...
 
virtual bool IsEqual (const IChangeable &object) const
 Compare this object with another object. More...
 
virtual IChangeableCloneMe (CompatibilityMode mode=CM_WITHOUT_REFS) const
 Make a copy of this object. More...
 
virtual bool ResetData (CompatibilityMode mode=CM_WITHOUT_REFS)
 Reset data to its default state. More...
 
virtual void BeginChanges (const ChangeSet &changeSet)
 Starts the change transaction. More...
 
virtual void EndChanges (const ChangeSet &changeSet)
 Ends the change transaction. More...
 
virtual void BeginChangeGroup (const ChangeSet &changeSet)
 Starts group of changes. More...
 
virtual void EndChangeGroup (const ChangeSet &changeSet)
 Ends group of changes. More...
 

Protected Member Functions

int GetOpenSessionsCount () const
 
virtual void OnCancelable (bool cancelState)
 Called when state of cancel operation has changed. More...
 
virtual void OnEndChanges (const ChangeSet &changeSet)
 Callback function for end change event. More...
 
- Protected Member Functions inherited from istd::IChangeable
virtual void OnBeginChanges ()
 Callback function for begin change event. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from istd::IChangeable
static const ChangeSetGetNoChanges ()
 Get empty set of changes. More...
 
static const ChangeSetGetAnyChange ()
 Get anonymous change set. More...
 
static const ChangeSetGetAllChanges ()
 Get anonymous change set. More...
 
static const ChangeSetGetDelegatedChanges ()
 Get delegated change set. More...
 

Detailed Description

Progress manager delegating cumulated progress result to another manager.

Definition at line 21 of file CDelegatedProgressManager.h.

Member Enumeration Documentation

Enumerator
CF_SESSIONS_NUMBER 
CF_PROGRESS_CHANGED 

Definition at line 26 of file CDelegatedProgressManager.h.

Constructor & Destructor Documentation

ibase::CDelegatedProgressManager::CDelegatedProgressManager ( )

Create progress manager without slave manager.

ibase::CDelegatedProgressManager::CDelegatedProgressManager ( IProgressManager slaveManagerPtr,
const QByteArray &  progressId,
const QString &  description,
bool  isCancelable = false 
)

Create progress manager with slave manager.

Parameters
slaveManagerPtrpointer to slave manager object.
progressIdID of type of progress slave manager session.
descriptionDescription of progress slave manager session.
virtual ibase::CDelegatedProgressManager::~CDelegatedProgressManager ( )
virtual

Member Function Documentation

virtual int ibase::CDelegatedProgressManager::BeginProgressSession ( const QByteArray &  progressId,
const QString &  description,
bool  isCancelable = false 
)
virtual

Begin progress report session.

Returns
session ID or negative value if failed.

Implements ibase::IProgressManager.

Reimplemented in iqtgui::CProgressManagerGuiComp.

virtual void ibase::CDelegatedProgressManager::EndProgressSession ( int  sessionId)
virtual

Close progress report session.

Parameters
sessionIdsession ID returned by BeginProgressSession.

Implements ibase::IProgressManager.

double ibase::CDelegatedProgressManager::GetCumulatedProgress ( ) const
int ibase::CDelegatedProgressManager::GetOpenSessionsCount ( ) const
protected
virtual bool ibase::CDelegatedProgressManager::IsCanceled ( int  sessionId) const
virtual

Check if this processing operation should be canceled.

Parameters
sessionIdsession ID returned by BeginProgressSession.

Implements ibase::IProgressManager.

Reimplemented in iqtgui::CProgressManagerGuiComp.

virtual void ibase::CDelegatedProgressManager::OnCancelable ( bool  cancelState)
protectedvirtual

Called when state of cancel operation has changed.

Reimplemented in iqtgui::CProgressManagerGuiComp.

virtual void ibase::CDelegatedProgressManager::OnEndChanges ( const ChangeSet changeSet)
protectedvirtual

Callback function for end change event.

Reimplemented from istd::IChangeable.

Reimplemented in iqtgui::CProgressManagerGuiComp.

virtual void ibase::CDelegatedProgressManager::OnProgress ( int  sessionId,
double  currentProgress 
)
virtual

Callback function for a progress event.

Parameters
sessionIdsession ID returned by BeginProgressSession.

Implements ibase::IProgressManager.


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

© 2007-2017 Witold Gantzke and Kirill Lepskiy