Medical Imaging Interaction Toolkit  2022.10.99-122321bb
Medical Imaging Interaction Toolkit
berry::ProgressProvider Struct Referenceabstract

#include <berryProgressProvider.h>

Inheritance diagram for berry::ProgressProvider:
Collaboration diagram for berry::ProgressProvider:

Public Member Functions

 berryObjectMacro (ProgressProvider)
 
virtual IProgressMonitor::Pointer CreateMonitor (Job::Pointer job)=0
 
virtual IProgressMonitor::Pointer CreateProgressGroup ()
 
virtual IProgressMonitor::Pointer CreateMonitor (Job::Pointer sptr_job, IProgressMonitor::Pointer sptr_group, int ticks)
 
virtual IProgressMonitor::Pointer GetDefaultMonitor ()
 
- Public Member Functions inherited from berry::Object
virtual QString GetClassName () const
 
virtual Reflection::TypeInfo GetTypeInfo () const
 
virtual QList< Reflection::TypeInfoGetSuperclasses () const
 
virtual void Delete ()
 
QDebug Print (QDebug os, Indent Indent=0) const
 
virtual QString ToString () const
 
virtual uint HashCode () const
 
virtual bool operator< (const Object *) const
 
void Register () const
 
void UnRegister (bool del=true) const
 
int GetReferenceCount () const
 
void SetReferenceCount (int)
 
void AddDestroyListener (const MessageAbstractDelegate<> &delegate) const
 
void RemoveDestroyListener (const MessageAbstractDelegate<> &delegate) const
 
virtual bool operator== (const Object *) const
 

Additional Inherited Members

- Public Types inherited from berry::Object
typedef Object Self
 
typedef berry::SmartPointer< SelfPointer
 
typedef berry::SmartPointer< const SelfConstPointer
 
typedef berry::WeakPointer< SelfWeakPtr
 
typedef berry::WeakPointer< const SelfConstWeakPtr
 
- Static Public Member Functions inherited from berry::Object
static const char * GetStaticClassName ()
 
static Reflection::TypeInfo GetStaticTypeInfo ()
 
static QList< Reflection::TypeInfoGetStaticSuperclasses ()
 
- Protected Member Functions inherited from berry::Object
 Object ()
 
virtual ~Object ()
 
virtual QDebug PrintSelf (QDebug os, Indent indent) const
 
virtual QDebug PrintHeader (QDebug os, Indent indent) const
 
virtual QDebug PrintTrailer (QDebug os, Indent indent) const
 
- Protected Attributes inherited from berry::Object
QAtomicInt m_ReferenceCount
 
QMutex m_ReferenceCountLock
 

Detailed Description

The progress provider supplies the job manager with progress monitors for running jobs. There can only be one progress provider at any given time.

This class is intended for use by the currently executing Eclipse application. Plug-ins outside the currently running application should not reference or subclass this class.

See also
IJobManager::SetProgressProvider(ProgressProvider::Pointer)

Definition at line 34 of file berryProgressProvider.h.

Member Function Documentation

◆ berryObjectMacro()

berry::ProgressProvider::berryObjectMacro ( ProgressProvider  )

◆ CreateMonitor() [1/2]

virtual IProgressMonitor::Pointer berry::ProgressProvider::CreateMonitor ( Job::Pointer  job)
pure virtual

Provides a new progress monitor instance to be used by the given job. This method is called prior to running any job that does not belong to a progress group. The returned monitor will be supplied to the job's Run method.

See also
CreateProgressGroup()
Job::SetProgressGroup(IProgressMonitor::Pointer, int)
Parameters
jobthe job to create a progress monitor for
Returns
a progress monitor, or null if no progress monitoring is needed.

◆ CreateMonitor() [2/2]

virtual IProgressMonitor::Pointer berry::ProgressProvider::CreateMonitor ( Job::Pointer  sptr_job,
IProgressMonitor::Pointer  sptr_group,
int  ticks 
)
virtual

Returns a progress monitor that can be used by a running job to report progress in the context of a progress group. This method implements Job.setProgressGroup. One of the two createMonitor methods will be invoked prior to each execution of a job, depending on whether a progress group was specified for the job.

The provided monitor must be a monitor returned by the method createProgressGroup. This method is responsible for asserting this and throwing an appropriate runtime exception if an invalid monitor is provided.

This default implementation returns a new SubProgressMonitor. Subclasses may override.

See also
IJobManager::CreateProgressGroup()
Job::setProgressGroup(IProgressMonitor, int)
Parameters
sptr_jobthe job to create a progress monitor for
sptr_groupthe progress monitor group that this job belongs to
ticksthe number of ticks of work for the progress monitor
Returns
a progress monitor, or null if no progress monitoring is needed.

◆ CreateProgressGroup()

virtual IProgressMonitor::Pointer berry::ProgressProvider::CreateProgressGroup ( )
virtual

Returns a progress monitor that can be used to provide aggregated progress feedback on a set of running jobs. This method implements IJobManager.createProgressGroup, and must obey all rules specified in that contract.

This default implementation returns a new NullProgressMonitor Subclasses may override.

See also
IJobManager::CreateProgressGroup()
Returns
a progress monitor

◆ GetDefaultMonitor()

virtual IProgressMonitor::Pointer berry::ProgressProvider::GetDefaultMonitor ( )
virtual

Returns a progress monitor to use when none has been provided by the client running the job.

This default implementation returns a new NullProgressMonitor Subclasses may override.

Returns
a progress monitor

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